Playbooks

Update a playbook

Update a playbook's title, description, or guide. At least one field is required.

User-scoped keys require write access to the playbook. Org-scoped keys can update org-visible (non-private) playbooks.

patch/playbooks/{id}

Request

Base URL
https://app.gc.ai/api/external/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/playbooks/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

The playbook ID

titlestring

New title (non-empty).

descriptionstring nullable

New description, or null to clear.

guidestring nullable

New guide text, or null to clear.

Updated playbook

idstring uuid required

Unique playbook identifier

titlestring required

Playbook title

descriptionstring nullable required

Playbook description, or null if unset

guidestring nullable required

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

is_officialboolean required

Whether this is an official GC AI playbook

status'draft' | 'processing' | 'completed' | 'failed' required

Playbook processing status

created_atstring nullable required

ISO 8601 creation timestamp

updated_atstring nullable required

ISO 8601 last-update timestamp

No recorded changes to this operation across all 1 revision of this API.