API endpoints

https://api.omnapi.com · x-api-key · API Explorer · OpenAPI

• Account
• Audio Editing
• Lyrics
• MV
• Pricing
• Storage
• Subtitles
• Suno
• Tasks
• Usage
• Vidu Direct

Find an endpoint or field

113 operations

Permissions, billable reads and recovery rules

Music Video: Omn uses /api/v2/mv; OneClick, OneClick Turbo and Studio use /api/v1/mv. See Music Video models. Other products use their listed paths.

Account

Read the Account guide

Method and path	Operation
GET /api/v1/account/credits Success: 200	Get Account Credits

Audio Editing

Read the Audio Editing guide

Method and path	Operation
POST /api/v1/audio/renders Success: 202	Render edited audio

Lyrics

Read the Lyrics guide

Method and path	Operation
POST /api/v1/lyrics/generate Success: 200 / 202	Generate Lyrics Package

MV

Read the MV guide

Method and path	Operation
GET /api/v1/mv/ Success: 200	List MVs
POST /api/v1/mv/ Success: 200	Create MV
GET /api/v1/mv/capabilities Success: 200	Read MV generation capabilities
POST /api/v1/mv/capabilities/check Success: 200	Check one Omn V1 capability combination
POST /api/v1/mv/drafts Success: 200	Save creative draft
GET /api/v1/mv/drafts/{id} Success: 200	Read creative draft
PUT /api/v1/mv/drafts/{id} Success: 200	Save creative draft
POST /api/v1/mv/drafts/{id}/generate Success: 200	Generate MV from creative draft
POST /api/v1/mv/drafts/{id}/preflight Success: 200	Preflight creative draft
POST /api/v1/mv/drafts/{id}/preview Success: 200	Generate a ten-second creative preview
POST /api/v1/mv/drafts/{id}/preview/preflight Success: 200	Quote a ten-second creative preview
GET /api/v1/mv/fast/availability Success: 200	Get Fast MV availability
POST /api/v1/mv/preflight Success: 200	Preflight MV create
POST /api/v1/mv/quote Success: 200	Quote MV credits
GET /api/v1/mv/styles Success: 200	List MV style cards
DELETE /api/v1/mv/{mvId} Success: 200	Delete MV
GET /api/v1/mv/{mvId} Success: 200	Get MV
GET /api/v1/mv/{mvId}/final Success: 200	Get final MV download URL
POST /api/v1/mv/{mvId}/finalize Success: 200	Finalize MV
POST /api/v1/mv/{mvId}/lock-character Success: 200	Lock Studio character anchor
GET /api/v1/mv/{mvId}/operations Success: 200	List MV operations and costs
POST /api/v1/mv/{mvId}/operations/{taskId}/cancel Success: 200	Cancel MV operation
POST /api/v1/mv/{mvId}/scenes/render-batch Success: 200	Render multiple Studio scenes
PATCH /api/v1/mv/{mvId}/scenes/{sceneIndex} Success: 200	Edit Studio scene
POST /api/v1/mv/{mvId}/scenes/{sceneIndex}/regenerate-image Success: 200	Regenerate Studio scene image
POST /api/v1/mv/{mvId}/scenes/{sceneIndex}/render Success: 200	Render MV scene
PATCH /api/v1/mv/{mvId}/scenes/{sceneIndex}/select-rendering Success: 200	Select scene rendering
POST /api/v1/mv/{mvId}/upgrade Success: 202	Upgrade an Omn MV to a higher render tier
POST /api/v1/mv/{mvId}/upgrade/preflight Success: 200	Preflight an Omn MV render-tier upgrade
GET /api/v1/tasks/{taskId}/workflow Success: 200	Read MV workflow and quality review
GET /api/v1/tasks/{taskId}/workflow/artifacts Success: 200	List MV workflow artifacts
GET /api/v1/tasks/{taskId}/workflow/artifacts/{assetId} Success: 200	Read MV workflow artifact access URL
GET /api/v1/tasks/{taskId}/workflow/events Success: 200	Read MV workflow events
GET /api/v1/tasks/{taskId}/workflow/stream Success: 200	Stream durable MV workflow events
GET /api/v2/mv/ Success: 200	List Omn MVs
POST /api/v2/mv/ Success: 200	Create Omn MV
GET /api/v2/mv/capabilities Success: 200	Read Omn product options
POST /api/v2/mv/capabilities/check Success: 200	Check Omn product combination
GET /api/v2/mv/creative-projects Success: 200	List reusable creative versions
DELETE /api/v2/mv/creative-projects/{id} Success: 200	Archive a creative project
POST /api/v2/mv/drafts/ Success: 200	Save v2 creative draft
GET /api/v2/mv/drafts/{id} Success: 200	Read v2 creative draft
PATCH /api/v2/mv/drafts/{id} Success: 200	Revise v2 creative draft
POST /api/v2/mv/drafts/{id}/generate Success: 200	Generate v2 draft
POST /api/v2/mv/drafts/{id}/preflight Success: 200	Preflight v2 draft
POST /api/v2/mv/drafts/{id}/preview Success: 200	Purchase v2 draft preview
POST /api/v2/mv/drafts/{id}/preview/preflight Success: 200	Preflight paid v2 preview
POST /api/v2/mv/preflight Success: 200	Preflight Omn creation
POST /api/v2/mv/quote Success: 200	Quote Omn creation
GET /api/v2/mv/tasks/{id}/workflow Success: 200	Read v2 Omn workflow
GET /api/v2/mv/tasks/{id}/workflow/artifacts Success: 200	List v2 workflow artifacts
GET /api/v2/mv/tasks/{id}/workflow/artifacts/{assetId} Success: 200	Read v2 workflow artifact
GET /api/v2/mv/tasks/{id}/workflow/events Success: 200	Read v2 workflow events
GET /api/v2/mv/tasks/{id}/workflow/stream Success: 200	Stream v2 workflow events
DELETE /api/v2/mv/{mvId} Success: 200	Delete Omn MV
GET /api/v2/mv/{mvId} Success: 200	Read Omn MV
GET /api/v2/mv/{mvId}/final Success: 200	Read final Omn video
GET /api/v2/mv/{mvId}/final-restore Success: 200	Preview restoring all scenes from the last delivered Omn video
POST /api/v2/mv/{mvId}/final-restore Success: 200	Restore the last delivered Omn video without purchasing or composing
GET /api/v2/mv/{mvId}/operations Success: 200	Read Omn operations and charges
POST /api/v2/mv/{mvId}/operations/{taskId}/cancel Success: 200	Cancel Omn operation
POST /api/v2/mv/{mvId}/quote Success: 200	Quote Omn edit or recompose
POST /api/v2/mv/{mvId}/recompose Success: 200	Recompose Omn MV
POST /api/v2/mv/{mvId}/scenes/{sceneIndex}/edit Success: 200	Edit an Omn scene
PATCH /api/v2/mv/{mvId}/scenes/{sceneIndex}/select-rendering Success: 200	Select an Omn scene rendering
POST /api/v2/mv/{mvId}/upgrade Success: 200	Upgrade Omn output resolution
POST /api/v2/mv/{mvId}/upgrade/preflight Success: 200	Preflight and quote Omn upgrade

