Create executable Playbook with mutable Draft

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

Authorization

sessionsessionrequired

Path parameters

agentIDstringrequired

Request body

requiredapplication/json

authoring_sourceany

descriptionstring

namestringrequired

template_keystring

Responses

200OK

draftDraftrequired

Show properties

agent_idstringrequired

authoring_sourceAuthoringSourcerequired

Show properties

documentAuthoringDocumentrequired

Show properties

jsonany

textstring

typestringrequired

execution_modestringrequired

guardrailsany[] | null

legacyobject

outcomeAuthoringOutcomerequired

Show properties

goalstringrequired

terminal_outcomesstring[] | nullrequired

schema_versioninteger<int64>required

settingsAuthoringSettingsrequired

Show properties

max_playbook_call_depthinteger<int64>required

max_retries_per_stepinteger<int64>required

max_stepsinteger<int64>required

success_checksany[] | null

triggerAuthoringTriggerrequired

Show properties

conditionsobject[] | nullrequired

examplesstring[] | nullrequired

created_atstringrequired

descriptionstring

last_validationany

namestring

organization_idstringrequired

plain_instructionsstringrequired

playbook_idstringrequired

revisioninteger<int64>required

schema_versioninteger<int64>required

source_hashstringrequired

statusstring

updated_atstringrequired

playbookPlaybookMetarequired

Show properties

AgentIDstringrequired

CreatedAtstringrequired

CurrentVersionIDstring | nullrequired

Descriptionstringrequired

IDstringrequired

LatestPublishedVersionIDstring | nullrequired

Namestringrequired

Statusstringrequired

UpdatedAtstringrequired

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/executable" \
  -H "Content-Type: application/json" \
  -d '{
  "authoring_source": "string",
  "description": "string",
  "name": "string",
  "template_key": "string"
}'

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

import requests

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

Response

{
  "draft": {
    "agent_id": "string",
    "authoring_source": {
      "document": {
        "json": "string",
        "text": "string",
        "type": "string"
      },
      "execution_mode": "string",
      "guardrails": [
        "string"
      ],
      "legacy": {},
      "outcome": {
        "goal": "string",
        "terminal_outcomes": [
          "string"
        ]
      },
      "schema_version": 0,
      "settings": {
        "max_playbook_call_depth": 0,
        "max_retries_per_step": 0,
        "max_steps": 0
      },
      "success_checks": [
        "string"
      ],
      "trigger": {
        "conditions": [
          {}
        ],
        "examples": [
          "string"
        ]
      }
    },
    "created_at": "string",
    "description": "string",
    "last_validation": "string",
    "name": "string",
    "organization_id": "string",
    "plain_instructions": "string",
    "playbook_id": "string",
    "revision": 0,
    "schema_version": 0,
    "source_hash": "string",
    "status": "string",
    "updated_at": "string"
  },
  "playbook": {
    "AgentID": "string",
    "CreatedAt": "string",
    "CurrentVersionID": "string",
    "Description": "string",
    "ID": "string",
    "LatestPublishedVersionID": "string",
    "Name": "string",
    "Status": "string",
    "UpdatedAt": "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"
  }
}