Generate Song

POST/api/v1/suno/songsCopy URL

Authentication · x-api-key

Create a song from text, a confirmed public Voice, or a managed upload + Extend/Cover workflow.

All endpointsRequestResponsesCode

Request

Idempotency-Keyheader · Optional

string

Unique key for one logical write. Retrying the same body with the same key replays the original result; reusing it with a different body returns 409.

Maximum characters: 255.

Preferheader · Optional

"respond-async"

Set to respond-async to skip the acknowledgement wait and return the generation receipt immediately.

Unknown fields are not accepted.

• Request · modeRequired

  string

  Generation mode. Vox accepts the three v6 generation models with account-specific permission checks; unsupported model combinations are rejected before task creation. Upload modes atomically import the supplied audio and then Extend or Cover it; standalone upload is not exposed.

  Pattern: ^(simple|custom|vox|upload-extend|upload-cover)$.

• Request · audioOptional

  object

  Public audio source and format information.

  Unknown fields are not accepted.

  2 fields

  • Request · audio.urlRequired

    string

    Publicly retrievable audio URL used only by upload-extend or upload-cover.

    Format: uri.

  • Request · audio.extensionTypeOptional

    "mp3" | "wav" | "m4a" | "flac" | "ogg"

    Audio filename or media extension hint.

• Request · configOptional

  object

  Standard task configuration: priority, tags, metadata, and webhookUrl.

  4 fields

  • Request · config.metadataOptional

    object

    Free-form caller metadata, echoed back on read. Stored as opaque JSON; the server never mutates it.

  • Request · config.priorityOptional

    number

    Task priority 1-10 (higher = sooner). Default 5.

    Minimum: 1. Maximum: 10. Default: 5.

  • Request · config.tagsOptional

    array<string>

    Free-form labels for filtering. Up to 20, 100 chars each.

    Maximum items: 20.

    1 field

    • Request · config.tags[]Each item

      string

      Maximum characters: 100.

  • Request · config.webhookUrlOptional

    string

    URL to receive task.* lifecycle events via the central webhook service.

    Format: uri.

• Request · continueAtOptional

  number

  Timestamp in seconds to continue from. Values beyond the source duration are forwarded unchanged and Suno continues from the clip end.

  Minimum: 0.

• Request · continuedAlignedPromptOptional

  string

  Aligned continuation prompt used for an Extend operation.

  Maximum characters: 5000.

• Request · controlSlidersOptional

  object

  Optional bounded generation-control weights.

  3 fields

  • Request · controlSliders.audio_weightOptional

    number

    Source-audio adherence weight from 0 to 1.

    Minimum: 0. Maximum: 1.

  • Request · controlSliders.style_weightOptional

    number

    Style adherence weight from 0 to 1.

    Minimum: 0. Maximum: 1.

  • Request · controlSliders.weirdness_constraintOptional

    number

    Creative-variation constraint from 0 to 1.

    Minimum: 0. Maximum: 1.

• Request · instrumentalOptional

  boolean

  Whether to generate an instrumental result.

• Request · lyricsOptional

  string

  Lyrics or lyric context supplied to the operation.

  Maximum characters: 5000.

• Request · modelOptional

  "chirp-hawk" | "chirp-hawk-wild" | "chirp-goose" | "chirp-auk-turbo" | "chirp-v4" | "chirp-auk" | "chirp-bluejay" | "chirp-crow" | "chirp-fenix"

  Current models: chirp-hawk, chirp-hawk-wild, chirp-goose. Legacy generation names and underscore spellings remain accepted: auk-turbo executes on goose; v4, auk, bluejay, crow and fenix execute on hawk. Requested model pricing and the legacy feature envelope are preserved. Omitted model retains the chirp-fenix pricing identity and executes on chirp-hawk.

  Default: "chirp-fenix".

• Request · negativeTagsOptional

  string

  Negative music-style tags or exclusions.

  Maximum characters: 1000.

• Request · promptOptional

  string

  Primary creative or operation instruction.

  Maximum characters: 5000.

• Request · tagsOptional

  string

  Style tags or caller labels, as defined by this schema.

  Maximum characters: 1000.

• Request · titleOptional

  string

  Optional customer-facing title.

  Maximum characters: 100.

• Request · voiceIdOptional

  string

  Reusable public Suno Voice identifier.

Responses

200 OK

application/json

Unknown fields are not accepted.

• Response 200 · autoFinalizeRequired

  boolean

• Response 200 · clipIdsRequired

  array<string>
  1 field

  • Response 200 · clipIds[]Each item

    string

