Agents API

Endpoint: /api/v1/workspaces/WORKSPACE_ID/agents. Use agents:read to list and agents:write to create, update, archive or publish.

Read and create drafts

GET returns { "data": [...] }. POST creates a draft and returns 201 with the saved agent:

curl -X POST 'https://dashboard.verbatik.com/api/v1/workspaces/WORKSPACE_ID/agents' \
  -H "Authorization: Bearer $VERBATIK_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"name":"Clinic receptionist draft","type":"single-prompt","channel":"voice","language":"en","prompt":"Answer clinic information from approved sources. Collect appointment requests for staff confirmation. Do not claim a booking was made without a successful booking tool receipt.","welcomeMessage":"Hello, you have reached the clinic assistant. How can I help?"}'

The example creates a basic draft using the default Mistral model. It does not connect a calendar, buy a number or route live calls. Use the editor to select and test the voice and integration tools before publishing.

Fields

Required: name (1–160 characters). Common fields include type (single-prompt, conversation-flow, chat), channel (voice, chat), description, language, prompt, welcomeMessage, model, voice, folder and configuration.

Managed voice engine, model and voice fields must match. Do not combine a managed engine with custom provider routing. Conversation-flow nodes need unique IDs and valid transition targets. Configuration must not contain credentials.

Update and publish

PATCH the collection with an id and changed fields. DELETE with ?id=AGENT_ID archives it. Saving a draft does not publish it.

Publish a validated version with:

curl -X POST 'https://dashboard.verbatik.com/api/v1/workspaces/WORKSPACE_ID/agents/AGENT_ID/publish' \
  -H "Authorization: Bearer $VERBATIK_API_KEY"

Success is { "data": ... }. Publishing can reject an invalid graph, unavailable required connection or invalid runtime configuration. Review the error and fix the draft; do not treat a failed request as a new deployed version.