One analysed recording

GET /speech/calls/{id}

One analysed recording

cURL

curl --request GET \
  --url https://api.pineyard.ai/speech/calls/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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>"
  },
  "audioUrl": "<string>",
  "outcomeRationale": "<string>",
  "observations": "<string>",
  "areasForImprovement": "<string>",
  "transcript": [
    {}
  ],
  "extractions": [
    {}
  ],
  "analytics": [
    {}
  ],
  "tags": [
    {}
  ],
  "udfs": {},
  "talkRatio": 123,
  "silenceRatio": 123,
  "interruptions": 123,
  "wordsPerMinute": 123
}

Required scope: speech.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Response

200

application/json

OK

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

audioUrl · string | null · required

outcomeRationale · string | null · required

observations · string | null · required

areasForImprovement · string | null · required

transcript · object[] | null · required

Show child attributes

extractions · object[] | null · required

Show child attributes

analytics · object[] | null · required

Show child attributes

tags · object[] | null · required

Show child attributes

udfs · object · required

Show child attributes

talkRatio · number | null · required

silenceRatio · number | null · required

interruptions · number | null · required

wordsPerMinute · number | null · required