For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Register a media URL as a reusable asset and get back its id. Use the id in generation inputs (input[].assetId) or as a voice clone sample. To upload a local file, first request a presigned URL via POST /v2/assets/upload, PUT the file there, then register the returned url here. Registration verifies the upload happened and enforces plan limits on the actual file size.
projectId is optional. When provided it must reference a project in your organization — a stale or foreign id is rejected with a 422 and errorCode project_not_found; omit the field if you don’t need the asset attached to a project.
Authentification
x-api-keystring
Authentification par clé API via en-tête
Requête
This endpoint expects an object.
urlstringRequis
The public URL of the media to register — e.g. the url returned by POST /v2/assets/upload. Registration verifies the upload happened and enforces plan limits on the actual file size.
typeenumRequis
The type of asset.
Valeurs autorisées:
namestringOptionnel
An optional display name for the asset.
visibilityenumOptionnelPar défaut USER
Who can see the asset. Defaults to USER.
Valeurs autorisées:
projectIdstringOptionnel
Optionally attach the asset to a project (created via POST /v2/projects) so it appears in Studio under that project's media. Must reference a project in your organization — otherwise the request is rejected with 422.
inputTypeenumOptionnel
The source of the asset.
thumbnailUrlstring or nullOptionnel
Optional thumbnail URL for the asset.
sizelongOptionnel
File size in bytes.
formatstringOptionnel
File format or extension.
durationSecondsdoubleOptionnel
Media duration in seconds.
widthintegerOptionnel
Width in pixels for video or image assets.
heightintegerOptionnel
Height in pixels for video or image assets.
Réponse
Asset registered successfully
idstring
A unique identifier for an asset.
createdAtdatetime
The date and time the asset was created.
updatedAtdatetime
The date and time the asset was last updated.
typeenum
The type of asset file.
Valeurs autorisées:
visibilityenum
Visibility scope for the asset.
Valeurs autorisées:
namestringOptionnel
The filename of the asset.
urlstringOptionnel
The URL to access the asset media.
sizelongOptionnel
File size in bytes.
formatstringOptionnel
File format/extension (e.g., "mp4", "wav").
inputTypeenumOptionnel
The source type of the asset.
durationSecondsdoubleOptionnel
Duration of the media in seconds (for audio/video).
thumbnailUrlstringOptionnel
URL to the asset's thumbnail image.
widthintegerOptionnel
Width in pixels (for video/image).
heightintegerOptionnel
Height in pixels (for video/image).
projectIdstringOptionnel
The id of the project this asset is attached to, or null when it belongs to no project.
proxyPathstring or nullOptionnel
Stable API proxy path for authenticated media playback.
