Validate a playbook definition

View as Markdown

Statelessly validates a playbook body (tasks, dependencies, start form, orchestrator) without persisting it, returning whether it is valid and any issues.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Request

This endpoint expects an object.
slugstringRequiredformat: "^[a-z][a-zA-Z0-9]*$"1-64 characters
namestringRequired1-200 characters
iconstringRequired1-64 characters
numberingobjectRequired
descriptionstringOptional<=5000 charactersDefaults to
colorstring or nullOptional
startableByUsersbooleanOptionalDefaults to true
orchestratorobjectOptionalDefaults to {"enabled":true,"model":{"provider":"anthropic","model":"claude-sonnet-4-6"},"autoTriggerActions":true,"autoTriggerAgentic":true,"autoTriggerDocumentTasks":true,"chatEnabled":true}
startFormobject or nullOptional
taskslist of objectsOptionalDefaults to []
dependencieslist of objectsOptionalDefaults to []

Response

The validation result (ok plus any issues).

okboolean
issueslist of maps from strings to any

Errors

400
Bad Request Error
401
Unauthorized Error