Skip to content

Calls

A call is one run of an agent on a phone line. Start one from your backend, list what happened, and fetch the transcript, recording and outcome.

MethodRouteWhat it does
calls.startPOST /api/v1/public/agent/{uuid}Place a call with an agent, by its public id.
calls.startTestPOST /api/v1/public/agent/test/{uuid}Place a test call that runs the draft.
calls.startByWorkflowPOST /api/v1/public/agent/workflow/{workflow_uuid}Place a call by workflow id.
calls.createPOST /api/v1/workflows/{workflow_id}/runsCreate a run for an agent (voice, text or web).
calls.listGET /api/v1/workflows/{workflow_id}/runsRuns of one agent, newest first.
calls.getGET /api/v1/workflows/{workflow_id}/runs/{run_id}One run: status, outcome, artifacts.
calls.listAllGET /api/v1/organizations/usage/runsEvery run in the account, across agents, with cost.
calls.artifactGET /api/v1/public/download/workflow/{token}/{artifact_type}Download a recording or transcript with a signed token.
calls.initiatePOST /api/v1/telephony/initiate-callDial a number with an agent through a telephony configuration.