limitquery · OptionalList Omn videos
/api/v2/mv/videosAuthentication · x-api-key
Your Omn videos, newest first. Pass nextCursor as cursor for the next page.
Scope: task:read
Billing and effects: Free resource read; no generation purchase.
Recovery: Read the current resource before retrying a mutation; do not assume this operation supports Idempotency-Key.
Follow this operation’s workflow → · All permission rulesOmn music video endpoint. Check capabilities and preflight before purchasing. How Music Video requests work
Request
Query parameters
cursorquery · OptionalOpaque pagination cursor returned as nextCursor; omit it on the first page.
Format: date-time.Responses
Read the HTTP status and body together. A receipt confirms acceptance; poll the returned Task or product view for terminal execution and media delivery. Example IDs and credit amounts are illustrative, not a price quote.
HTTP 401 · Request rejected; correct the key before retrying
Complete JSON example (optional fields may be omitted).
{ "success": false, "error": { "code": "INVALID_API_KEY", "message": "Invalid API key" }}200 OK
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 200 ·
itemsRequiredarray<object>Videos, newest first.
1 field
-
Response 200 ·
items[]Each itemobject11 fields
-
Response 200 ·
items[].createdAtRequiredstringCreation time (ISO 8601).
-
Response 200 ·
items[].failureRequiredobject | nullWhy the video failed; null unless status is failed.
May be null. Use a complete option below; the value must satisfy at least one option.
2 options
-
Response 200 ·
Option 1 — requires code, message, retryableOptionobjectWhy the video failed; null unless status is failed.
3 fields
-
Response 200 ·
items[].failure.codeRequiredstring | nullError code.
May be null. Use a complete option below; the value must satisfy at least one option.
2 options
-
Response 200 ·
Option 1 — stringOptionstringError code.
-
Response 200 ·
Option 2 — nullOptionnull
-
-
Response 200 ·
items[].failure.messageRequiredstring | nullHuman-readable reason.
May be null. Use a complete option below; the value must satisfy at least one option.
2 options
-
Response 200 ·
Option 1 — stringOptionstringHuman-readable reason.
-
Response 200 ·
Option 2 — nullOptionnull
-
-
Response 200 ·
items[].failure.retryableRequiredbooleanWhether buying again may succeed unchanged.
-
-
Response 200 ·
Option 2 — nullOptionnull
-
-
Response 200 ·
items[].idRequiredstringVideo id.
-
Response 200 ·
items[].linksRequiredobjectRelated resources.
5 fields
-
Response 200 ·
items[].links.chargesRequiredstringCharges and refunds.
-
Response 200 ·
items[].links.eventsRequiredstringSSE progress stream.
-
Response 200 ·
items[].links.fileRequiredstring | nullDelivered file link; null until completed.
May be null. Use a complete option below; the value must satisfy at least one option.
2 options
-
Response 200 ·
Option 1 — stringOptionstringDelivered file link; null until completed.
-
Response 200 ·
Option 2 — nullOptionnull
-
-
Response 200 ·
items[].links.selfRequiredstringThis video.
-
Response 200 ·
items[].links.shotsRequiredstringPer-shot progress.
-
-
Response 200 ·
items[].priceRequiredobject | nullCharge and refund so far.
May be null. Use a complete option below; the value must satisfy at least one option.
2 options
-
Response 200 ·
Option 1 — requires credits, refundedCreditsOptionobjectCharge and refund so far.
2 fields
-
Response 200 ·
items[].price.creditsRequirednumberCredits charged.
Minimum: 0.
-
Response 200 ·
items[].price.refundedCreditsRequirednumberCredits refunded.
Minimum: 0.
-
-
Response 200 ·
Option 2 — nullOptionnull
-
-
Response 200 ·
items[].progressRequirednumberProgress percent.
Minimum: 0. Maximum: 100.
-
Response 200 ·
items[].specRequiredobjectWhat was bought.
4 fields
-
Response 200 ·
items[].spec.creativeRequiredobjectWhat the video shows.
Only the listed fields are accepted in this object.
5 fields
-
Response 200 ·
items[].spec.creative.briefOptionalstringWhat the video shows: story, setting, people, events.
Maximum characters: 3000.
-
Response 200 ·
items[].spec.creative.modeOptional"auto" | "sing" | "story" | "mood"auto: Omn chooses the direction and whether people appear (no singing). sing: the referenced performer sings the song (lip-synced, requires references.performer). story: a narrative from the lyrics or brief (requires storySource). mood: atmospheric visuals.
Default: "auto".
-
Response 200 ·
items[].spec.creative.peopleOptional"auto" | "none"none: no people or characters on screen (not with sing).
Default: "auto".
-
Response 200 ·
items[].spec.creative.storySourceOptional"lyrics" | "brief"Required when mode is story, not allowed otherwise. lyrics: tell the story of the lyrics. brief: tell the story in creative.brief (brief required).
Default: "lyrics".
-
Response 200 ·
items[].spec.creative.styleOptionalstringVisual treatment: look, palette, camera feel.
Maximum characters: 1000.
-
-
Response 200 ·
items[].spec.outputRequiredobjectDelivered output.
2 fields
-
Response 200 ·
items[].spec.output.aspectRatioRequiredstringDelivered aspect ratio.
-
Response 200 ·
items[].spec.output.resolutionRequiredstringPurchased delivery resolution: 480p, 768p, 1080p or 1440p.
-
-
Response 200 ·
items[].spec.sourceRequiredobjectAudio used for the video.
4 fields
-
Response 200 ·
items[].spec.source.typeRequired"audio_url" | "suno_clip"Audio source kind.
Default: "audio_url".
-
Response 200 ·
items[].spec.source.durationSecOptionalnumber | nullEffective audio length in seconds.
May be null. Use a complete option below; the value must satisfy at least one option.
2 options
-
Response 200 ·
Option 1 — numberOptionnumberEffective audio length in seconds.
-
Response 200 ·
Option 2 — nullOptionnull
-
-
Response 200 ·
items[].spec.source.endSecOptionalnumberSelected range end in seconds.
-
Response 200 ·
items[].spec.source.startSecOptionalnumberSelected range start in seconds.
-
-
Response 200 ·
items[].spec.titleRequiredstring | nullVideo title.
May be null. Use a complete option below; the value must satisfy at least one option.
2 options
-
Response 200 ·
Option 1 — stringOptionstringVideo title.
-
Response 200 ·
Option 2 — nullOptionnull
-
-
-
Response 200 ·
items[].statusRequired"queued" | "generating" | "delivering" | "completed" | "failed" | "cancelled" | "deleted"Product status of the video.
Default: "queued".
-
Response 200 ·
items[].taskIdRequiredstring | nullThe generation Task; Task webhooks and /api/v1/tasks/{taskId} carry this id.
May be null. Use a complete option below; the value must satisfy at least one option.
2 options
-
Response 200 ·
Option 1 — stringOptionstringThe generation Task; Task webhooks and /api/v1/tasks/{taskId} carry this id.
-
Response 200 ·
Option 2 — nullOptionnull
-
-
Response 200 ·
items[].updatedAtRequiredstringLast change (ISO 8601).
-
Response 200 ·
items[].warningsRequiredarray<string>Advisory warning codes.
1 field
-
Response 200 ·
items[].warnings[]Each itemstring
-
-
-
-
Response 200 ·
nextCursorRequiredstring | nullPass as cursor for the next page.
May be null. Use a complete option below; the value must satisfy at least one option.
2 options
-
Response 200 ·
Option 1 — stringOptionstringPass as cursor for the next page.
-
Response 200 ·
Option 2 — nullOptionnull
-
400 Bad Request
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 400 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 400 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 400 ·
error.messageRequiredstringHuman readable error message
-
Response 400 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 400 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 400 ·
successRequiredfalseAlways false for error responses
401 Unauthorized
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 401 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 401 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 401 ·
error.messageRequiredstringHuman readable error message
-
Response 401 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 401 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 401 ·
successRequiredfalseAlways false for error responses
402 Payment Required
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 402 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 402 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 402 ·
error.messageRequiredstringHuman readable error message
-
Response 402 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 402 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 402 ·
successRequiredfalseAlways false for error responses
403 Forbidden
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 403 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 403 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 403 ·
error.messageRequiredstringHuman readable error message
-
Response 403 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 403 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 403 ·
successRequiredfalseAlways false for error responses
404 Not Found
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 404 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 404 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 404 ·
error.messageRequiredstringHuman readable error message
-
Response 404 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 404 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 404 ·
successRequiredfalseAlways false for error responses
409 Conflict
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 409 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 409 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 409 ·
error.messageRequiredstringHuman readable error message
-
Response 409 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 409 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 409 ·
successRequiredfalseAlways false for error responses
413 Payload Too Large
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 413 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 413 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 413 ·
error.messageRequiredstringHuman readable error message
-
Response 413 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 413 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 413 ·
successRequiredfalseAlways false for error responses
422 Unprocessable Entity
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 422 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 422 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 422 ·
error.messageRequiredstringHuman readable error message
-
Response 422 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 422 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 422 ·
successRequiredfalseAlways false for error responses
429 Too Many Requests
Request allowance or task admission capacity exceeded. Follow Retry-After when present; otherwise wait for active tasks and use bounded backoff. Limits do not guarantee throughput. For SSE, this is the HTTP connection response, not an event.
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 429 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 429 ·
error.codeRequiredstringRATE_LIMITED for request and task admission rejections.
-
Response 429 ·
error.messageRequiredstringHuman-readable explanation. Wording may change; use the machine-readable code for programmatic decisions.
-
Response 429 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
9 fields
-
Response 429 ·
error.details.currentOptionalintegerCurrent count for the rate-limit window identified by policy and scope.
Minimum: 0.
-
Response 429 ·
error.details.inFlightOptionalintegerCurrent accepted tasks counted against the relevant account or API-key admission limit.
Minimum: 0.
-
Response 429 ·
error.details.limitOptionalintegerMaximum count allowed by this response context. A limit is not a throughput guarantee.
Minimum: 0.
-
Response 429 ·
error.details.policyOptional"operation" | "query"Allowance bucket: query for resource reads, operation for task-producing or operation requests. See the rate-limit response headers.
-
Response 429 ·
error.details.retryAfterSecOptionalintegerSuggested delay in seconds before another request. Honor the Retry-After header when present; use bounded backoff.
Minimum: 1.
-
Response 429 ·
error.details.scopeOptional"user" | "api-key" | "ip" | "apiKey"Entity whose allowance was exceeded, such as the user, API key or IP address.
-
Response 429 ·
error.details.tierOptional"FREE" | "PREMIUM" | "ENTERPRISE"Account allowance tier used for this admission or rate-limit decision.
-
Response 429 ·
error.details.typeOptional"rps" | "daily" | "monthly"Admission limit that rejected the request: rps (continuously refilled requests-per-second bucket), daily or monthly UTC request budget. Interpret with policy, scope and retryAfterSec.
-
Response 429 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 429 ·
successRequiredfalseWhether this response reports a successful action; false accompanies the structured error object.
Default: false.
500 Internal Server Error
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 500 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 500 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 500 ·
error.messageRequiredstringHuman readable error message
-
Response 500 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 500 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 500 ·
successRequiredfalseAlways false for error responses
502 Bad Gateway
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 502 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 502 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 502 ·
error.messageRequiredstringHuman readable error message
-
Response 502 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 502 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 502 ·
successRequiredfalseAlways false for error responses
503 Service Unavailable
application/json
Required, optional and null
Required fields apply within their object and selected option. An optional object may be absent; when present, its required fields must be included. Required and nullable are independent: null is allowed only where listed.
-
Response 503 ·
errorRequiredobjectStructured failure information. Branch on code, show message, and interpret details only for that code. The request ID is returned in the X-Request-Id header.
3 fields
-
Response 503 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 503 ·
error.messageRequiredstringHuman readable error message
-
Response 503 ·
error.detailsOptionalobjectOptional error-specific context. Read code first; details keys depend on that code. Unknown keys must not break error handling. See /resources/errors/.
1 field
-
Response 503 ·
error.details[key]Each valueany JSON valueKey pattern: ^(.*)$.
-
-
-
Response 503 ·
successRequiredfalseAlways false for error responses