Skip to main content
GET
/
playbooks
/
{id}
/
checks
/
{checkId}
Get a check
curl --request GET \
  --url https://app.gc.ai/api/external/v1/playbooks/{id}/checks/{checkId} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "description": "<string>",
  "positions": [
    {
      "guidance": "<string>"
    }
  ],
  "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

Playbook ID from GET /playbooks.

​
checkId
string<uuid>
required

Check ID from GET /playbooks/{id}/checks.

Response

Check details

​
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