drafts

Validate a draft

Compile a draft and read its diagnostics, next version number and digest. Resolve error diagnostics before publishing.

Send {draft_id, expected_revision}. The response includes ok, version, digest and diagnostics. Use the returned version when publishing. Set include_plan: true to also receive the compiled public plan for review when validation succeeds.

When ok is false, resolve the error diagnostics. If a diagnostic supplies fixes[].edits, apply them with drafts_edit against the validated revision, then validate again. telephony_* warnings explain why a phone call would be refused.

post/api/v1/agents/{agent_id}/draft/validate

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/agents/{agent_id}/draft/validate
  • Auth: HTTP bearer

Path parameters

agent_idstring required

Request body

draft_idstring uuid required
expected_revisioninteger required
include_planboolean

Response

Compile the draft and return diagnostics and the would-be digest

okboolean required
versioninteger required
digeststring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.