• Response 200 · creditsRequiredRequired

  number

  Minimum: 0.

• Response 200 · deliveryStatusRequired

  "submitted" | "queued" | "streaming" | "complete" | "error" | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · deliveryStatus · anyOf 1Alternative

    "submitted" | "queued" | "streaming" | "complete" | "error"

    Must match at least one alternative.

    5 fields / alternatives

    • Response 200 · deliveryStatus · anyOf 1 · anyOf 1Alternative

      "submitted"

    • Response 200 · deliveryStatus · anyOf 1 · anyOf 2Alternative

      "queued"

    • Response 200 · deliveryStatus · anyOf 1 · anyOf 3Alternative

      "streaming"

    • Response 200 · deliveryStatus · anyOf 1 · anyOf 4Alternative

      "complete"

    • Response 200 · deliveryStatus · anyOf 1 · anyOf 5Alternative

      "error"

  • Response 200 · deliveryStatus · anyOf 2Alternative

    null

• Response 200 · finalUrlRequired

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · finalUrl · anyOf 1Alternative

    string

  • Response 200 · finalUrl · anyOf 2Alternative

    null

• Response 200 · generationIdRequired

  string

• Response 200 · linksRequired

  object

  Unknown fields are not accepted.

  3 fields

  • Response 200 · links.finalRequired

    string | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · links.final · anyOf 1Alternative

      string

    • Response 200 · links.final · anyOf 2Alternative

      null

  • Response 200 · links.resourceRequired

    string

  • Response 200 · links.taskRequired

    string

• Response 200 · pollUrlRequired

  string

• Response 200 · pricingRequired

  object

  Unknown fields are not accepted.

  9 fields

  • Response 200 · pricing.adjustmentCreditsRequired

    number

    chargedCredits - baseCredits

  • Response 200 · pricing.baseCreditsRequired

    number

    Standard quoted credits before customer pricing adjustment

  • Response 200 · pricing.chargedCreditsRequired

    number

    Credits charged for this create request

    Minimum: 0.

  • Response 200 · pricing.quoteVersionRequired

    number

    Pricing quote version stored with the task

  • Response 200 · pricing.sourceRequired

    "standard" | "customer_rule"

    Public pricing source category

  • Response 200 · pricing.billingIncrementCreditsOptional

    number

    Smallest customer charge increment

    Minimum: 0.0001.

  • Response 200 · pricing.calculatedCreditsOptional

    number

    Precise whole-order subtotal before settlement rounding

  • Response 200 · pricing.settlementPolicyVersionOptional

    string

    Versioned customer settlement policy

  • Response 200 · pricing.settlementRoundingCreditsOptional

    number

    Whole-order rounding adjustment added at settlement

    Minimum: 0.

• Response 200 · productRequired

  object

  Unknown fields are not accepted.

  7 fields

  • Response 200 · product.autoFinalizeRequired

    boolean

  • Response 200 · product.deliveryStatusRequired

    "submitted" | "queued" | "streaming" | "complete" | "error" | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · product.deliveryStatus · anyOf 1Alternative

      "submitted" | "queued" | "streaming" | "complete" | "error"

      Must match at least one alternative.

      5 fields / alternatives

      • Response 200 · product.deliveryStatus · anyOf 1 · anyOf 1Alternative

        "submitted"

      • Response 200 · product.deliveryStatus · anyOf 1 · anyOf 2Alternative

        "queued"

      • Response 200 · product.deliveryStatus · anyOf 1 · anyOf 3Alternative

        "streaming"

      • Response 200 · product.deliveryStatus · anyOf 1 · anyOf 4Alternative

        "complete"

      • Response 200 · product.deliveryStatus · anyOf 1 · anyOf 5Alternative

        "error"

    • Response 200 · product.deliveryStatus · anyOf 2Alternative

      null

  • Response 200 · product.featureCodeRequired

    string

  • Response 200 · product.modelCodeRequired

    string

  • Response 200 · product.providerCodeRequired

    "suno"

  • Response 200 · product.resourceIdRequired

    string

  • Response 200 · product.typeRequired

    "suno"

• Response 200 · requestIdRequired

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · requestId · anyOf 1Alternative

    string

  • Response 200 · requestId · anyOf 2Alternative

    null

• Response 200 · statusRequired

  "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED"

  Default: "PENDING".

• Response 200 · taskIdRequired

  string

• Response 200 · viewUrlRequired

  string

• Response 200 · warningCodesRequired

  array<string>
  1 field

  • Response 200 · warningCodes[]Each item

    string

