Skip to navigation

Create a voice test draft

Hold an unsaved agent definition for about 15 minutes so a browser voice call can run it instead of the saved agent, without saving or publishing. The body is merged onto the saved agent exactly as PUT /agents/{id} would merge it, and nothing is written to the agent. Runtype agents only; the merged config must have voice enabled.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.
configobjectOptional
descriptionstringOptional
namestringOptional>=1 character

Response

Draft created
draftIdstring

Pass as the agentDraftId query parameter when opening /ws/agents/{id}/voice to run this draft.

expiresAtstring
After this time the draft can no longer start a call. A call already running keeps it.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error