Skip to main content
POST
Add a check to a playbook

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

Playbook ID from GET /playbooks.

Body

application/json
title
string
required

Check title (required, non-empty).

Minimum string length: 1
Example:

"Limitation of liability"

positions
object[]
required

The check's positions: exactly one standard position plus any number of fallback positions.

Minimum array length: 1
description
string | null

Optional internal description.

importance
enum<string> | null

Optional priority within the playbook.

Available options:
low,
medium,
high,
null

Response

Check created

id
string<uuid>
required

Unique check identifier

title
string
required

Check title

description
string | null
required

Optional internal description, or null if unset

importance
enum<string> | null
required

Priority of this check within the playbook, or null if unset

Available options:
low,
medium,
high,
null
positions
object[]
required

The check's positions: one standard stance plus any fallbacks.

created_at
string | null
required

ISO 8601 creation timestamp

updated_at
string | null
required

ISO 8601 last-update timestamp