Analyse a Pineyard call

Analyse a call placed by Pineyard. No upload is needed: the recording is already stored.

POST /speech/calls/analyse-call

Analyse a Pineyard call

cURL

curl --request POST \
  --url https://api.pineyard.ai/speech/calls/analyse-call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scorecardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

202

{
  "id": "<string>",
  "status": "UPLOADING",
  "fileName": "<string>",
  "fileSizeBytes": 123,
  "durationSeconds": 123,
  "score": 123,
  "outcomeLabel": "<string>",
  "summary": "<string>",
  "errorMessage": "<string>",
  "callDate": "<string>",
  "createdAt": "<string>",
  "completedAt": "<string>",
  "rep": {
    "id": "<string>",
    "name": "<string>"
  },
  "scorecard": {
    "id": "<string>",
    "name": "<string>"
  }
}

Required scope: speech.upload

Requires speech analysis enabled for your workspace. Otherwise the request is refused; see Errors.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

scorecardId · string<uuid> · required

callId · string<uuid>

campaignContactId · string<uuid>

Response

202

application/json

Accepted

id · string · required

status · enum<string> · required

Available options: UPLOADING, PROCESSING, COMPLETED, FAILED, INGEST_FAILED

fileName · string · required

fileSizeBytes · number · required

durationSeconds · number | null · required

score · number | null · required

outcomeLabel · string | null · required

summary · string | null · required

errorMessage · string | null · required

callDate · string | null · required

createdAt · string · required

completedAt · string | null · required

rep · object · required

Show child attributes

scorecard · object · required

Show child attributes