Pricing

Read the Pricing guide

Method and path	Operation
GET /api/v1/pricing/catalog Success: 200	Get public pricing catalog — no API key required

Storage

Method and path	Operation
GET /api/v1/storage/ Success: 200	Read monthly resource storage subscription
GET /api/v1/storage/assets Success: 200	List retained final resources
DELETE /api/v1/storage/assets/{id} Success: 200	Delete a retained final resource
GET /api/v1/storage/assets/{id}/download Success: 200	Download a retained final resource
GET /api/v1/storage/charges Success: 200	List monthly storage charges
GET /api/v1/storage/charges/{id} Success: 200	Read a monthly storage charge

Subtitles

Read the Subtitles guide

Method and path	Operation
POST /api/v1/subtitles/ Success: 200	Create subtitle extraction task
POST /api/v1/subtitles/quote Success: 200	Quote subtitle extraction
GET /api/v1/subtitles/{id} Success: 200	Get subtitle task

Suno

Read the Suno guide

Method and path	Operation
GET /api/v1/suno/assets Success: 200	List retained Suno assets
GET /api/v1/suno/assets/{id}/download Success: 200	Get a retained Suno asset download
GET /api/v1/suno/availability Success: 200	Get Suno availability
GET /api/v1/suno/clips Success: 200	Query multiple clips
GET /api/v1/suno/clips/{clipId} Success: 200	Get clip detail
GET /api/v1/suno/clips/{clipId}/audio-analysis Success: 200 / 202	Get clip audio analysis
POST /api/v1/suno/clips/{clipId}/derive Success: 200	Derive a clip
POST /api/v1/suno/clips/{clipId}/export Success: 200	Export clip audio
GET /api/v1/suno/clips/{clipId}/timeline Success: 200 / 202	Get aligned lyrics timeline
GET /api/v1/suno/generations Success: 200	List Suno generations
GET /api/v1/suno/generations/{generationId} Success: 200	Get a Suno generation
POST /api/v1/suno/lyrics Success: 200	Generate Lyrics
POST /api/v1/suno/songs Success: 200	Generate Song
GET /api/v1/suno/storage Success: 200	Inspect Suno storage policy, rate and subscription
PUT /api/v1/suno/storage Success: 200	Opt in to or cancel paid long-term audio storage
GET /api/v1/suno/storage/charges Success: 200	List Suno storage charges
GET /api/v1/suno/styles/recommend Success: 200 / 202	Recommend Styles
GET /api/v1/suno/voices Success: 200	List Voices
POST /api/v1/suno/voices Success: 200	Create Voice
POST /api/v1/suno/voices/from-clip Success: 200	Create Voice from Clip
GET /api/v1/suno/voices/verification-phrase Success: 200 / 202	Get Voice verification phrase
GET /api/v1/suno/voices/{voiceId} Success: 200 / 202	Get Voice

Tasks

Read the Tasks guide

Method and path	Operation
GET /api/v1/tasks Success: 200	List Tasks
POST /api/v1/tasks Success: 200	Create Task
POST /api/v1/tasks/sync Success: 200 / 202	Create Task (Sync)
GET /api/v1/tasks/{taskId} Success: 200	Get Task
POST /api/v1/tasks/{taskId}/cancel Success: 200	Cancel Task
GET /api/v1/tasks/{taskId}/stream Success: 200	Stream Task Status (SSE)

Usage

Read the Usage guide

Method and path	Operation
GET /api/v1/usage/export Success: 200	Export usage records (self-serve)

Vidu Direct

Read the Vidu Direct guide

Method and path	Operation
POST /api/v1/vidu/quote Success: 200	Quote a Vidu Direct operation
POST /api/v1/vidu/tasks Success: 200	Create a Vidu Direct task
GET /api/v1/vidu/tasks/{id} Success: 200	Get a Vidu Direct task
POST /api/v1/vidu/tasks/{id}/cancel Success: 200	Cancel a Vidu Direct task