Test exact compiled Playbook artifact

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

Authorization

sessionsessionrequired

Path parameters

agentIDstringrequired

playbookIDstringrequired

Request body

requiredapplication/json

compiler_versionstring

inputobject

modestring

plan_hashstring

playbook_version_idstring

scenariostring

source_hashstring

Responses

200OK

identityArtifactIdentityrequired

Show properties

compiler_versionstringrequired

deployment_idstring

plan_hashstringrequired

plan_step_idstring

playbook_idstringrequired

playbook_release_idstring

playbook_version_idstring

source_hashstringrequired

source_node_idstring

messagestring

okbooleanrequired

outcomestring

planPlanrequired

Show properties

compiler_versionstringrequired

entry_step_idstringrequired

execution_modestringrequired

inputsobject[] | null

resource_grantsResourceGrant[] | nullrequired

Show properties

Array of ResourceGrant

kindstringrequired

labelstring

permissionstringrequired

resource_idstringrequired

schema_versioninteger<int64>required

settingsAuthoringSettingsrequired

Show properties

max_playbook_call_depthinteger<int64>required

max_retries_per_stepinteger<int64>required

max_stepsinteger<int64>required

source_hashstringrequired

stepsPlanStep[] | nullrequired

Show properties

Array of PlanStep

branchesobject

configobject

idstringrequired

kindstringrequired

nextstring

source_node_idstring

terminal_outcomesstring[] | nullrequired

stalebooleanrequired

stepsobject[] | null

traceobject[] | null

validationValidationReportrequired

Show properties

compiled_atstring<date-time>required

compiler_versionstringrequired

diagnosticsDiagnostic[] | nullrequired

Show properties

Array of Diagnostic

codestringrequired

messagestringrequired

pathstring

severitystringrequired

source_node_idstring

okbooleanrequired

plan_hashstring

source_hashstringrequired

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/string/tests" \
  -H "Content-Type: application/json" \
  -d '{
  "compiler_version": "string",
  "input": {},
  "mode": "string",
  "plan_hash": "string",
  "playbook_version_id": "string",
  "scenario": "string",
  "source_hash": "string"
}'

const response = await fetch("/v1/ai/agents/string/playbooks/string/tests", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "compiler_version": "string",
  "input": {},
  "mode": "string",
  "plan_hash": "string",
  "playbook_version_id": "string",
  "scenario": "string",
  "source_hash": "string"
})
});

import requests

response = requests.post(
    "/v1/ai/agents/string/playbooks/string/tests",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "compiler_version": "string",
  "input": {},
  "mode": "string",
  "plan_hash": "string",
  "playbook_version_id": "string",
  "scenario": "string",
  "source_hash": "string"
},
)

Response

{
  "identity": {
    "compiler_version": "string",
    "deployment_id": "string",
    "plan_hash": "string",
    "plan_step_id": "string",
    "playbook_id": "string",
    "playbook_release_id": "string",
    "playbook_version_id": "string",
    "source_hash": "string",
    "source_node_id": "string"
  },
  "message": "string",
  "ok": true,
  "outcome": "string",
  "plan": {
    "compiler_version": "string",
    "entry_step_id": "string",
    "execution_mode": "string",
    "inputs": [
      {}
    ],
    "resource_grants": [
      {
        "kind": "string",
        "label": "string",
        "permission": "string",
        "resource_id": "string"
      }
    ],
    "schema_version": 0,
    "settings": {
      "max_playbook_call_depth": 0,
      "max_retries_per_step": 0,
      "max_steps": 0
    },
    "source_hash": "string",
    "steps": [
      {
        "branches": {},
        "config": {},
        "id": "string",
        "kind": "string",
        "next": "string",
        "source_node_id": "string"
      }
    ],
    "terminal_outcomes": [
      "string"
    ]
  },
  "stale": true,
  "steps": [
    {}
  ],
  "trace": [
    {}
  ],
  "validation": {
    "compiled_at": "2024-01-01T00:00:00Z",
    "compiler_version": "string",
    "diagnostics": [
      {
        "code": "string",
        "message": "string",
        "path": "string",
        "severity": "string",
        "source_node_id": "string"
      }
    ],
    "ok": true,
    "plan_hash": "string",
    "source_hash": "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"
  }
}