Calls

Test Analytics

POSThttps://voxa.abhinavyadav.in/api/v1/agents/{agent_id}/analytics/test

Run summary and extraction on a call or transcript and return the result. Nothing is saved.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the agents.edit permission.

X-API-KeyAuthorization: Beareragents.edit

Path parameters

agent_idstringrequired

The agent's id.

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

call_idstring

a call of this workspace to analyse

transcriptstring

or a transcript to analyse instead

at most 50000 characters

analyticsobject | null

settings to try (default: the saved ones)

Show child attributes

summarizebooleandefault: false

Write a short summary of the call.

extractionsobject[]

at most 50 items

Show item attributes

keystringrequired

the JSON key, e.g. lead_status

matches ^[a-z][a-z0-9_]{0,39}$

labelstring

at most 80 characters

typeenum<string>default: "text"

One of:textnumberbooleanchoicedatelist

descriptionstring

what to extract and how

at most 600 characters

choicesobject[]

at most 20 items

Show item attributes

valuestringrequired

1 to 60 characters

whenstring

at most 300 characters

extraction_promptstring

What to pull out of the transcript, in plain words; saved as JSON in extracted.

at most 4000 characters

Response

200Success.

No body.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request POST \ --url 'https://voxa.abhinavyadav.in/api/v1/agents/{agent_id}/analytics/test?timezone=Asia/Kolkata' \ --header 'X-API-Key: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "call_id": "", "transcript": "", "analytics": null }'

import requests url = "https://voxa.abhinavyadav.in/api/v1/agents/{agent_id}/analytics/test" params = { "timezone": "Asia/Kolkata", } headers = { "X-API-Key": "<api-key>", } payload = { "call_id": "", "transcript": "", "analytics": None, } response = requests.post(url, params=params, headers=headers, json=payload) print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/agents/{agent_id}/analytics/test?timezone=Asia/Kolkata", { method: "POST", headers: { "X-API-Key": "<api-key>", "Content-Type": "application/json", }, body: JSON.stringify({ "call_id": "", "transcript": "", "analytics": null }), }) const data = await response.json() console.log(response.status, data)