Skip to main content
GET
/
api
/
v1
/
voc
/
tenants
/
{tenantId}
/
recording
/
{jobId}
/
status
Get VOC job status
curl --request GET \
  --url https://platform.crescendo.ai/api/v1/voc/tenants/{tenantId}/recording/{jobId}/status \
  --header 'Authorization: Bearer <token>'
{
  "id": "job-voc-001",
  "status": "started",
  "started": 1769557000000,
  "file": "tenant-alpha/ingest/queue/uploads/call-123.mp3",
  "recordingId": "call-123"
}

Documentation Index

Fetch the complete documentation index at: https://docs.crescendo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to poll the status of a previously uploaded recording.

​
Status values

  • started
  • completed
  • failed

​
Example: poll with curl

export CRESCENDO_TENANT_ID="tenant-alpha"
export CRESCENDO_API_KEY="YOUR_API_KEY"
export VOC_JOB_ID="job-voc-001"

curl -sS \
  -H "Authorization: Bearer $CRESCENDO_API_KEY" \
  "https://platform.crescendo.ai/api/v1/voc/tenants/$CRESCENDO_TENANT_ID/recording/$VOC_JOB_ID/status"

​
Example: poll until completion (bash)

while true; do
  body="$(curl -sS -H "Authorization: Bearer $CRESCENDO_API_KEY" \
    "https://platform.crescendo.ai/api/v1/voc/tenants/$CRESCENDO_TENANT_ID/recording/$VOC_JOB_ID/status")"

  status="$(node -e "console.log(JSON.parse(process.argv[1]).status)" "$body")"
  echo "status=$status"

  if [ "$status" = "completed" ] || [ "$status" = "failed" ]; then
    break
  fi
  sleep 5
done

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tenantId
string
required

Tenant identifier.

​
jobId
string
required

VOC job execution identifier returned by the upload endpoint.

Response

OK

VOC job status payload. Fields may vary depending on job stage.

​
id
string
required
​
status
enum<string>
required
Available options:
started,
completed,
failed
​
started
integer<int64>
required
​
finished
integer<int64> | null
​
file
string | null
​
recordingId
string | null
​
result
object
​
error
string | null