Upload an ambient clip

POSThttps://server.heyrik.com/api/v1/background-audios

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Parameters 2

Fields documented for this operation. See the request example for placement and structure.

filemultipart fileRequired

Audio clip (mp3/wav).

namestring

Label used when selecting it on an agent.

Response

No response example is documented for this operation yet.

Error reference

POST/background-audios

cURL

curl -X POST https://server.heyrik.com/api/v1/background-audios \
  -H "Authorization: Bearer $HEYRIK_API_KEY" \
  -F "file=@office.mp3" \
  -F "name=Office"

Illustrative examples · No live request is sent