Update Audio Tags

Learn how to update tags on a brand audio file

Published ·Updated


Overview#

This endpoint allows you to update the tags on a specific brand audio file in your workspace.

https://api.orshot.com/v1/brand-assets/audio/update/:id

Request#

await fetch("https://api.orshot.com/v1/brand-assets/audio/update/42", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    tags: ["intro", "music", "upbeat"],
  }),
});

Path Parameters#

ParameterTypeRequiredDescription
idNumberYesThe unique identifier of the audio to update

Request Parameters#

ParameterTypeRequiredDescription
tagsString[]YesArray of tags to set on the audio (replaces any existing tags)

Notes#

  • Tags are automatically normalized: trimmed, deduplicated (case-insensitive), and empty values are removed
  • Passing an empty array [] will clear all tags from the audio

Error Responses#

Audio Not Found (404)#

{
  "error": "Audio not found"
}

Invalid Tags (400)#

{
  "error": "\"tags\" must be an array of strings"
}

Query Parameters#

ParameterTypeRequiredDescription
embedIdStringNoEmbed instance ID. Pair with embedUserId to scope this call to one embed user
embedUserIdStringNoThe same userId your app passes to the embed URL. Requires embedId

Per-User Libraries#

Pass embedId and embedUserId together to target only that embed user's audio, so one user's ID can never retag another's. This is how one embed serves many brands or tenants, each with its own brand space.

Omit them and this endpoint behaves exactly as documented above. See Per-User Brand Assets for the full picture.

Rate Limits#

  • 30 requests per minute per endpoint

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key
  • Image, PDF and video generation via API
  • Visual editor with AI and smart layouts
  • Zapier, Make, MCP and 50+ integrations
  • White-label embed for your own app
  • 30 free credits — no credit card required