Skip to main content
PATCH
/
playbooks
/
{id}
Update a playbook
curl --request PATCH \
  --url https://app.gc.ai/api/external/v1/playbooks/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "guide": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "description": "<string>",
  "guide": "<string>",
  "is_official": true,
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Path Parameters

​
id
string<uuid>
required

The playbook ID

Body

application/json
​
title
string

New title (non-empty).

Minimum string length: 1
​
description
string | null

New description, or null to clear.

​
guide
string | null

New guide text, or null to clear.

Response

Updated playbook

​
id
string<uuid>
required

Unique playbook identifier

​
title
string
required

Playbook title

​
description
string | null
required

Playbook description, or null if unset

​
guide
string | null
required

Free-text guidance applied across the whole playbook when it runs, or null if unset.

​
is_official
boolean
required

Whether this is an official GC AI playbook

​
status
enum<string>
required

Playbook processing status

Available options:
draft,
processing,
completed,
failed
​
created_at
string | null
required

ISO 8601 creation timestamp

​
updated_at
string | null
required

ISO 8601 last-update timestamp