clipIdpath · RequiredSuno clip identifier returned by a Generation or clip read.
/api/v1/suno/clips/{clipId}/timelineAuthentication · x-api-key
Word/line-level timestamps for a clip. Short sync-wait; returns 202 with taskId on timeout.
clipIdpath · RequiredSuno clip identifier returned by a Generation or clip read.
application/json
Unknown fields are not accepted.
creditsChargedRequiredMay be null. Must match at least one alternative.
creditsCharged · anyOf 1AlternativeExact credits actually charged
Minimum: 0.
creditsCharged · anyOf 2AlternativecreditsRequiredRequiredExact credits deducted to start the task
Minimum: 0.
errorCodeRequiredMay be null. Must match at least one alternative.
errorCode · anyOf 1AlternativeError code if task failed
errorCode · anyOf 2AlternativeerrorMessageRequiredMay be null. Must match at least one alternative.
errorMessage · anyOf 1AlternativeError message if task failed
errorMessage · anyOf 2AlternativeoutputResultsRequiredMay be null. Must match at least one alternative.
outputResults · anyOf 1AlternativeUnknown fields are not accepted.
outputResults · anyOf 1.clipIdRequiredoutputResults · anyOf 1.linesRequiredoutputResults · anyOf 1.lines[]Each itemUnknown fields are not accepted.
outputResults · anyOf 1.lines[].endRequiredMinimum: 0.
outputResults · anyOf 1.lines[].endSee schemaExpand this value in the interactive reference.
Minimum: 0.
outputResults · anyOf 1.lines[].startRequiredMinimum: 0.
outputResults · anyOf 1.lines[].startSee schemaExpand this value in the interactive reference.
Minimum: 0.
outputResults · anyOf 1.lines[].textRequiredoutputResults · anyOf 1.lines[].textSee schemaExpand this value in the interactive reference.
outputResults · anyOf 1.lines[].wordsRequiredoutputResults · anyOf 1.lines[].wordsSee schemaExpand this value in the interactive reference.
outputResults · anyOf 1.lines[].sectionOptionaloutputResults · anyOf 1.lines[].sectionSee schemaExpand this value in the interactive reference.
outputResults · anyOf 1.waveform_dataRequiredoutputResults · anyOf 1.waveform_data[]Each itemoutputResults · anyOf 1.wordsRequiredoutputResults · anyOf 1.words[]Each itemUnknown fields are not accepted.
outputResults · anyOf 1.words[].endRequiredMinimum: 0.
outputResults · anyOf 1.words[].endSee schemaExpand this value in the interactive reference.
Minimum: 0.
outputResults · anyOf 1.words[].startRequiredMinimum: 0.
outputResults · anyOf 1.words[].startSee schemaExpand this value in the interactive reference.
Minimum: 0.
outputResults · anyOf 1.words[].wordRequiredoutputResults · anyOf 1.words[].wordSee schemaExpand this value in the interactive reference.
outputResults · anyOf 1.words[].confidenceOptionaloutputResults · anyOf 1.words[].confidenceSee schemaExpand this value in the interactive reference.
outputResults · anyOf 1.words[].successOptionaloutputResults · anyOf 1.words[].successSee schemaExpand this value in the interactive reference.
outputResults · anyOf 2AlternativeprocessingDurationRequiredMay be null. Must match at least one alternative.
processingDuration · anyOf 1AlternativeProcessing duration in milliseconds
processingDuration · anyOf 2AlternativeprocessingDurationTextRequiredMay be null. Must match at least one alternative.
processingDurationText · anyOf 1AlternativeHuman-readable processing duration, e.g. 16.2s
processingDurationText · anyOf 2AlternativestatusRequiredDefault: "PENDING".
taskIdRequiredTask unique identifier
pollUrlOptionalMay be null. Must match at least one alternative.
pollUrl · anyOf 1AlternativeSet only when the synchronous wait timed out (HTTP 202, status=PROCESSING). The task is still running — poll this URL for the final result. Null/absent on terminal responses.
pollUrl · anyOf 2AlternativeresourcesOptionalStandardized resources produced by the task
resources[]Each itemA consumable resource produced by the task.
resources[].idRequiredStable resource id (OmnAPI resource id).
resources[].indexRequiredStable zero-based provider result slot. Finalized post-process resources may use a higher reserved slot.
Minimum: 0.
resources[].roleRequiredHow clients should interpret the resource. Prefer `final` when present; `candidate` items remain selectable alternatives.
resources[].typeRequiredUppercase resource kind. MUSIC carries a song URL and optional thumbnailUrl; TEXT carries inline content. Optional fields depend on the operation.
resources[].assetIdOptionalStable OmnAPI-owned asset id when available.
resources[].assetStatusOptionalresources[].byteLengthOptionalMay be null. Must match at least one alternative.
resources[].byteLength · anyOf 1AlternativeResource size in bytes.
resources[].byteLength · anyOf 2Alternativeresources[].contentOptionalMay be null. Must match at least one alternative.
resources[].content · anyOf 1AlternativeInline text content (e.g. lyrics).
resources[].content · anyOf 2Alternativeresources[].contentTypeOptionalMay be null. Must match at least one alternative.
resources[].contentType · anyOf 1AlternativeResource content type.
resources[].contentType · anyOf 2Alternativeresources[].durationOptionalMay be null. Must match at least one alternative.
resources[].duration · anyOf 1Alternativeresources[].duration · anyOf 2Alternativeresources[].durationSecOptionalMay be null. Must match at least one alternative.
resources[].durationSec · anyOf 1AlternativeResource duration in seconds.
resources[].durationSec · anyOf 2Alternativeresources[].heightOptionalMay be null. Must match at least one alternative.
resources[].height · anyOf 1Alternativeresources[].height · anyOf 2Alternativeresources[].metadataOptionalMay be null. Must match at least one alternative.
resources[].metadata · anyOf 1Alternativeresources[].metadata · anyOf 2Alternativeresources[].retainedUntilOptionalMay be null. Must match at least one alternative.
resources[].retainedUntil · anyOf 1AlternativeFormat: date-time.
resources[].retainedUntil · anyOf 2Alternativeresources[].thumbnailUrlOptionalMay be null. Must match at least one alternative.
resources[].thumbnailUrl · anyOf 1Alternativeresources[].thumbnailUrl · anyOf 2Alternativeresources[].titleOptionalMay be null. Must match at least one alternative.
resources[].title · anyOf 1Alternativeresources[].title · anyOf 2Alternativeresources[].urlOptionalMay be null. Must match at least one alternative.
resources[].url · anyOf 1AlternativePresigned/public URL.
resources[].url · anyOf 2Alternativeresources[].urlExpiresAtOptionalMay be null. Must match at least one alternative.
resources[].urlExpiresAt · anyOf 1AlternativeFormat: date-time.
resources[].urlExpiresAt · anyOf 2Alternativeresources[].widthOptionalMay be null. Must match at least one alternative.
resources[].width · anyOf 1Alternativeresources[].width · anyOf 2Alternativeapplication/json
Unknown fields are not accepted.
creditsChargedRequiredMay be null. Must match at least one alternative.
creditsCharged · anyOf 1AlternativeExact credits actually charged
Minimum: 0.
creditsCharged · anyOf 2AlternativecreditsRequiredRequiredExact credits deducted to start the task
Minimum: 0.
errorCodeRequiredMay be null. Must match at least one alternative.
errorCode · anyOf 1AlternativeError code if task failed
errorCode · anyOf 2AlternativeerrorMessageRequiredMay be null. Must match at least one alternative.
errorMessage · anyOf 1AlternativeError message if task failed
errorMessage · anyOf 2AlternativeoutputResultsRequiredMay be null. Must match at least one alternative.
outputResults · anyOf 1AlternativeUnknown fields are not accepted.
outputResults · anyOf 1.clipIdRequiredoutputResults · anyOf 1.linesRequiredoutputResults · anyOf 1.lines[]Each itemUnknown fields are not accepted.
outputResults · anyOf 1.lines[].endRequiredMinimum: 0.
outputResults · anyOf 1.lines[].endSee schemaExpand this value in the interactive reference.
Minimum: 0.
outputResults · anyOf 1.lines[].startRequiredMinimum: 0.
outputResults · anyOf 1.lines[].startSee schemaExpand this value in the interactive reference.
Minimum: 0.
outputResults · anyOf 1.lines[].textRequiredoutputResults · anyOf 1.lines[].textSee schemaExpand this value in the interactive reference.
outputResults · anyOf 1.lines[].wordsRequiredoutputResults · anyOf 1.lines[].wordsSee schemaExpand this value in the interactive reference.
outputResults · anyOf 1.lines[].sectionOptionaloutputResults · anyOf 1.lines[].sectionSee schemaExpand this value in the interactive reference.
outputResults · anyOf 1.waveform_dataRequiredoutputResults · anyOf 1.waveform_data[]Each itemoutputResults · anyOf 1.wordsRequiredoutputResults · anyOf 1.words[]Each itemUnknown fields are not accepted.
outputResults · anyOf 1.words[].endRequiredMinimum: 0.
outputResults · anyOf 1.words[].endSee schemaExpand this value in the interactive reference.
Minimum: 0.
outputResults · anyOf 1.words[].startRequiredMinimum: 0.
outputResults · anyOf 1.words[].startSee schemaExpand this value in the interactive reference.
Minimum: 0.
outputResults · anyOf 1.words[].wordRequiredoutputResults · anyOf 1.words[].wordSee schemaExpand this value in the interactive reference.
outputResults · anyOf 1.words[].confidenceOptionaloutputResults · anyOf 1.words[].confidenceSee schemaExpand this value in the interactive reference.
outputResults · anyOf 1.words[].successOptionaloutputResults · anyOf 1.words[].successSee schemaExpand this value in the interactive reference.
outputResults · anyOf 2AlternativeprocessingDurationRequiredMay be null. Must match at least one alternative.
processingDuration · anyOf 1AlternativeProcessing duration in milliseconds
processingDuration · anyOf 2AlternativeprocessingDurationTextRequiredMay be null. Must match at least one alternative.
processingDurationText · anyOf 1AlternativeHuman-readable processing duration, e.g. 16.2s
processingDurationText · anyOf 2AlternativestatusRequiredDefault: "PENDING".
taskIdRequiredTask unique identifier
pollUrlOptionalMay be null. Must match at least one alternative.
pollUrl · anyOf 1AlternativeSet only when the synchronous wait timed out (HTTP 202, status=PROCESSING). The task is still running — poll this URL for the final result. Null/absent on terminal responses.
pollUrl · anyOf 2AlternativeresourcesOptionalStandardized resources produced by the task
resources[]Each itemA consumable resource produced by the task.
resources[].idRequiredStable resource id (OmnAPI resource id).
resources[].indexRequiredStable zero-based provider result slot. Finalized post-process resources may use a higher reserved slot.
Minimum: 0.
resources[].roleRequiredHow clients should interpret the resource. Prefer `final` when present; `candidate` items remain selectable alternatives.
resources[].typeRequiredUppercase resource kind. MUSIC carries a song URL and optional thumbnailUrl; TEXT carries inline content. Optional fields depend on the operation.
resources[].assetIdOptionalStable OmnAPI-owned asset id when available.
resources[].assetStatusOptionalresources[].byteLengthOptionalMay be null. Must match at least one alternative.
resources[].byteLength · anyOf 1AlternativeResource size in bytes.
resources[].byteLength · anyOf 2Alternativeresources[].contentOptionalMay be null. Must match at least one alternative.
resources[].content · anyOf 1AlternativeInline text content (e.g. lyrics).
resources[].content · anyOf 2Alternativeresources[].contentTypeOptionalMay be null. Must match at least one alternative.
resources[].contentType · anyOf 1AlternativeResource content type.
resources[].contentType · anyOf 2Alternativeresources[].durationOptionalMay be null. Must match at least one alternative.
resources[].duration · anyOf 1Alternativeresources[].duration · anyOf 2Alternativeresources[].durationSecOptionalMay be null. Must match at least one alternative.
resources[].durationSec · anyOf 1AlternativeResource duration in seconds.
resources[].durationSec · anyOf 2Alternativeresources[].heightOptionalMay be null. Must match at least one alternative.
resources[].height · anyOf 1Alternativeresources[].height · anyOf 2Alternativeresources[].metadataOptionalMay be null. Must match at least one alternative.
resources[].metadata · anyOf 1Alternativeresources[].metadata · anyOf 2Alternativeresources[].retainedUntilOptionalMay be null. Must match at least one alternative.
resources[].retainedUntil · anyOf 1AlternativeFormat: date-time.
resources[].retainedUntil · anyOf 2Alternativeresources[].thumbnailUrlOptionalMay be null. Must match at least one alternative.
resources[].thumbnailUrl · anyOf 1Alternativeresources[].thumbnailUrl · anyOf 2Alternativeresources[].titleOptionalMay be null. Must match at least one alternative.
resources[].title · anyOf 1Alternativeresources[].title · anyOf 2Alternativeresources[].urlOptionalMay be null. Must match at least one alternative.
resources[].url · anyOf 1AlternativePresigned/public URL.
resources[].url · anyOf 2Alternativeresources[].urlExpiresAtOptionalMay be null. Must match at least one alternative.
resources[].urlExpiresAt · anyOf 1AlternativeFormat: date-time.
resources[].urlExpiresAt · anyOf 2Alternativeresources[].widthOptionalMay be null. Must match at least one alternative.
resources[].width · anyOf 1Alternativeresources[].width · anyOf 2Alternativeapplication/json
errorRequirederror.codeRequiredApplication-specific error code (see error catalog)
error.messageRequiredHuman readable error message
error.detailsOptionalAdditional error details (optional)
successRequiredAlways false for error responses
application/json
errorRequirederror.codeRequiredApplication-specific error code (see error catalog)
error.messageRequiredHuman readable error message
error.detailsOptionalAdditional error details (optional)
successRequiredAlways false for error responses
application/json
errorRequirederror.codeRequiredApplication-specific error code (see error catalog)
error.messageRequiredHuman readable error message
error.detailsOptionalAdditional error details (optional)
successRequiredAlways false for error responses
Forbidden: the API key lacks the required scope or its IP policy rejects this request. Forbidden: API-key scope/IP restrictions or billing hold. A positive balance does not bypass payment review. Check GET /api/v1/account/credits billingStatus before further paid requests.
application/json
errorRequirederror.codeRequiredApplication-specific error code (see error catalog)
error.messageRequiredHuman readable error message
error.detailsOptionalAdditional error details (optional)
successRequiredAlways false for error responses
application/json
errorRequirederror.codeRequiredApplication-specific error code (see error catalog)
error.messageRequiredHuman readable error message
error.detailsOptionalAdditional error details (optional)
successRequiredAlways false for error responses
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
errorRequirederror.codeRequiredRATE_LIMITED for request and task admission rejections.
error.messageRequirederror.detailsOptionalOptional 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.
error.details.currentOptionalMinimum: 0.
error.details.inFlightOptionalMinimum: 0.
error.details.limitOptionalMinimum: 0.
error.details.policyOptionalerror.details.retryAfterSecOptionalMinimum: 1.
error.details.scopeOptionalerror.details.tierOptionalerror.details.typeOptionalsuccessRequiredDefault: false.
application/json
errorRequirederror.codeRequiredApplication-specific error code (see error catalog)
error.messageRequiredHuman readable error message
error.detailsOptionalAdditional error details (optional)
successRequiredAlways false for error responses
application/json
errorRequirederror.codeRequiredApplication-specific error code (see error catalog)
error.messageRequiredHuman readable error message
error.detailsOptionalAdditional error details (optional)
successRequiredAlways false for error responses