taskIdpath · RequiredGet Task
/api/v1/tasks/{taskId}Authentication · x-api-key
Get task details by ID
Request
Responses
200 OK
application/json
Unknown fields are not accepted.
-
Response 200 ·
createdAtRequiredDate | string | numberTask creation timestamp
Must match at least one alternative.
4 fields / alternatives
-
Response 200 ·
createdAt · anyOf 1AlternativeDateTask creation timestamp
-
Response 200 ·
createdAt · anyOf 2AlternativestringFormat: date-time.
-
Response 200 ·
createdAt · anyOf 3AlternativestringFormat: date.
-
Response 200 ·
createdAt · anyOf 4Alternativenumber
-
-
Response 200 ·
creditsChargedRequirednumber | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
creditsCharged · anyOf 1AlternativenumberCredits actually charged
Minimum: 0.
-
Response 200 ·
creditsCharged · anyOf 2Alternativenull
-
-
Response 200 ·
creditsRequiredRequirednumberCredits deducted to start the task
Minimum: 0.
-
Response 200 ·
errorCodeRequiredstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
errorCode · anyOf 1AlternativestringError code if task failed
-
Response 200 ·
errorCode · anyOf 2Alternativenull
-
-
Response 200 ·
errorMessageRequiredstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
errorMessage · anyOf 1AlternativestringError message if task failed
-
Response 200 ·
errorMessage · anyOf 2Alternativenull
-
-
Response 200 ·
metadataRequiredany | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
metadata · anyOf 1AlternativeanyAdditional metadata
-
Response 200 ·
metadata · anyOf 2Alternativenull
-
-
Response 200 ·
outputResultsRequiredany | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
outputResults · anyOf 1AlternativeanyTask output results
-
Response 200 ·
outputResults · anyOf 2Alternativenull
-
-
Response 200 ·
processingCompletedAtRequiredDate | string | number | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
processingCompletedAt · anyOf 1AlternativeDate | string | numberProcessing completion timestamp
Must match at least one alternative.
4 fields / alternatives
-
Response 200 ·
processingCompletedAt · anyOf 1 · anyOf 1AlternativeDateProcessing completion timestamp
-
Response 200 ·
processingCompletedAt · anyOf 1 · anyOf 2AlternativestringFormat: date-time.
-
Response 200 ·
processingCompletedAt · anyOf 1 · anyOf 3AlternativestringFormat: date.
-
Response 200 ·
processingCompletedAt · anyOf 1 · anyOf 4Alternativenumber
-
-
Response 200 ·
processingCompletedAt · anyOf 2Alternativenull
-
-
Response 200 ·
processingDurationRequirednumber | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
processingDuration · anyOf 1AlternativenumberProcessing duration in milliseconds
-
Response 200 ·
processingDuration · anyOf 2Alternativenull
-
-
Response 200 ·
processingDurationTextRequiredstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
processingDurationText · anyOf 1AlternativestringHuman-readable processing duration, e.g. 16.2s
-
Response 200 ·
processingDurationText · anyOf 2Alternativenull
-
-
Response 200 ·
processingStartedAtRequiredDate | string | number | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
processingStartedAt · anyOf 1AlternativeDate | string | numberProcessing start timestamp
Must match at least one alternative.
4 fields / alternatives
-
Response 200 ·
processingStartedAt · anyOf 1 · anyOf 1AlternativeDateProcessing start timestamp
-
Response 200 ·
processingStartedAt · anyOf 1 · anyOf 2AlternativestringFormat: date-time.
-
Response 200 ·
processingStartedAt · anyOf 1 · anyOf 3AlternativestringFormat: date.
-
Response 200 ·
processingStartedAt · anyOf 1 · anyOf 4Alternativenumber
-
-
Response 200 ·
processingStartedAt · anyOf 2Alternativenull
-
-
Response 200 ·
progressRequirednumber | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
progress · anyOf 1AlternativenumberTask progress percentage (0-100)
Minimum: 0. Maximum: 100.
-
Response 200 ·
progress · anyOf 2Alternativenull
-
-
Response 200 ·
refundedRequiredbooleanWhether credits were refunded
-
Response 200 ·
retryableRequiredbooleanWhether a new request may succeed after the reported terminal failure.
-
Response 200 ·
statusRequired"PENDING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED"Default: "PENDING".
-
Response 200 ·
taskIdRequiredstringTask unique identifier
-
Response 200 ·
updatedAtRequiredDate | string | numberLast update timestamp
Must match at least one alternative.
4 fields / alternatives
-
Response 200 ·
updatedAt · anyOf 1AlternativeDateLast update timestamp
-
Response 200 ·
updatedAt · anyOf 2AlternativestringFormat: date-time.
-
Response 200 ·
updatedAt · anyOf 3AlternativestringFormat: date.
-
Response 200 ·
updatedAt · anyOf 4Alternativenumber
-
-
Response 200 ·
warningCodesRequiredarray<string>1 field
-
Response 200 ·
warningCodes[]Each itemstringNon-fatal warnings accumulated during processing and at delivery
-
-
Response 200 ·
actionRequiredOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
actionRequired · anyOf 1AlternativestringStable action the caller should take before retrying.
-
Response 200 ·
actionRequired · anyOf 2Alternativenull
-
-
Response 200 ·
errorReasonOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
errorReason · anyOf 1AlternativestringStable machine-readable reason for an actionable error.
-
Response 200 ·
errorReason · anyOf 2Alternativenull
-
-
Response 200 ·
featureOptionalobject | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
feature · anyOf 1Alternativeobject2 fields
-
Response 200 ·
feature · anyOf 1.codeRequiredstringFeature code
-
Response 200 ·
feature · anyOf 1.nameRequiredstringFeature name
-
-
Response 200 ·
feature · anyOf 2Alternativenull
-
-
Response 200 ·
inputParametersOptionalanyTask input parameters
-
Response 200 ·
modelOptionalobject | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
model · anyOf 1Alternativeobject3 fields
-
Response 200 ·
model · anyOf 1.codeRequiredstringModel code
-
Response 200 ·
model · anyOf 1.nameRequiredstringModel display name
-
Response 200 ·
model · anyOf 1.versionRequiredstringModel version
-
-
Response 200 ·
model · anyOf 2Alternativenull
-
-
Response 200 ·
pricingOptionalobject | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
pricing · anyOf 1AlternativeobjectUnknown fields are not accepted.
2 fields
-
Response 200 ·
pricing · anyOf 1.componentsRequiredarray<object>1 field
-
Response 200 ·
pricing · anyOf 1.components[]Each itemobjectUnknown fields are not accepted.
3 fields
-
Response 200 ·
pricing · anyOf 1.components[].creditsRequirednumberFinal credits charged for this component.
Minimum: 0.
1 field
-
Response 200 ·
pricing · anyOf 1.components[].creditsSee schemanumberExpand this value in the interactive reference.
Minimum: 0.
-
-
Response 200 ·
pricing · anyOf 1.components[].keyRequiredstringStable billing component key.
1 field
-
Response 200 ·
pricing · anyOf 1.components[].keySee schemastringExpand this value in the interactive reference.
-
-
Response 200 ·
pricing · anyOf 1.components[].labelRequiredstringHuman-readable component label.
1 field
-
Response 200 ·
pricing · anyOf 1.components[].labelSee schemastringExpand this value in the interactive reference.
-
-
-
-
Response 200 ·
pricing · anyOf 1.quoteVersionRequirednumberPricing quote version stored with the task.
Minimum: 1.
-
-
Response 200 ·
pricing · anyOf 2Alternativenull
-
-
Response 200 ·
productOptionalobject | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
product · anyOf 1AlternativeobjectUnknown fields are not accepted.
5 fields
-
Response 200 ·
product · anyOf 1.typeRequiredstringProduct family for this task, e.g. mv.
-
Response 200 ·
product · anyOf 1.finalUrlOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
product · anyOf 1.finalUrl · anyOf 1AlternativestringFinal downloadable asset URL when ready.
-
Response 200 ·
product · anyOf 1.finalUrl · anyOf 2Alternativenull
-
-
Response 200 ·
product · anyOf 1.modeOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
product · anyOf 1.mode · anyOf 1AlternativestringProduct mode when applicable, e.g. fast or studio.
-
Response 200 ·
product · anyOf 1.mode · anyOf 2Alternativenull
-
-
Response 200 ·
product · anyOf 1.mvIdOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
product · anyOf 1.mvId · anyOf 1AlternativestringCanonical MV id.
-
Response 200 ·
product · anyOf 1.mvId · anyOf 2Alternativenull
-
-
Response 200 ·
product · anyOf 1.viewUrlOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
product · anyOf 1.viewUrl · anyOf 1AlternativestringProduct detail endpoint for this resource.
-
Response 200 ·
product · anyOf 1.viewUrl · anyOf 2Alternativenull
-
-
-
Response 200 ·
product · anyOf 2Alternativenull
-
-
Response 200 ·
providerOptionalobject | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
provider · anyOf 1Alternativeobject2 fields
-
Response 200 ·
provider · anyOf 1.codeRequiredstringProvider code
-
Response 200 ·
provider · anyOf 1.nameRequiredstringProvider display name
-
-
Response 200 ·
provider · anyOf 2Alternativenull
-
-
Response 200 ·
qualityReviewUrlOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
qualityReviewUrl · anyOf 1Alternativestring -
Response 200 ·
qualityReviewUrl · anyOf 2Alternativenull
-
-
Response 200 ·
qualityStatusOptional"pending" | "not_evaluated" | "human_review_required" | "needs_revision"Creative acceptance, independent of delivery status. Completion does not imply a passing score.
-
Response 200 ·
refundReasonOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
refundReason · anyOf 1Alternativestring -
Response 200 ·
refundReason · anyOf 2Alternativenull
-
-
Response 200 ·
refundTypeOptional"none" | "partial" | "full" -
Response 200 ·
refundedCreditsOptionalnumberCredits actually returned at settlement, including partial refunds.
Minimum: 0.
-
Response 200 ·
rejectedFieldOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
rejectedField · anyOf 1AlternativestringInput field that must be changed before a new task.
-
Response 200 ·
rejectedField · anyOf 2Alternativenull
-
-
Response 200 ·
resourcesOptionalarray<object>Standardized resources produced by the task
1 field
-
Response 200 ·
resources[]Each itemobjectA consumable resource produced by the task.
19 fields
-
Response 200 ·
resources[].idRequiredstringStable resource id (OmnAPI resource id).
-
Response 200 ·
resources[].indexRequirednumberStable zero-based provider result slot. Finalized post-process resources may use a higher reserved slot.
Minimum: 0.
-
Response 200 ·
resources[].roleRequired"candidate" | "final" | "stem" | "fallback" | "output"How clients should interpret the resource. Prefer `final` when present; `candidate` items remain selectable alternatives.
-
Response 200 ·
resources[].typeRequired"MUSIC" | "IMAGE" | "VIDEO" | "AUDIO" | "TEXT" | "METADATA"Uppercase resource kind. MUSIC carries a song URL and optional thumbnailUrl; TEXT carries inline content. Optional fields depend on the operation.
-
Response 200 ·
resources[].assetIdOptionalstringStable OmnAPI-owned asset id when available.
-
Response 200 ·
resources[].assetStatusOptional"READY" | "EXPIRED" | "DELETING" | "DELETED" -
Response 200 ·
resources[].byteLengthOptionalnumber | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].byteLength · anyOf 1AlternativenumberResource size in bytes.
-
Response 200 ·
resources[].byteLength · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].contentOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].content · anyOf 1AlternativestringInline text content (e.g. lyrics).
-
Response 200 ·
resources[].content · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].contentTypeOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].contentType · anyOf 1AlternativestringResource content type.
-
Response 200 ·
resources[].contentType · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].durationOptionalnumber | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].duration · anyOf 1Alternativenumber -
Response 200 ·
resources[].duration · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].durationSecOptionalnumber | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].durationSec · anyOf 1AlternativenumberResource duration in seconds.
-
Response 200 ·
resources[].durationSec · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].heightOptionalnumber | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].height · anyOf 1Alternativenumber -
Response 200 ·
resources[].height · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].metadataOptionalobject | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].metadata · anyOf 1Alternativeobject -
Response 200 ·
resources[].metadata · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].retainedUntilOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].retainedUntil · anyOf 1AlternativestringFormat: date-time.
-
Response 200 ·
resources[].retainedUntil · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].thumbnailUrlOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].thumbnailUrl · anyOf 1Alternativestring -
Response 200 ·
resources[].thumbnailUrl · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].titleOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].title · anyOf 1Alternativestring -
Response 200 ·
resources[].title · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].urlOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].url · anyOf 1AlternativestringPresigned/public URL.
-
Response 200 ·
resources[].url · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].urlExpiresAtOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].urlExpiresAt · anyOf 1AlternativestringFormat: date-time.
-
Response 200 ·
resources[].urlExpiresAt · anyOf 2Alternativenull
-
-
Response 200 ·
resources[].widthOptionalnumber | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
resources[].width · anyOf 1Alternativenumber -
Response 200 ·
resources[].width · anyOf 2Alternativenull
-
-
-
-
Response 200 ·
settlementStatusOptional"PENDING" | "CHARGED" | "REFUNDED" -
Response 200 ·
webhookUrlOptionalstring | nullMay be null. Must match at least one alternative.
2 fields / alternatives
-
Response 200 ·
webhookUrl · anyOf 1AlternativestringWebhook callback URL
-
Response 200 ·
webhookUrl · anyOf 2Alternativenull
-
400 Bad Request
application/json
-
Response 400 ·
errorRequiredobject3 fields
-
Response 400 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 400 ·
error.messageRequiredstringHuman readable error message
-
Response 400 ·
error.detailsOptionalobjectAdditional error details (optional)
-
-
Response 400 ·
successRequiredfalseAlways false for error responses
401 Unauthorized
application/json
-
Response 401 ·
errorRequiredobject3 fields
-
Response 401 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 401 ·
error.messageRequiredstringHuman readable error message
-
Response 401 ·
error.detailsOptionalobjectAdditional error details (optional)
-
-
Response 401 ·
successRequiredfalseAlways false for error responses
403 Forbidden
application/json
-
Response 403 ·
errorRequiredobject3 fields
-
Response 403 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 403 ·
error.messageRequiredstringHuman readable error message
-
Response 403 ·
error.detailsOptionalobjectAdditional error details (optional)
-
-
Response 403 ·
successRequiredfalseAlways false for error responses
404 Not Found
application/json
-
Response 404 ·
errorRequiredobject3 fields
-
Response 404 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 404 ·
error.messageRequiredstringHuman readable error message
-
Response 404 ·
error.detailsOptionalobjectAdditional error details (optional)
-
-
Response 404 ·
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
-
Response 429 ·
errorRequiredobject3 fields
-
Response 429 ·
error.codeRequiredstringRATE_LIMITED for request and task admission rejections.
-
Response 429 ·
error.messageRequiredstring -
Response 429 ·
error.detailsOptionalobjectOptional and scope-dependent. Request limits supply scope/policy/type/limit/current/retryAfterSec. Task admission supplies inFlight/limit/tier, plus scope=apiKey for a key cap. IP rejection can omit details. In-flight rejection does not promise Retry-After.
8 fields
-
Response 429 ·
error.details.currentOptionalintegerMinimum: 0.
-
Response 429 ·
error.details.inFlightOptionalintegerMinimum: 0.
-
Response 429 ·
error.details.limitOptionalintegerMinimum: 0.
-
Response 429 ·
error.details.policyOptional"operation" | "query" -
Response 429 ·
error.details.retryAfterSecOptionalintegerMinimum: 1.
-
Response 429 ·
error.details.scopeOptional"user" | "api-key" | "ip" | "apiKey" -
Response 429 ·
error.details.tierOptional"FREE" | "PREMIUM" | "ENTERPRISE" -
Response 429 ·
error.details.typeOptional"rps" | "daily" | "monthly"
-
-
-
Response 429 ·
successRequiredfalseDefault: false.
500 Internal Server Error
application/json
-
Response 500 ·
errorRequiredobject3 fields
-
Response 500 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 500 ·
error.messageRequiredstringHuman readable error message
-
Response 500 ·
error.detailsOptionalobjectAdditional error details (optional)
-
-
Response 500 ·
successRequiredfalseAlways false for error responses
503 Service Unavailable
application/json
-
Response 503 ·
errorRequiredobject3 fields
-
Response 503 ·
error.codeRequiredstringApplication-specific error code (see error catalog)
-
Response 503 ·
error.messageRequiredstringHuman readable error message
-
Response 503 ·
error.detailsOptionalobjectAdditional error details (optional)
-
-
Response 503 ·
successRequiredfalseAlways false for error responses