Create AI playbook

POST/v1/ai/agents/{agentID}/playbooks

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

agentIDstringrequired

Request body

requiredapplication/json

descriptionstring

input_schemaobject

instructionsstring

namestringrequired

Responses

200OK

agent_idstringrequired

created_atstringrequired

current_versioninteger<int32>required

current_version_idstring

descriptionstring

idstringrequired

latest_draftPlaybookVersion

Show properties

agent_idstringrequired

created_atstringrequired

idstringrequired

input_schemaobjectrequired

instructionsstringrequired

playbook_idstringrequired

published_atstring

versioninteger<int32>required

namestringrequired

statusstringrequired

successRatenumber<double>required

summarystringrequired

triggerstringrequired

updatedAtstringrequired

updated_atstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

409Conflict

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/ai/agents/string/playbooks" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "input_schema": {},
  "instructions": "string",
  "name": "string"
}'

const response = await fetch("/v1/ai/agents/string/playbooks", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "description": "string",
  "input_schema": {},
  "instructions": "string",
  "name": "string"
})
});

import requests

response = requests.post(
    "/v1/ai/agents/string/playbooks",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "description": "string",
  "input_schema": {},
  "instructions": "string",
  "name": "string"
},
)

Response

{
  "agent_id": "string",
  "created_at": "string",
  "current_version": 0,
  "current_version_id": "string",
  "description": "string",
  "id": "string",
  "latest_draft": {
    "agent_id": "string",
    "created_at": "string",
    "id": "string",
    "input_schema": {},
    "instructions": "string",
    "playbook_id": "string",
    "published_at": "string",
    "version": 0
  },
  "name": "string",
  "status": "string",
  "successRate": 0,
  "summary": "string",
  "trigger": "string",
  "updatedAt": "string",
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}