Skip to main content
POST
/
playbooks
Create a playbook
curl --request POST \
  --url https://app.gc.ai/api/external/v1/playbooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Vendor NDA review",
  "description": "<string>",
  "guide": "<string>"
}
'
import requests

url = "https://app.gc.ai/api/external/v1/playbooks"

payload = {
"title": "Vendor NDA review",
"description": "<string>",
"guide": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({title: 'Vendor NDA review', description: '<string>', guide: '<string>'})
};

fetch('https://app.gc.ai/api/external/v1/playbooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.gc.ai/api/external/v1/playbooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'Vendor NDA review',
'description' => '<string>',
'guide' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://app.gc.ai/api/external/v1/playbooks"

payload := strings.NewReader("{\n \"title\": \"Vendor NDA review\",\n \"description\": \"<string>\",\n \"guide\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.gc.ai/api/external/v1/playbooks")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Vendor NDA review\",\n \"description\": \"<string>\",\n \"guide\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.gc.ai/api/external/v1/playbooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Vendor NDA review\",\n \"description\": \"<string>\",\n \"guide\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "description": "<string>",
  "guide": "<string>",
  "is_official": true,
  "created_at": "<string>",
  "updated_at": "<string>"
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}

Authorizations

Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Body

application/json
title
string
required

Playbook title (required, non-empty).

Minimum string length: 1
Example:

"Vendor NDA review"

description
string | null

Optional human-facing description.

guide
string | null

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

Response

Playbook created

id
string<uuid>
required

Unique playbook identifier

title
string
required

Playbook title

description
string | null
required

Playbook description, or null if unset

guide
string | null
required

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

is_official
boolean
required

Whether this is an official GC AI playbook

status
enum<string>
required

Playbook processing status

Available options:
draft,
processing,
completed,
failed
created_at
string | null
required

ISO 8601 creation timestamp

updated_at
string | null
required

ISO 8601 last-update timestamp