List AI playbooks

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

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

agentIDstringrequired

Responses

200OK

itemsPlaybookView[] | nullrequired

Show properties

Array of PlaybookView

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

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 GET "/v1/ai/agents/string/playbooks"

const response = await fetch("/v1/ai/agents/string/playbooks", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/ai/agents/string/playbooks",
)

Response

{
  "items": [
    {
      "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"
  }
}