drafts

Edit a draft

Apply typed edits to a draft in order. Send the revision you last read to prevent overwriting another editor’s changes.

Send {draft_id, expected_revision, edits}. Edits are typed and applied in order. Read node IDs from drafts_get.

Common edits include:

  • agent.telephony with value: {trunkId, from}.
  • flow.prompt with text for the global prompt.
  • node.instruction with component_id, node_id and instruction: {type: "prompt" | "static_text", text}; use component_id: null for the main flow.
  • agent.settings with values and clear.
  • agent.provider with role (llm, stt or tts) and changes.
  • notification.put with the signed webhook configuration.

For incoming caller context, define a dedicated phone POST action with action.put, effect_key idempotency and timeout_ms at most 10000. Bind it with phone.inbound_context and value: {action_id, variables: ["customer_name", "noCallerIdMatch"]}. The action runs before speech, receives {event: "call_inbound", call_inbound: {agent_id, agent_version, from_number, to_number}} and returns {call_inbound: {dynamic_variables: string_map, reject?: boolean}}.

An existing Retell-verified endpoint can use auth.scheme: "retell_signature" with a pinned http_auth secret. Other HTTP authentication schemes are also supported. Set the context binding’s value to null to remove it.

A validation diagnostic’s fixes[].edits can be submitted as draft edits against the revision you validated.

patch/api/v1/agents/{agent_id}/draft

Request

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

Path parameters

agent_idstring required

Request body

draft_idstring uuid required
expected_revisioninteger required

Response

Apply domain edits to the draft (revision compare-and-set)

draft_idstring uuid required
revisioninteger required
base_versioninteger nullable required
published_revisioninteger nullable required
updated_atstring date-time required

Changes

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