ORorshot
Audio

Upload Audio

Changed on

Learn how to upload brand audio to your workspace

post/brand-assets/audio/add

Request

  • Base URL
    https://api.orshot.com/v1
  • URL
    https://api.orshot.com/v1/brand-assets/audio/add
  • Auth
    HTTP bearer

Query parameters

embedIdstring

Embed instance ID. Pair with embedUserId to scope this call to one embed user

embedUserIdstring

The same userId your app passes to the embed URL. Requires embedId

Request body multipart/form-data

filestring required

URL, base64-encoded string, or binary upload of the audio file

namestring

Custom name for the audio. Defaults to the uploaded file's name for multipart uploads. URL and base64 uploads get an auto-generated name

tagsstring[]

Array of tags to associate with the audio (e.g., ["intro", "music"])

metadataobject

Custom metadata to attach to the audio (can include duration)

Response

Successful response

object required

Changes

  • a0c2c3003dc0Revision changes
    • info

      added the non-success response with the status

  • b2284a52aaadRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status