Playbooks

Create a playbook

Create a new, empty playbook. Add checks to it with the check endpoints, then run it against files.

With a user-scoped key, the caller is recorded as the creator and the playbook is private to them. With an org-scoped key, the playbook is org-visible (any member of the organization can read and manage it) and has no individual creator.

post/playbooks

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/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

titlestring required

Playbook title (required, non-empty).

descriptionstring nullable

Optional human-facing description.

guidestring nullable

Optional free-text guidance applied across the whole playbook when it runs.

Example request

{
  "title": "Vendor NDA review"
}

Response

Playbook created

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.