Skip to content

Agents

An agent is a job the business has hired an agent for: answer the phone, confirm orders, chase payments. Create one from a template or a definition, update its draft, publish, and read its versions.

MethodRouteWhat it does
bots.createFromTemplatePOST /api/v1/workflows/create/templateDescribe the agent in plain words and get a working draft.
bots.createPOST /api/v1/workflows/create/definitionCreate an agent from a full definition.
bots.listGET /api/v1/workflows/fetchEvery agent in the account.
bots.summaryGET /api/v1/workflows/summaryIds and names only, for pickers.
bots.countGET /api/v1/workflows/countHow many agents the account has.
bots.getGET /api/v1/workflows/fetch/{workflow_id}One agent: its draft if it has one, else what is live.
bots.updatePUT /api/v1/workflows/{workflow_id}Save the draft.
bots.validatePOST /api/v1/workflows/{workflow_id}/validateCheck a definition before publishing.
bots.publishPOST /api/v1/workflows/{workflow_id}/publishMake the draft the live version.
bots.createDraftPOST /api/v1/workflows/{workflow_id}/create-draftStart a draft from what is live.
bots.versionsGET /api/v1/workflows/{workflow_id}/versionsEvery version, newest first.
bots.restoreVersionPOST /api/v1/workflows/{workflow_id}/versions/{version_id}/restoreCopy an older version into the draft.
bots.setLivePUT /api/v1/workflows/{workflow_id}/liveTurn an agent on or off for calls.
bots.setStatusPUT /api/v1/workflows/{workflow_id}/statusArchive or restore an agent.
bots.duplicatePOST /api/v1/workflows/{workflow_id}/duplicateCopy an agent.
bots.callOutcomesGET /api/v1/workflows/call-outcomesEvery outcome label the account’s calls can carry.