• Response 200 · estimatedCompletionTimeOptional

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · estimatedCompletionTime · anyOf 1Alternative

    string

    Estimated completion time as an RFC 3339 string.

    Format: date-time.

  • Response 200 · estimatedCompletionTime · anyOf 2Alternative

    null

400 Bad Request

application/json

• Response 400 · errorRequired

  object
  3 fields

  • Response 400 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 400 · error.messageRequired

    string

    Human readable error message

  • Response 400 · error.detailsOptional

    object

    Additional error details (optional)

• Response 400 · successRequired

  false

  Always false for error responses

401 Unauthorized

application/json

• Response 401 · errorRequired

  object
  3 fields

  • Response 401 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 401 · error.messageRequired

    string

    Human readable error message

  • Response 401 · error.detailsOptional

    object

    Additional error details (optional)

• Response 401 · successRequired

  false

  Always false for error responses

402 Payment Required

application/json

• Response 402 · errorRequired

  object
  3 fields

  • Response 402 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 402 · error.messageRequired

    string

    Human readable error message

  • Response 402 · error.detailsOptional

    object

    Additional error details (optional)

• Response 402 · successRequired

  false

  Always false for error responses

403 Forbidden

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

• Response 403 · errorRequired

  object
  3 fields

  • Response 403 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 403 · error.messageRequired

    string

    Human readable error message

  • Response 403 · error.detailsOptional

    object

    Additional error details (optional)

• Response 403 · successRequired

  false

  Always false for error responses

404 Not Found

application/json

• Response 404 · errorRequired

  object
  3 fields

  • Response 404 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 404 · error.messageRequired

    string

    Human readable error message

  • Response 404 · error.detailsOptional

    object

    Additional error details (optional)

• Response 404 · successRequired

  false

  Always false for error responses

422 Unprocessable Entity

application/json

• Response 422 · errorRequired

  object
  3 fields

  • Response 422 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 422 · error.messageRequired

    string

    Human readable error message

  • Response 422 · error.detailsOptional

    object

    Additional error details (optional)

• Response 422 · successRequired

  false

  Always 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 · errorRequired

  object
  3 fields

  • Response 429 · error.codeRequired

    string

    RATE_LIMITED for request and task admission rejections.

  • Response 429 · error.messageRequired

    string

  • Response 429 · error.detailsOptional

    object

    Optional 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.currentOptional

      integer

      Minimum: 0.

    • Response 429 · error.details.inFlightOptional

      integer

      Minimum: 0.

    • Response 429 · error.details.limitOptional

      integer

      Minimum: 0.

    • Response 429 · error.details.policyOptional

      "operation" | "query"

    • Response 429 · error.details.retryAfterSecOptional

      integer

      Minimum: 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 · successRequired

  false

  Default: false.

500 Internal Server Error

application/json

• Response 500 · errorRequired

  object
  3 fields

  • Response 500 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 500 · error.messageRequired

    string

    Human readable error message

  • Response 500 · error.detailsOptional

    object

    Additional error details (optional)

• Response 500 · successRequired

  false

  Always false for error responses

503 Service Unavailable

application/json

• Response 503 · errorRequired

  object
  3 fields

  • Response 503 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 503 · error.messageRequired

    string

    Human readable error message

  • Response 503 · error.detailsOptional

    object

    Additional error details (optional)

• Response 503 · successRequired

  false

  Always false for error responses

Request example

Wrap lines

cURL

curl --globoff --request POST \
  --url 'https://api.omnapi.com/api/v1/suno/songs' \
  --header "x-api-key: $OMNAPI_KEY" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header 'Content-Type: application/json' \
  --data @request.json

Node.js

import { readFile } from "node:fs/promises";
const response = await fetch("https://api.omnapi.com/api/v1/suno/songs", {
  method: "POST",
  headers: {
    "x-api-key": process.env.OMNAPI_KEY,
    "Idempotency-Key": process.env.IDEMPOTENCY_KEY,
    "Content-Type": "application/json",
  },
  body: await readFile("request.json", "utf8"),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.text());

Python

import os, json
import requests

response = requests.request(
    "POST", "https://api.omnapi.com/api/v1/suno/songs",
    headers={
        "x-api-key": os.environ["OMNAPI_KEY"],
        "Idempotency-Key": os.environ["IDEMPOTENCY_KEY"],
    },
    json=json.load(open("request.json")),
    timeout=60,
)
response.raise_for_status()
print(response.text)

Set URL and header variables. Save your JSON body as request.json. Reuse the same IDEMPOTENCY_KEY and body on retries.

Interactive API Explorer → · OpenAPI JSON