Skip to content

Upload a custom contest prompt

PUT
/v1/studios/{studio}/contest-prompt
curl --request PUT \
--url 'https://api.caller9.app/v1/studios/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/contest-prompt?kind=caller' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: audio/*' \
--data binary

Uploads raw audio as the override for one prompt slot, replacing any existing override for that slot. Send the audio bytes as the request body with an audio/* Content-Type (defaults to audio/mpeg if omitted). Requires a full-access key.

studio
required
string format: uuid

Studio ID (UUID).

kind
required
string
Allowed values: caller pre loser

Prompt slot — pre (pre-contest message), loser (non-winning callers), or caller (announcement for a specific caller number).

number
integer
>= 1 <= 109

Caller number for kind=caller (required then); ignored otherwise.

Media typeaudio/*
string format: binary

Prompt uploaded.

Media typeapplication/json
object
ok
required
boolean
kind
required
string
Allowed values: caller pre loser
number
required
integer | null
r2_key
required

Storage key of the uploaded audio.

string

Example

{
"ok": true,
"kind": "caller"
}

The request was invalid.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

The key isn’t allowed to do this (e.g. a read-only key making a change).

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Not found, or belongs to another organization.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Too many requests for this API key. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}
Retry-After
integer

Seconds until the rate-limit window resets.