Skip to main content
POST
Upload a recording for analysis
Required scope: speech.upload Idempotency: an Idempotency-Key header is required when calling with an API key. See Idempotency.
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.

Headers

Idempotency-Key
string
required

Unique value (e.g. a UUID) per action, up to 200 printable ASCII characters. Reuse it only to retry the same request; the first response is replayed for 24 hours.

Maximum string length: 200
Example:

"f1d2c3b4-0000-4000-8000-000000000000"

Body

multipart/form-data
file
file
required
repId
string
required
scorecardId
string
required
callDate
string
udfs
string

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