GCgc-ai
Playbooks

Get a playbook

Retrieve a single playbook by ID, including its guide text.

User-scoped keys can read playbooks they created, playbooks shared with them, org-visible playbooks, and official playbooks. Org-scoped keys can read org-visible and official playbooks, but not private ones.

get/playbooks/{id}

Request

Path parameters

idstring uuid required

Playbook ID from GET /playbooks.

Response

Playbook details

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

Changes

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