Run analyzers again over a Call

POST /v1/calls/{call_id}/analyses

Schedules a new run of the named analyzers, or of every analyzer the Call's Agent version binds, over the Call's stored transcript as a call.analyze job, and answers 202 with the analyses pending (1.56.0; workspace ADR 0052 decisions 8 and 9). A Call with no stored transcript, not finalized, scrubbed or of an Organization whose retention keeps none, is 409 transcript_unavailable with its reason. A reserved analyzer is 422 capability_not_available with analyzer_kind_not_available; the other issues are validation_failed, from 1.58.0 with the codes of AnalysisRerunIssueCode: analysis_none_bound when no analyzer is named and the Agent version binds none. A re-run is priced at the price in force when it is requested and checks the spend cap (402 spend_cap_reached), where scheduled analyses run past it. Each settled run emits analysis.completed or analysis.failed, and call.analyzed fires again once the re-run settles.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the calls:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/calls/call_.../analyses" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/calls/call_.../analyses`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/calls/call_.../analyses",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: AnalysisRequest.

Responses

Fields of the 202 answer

The shape is AnalysisRerun.