Skip to main content
POST
Upload a case's audio

Authorizations

Authorization
string
header
required

Send Authorization: Bearer YOUR_API_KEY. The key resolves to a single organization.

Path Parameters

id
string<uuid>
required

Benchmark id.

Body

application/json
caseId
string<uuid>
required

The audio case.

action
enum<string>
default:start
Available options:
start,
complete
uploadId
string<uuid>

complete: the uploadId that start returned.

contentType
string

start: the file's audio MIME type.

Pattern: ^audio\/[A-Za-z0-9.+-]+$
byteSize
integer

start: the file size in bytes.

Required range: 1 <= x <= 209715200
durationSeconds
number

start: the clip length, if known.

Required range: x <= 1800
fileName
string
Maximum string length: 255
audioBase64
string

start: the whole file, base64 (≤ 3 MB decoded). Completes the upload in one call.

Maximum string length: 4194308

Response

Successful response.

An audio upload for one audio case.

uploadId
string
required
caseId
string
required
revision
integer
required

The case revision the clip belongs to.

status
enum<string>
required

awaiting_upload until complete; preparing while the clip is normalized; then ready or failed.

Available options:
awaiting_upload,
preparing,
ready,
failed
upload
object | null
required

Where to PUT the bytes. Null once the upload is complete.

contentType
string | null
required
byteSize
integer | null
required
durationSeconds
number | null
required
maxBytes
integer
required
maxSeconds
integer
required
error
string | null
required
{key}
any