Skip to main content
POST
Analyse a Pineyard call
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

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
scorecard
object
required