Create Task

POST/api/v1/tasksCopy URL

Authentication · x-api-key

Create a new AI task

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.

Unknown fields are not accepted. Must match exactly one alternative.

• Request · inputParametersRequired

  object

  Input parameters for the task

• Request · modelRequired

  "gpt/gpt-4.1-mini/lyrics-generation" | "gpt/gpt-4.1/lyrics-generation" | "gpt/gpt-4o-mini/lyrics-generation" | "gpt/gpt-4o/lyrics-generation" | "mv/mv-managed-basic/generate-managed-mv" | "producer/lyria-3-5/generate-image" | "producer/lyria-3-5/generate-lyrics" | "producer/lyria-3-5/generate-music-compose" | "producer/lyria-3-5/generate-music-modify" | "producer/lyria-3-5/producer-edit-lyrics" | "producer/lyria-3-5/producer-export-batch" | "producer/lyria-3-5/producer-export-song" | "producer/lyria-3-5/producer-mutate-song" | "producer/lyria-3-5/producer-split-stems" | "producer/lyria-3-5/producer-trim-audio" | "producer/lyria-3-preview/generate-image" | "producer/lyria-3-preview/generate-lyrics" | "producer/lyria-3-preview/generate-music-compose" | "producer/lyria-3-preview/generate-music-modify" | "producer/lyria-3-preview/producer-edit-lyrics" | "producer/lyria-3-preview/producer-export-batch" | "producer/lyria-3-preview/producer-export-song" | "producer/lyria-3-preview/producer-mutate-song" | "producer/lyria-3-preview/producer-split-stems" | "producer/lyria-3-preview/producer-trim-audio" | "producer/lyria-3-pro/generate-image" | "producer/lyria-3-pro/generate-lyrics" | "producer/lyria-3-pro/generate-music-compose" | "producer/lyria-3-pro/generate-music-modify" | "producer/lyria-3-pro/producer-edit-lyrics" | "producer/lyria-3-pro/producer-export-batch" | "producer/lyria-3-pro/producer-export-song" | "producer/lyria-3-pro/producer-mutate-song" | "producer/lyria-3-pro/producer-split-stems" | "producer/lyria-3-pro/producer-trim-audio" | "suno/chirp-auk-turbo/get-audio-analysis" | "suno/chirp-auk-turbo/get-clip-detail" | "suno/chirp-auk-turbo/get-lyrics-timeline" | "suno/chirp-auk-turbo/get-persona" | "suno/chirp-auk-turbo/get-voice" | "suno/chirp-auk-turbo/list-personas" | "suno/chirp-auk-turbo/list-voices" | "suno/chirp-auk-turbo/lyrics-pair" | "suno/chirp-auk-turbo/query-songs" | "suno/chirp-auk-turbo/recommend-styles" | "suno/chirp-auk-turbo/text-to-lyrics" | "suno/chirp-auk-turbo/text-to-music-simple" | "suno/chirp-auk/get-audio-analysis" | "suno/chirp-auk/get-clip-detail" | "suno/chirp-auk/get-lyrics-timeline" | "suno/chirp-auk/get-persona" | "suno/chirp-auk/get-voice" | "suno/chirp-auk/list-personas" | "suno/chirp-auk/list-voices" | "suno/chirp-auk/lyrics-pair" | "suno/chirp-auk/query-songs" | "suno/chirp-auk/recommend-styles" | "suno/chirp-auk/text-to-lyrics" | "suno/chirp-auk/text-to-music-simple" | "suno/chirp-bluejay/get-audio-analysis" | "suno/chirp-bluejay/get-clip-detail" | "suno/chirp-bluejay/get-lyrics-timeline" | "suno/chirp-bluejay/get-persona" | "suno/chirp-bluejay/get-voice" | "suno/chirp-bluejay/list-personas" | "suno/chirp-bluejay/list-voices" | "suno/chirp-bluejay/lyrics-pair" | "suno/chirp-bluejay/query-songs" | "suno/chirp-bluejay/recommend-styles" | "suno/chirp-bluejay/text-to-lyrics" | "suno/chirp-bluejay/text-to-music-simple" | "suno/chirp-crow/get-audio-analysis" | "suno/chirp-crow/get-clip-detail" | "suno/chirp-crow/get-lyrics-timeline" | "suno/chirp-crow/get-persona" | "suno/chirp-crow/get-voice" | "suno/chirp-crow/list-personas" | "suno/chirp-crow/list-voices" | "suno/chirp-crow/lyrics-pair" | "suno/chirp-crow/query-songs" | "suno/chirp-crow/recommend-styles" | "suno/chirp-crow/text-to-lyrics" | "suno/chirp-crow/text-to-music-simple" | "suno/chirp-fenix/get-audio-analysis" | "suno/chirp-fenix/get-clip-detail" | "suno/chirp-fenix/get-lyrics-timeline" | "suno/chirp-fenix/get-persona" | "suno/chirp-fenix/get-voice" | "suno/chirp-fenix/list-personas" | "suno/chirp-fenix/list-voices" | "suno/chirp-fenix/lyrics-pair" | "suno/chirp-fenix/query-songs" | "suno/chirp-fenix/recommend-styles" | "suno/chirp-fenix/text-to-lyrics" | "suno/chirp-fenix/text-to-music-simple" | "suno/chirp-goose/get-audio-analysis" | "suno/chirp-goose/get-clip-detail" | "suno/chirp-goose/get-lyrics-timeline" | "suno/chirp-goose/get-persona" | "suno/chirp-goose/get-voice" | "suno/chirp-goose/list-personas" | "suno/chirp-goose/list-voices" | "suno/chirp-goose/lyrics-pair" | "suno/chirp-goose/query-songs" | "suno/chirp-goose/recommend-styles" | "suno/chirp-goose/text-to-lyrics" | "suno/chirp-goose/text-to-music-simple" | "suno/chirp-hawk-wild/get-audio-analysis" | "suno/chirp-hawk-wild/get-clip-detail" | "suno/chirp-hawk-wild/get-lyrics-timeline" | "suno/chirp-hawk-wild/get-persona" | "suno/chirp-hawk-wild/get-voice" | "suno/chirp-hawk-wild/list-personas" | "suno/chirp-hawk-wild/list-voices" | "suno/chirp-hawk-wild/lyrics-pair" | "suno/chirp-hawk-wild/query-songs" | "suno/chirp-hawk-wild/recommend-styles" | "suno/chirp-hawk-wild/text-to-lyrics" | "suno/chirp-hawk-wild/text-to-music-simple" | "suno/chirp-hawk/get-audio-analysis" | "suno/chirp-hawk/get-clip-detail" | "suno/chirp-hawk/get-lyrics-timeline" | "suno/chirp-hawk/get-persona" | "suno/chirp-hawk/get-voice" | "suno/chirp-hawk/list-personas" | "suno/chirp-hawk/list-voices" | "suno/chirp-hawk/lyrics-pair" | "suno/chirp-hawk/query-songs" | "suno/chirp-hawk/recommend-styles" | "suno/chirp-hawk/text-to-lyrics" | "suno/chirp-hawk/text-to-music-simple" | "suno/chirp-v4/get-audio-analysis" | "suno/chirp-v4/get-clip-detail" | "suno/chirp-v4/get-lyrics-timeline" | "suno/chirp-v4/get-persona" | "suno/chirp-v4/get-voice" | "suno/chirp-v4/list-personas" | "suno/chirp-v4/list-voices" | "suno/chirp-v4/lyrics-pair" | "suno/chirp-v4/query-songs" | "suno/chirp-v4/recommend-styles" | "suno/chirp-v4/text-to-lyrics" | "suno/chirp-v4/text-to-music-simple" | "suno/chirp_auk/get-audio-analysis" | "suno/chirp_auk/get-clip-detail" | "suno/chirp_auk/get-lyrics-timeline" | "suno/chirp_auk/get-persona" | "suno/chirp_auk/get-voice" | "suno/chirp_auk/list-personas" | "suno/chirp_auk/list-voices" | "suno/chirp_auk/lyrics-pair" | "suno/chirp_auk/query-songs" | "suno/chirp_auk/recommend-styles" | "suno/chirp_auk/text-to-lyrics" | "suno/chirp_auk/text-to-music-simple" | "suno/chirp_auk_turbo/get-audio-analysis" | "suno/chirp_auk_turbo/get-clip-detail" | "suno/chirp_auk_turbo/get-lyrics-timeline" | "suno/chirp_auk_turbo/get-persona" | "suno/chirp_auk_turbo/get-voice" | "suno/chirp_auk_turbo/list-personas" | "suno/chirp_auk_turbo/list-voices" | "suno/chirp_auk_turbo/lyrics-pair" | "suno/chirp_auk_turbo/query-songs" | "suno/chirp_auk_turbo/recommend-styles" | "suno/chirp_auk_turbo/text-to-lyrics" | "suno/chirp_auk_turbo/text-to-music-simple" | "suno/chirp_bluejay/get-audio-analysis" | "suno/chirp_bluejay/get-clip-detail" | "suno/chirp_bluejay/get-lyrics-timeline" | "suno/chirp_bluejay/get-persona" | "suno/chirp_bluejay/get-voice" | "suno/chirp_bluejay/list-personas" | "suno/chirp_bluejay/list-voices" | "suno/chirp_bluejay/lyrics-pair" | "suno/chirp_bluejay/query-songs" | "suno/chirp_bluejay/recommend-styles" | "suno/chirp_bluejay/text-to-lyrics" | "suno/chirp_bluejay/text-to-music-simple" | "suno/chirp_crow/get-audio-analysis" | "suno/chirp_crow/get-clip-detail" | "suno/chirp_crow/get-lyrics-timeline" | "suno/chirp_crow/get-persona" | "suno/chirp_crow/get-voice" | "suno/chirp_crow/list-personas" | "suno/chirp_crow/list-voices" | "suno/chirp_crow/lyrics-pair" | "suno/chirp_crow/query-songs" | "suno/chirp_crow/recommend-styles" | "suno/chirp_crow/text-to-lyrics" | "suno/chirp_crow/text-to-music-simple" | "suno/chirp_fenix/get-audio-analysis" | "suno/chirp_fenix/get-clip-detail" | "suno/chirp_fenix/get-lyrics-timeline" | "suno/chirp_fenix/get-persona" | "suno/chirp_fenix/get-voice" | "suno/chirp_fenix/list-personas" | "suno/chirp_fenix/list-voices" | "suno/chirp_fenix/lyrics-pair" | "suno/chirp_fenix/query-songs" | "suno/chirp_fenix/recommend-styles" | "suno/chirp_fenix/text-to-lyrics" | "suno/chirp_fenix/text-to-music-simple" | "suno/chirp_v4/get-audio-analysis" | "suno/chirp_v4/get-clip-detail" | "suno/chirp_v4/get-lyrics-timeline" | "suno/chirp_v4/get-persona" | "suno/chirp_v4/get-voice" | "suno/chirp_v4/list-personas" | "suno/chirp_v4/list-voices" | "suno/chirp_v4/lyrics-pair" | "suno/chirp_v4/query-songs" | "suno/chirp_v4/recommend-styles" | "suno/chirp_v4/text-to-lyrics" | "suno/chirp_v4/text-to-music-simple"

  Public model path in format "providerCode/modelCode/featureCode". Legacy Suno model names remain accepted and execute on their V6 equivalents while retaining the requested pricing identity.

  Default: "gpt/gpt-4.1-mini/lyrics-generation".

• Request · configOptional

  not accepted

  Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

  This value is not accepted.

• Request · metadataOptional

  object

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

• Request · priorityOptional

  number

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

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

• Request · tagsOptional

  array<string>

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

  Maximum items: 20.

  1 field

  • Request · tags[]Each item

    string

    Maximum characters: 100.

• Request · webhookUrlOptional

  string

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

  Format: uri.

• Request · body · oneOf 1Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 1.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    Unknown fields are not accepted.

    17 fields

    • Request · body · oneOf 1.inputParameters.promptRequired

      string

      Core song brief, story, scene, or hook idea.

      Maximum characters: 2000.

    • Request · body · oneOf 1.inputParameters.durationSecOptional

      number

      Target duration in seconds.

      Minimum: 30. Maximum: 480.

    • Request · body · oneOf 1.inputParameters.explicitOptional

      boolean

      Whether explicit language is allowed.

    • Request · body · oneOf 1.inputParameters.extraGuidanceOptional

      string

      Additional creative guidance and constraints.

      Maximum characters: 2000.

    • Request · body · oneOf 1.inputParameters.genreOptional

      string

      Requested musical genre direction.

      Maximum characters: 200.

    • Request · body · oneOf 1.inputParameters.languageOptional

      string

      Primary lyric language. Use 'auto' to let the model decide.

      Maximum characters: 80.

    • Request · body · oneOf 1.inputParameters.languagesOptional

      array<string>

      Additional languages to include or consider.

      1 field

      • Request · body · oneOf 1.inputParameters.languages[]Each item

        string

        Additional languages to consider for multilingual lyrics.

        Maximum characters: 80.

    • Request · body · oneOf 1.inputParameters.maxTokensOptional

      number

      Maximum completion tokens for lyrics generation.

      Minimum: 500. Maximum: 4000.

    • Request · body · oneOf 1.inputParameters.modelOptional

      string

      Optional lyrics model override. Defaults to the configured lyrics model.

      Maximum characters: 120.

    • Request · body · oneOf 1.inputParameters.moodOptional

      string

      Requested musical or visual mood.

      Maximum characters: 200.

    • Request · body · oneOf 1.inputParameters.multilingualModeOptional

      "auto" | "sectioned" | "blended" | "call_and_response"

      How multiple languages should be mixed.

      Must match at least one alternative.

      4 fields / alternatives

      • Request · body · oneOf 1.inputParameters.multilingualMode · anyOf 1Alternative

        "auto"

      • Request · body · oneOf 1.inputParameters.multilingualMode · anyOf 2Alternative

        "sectioned"

      • Request · body · oneOf 1.inputParameters.multilingualMode · anyOf 3Alternative

        "blended"

      • Request · body · oneOf 1.inputParameters.multilingualMode · anyOf 4Alternative

        "call_and_response"

    • Request · body · oneOf 1.inputParameters.negativeConstraintsOptional

      array<string>

      Topics, styles, or tropes the output should avoid.

      1 field

      • Request · body · oneOf 1.inputParameters.negativeConstraints[]Each item

        string

        Maximum characters: 80.

    • Request · body · oneOf 1.inputParameters.perspectiveOptional

      "first_person" | "second_person" | "third_person" | "mixed"

      Requested lyric narrative perspective.

      Must match at least one alternative.

      4 fields / alternatives

      • Request · body · oneOf 1.inputParameters.perspective · anyOf 1Alternative

        "first_person"

      • Request · body · oneOf 1.inputParameters.perspective · anyOf 2Alternative

        "second_person"

      • Request · body · oneOf 1.inputParameters.perspective · anyOf 3Alternative

        "third_person"

      • Request · body · oneOf 1.inputParameters.perspective · anyOf 4Alternative

        "mixed"

    • Request · body · oneOf 1.inputParameters.structureOptional

      array<string>

      Requested lyric section order.

      1 field

      • Request · body · oneOf 1.inputParameters.structure[]Each item

        string

        Maximum characters: 50.

    • Request · body · oneOf 1.inputParameters.temperatureOptional

      number

      Sampling temperature for lyrics generation.

      Minimum: 0. Maximum: 2.

    • Request · body · oneOf 1.inputParameters.themeKeywordsOptional

      array<string>

      Short theme anchors for structured lyrics.

      1 field

      • Request · body · oneOf 1.inputParameters.themeKeywords[]Each item

        string

        Maximum characters: 60.

    • Request · body · oneOf 1.inputParameters.vocalStyleOptional

      string

      Requested vocal performance direction.

      Maximum characters: 200.

  • Request · body · oneOf 1.modelRequired

    "gpt/gpt-4.1-mini/lyrics-generation" | "gpt/gpt-4.1/lyrics-generation" | "gpt/gpt-4o-mini/lyrics-generation" | "gpt/gpt-4o/lyrics-generation"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 1.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 1.metadataOptional

    object

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

  • Request · body · oneOf 1.priorityOptional

    number

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

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

  • Request · body · oneOf 1.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 1.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 1.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 2Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 2.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    Must match at least one alternative.

    2 fields / alternatives

    • Request · body · oneOf 2.inputParameters · anyOf 1Alternative

      object

      Unknown fields are not accepted.

      19 fields

      • Request · body · oneOf 2.inputParameters · anyOf 1.modeRequired

        "fast"

        Operation or product mode discriminator for this schema variant.

      • Request · body · oneOf 2.inputParameters · anyOf 1.sourceRequired

        object

        Public source media or product reference.

        Must match at least one alternative.

        2 fields / alternatives

        • Request · body · oneOf 2.inputParameters · anyOf 1.source · anyOf 1Alternative

          object

          Unknown fields are not accepted.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.source · anyOf 1See schema

            object

            Expand this value in the interactive reference.

            Unknown fields are not accepted.

        • Request · body · oneOf 2.inputParameters · anyOf 1.source · anyOf 2Alternative

          object

          Unknown fields are not accepted.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.source · anyOf 2See schema

            object

            Expand this value in the interactive reference.

            Unknown fields are not accepted.

      • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatioOptional

        "16:9" | "9:16" | "1:1" | "4:3" | "3:4"

        Requested output aspect ratio.

        Must match at least one alternative.

        5 fields / alternatives

        • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatio · anyOf 1Alternative

          "16:9"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatio · anyOf 1See schema

            "16:9"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatio · anyOf 2Alternative

          "9:16"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatio · anyOf 2See schema

            "9:16"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatio · anyOf 3Alternative

          "1:1"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatio · anyOf 3See schema

            "1:1"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatio · anyOf 4Alternative

          "4:3"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatio · anyOf 4See schema

            "4:3"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatio · anyOf 5Alternative

          "3:4"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.aspectRatio · anyOf 5See schema

            "3:4"

            Expand this value in the interactive reference.

      • Request · body · oneOf 2.inputParameters · anyOf 1.characterImageOptional

        string

        Public character reference image URL.

        Minimum characters: 1.

      • Request · body · oneOf 2.inputParameters · anyOf 1.configOptional

        object

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

        4 fields

        • Request · body · oneOf 2.inputParameters · anyOf 1.config.metadataOptional

          object

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

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.config.metadataSee schema

            object

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.config.priorityOptional

          number

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

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

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.config.prioritySee schema

            number

            Expand this value in the interactive reference.

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

        • Request · body · oneOf 2.inputParameters · anyOf 1.config.tagsOptional

          array<string>

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

          Maximum items: 20.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.config.tagsSee schema

            array<string>

            Expand this value in the interactive reference.

            Maximum items: 20.

        • Request · body · oneOf 2.inputParameters · anyOf 1.config.webhookUrlOptional

          string

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

          Format: uri.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.config.webhookUrlSee schema

            string

            Expand this value in the interactive reference.

            Format: uri.

      • Request · body · oneOf 2.inputParameters · anyOf 1.generationOptional

        object

        Product-specific generation controls.

        Unknown fields are not accepted.

        16 fields

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.creativeModeOptional

          "auto" | "lyrics_story" | "prompt_story" | "mood_visual" | "performance" | "sing_dance" | "sing_play"

          Creative intent used by Fast MV prompt and reference planning.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.creativeModeSee schema

            "auto" | "lyrics_story" | "prompt_story" | "mood_visual" | "performance" | "sing_dance" | "sing_play"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.engineVersionOptional

          "vidu-v1" | "vidu-v2" | "omn-v1"

          Explicit MV generation option. Check capabilities and preflight before selecting omn-v1; unsupported combinations fail before credit debit.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.engineVersionSee schema

            "vidu-v1" | "vidu-v2" | "omn-v1"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.lipReferenceImagesOptional

          array<string>

          Ordered singer portrait URLs for sing/sing_perform; optional on Omn V1 (a performer is generated when omitted), required on Vidu V2 unless characterImage is supplied. The first item maps to the first singer.

          Minimum items: 1. Maximum items: 2.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.lipReferenceImagesSee schema

            array<string>

            Expand this value in the interactive reference.

            Minimum items: 1. Maximum items: 2.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.managedVersionOptional

          "oneclick-v1" | "premium-v2"

          Managed Fast MV engine version. Existing clients default to oneclick-v1; premium-v2 must be selected explicitly.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.managedVersionSee schema

            "oneclick-v1" | "premium-v2"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.motionPresetOptional

          "stable_performance" | "cinematic_light" | "dynamic_dance" | "lip_sync_closeup"

          Fast MV motion prompt policy.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.motionPresetSee schema

            "stable_performance" | "cinematic_light" | "dynamic_dance" | "lip_sync_closeup"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.motionReferenceVideoOptional

          string

          Omn V1 Premium V2 dance only: public HTTPS URL of a motion reference video whose moves drive dance shots (render tiers draft/standard). Requires motionRightsConfirmed=true. The URL must declare its size (at most 128 MB) and, when it declares a content type, a video/* or application/octet-stream one; otherwise 400 VALIDATION_ERROR on this field. The video should be 2–660 seconds long with a short side of at least 240 px and a long side of at most 4096 px; its audio is not used (each dance shot uses a silent clip aligned to its song window, looping a shorter video). Motion transfer applies only to 16:9 and 9:16 MVs, and a 16:9 or 9:16 request is rejected with 422 MV_ENGINE_UNSUPPORTED (reason specialist_mode_unsupported) before any charge when motion transfer is unavailable; other aspect ratios, and videos that turn out to be unusable (unreachable, not decodable, or outside these bounds), dance without motion transfer at the same price.

          Minimum characters: 1.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.motionReferenceVideoSee schema

            string

            Expand this value in the interactive reference.

            Minimum characters: 1.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.motionRightsConfirmedOptional

          true

          Required with motionReferenceVideo: you confirm you hold the rights to use the motion footage.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.motionRightsConfirmedSee schema

            true

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.performanceModeOptional

          "sing" | "sing_perform" | "perform" | "dance"

          Premium V2 performance mode: singing, singing with performance, instrumental performance, or dance.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.performanceModeSee schema

            "sing" | "sing_perform" | "perform" | "dance"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.promptModeOptional

          "auto" | "verbatim" | "creative_brief"

          Whether Fast MV preserves or compiles the caller prompt.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.promptModeSee schema

            "auto" | "verbatim" | "creative_brief"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.qualityOptional

          "standard" | "high"

          Requested public quality tier.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.qualitySee schema

            "standard" | "high"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.referenceStrategyOptional

          "direct" | "synthesize"

          Fast MV policy for direct or synthesized references.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.referenceStrategySee schema

            "direct" | "synthesize"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.renderTierOptional

          "draft" | "standard" | "hd" | "ultra"

          Omn V1 only. draft delivers 540p; standard 720p; hd 1080p; ultra 720p, 1080p or 1440p. When omitted: resolution=1440p or quality="high" selects ultra, standard quality selects draft at 540p and standard at 720p and hd at 1080p. Native shot rendering offers these tiers for both managed versions subject to capability and preflight checks. Dance motion transfer supports draft or standard only.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.renderTierSee schema

            "draft" | "standard" | "hd" | "ultra"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.scheduleOptional

          "standard" | "economy"

          Omn V1 only. economy renders shots only in the off-peak window at the same video price as standard scheduling, with a longer delivery window: shots start between 00:00 and 07:40 Beijing time (no new shot in the window's last 20 minutes, so none runs into peak pricing). MVView.generation.scheduleWindow reports the window the waiting shots are bought in; its offPeakEndsAt is the 08:00 window end.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.scheduleSee schema

            "standard" | "economy"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.styleOptional

          string

          Requested creative style direction.

          Maximum characters: 200.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.styleSee schema

            string

            Expand this value in the interactive reference.

            Maximum characters: 200.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.subtitleModeOptional

          "vidu" | "custom"

          Fast MV subtitle rendering mode.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.subtitleModeSee schema

            "vidu" | "custom"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.generation.visualBoardOptional

          object

          Fast MV Visual Board configuration.

          Unknown fields are not accepted.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.generation.visualBoardSee schema

            object

            Expand this value in the interactive reference.

            Unknown fields are not accepted.

      • Request · body · oneOf 2.inputParameters · anyOf 1.languageOptional

        "auto" | "en" | "zh"

        Requested or known language code/name.

        Must match at least one alternative.

        3 fields / alternatives

        • Request · body · oneOf 2.inputParameters · anyOf 1.language · anyOf 1Alternative

          "auto"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.language · anyOf 1See schema

            "auto"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.language · anyOf 2Alternative

          "en"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.language · anyOf 2See schema

            "en"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.language · anyOf 3Alternative

          "zh"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.language · anyOf 3See schema

            "zh"

            Expand this value in the interactive reference.

      • Request · body · oneOf 2.inputParameters · anyOf 1.lipSyncOptional

        boolean

        Whether the MV should use the supported lip-sync workflow.

      • Request · body · oneOf 2.inputParameters · anyOf 1.maxCreditsOptional

        number

        Maximum OmnAPI credits authorized for this paid request.

        Minimum: 1.

      • Request · body · oneOf 2.inputParameters · anyOf 1.preflightIdOptional

        string

        Reusable MV preflight snapshot identifier.

        Minimum characters: 1. Maximum characters: 100.

      • Request · body · oneOf 2.inputParameters · anyOf 1.promptOptional

        string

        Primary creative or operation instruction.

        Maximum characters: 3000.

      • Request · body · oneOf 2.inputParameters · anyOf 1.quoteIdOptional

        string

        Short-lived quote identifier for the matching paid operation.

        Minimum characters: 1. Maximum characters: 100.

      • Request · body · oneOf 2.inputParameters · anyOf 1.referenceImagesOptional

        array<string>

        Public reference image URLs.

        Maximum items: 7.

        1 field

        • Request · body · oneOf 2.inputParameters · anyOf 1.referenceImages[]Each item

          string

          Minimum characters: 1.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.referenceImages[]See schema

            string

            Expand this value in the interactive reference.

            Minimum characters: 1.

      • Request · body · oneOf 2.inputParameters · anyOf 1.resolutionOptional

        "540p" | "720p" | "1080p" | "1440p"

        Delivery resolution. Default 540p. 1440p is available only with generation.engineVersion="omn-v1"; other engines return MV_RESOLUTION_INVALID.

        Must match at least one alternative.

        4 fields / alternatives

        • Request · body · oneOf 2.inputParameters · anyOf 1.resolution · anyOf 1Alternative

          "540p"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.resolution · anyOf 1See schema

            "540p"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.resolution · anyOf 2Alternative

          "720p"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.resolution · anyOf 2See schema

            "720p"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.resolution · anyOf 3Alternative

          "1080p"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.resolution · anyOf 3See schema

            "1080p"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 1.resolution · anyOf 4Alternative

          "1440p"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.resolution · anyOf 4See schema

            "1440p"

            Expand this value in the interactive reference.

      • Request · body · oneOf 2.inputParameters · anyOf 1.srtUrlOptional

        string

        Public URL of caller-supplied SRT subtitles.

        Minimum characters: 1.

      • Request · body · oneOf 2.inputParameters · anyOf 1.subtitleOptional

        object

        MV subtitle generation and fallback policy.

        Unknown fields are not accepted.

        6 fields

        • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.fallbackOptional

          "fail" | "continue_without_subtitles"

          Behavior when the preferred subtitle path cannot complete.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.fallbackSee schema

            "fail" | "continue_without_subtitles"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.languageOptional

          "auto" | "en" | "zh"

          Requested or known language code/name.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.languageSee schema

            "auto" | "en" | "zh"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.maxCostUsdPerMinOptional

          number

          Maximum accepted public subtitle price in USD per minute.

          Minimum: 0.001. Maximum: 1.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.maxCostUsdPerMinSee schema

            number

            Expand this value in the interactive reference.

            Minimum: 0.001. Maximum: 1.

        • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.modeOptional

          "auto" | "provided" | "off"

          Operation or product mode discriminator for this schema variant.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.modeSee schema

            "auto" | "provided" | "off"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.qualityOptional

          "standard" | "premium"

          Requested public quality tier.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.qualitySee schema

            "standard" | "premium"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.requiredOptional

          boolean

          Whether the selected subtitle policy must succeed.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 1.subtitle.requiredSee schema

            boolean

            Expand this value in the interactive reference.

      • Request · body · oneOf 2.inputParameters · anyOf 1.subtitleColorOptional

        string

        Requested subtitle foreground color.

        Maximum characters: 20.

      • Request · body · oneOf 2.inputParameters · anyOf 1.subtitlesOptional

        boolean

        Whether subtitles are enabled for the MV.

      • Request · body · oneOf 2.inputParameters · anyOf 1.titleOptional

        string

        Optional customer-facing title.

        Maximum characters: 200.

    • Request · body · oneOf 2.inputParameters · anyOf 2Alternative

      object

      Unknown fields are not accepted.

      19 fields

      • Request · body · oneOf 2.inputParameters · anyOf 2.modeRequired

        "studio"

        Operation or product mode discriminator for this schema variant.

      • Request · body · oneOf 2.inputParameters · anyOf 2.sourceRequired

        object

        Public source media or product reference.

        Must match at least one alternative.

        2 fields / alternatives

        • Request · body · oneOf 2.inputParameters · anyOf 2.source · anyOf 1Alternative

          object

          Unknown fields are not accepted.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.source · anyOf 1See schema

            object

            Expand this value in the interactive reference.

            Unknown fields are not accepted.

        • Request · body · oneOf 2.inputParameters · anyOf 2.source · anyOf 2Alternative

          object

          Unknown fields are not accepted.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.source · anyOf 2See schema

            object

            Expand this value in the interactive reference.

            Unknown fields are not accepted.

      • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatioOptional

        "16:9" | "9:16" | "1:1" | "4:3" | "3:4"

        Requested output aspect ratio.

        Must match at least one alternative.

        5 fields / alternatives

        • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatio · anyOf 1Alternative

          "16:9"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatio · anyOf 1See schema

            "16:9"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatio · anyOf 2Alternative

          "9:16"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatio · anyOf 2See schema

            "9:16"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatio · anyOf 3Alternative

          "1:1"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatio · anyOf 3See schema

            "1:1"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatio · anyOf 4Alternative

          "4:3"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatio · anyOf 4See schema

            "4:3"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatio · anyOf 5Alternative

          "3:4"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.aspectRatio · anyOf 5See schema

            "3:4"

            Expand this value in the interactive reference.

      • Request · body · oneOf 2.inputParameters · anyOf 2.characterImageOptional

        string

        Public character reference image URL.

        Minimum characters: 1.

      • Request · body · oneOf 2.inputParameters · anyOf 2.configOptional

        object

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

        4 fields

        • Request · body · oneOf 2.inputParameters · anyOf 2.config.metadataOptional

          object

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

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.config.metadataSee schema

            object

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 2.config.priorityOptional

          number

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

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

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.config.prioritySee schema

            number

            Expand this value in the interactive reference.

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

        • Request · body · oneOf 2.inputParameters · anyOf 2.config.tagsOptional

          array<string>

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

          Maximum items: 20.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.config.tagsSee schema

            array<string>

            Expand this value in the interactive reference.

            Maximum items: 20.

        • Request · body · oneOf 2.inputParameters · anyOf 2.config.webhookUrlOptional

          string

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

          Format: uri.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.config.webhookUrlSee schema

            string

            Expand this value in the interactive reference.

            Format: uri.

      • Request · body · oneOf 2.inputParameters · anyOf 2.generationOptional

        object

        Product-specific generation controls.

        Unknown fields are not accepted.

        3 fields

        • Request · body · oneOf 2.inputParameters · anyOf 2.generation.imageProviderOptional

          "p-image" | "gpt-image-2" | "viduq2"

          Public image-generation option code.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.generation.imageProviderSee schema

            "p-image" | "gpt-image-2" | "viduq2"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 2.generation.videoModelOptional

          string

          Public scene-video model code.

          Maximum characters: 100.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.generation.videoModelSee schema

            string

            Expand this value in the interactive reference.

            Maximum characters: 100.

        • Request · body · oneOf 2.inputParameters · anyOf 2.generation.videoProviderOptional

          "p-video" | "hailuo" | "minimax-h3" | "vidu"

          Public scene-video option code.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.generation.videoProviderSee schema

            "p-video" | "hailuo" | "minimax-h3" | "vidu"

            Expand this value in the interactive reference.

            Must match at least one alternative.

      • Request · body · oneOf 2.inputParameters · anyOf 2.languageOptional

        "auto" | "en" | "zh"

        Requested or known language code/name.

        Must match at least one alternative.

        3 fields / alternatives

        • Request · body · oneOf 2.inputParameters · anyOf 2.language · anyOf 1Alternative

          "auto"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.language · anyOf 1See schema

            "auto"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 2.language · anyOf 2Alternative

          "en"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.language · anyOf 2See schema

            "en"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 2.language · anyOf 3Alternative

          "zh"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.language · anyOf 3See schema

            "zh"

            Expand this value in the interactive reference.

      • Request · body · oneOf 2.inputParameters · anyOf 2.lipSyncOptional

        boolean

        Whether the MV should use the supported lip-sync workflow.

      • Request · body · oneOf 2.inputParameters · anyOf 2.maxCreditsOptional

        number

        Maximum OmnAPI credits authorized for this paid request.

        Minimum: 1.

      • Request · body · oneOf 2.inputParameters · anyOf 2.preflightIdOptional

        string

        Reusable MV preflight snapshot identifier.

        Minimum characters: 1. Maximum characters: 100.

      • Request · body · oneOf 2.inputParameters · anyOf 2.promptOptional

        string

        Primary creative or operation instruction.

        Maximum characters: 3000.

      • Request · body · oneOf 2.inputParameters · anyOf 2.quoteIdOptional

        string

        Short-lived quote identifier for the matching paid operation.

        Minimum characters: 1. Maximum characters: 100.

      • Request · body · oneOf 2.inputParameters · anyOf 2.referenceImagesOptional

        array<string>

        Public reference image URLs.

        Maximum items: 7.

        1 field

        • Request · body · oneOf 2.inputParameters · anyOf 2.referenceImages[]Each item

          string

          Minimum characters: 1.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.referenceImages[]See schema

            string

            Expand this value in the interactive reference.

            Minimum characters: 1.

      • Request · body · oneOf 2.inputParameters · anyOf 2.resolutionOptional

        "540p" | "720p" | "1080p" | "1440p"

        Delivery resolution. Default 540p. 1440p is available only with generation.engineVersion="omn-v1"; other engines return MV_RESOLUTION_INVALID.

        Must match at least one alternative.

        4 fields / alternatives

        • Request · body · oneOf 2.inputParameters · anyOf 2.resolution · anyOf 1Alternative

          "540p"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.resolution · anyOf 1See schema

            "540p"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 2.resolution · anyOf 2Alternative

          "720p"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.resolution · anyOf 2See schema

            "720p"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 2.resolution · anyOf 3Alternative

          "1080p"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.resolution · anyOf 3See schema

            "1080p"

            Expand this value in the interactive reference.

        • Request · body · oneOf 2.inputParameters · anyOf 2.resolution · anyOf 4Alternative

          "1440p"
          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.resolution · anyOf 4See schema

            "1440p"

            Expand this value in the interactive reference.

      • Request · body · oneOf 2.inputParameters · anyOf 2.srtUrlOptional

        string

        Public URL of caller-supplied SRT subtitles.

        Minimum characters: 1.

      • Request · body · oneOf 2.inputParameters · anyOf 2.subtitleOptional

        object

        MV subtitle generation and fallback policy.

        Unknown fields are not accepted.

        6 fields

        • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.fallbackOptional

          "fail" | "continue_without_subtitles"

          Behavior when the preferred subtitle path cannot complete.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.fallbackSee schema

            "fail" | "continue_without_subtitles"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.languageOptional

          "auto" | "en" | "zh"

          Requested or known language code/name.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.languageSee schema

            "auto" | "en" | "zh"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.maxCostUsdPerMinOptional

          number

          Maximum accepted public subtitle price in USD per minute.

          Minimum: 0.001. Maximum: 1.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.maxCostUsdPerMinSee schema

            number

            Expand this value in the interactive reference.

            Minimum: 0.001. Maximum: 1.

        • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.modeOptional

          "auto" | "provided" | "off"

          Operation or product mode discriminator for this schema variant.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.modeSee schema

            "auto" | "provided" | "off"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.qualityOptional

          "standard" | "premium"

          Requested public quality tier.

          Must match at least one alternative.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.qualitySee schema

            "standard" | "premium"

            Expand this value in the interactive reference.

            Must match at least one alternative.

        • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.requiredOptional

          boolean

          Whether the selected subtitle policy must succeed.

          1 field

          • Request · body · oneOf 2.inputParameters · anyOf 2.subtitle.requiredSee schema

            boolean

            Expand this value in the interactive reference.

      • Request · body · oneOf 2.inputParameters · anyOf 2.subtitleColorOptional

        string

        Requested subtitle foreground color.

        Maximum characters: 20.

      • Request · body · oneOf 2.inputParameters · anyOf 2.subtitlesOptional

        boolean

        Whether subtitles are enabled for the MV.

      • Request · body · oneOf 2.inputParameters · anyOf 2.titleOptional

        string

        Optional customer-facing title.

        Maximum characters: 200.

  • Request · body · oneOf 2.modelRequired

    "mv/mv-managed-basic/generate-managed-mv"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 2.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 2.metadataOptional

    object

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

  • Request · body · oneOf 2.priorityOptional

    number

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

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

  • Request · body · oneOf 2.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 2.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 2.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 3Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 3.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    4 fields

    • Request · body · oneOf 3.inputParameters.promptRequired

      string

      Image generation prompt

      Maximum characters: 2000.

    • Request · body · oneOf 3.inputParameters.heightOptional

      number

      Requested image height in pixels for this model branch.

      Minimum: 256. Maximum: 2048. Default: 1024.

    • Request · body · oneOf 3.inputParameters.styleOptional

      string

      Requested creative style direction.

      Maximum characters: 100.

    • Request · body · oneOf 3.inputParameters.widthOptional

      number

      Requested image width in pixels for this model branch.

      Minimum: 256. Maximum: 2048. Default: 1024.

  • Request · body · oneOf 3.modelRequired

    "producer/lyria-3-5/generate-image" | "producer/lyria-3-preview/generate-image" | "producer/lyria-3-pro/generate-image"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 3.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 3.metadataOptional

    object

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

  • Request · body · oneOf 3.priorityOptional

    number

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

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

  • Request · body · oneOf 3.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 3.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 3.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 4Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 4.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    3 fields

    • Request · body · oneOf 4.inputParameters.promptRequired

      string

      Text prompt for lyrics generation

      Maximum characters: 3000.

    • Request · body · oneOf 4.inputParameters.numVersesOptional

      number

      Requested number of lyric verses.

      Minimum: 1. Maximum: 10.

    • Request · body · oneOf 4.inputParameters.styleOptional

      string

      Requested creative style direction.

      Maximum characters: 200.

  • Request · body · oneOf 4.modelRequired

    "producer/lyria-3-5/generate-lyrics" | "producer/lyria-3-preview/generate-lyrics" | "producer/lyria-3-pro/generate-lyrics"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 4.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 4.metadataOptional

    object

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

  • Request · body · oneOf 4.priorityOptional

    number

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

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

  • Request · body · oneOf 4.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 4.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 4.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 5Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 5.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    14 fields

    • Request · body · oneOf 5.inputParameters.soundPromptRequired

      string

      Sound prompt for music generation

      Maximum characters: 3000.

    • Request · body · oneOf 5.inputParameters.bpmOptional

      number

      Optional BPM hint

      Minimum: 1. Maximum: 999.

    • Request · body · oneOf 5.inputParameters.conversationIdOptional

      string

      Optional existing conversation identifier to reuse.

    • Request · body · oneOf 5.inputParameters.currentSongIdOptional

      string

      Optional current song id used for queue/context continuity

    • Request · body · oneOf 5.inputParameters.imageIdOptional

      string

      Optional cover image id

    • Request · body · oneOf 5.inputParameters.imagePromptOptional

      string

      Optional prompt for generating a cover image

      Maximum characters: 1000.

    • Request · body · oneOf 5.inputParameters.instrumentalOptional

      boolean

      Whether to force instrumental generation

      Default: false.

    • Request · body · oneOf 5.inputParameters.lengthOptional

      number

      Optional length hint in seconds. Lyria 3.5 requires 60-180 seconds; Lyria 3 Pro accepts shorter values.

      Minimum: 1. Maximum: 180.

    • Request · body · oneOf 5.inputParameters.lyricsOptional

      string

      Optional lyrics text for compose generation. If omitted while instrumental=false, OmnAPI auto-generates lyrics before compose.

      Maximum characters: 3000.

    • Request · body · oneOf 5.inputParameters.lyricsIdOptional

      string

      Optional existing lyrics id

    • Request · body · oneOf 5.inputParameters.modelOptional

      "Lyria 3.5" | "Lyria 3 Pro" | "Lyria 3 preview"

      Producer music model. 'Lyria 3 preview' is accepted as a deprecated alias for Lyria 3.5.

      Must match at least one alternative.

      3 fields / alternatives

      • Request · body · oneOf 5.inputParameters.model · anyOf 1Alternative

        "Lyria 3.5"

      • Request · body · oneOf 5.inputParameters.model · anyOf 2Alternative

        "Lyria 3 Pro"

      • Request · body · oneOf 5.inputParameters.model · anyOf 3Alternative

        "Lyria 3 preview"

        Deprecated; omit in new integrations.

    • Request · body · oneOf 5.inputParameters.seedOptional

      number

      Optional seed value

      Minimum: 0.

    • Request · body · oneOf 5.inputParameters.titleOptional

      string

      Optional customer-facing title.

      Maximum characters: 200.

    • Request · body · oneOf 5.inputParameters.advancedModeOptional

      boolean

      Deprecated compatibility field; Producer compose ignores this value.

      Default: false. Deprecated; omit in new integrations.

  • Request · body · oneOf 5.modelRequired

    "producer/lyria-3-5/generate-music-compose" | "producer/lyria-3-preview/generate-music-compose" | "producer/lyria-3-pro/generate-music-compose"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 5.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 5.metadataOptional

    object

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

  • Request · body · oneOf 5.priorityOptional

    number

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

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

  • Request · body · oneOf 5.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 5.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 5.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 6Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 6.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    20 fields

    • Request · body · oneOf 6.inputParameters.clipIdRequired

      string

      Source clip id to modify

    • Request · body · oneOf 6.inputParameters.transformRequired

      "extend" | "cover" | "replace" | "inpaint" | "swap_vocals" | "swap_sound"

      Current deterministic edit type. inpaint is a deprecated alias for replace; swap_* use the legacy conversation path.

      Must match at least one alternative.

      6 fields / alternatives

      • Request · body · oneOf 6.inputParameters.transform · anyOf 1Alternative

        "extend"

      • Request · body · oneOf 6.inputParameters.transform · anyOf 2Alternative

        "cover"

      • Request · body · oneOf 6.inputParameters.transform · anyOf 3Alternative

        "replace"

      • Request · body · oneOf 6.inputParameters.transform · anyOf 4Alternative

        "inpaint"

        Deprecated; omit in new integrations.

      • Request · body · oneOf 6.inputParameters.transform · anyOf 5Alternative

        "swap_vocals"

        Deprecated; omit in new integrations.

      • Request · body · oneOf 6.inputParameters.transform · anyOf 6Alternative

        "swap_sound"

        Deprecated; omit in new integrations.

    • Request · body · oneOf 6.inputParameters.conversationIdOptional

      string

      Optional existing conversation id to reuse

    • Request · body · oneOf 6.inputParameters.currentSongIdOptional

      string

      Optional current song id for client_context; defaults to clipId

    • Request · body · oneOf 6.inputParameters.extendFromSecondsOptional

      number

      Source timestamp where extension begins

      Minimum: 0.

    • Request · body · oneOf 6.inputParameters.extendSecondsOptional

      number

      Seconds generated by ExtendSection

      Maximum: 180. Exclusive lower bound: 0. Default: 60.

    • Request · body · oneOf 6.inputParameters.imageIdOptional

      string

      Optional output cover image id

    • Request · body · oneOf 6.inputParameters.lyricsOptional

      string

      New lyrics (useful for cover / swap_vocals)

      Maximum characters: 3000.

    • Request · body · oneOf 6.inputParameters.lyricsIdOptional

      string

      Optional lyrics id paired with lyrics when using conversation-based modify flows

    • Request · body · oneOf 6.inputParameters.modifyModeOptional

      "task" | "conversation"

      Modify transport: 'task' uses Recipe + audio__render_edit; 'conversation' lets Producer interpret a legacy/agentic request first.

      Must match at least one alternative.

      2 fields / alternatives

      • Request · body · oneOf 6.inputParameters.modifyMode · anyOf 1Alternative

        "task"

      • Request · body · oneOf 6.inputParameters.modifyMode · anyOf 2Alternative

        "conversation"

    • Request · body · oneOf 6.inputParameters.promptOptional

      string

      Additional modification instructions

      Maximum characters: 1000.

    • Request · body · oneOf 6.inputParameters.regionsOptional

      array<object>

      Ordered, non-overlapping regions for ReplaceSection

      Minimum items: 1.

      1 field

      • Request · body · oneOf 6.inputParameters.regions[]Each item

        object

        Unknown fields are not accepted.

        2 fields

        • Request · body · oneOf 6.inputParameters.regions[].endRequired

          number

          Region end timestamp in seconds

          Exclusive lower bound: 0.

          1 field

          • Request · body · oneOf 6.inputParameters.regions[].endSee schema

            number

            Expand this value in the interactive reference.

            Exclusive lower bound: 0.

        • Request · body · oneOf 6.inputParameters.regions[].startRequired

          number

          Region start timestamp in seconds

          Minimum: 0.

          1 field

          • Request · body · oneOf 6.inputParameters.regions[].startSee schema

            number

            Expand this value in the interactive reference.

            Minimum: 0.

    • Request · body · oneOf 6.inputParameters.seedOptional

      number

      Optional deterministic seed for the modification

      Minimum: 0.

    • Request · body · oneOf 6.inputParameters.soundPromptOptional

      string

      New sound prompt (useful for swap_sound)

      Maximum characters: 3000.

    • Request · body · oneOf 6.inputParameters.strengthOptional

      number

      Cover similarity strength (0-1)

      Minimum: 0. Maximum: 1. Default: 0.5.

    • Request · body · oneOf 6.inputParameters.tagsOptional

      string

      Style tags for the modified clip

      Maximum characters: 300.

    • Request · body · oneOf 6.inputParameters.titleOptional

      string

      Optional customer-facing title.

      Maximum characters: 200.

    • Request · body · oneOf 6.inputParameters.cropEndAtOptional

      number

      Deprecated alias for extendFromSeconds

      Minimum: 0. Deprecated; omit in new integrations.

    • Request · body · oneOf 6.inputParameters.replaceEndAtOptional

      number

      Deprecated single-region alias for regions[].end

      Minimum: 0. Deprecated; omit in new integrations.

    • Request · body · oneOf 6.inputParameters.replaceStartAtOptional

      number

      Deprecated single-region alias for regions[].start

      Minimum: 0. Deprecated; omit in new integrations.

  • Request · body · oneOf 6.modelRequired

    "producer/lyria-3-5/generate-music-modify" | "producer/lyria-3-preview/generate-music-modify" | "producer/lyria-3-pro/generate-music-modify"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 6.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 6.metadataOptional

    object

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

  • Request · body · oneOf 6.priorityOptional

    number

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

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

  • Request · body · oneOf 6.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 6.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 6.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 7Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 7.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    Unknown fields are not accepted.

    3 fields

    • Request · body · oneOf 7.inputParameters.promptRequired

      string

      Requested changes to the selected lyrics.

      Minimum characters: 1. Maximum characters: 3000.

    • Request · body · oneOf 7.inputParameters.lyricsOptional

      string

      Original lyrics text. Supply exactly one of lyrics and lyricsId.

      Minimum characters: 1. Maximum characters: 3000.

    • Request · body · oneOf 7.inputParameters.lyricsIdOptional

      string

      Authorized Producer resource ID from your completed Task or song library.

      Minimum characters: 1. Maximum characters: 255.

  • Request · body · oneOf 7.modelRequired

    "producer/lyria-3-5/producer-edit-lyrics" | "producer/lyria-3-preview/producer-edit-lyrics" | "producer/lyria-3-pro/producer-edit-lyrics"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 7.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 7.metadataOptional

    object

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

  • Request · body · oneOf 7.priorityOptional

    number

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

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

  • Request · body · oneOf 7.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 7.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 7.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 8Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 8.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    Unknown fields are not accepted.

    2 fields

    • Request · body · oneOf 8.inputParameters.formatRequired

      "m4a"

      Format of every audio member in the ZIP.

    • Request · body · oneOf 8.inputParameters.songIdsRequired

      array<string>

      One to twenty distinct authorized songs to include in the ZIP.

      Minimum items: 1. Maximum items: 20. Items must be unique.

      1 field

      • Request · body · oneOf 8.inputParameters.songIds[]Each item

        string

        Authorized Producer resource ID from your completed Task or song library.

        Minimum characters: 1. Maximum characters: 255.

  • Request · body · oneOf 8.modelRequired

    "producer/lyria-3-5/producer-export-batch" | "producer/lyria-3-preview/producer-export-batch" | "producer/lyria-3-pro/producer-export-batch"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 8.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 8.metadataOptional

    object

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

  • Request · body · oneOf 8.priorityOptional

    number

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

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

  • Request · body · oneOf 8.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 8.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 8.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 9Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 9.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    Unknown fields are not accepted.

    2 fields

    • Request · body · oneOf 9.inputParameters.formatRequired

      "m4a"

      Requested private audio format; only M4A is supported.

    • Request · body · oneOf 9.inputParameters.songIdRequired

      string

      Authorized Producer resource ID from your completed Task or song library.

      Minimum characters: 1. Maximum characters: 255.

  • Request · body · oneOf 9.modelRequired

    "producer/lyria-3-5/producer-export-song" | "producer/lyria-3-preview/producer-export-song" | "producer/lyria-3-pro/producer-export-song"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 9.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 9.metadataOptional

    object

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

  • Request · body · oneOf 9.priorityOptional

    number

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

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

  • Request · body · oneOf 9.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 9.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 9.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 10Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 10.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    Unknown fields are not accepted.

    5 fields

    • Request · body · oneOf 10.inputParameters.expectedVersionRequired

      string | integer

      Current song version from GET song; stale versions return 409.

      Minimum: 1. Must match at least one alternative.

      2 fields / alternatives

      • Request · body · oneOf 10.inputParameters.expectedVersion · anyOf 1Alternative

        string

        Format: integer. Default: 0.

      • Request · body · oneOf 10.inputParameters.expectedVersion · anyOf 2Alternative

        integer

        Current song version from GET song; stale versions return 409.

        Minimum: 1.

    • Request · body · oneOf 10.inputParameters.songIdRequired

      string

      Authorized Producer resource ID from your completed Task or song library.

      Minimum characters: 1. Maximum characters: 255.

    • Request · body · oneOf 10.inputParameters.deleteOptional

      boolean

      Request verified source-song deletion; cannot be combined with title or privacy changes.

    • Request · body · oneOf 10.inputParameters.privacyOptional

      "private" | "unlisted" | "public"

      Requested privacy of the source song; requires management permission.

    • Request · body · oneOf 10.inputParameters.titleOptional

      string

      Title for the new or updated resource.

      Minimum characters: 1. Maximum characters: 200.

  • Request · body · oneOf 10.modelRequired

    "producer/lyria-3-5/producer-mutate-song" | "producer/lyria-3-preview/producer-mutate-song" | "producer/lyria-3-pro/producer-mutate-song"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 10.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 10.metadataOptional

    object

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

  • Request · body · oneOf 10.priorityOptional

    number

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

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

  • Request · body · oneOf 10.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 10.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 10.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 11Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 11.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    Unknown fields are not accepted.

    1 field

    • Request · body · oneOf 11.inputParameters.songIdRequired

      string

      Authorized Producer resource ID from your completed Task or song library.

      Minimum characters: 1. Maximum characters: 255.

  • Request · body · oneOf 11.modelRequired

    "producer/lyria-3-5/producer-split-stems" | "producer/lyria-3-preview/producer-split-stems" | "producer/lyria-3-pro/producer-split-stems"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 11.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 11.metadataOptional

    object

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

  • Request · body · oneOf 11.priorityOptional

    number

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

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

  • Request · body · oneOf 11.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 11.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 11.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 12Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 12.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    Unknown fields are not accepted.

    4 fields

    • Request · body · oneOf 12.inputParameters.endRequired

      number

      End time in seconds, no later than the source duration.

      Maximum: 900. Exclusive lower bound: 0.

    • Request · body · oneOf 12.inputParameters.songIdRequired

      string

      Authorized Producer resource ID from your completed Task or song library.

      Minimum characters: 1. Maximum characters: 255.

    • Request · body · oneOf 12.inputParameters.startRequired

      number

      Start time in seconds, before end.

      Minimum: 0.

    • Request · body · oneOf 12.inputParameters.titleOptional

      string

      Title for the new or updated resource.

      Minimum characters: 1. Maximum characters: 200.

  • Request · body · oneOf 12.modelRequired

    "producer/lyria-3-5/producer-trim-audio" | "producer/lyria-3-preview/producer-trim-audio" | "producer/lyria-3-pro/producer-trim-audio"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 12.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 12.metadataOptional

    object

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

  • Request · body · oneOf 12.priorityOptional

    number

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

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

  • Request · body · oneOf 12.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 12.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 12.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 13Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 13.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    1 field

    • Request · body · oneOf 13.inputParameters.clipIdRequired

      string

      Clip ID to analyze

  • Request · body · oneOf 13.modelRequired

    "suno/chirp-auk-turbo/get-audio-analysis" | "suno/chirp-auk/get-audio-analysis" | "suno/chirp-bluejay/get-audio-analysis" | "suno/chirp-crow/get-audio-analysis" | "suno/chirp-fenix/get-audio-analysis" | "suno/chirp-goose/get-audio-analysis" | "suno/chirp-hawk-wild/get-audio-analysis" | "suno/chirp-hawk/get-audio-analysis" | "suno/chirp-v4/get-audio-analysis" | "suno/chirp_auk/get-audio-analysis" | "suno/chirp_auk_turbo/get-audio-analysis" | "suno/chirp_bluejay/get-audio-analysis" | "suno/chirp_crow/get-audio-analysis" | "suno/chirp_fenix/get-audio-analysis" | "suno/chirp_v4/get-audio-analysis"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 13.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 13.metadataOptional

    object

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

  • Request · body · oneOf 13.priorityOptional

    number

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

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

  • Request · body · oneOf 13.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 13.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 13.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 14Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 14.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    1 field

    • Request · body · oneOf 14.inputParameters.clipIdRequired

      string

      Clip ID to fetch detail for

  • Request · body · oneOf 14.modelRequired

    "suno/chirp-auk-turbo/get-clip-detail" | "suno/chirp-auk/get-clip-detail" | "suno/chirp-bluejay/get-clip-detail" | "suno/chirp-crow/get-clip-detail" | "suno/chirp-fenix/get-clip-detail" | "suno/chirp-goose/get-clip-detail" | "suno/chirp-hawk-wild/get-clip-detail" | "suno/chirp-hawk/get-clip-detail" | "suno/chirp-v4/get-clip-detail" | "suno/chirp_auk/get-clip-detail" | "suno/chirp_auk_turbo/get-clip-detail" | "suno/chirp_bluejay/get-clip-detail" | "suno/chirp_crow/get-clip-detail" | "suno/chirp_fenix/get-clip-detail" | "suno/chirp_v4/get-clip-detail"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 14.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 14.metadataOptional

    object

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

  • Request · body · oneOf 14.priorityOptional

    number

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

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

  • Request · body · oneOf 14.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 14.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 14.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 15Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 15.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    1 field

    • Request · body · oneOf 15.inputParameters.clipIdRequired

      string

      Clip ID to get lyrics timeline for

  • Request · body · oneOf 15.modelRequired

    "suno/chirp-auk-turbo/get-lyrics-timeline" | "suno/chirp-auk/get-lyrics-timeline" | "suno/chirp-bluejay/get-lyrics-timeline" | "suno/chirp-crow/get-lyrics-timeline" | "suno/chirp-fenix/get-lyrics-timeline" | "suno/chirp-goose/get-lyrics-timeline" | "suno/chirp-hawk-wild/get-lyrics-timeline" | "suno/chirp-hawk/get-lyrics-timeline" | "suno/chirp-v4/get-lyrics-timeline" | "suno/chirp_auk/get-lyrics-timeline" | "suno/chirp_auk_turbo/get-lyrics-timeline" | "suno/chirp_bluejay/get-lyrics-timeline" | "suno/chirp_crow/get-lyrics-timeline" | "suno/chirp_fenix/get-lyrics-timeline" | "suno/chirp_v4/get-lyrics-timeline"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 15.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 15.metadataOptional

    object

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

  • Request · body · oneOf 15.priorityOptional

    number

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

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

  • Request · body · oneOf 15.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 15.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 15.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 16Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 16.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    1 field

    • Request · body · oneOf 16.inputParameters.voiceIdRequired

      string

      Voice ID to fetch

  • Request · body · oneOf 16.modelRequired

    "suno/chirp-auk-turbo/get-persona" | "suno/chirp-auk-turbo/get-voice" | "suno/chirp-auk/get-persona" | "suno/chirp-auk/get-voice" | "suno/chirp-bluejay/get-persona" | "suno/chirp-bluejay/get-voice" | "suno/chirp-crow/get-persona" | "suno/chirp-crow/get-voice" | "suno/chirp-fenix/get-persona" | "suno/chirp-fenix/get-voice" | "suno/chirp-goose/get-persona" | "suno/chirp-goose/get-voice" | "suno/chirp-hawk-wild/get-persona" | "suno/chirp-hawk-wild/get-voice" | "suno/chirp-hawk/get-persona" | "suno/chirp-hawk/get-voice" | "suno/chirp-v4/get-persona" | "suno/chirp-v4/get-voice" | "suno/chirp_auk/get-persona" | "suno/chirp_auk/get-voice" | "suno/chirp_auk_turbo/get-persona" | "suno/chirp_auk_turbo/get-voice" | "suno/chirp_bluejay/get-persona" | "suno/chirp_bluejay/get-voice" | "suno/chirp_crow/get-persona" | "suno/chirp_crow/get-voice" | "suno/chirp_fenix/get-persona" | "suno/chirp_fenix/get-voice" | "suno/chirp_v4/get-persona" | "suno/chirp_v4/get-voice"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 16.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 16.metadataOptional

    object

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

  • Request · body · oneOf 16.priorityOptional

    number

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

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

  • Request · body · oneOf 16.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 16.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 16.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 17Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 17.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    1 field

    • Request · body · oneOf 17.inputParameters.pageOptional

      number

      One-based result page.

      Minimum: 1. Default: 1.

  • Request · body · oneOf 17.modelRequired

    "suno/chirp-auk-turbo/list-personas" | "suno/chirp-auk-turbo/list-voices" | "suno/chirp-auk/list-personas" | "suno/chirp-auk/list-voices" | "suno/chirp-bluejay/list-personas" | "suno/chirp-bluejay/list-voices" | "suno/chirp-crow/list-personas" | "suno/chirp-crow/list-voices" | "suno/chirp-fenix/list-personas" | "suno/chirp-fenix/list-voices" | "suno/chirp-goose/list-personas" | "suno/chirp-goose/list-voices" | "suno/chirp-hawk-wild/list-personas" | "suno/chirp-hawk-wild/list-voices" | "suno/chirp-hawk/list-personas" | "suno/chirp-hawk/list-voices" | "suno/chirp-v4/list-personas" | "suno/chirp-v4/list-voices" | "suno/chirp_auk/list-personas" | "suno/chirp_auk/list-voices" | "suno/chirp_auk_turbo/list-personas" | "suno/chirp_auk_turbo/list-voices" | "suno/chirp_bluejay/list-personas" | "suno/chirp_bluejay/list-voices" | "suno/chirp_crow/list-personas" | "suno/chirp_crow/list-voices" | "suno/chirp_fenix/list-personas" | "suno/chirp_fenix/list-voices" | "suno/chirp_v4/list-personas" | "suno/chirp_v4/list-voices"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 17.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 17.metadataOptional

    object

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

  • Request · body · oneOf 17.priorityOptional

    number

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

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

  • Request · body · oneOf 17.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 17.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 17.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 18Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 18.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    4 fields

    • Request · body · oneOf 18.inputParameters.promptRequired

      string

      Text prompt for generating two lyrics candidates

      Maximum characters: 3000.

    • Request · body · oneOf 18.inputParameters.createSessionTokenOptional

      string

      Optional create session token

    • Request · body · oneOf 18.inputParameters.lyricsModelOptional

      "default"

      Only the stable "default" lyrics model is supported for paired candidates

    • Request · body · oneOf 18.inputParameters.sourceOptional

      string

      Caller source tag retained in Task audit input

      Maximum characters: 100.

  • Request · body · oneOf 18.modelRequired

    "suno/chirp-auk-turbo/lyrics-pair" | "suno/chirp-auk/lyrics-pair" | "suno/chirp-bluejay/lyrics-pair" | "suno/chirp-crow/lyrics-pair" | "suno/chirp-fenix/lyrics-pair" | "suno/chirp-goose/lyrics-pair" | "suno/chirp-hawk-wild/lyrics-pair" | "suno/chirp-hawk/lyrics-pair" | "suno/chirp-v4/lyrics-pair" | "suno/chirp_auk/lyrics-pair" | "suno/chirp_auk_turbo/lyrics-pair" | "suno/chirp_bluejay/lyrics-pair" | "suno/chirp_crow/lyrics-pair" | "suno/chirp_fenix/lyrics-pair" | "suno/chirp_v4/lyrics-pair"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 18.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 18.metadataOptional

    object

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

  • Request · body · oneOf 18.priorityOptional

    number

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

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

  • Request · body · oneOf 18.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 18.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 18.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 19Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 19.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    2 fields

    • Request · body · oneOf 19.inputParameters.midsRequired

      string | array<string>

      Clip identifiers accepted by this model branch.

      Must match at least one alternative.

      2 fields / alternatives

      • Request · body · oneOf 19.inputParameters.mids · anyOf 1Alternative

        string

        Comma-separated clip IDs

      • Request · body · oneOf 19.inputParameters.mids · anyOf 2Alternative

        array<string>

        Array of clip IDs

        1 field

        • Request · body · oneOf 19.inputParameters.mids · anyOf 2[]Each item

          string
          1 field

          • Request · body · oneOf 19.inputParameters.mids · anyOf 2[]See schema

            string

            Expand this value in the interactive reference.

    • Request · body · oneOf 19.inputParameters.versionOptional

      "v2" | "v3"

      Requested compatibility or resource version.

      Must match at least one alternative.

      2 fields / alternatives

      • Request · body · oneOf 19.inputParameters.version · anyOf 1Alternative

        "v2"

      • Request · body · oneOf 19.inputParameters.version · anyOf 2Alternative

        "v3"

  • Request · body · oneOf 19.modelRequired

    "suno/chirp-auk-turbo/query-songs" | "suno/chirp-auk/query-songs" | "suno/chirp-bluejay/query-songs" | "suno/chirp-crow/query-songs" | "suno/chirp-fenix/query-songs" | "suno/chirp-goose/query-songs" | "suno/chirp-hawk-wild/query-songs" | "suno/chirp-hawk/query-songs" | "suno/chirp-v4/query-songs" | "suno/chirp_auk/query-songs" | "suno/chirp_auk_turbo/query-songs" | "suno/chirp_bluejay/query-songs" | "suno/chirp_crow/query-songs" | "suno/chirp_fenix/query-songs" | "suno/chirp_v4/query-songs"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 19.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 19.metadataOptional

    object

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

  • Request · body · oneOf 19.priorityOptional

    number

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

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

  • Request · body · oneOf 19.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 19.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 19.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 20Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 20.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    1 field

    • Request · body · oneOf 20.inputParameters.excludedStylesOptional

      array<string>

      Styles to exclude from the generated result.

      1 field

      • Request · body · oneOf 20.inputParameters.excludedStyles[]Each item

        string

        Styles to exclude from recommendations

  • Request · body · oneOf 20.modelRequired

    "suno/chirp-auk-turbo/recommend-styles" | "suno/chirp-auk/recommend-styles" | "suno/chirp-bluejay/recommend-styles" | "suno/chirp-crow/recommend-styles" | "suno/chirp-fenix/recommend-styles" | "suno/chirp-goose/recommend-styles" | "suno/chirp-hawk-wild/recommend-styles" | "suno/chirp-hawk/recommend-styles" | "suno/chirp-v4/recommend-styles" | "suno/chirp_auk/recommend-styles" | "suno/chirp_auk_turbo/recommend-styles" | "suno/chirp_bluejay/recommend-styles" | "suno/chirp_crow/recommend-styles" | "suno/chirp_fenix/recommend-styles" | "suno/chirp_v4/recommend-styles"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 20.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 20.metadataOptional

    object

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

  • Request · body · oneOf 20.priorityOptional

    number

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

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

  • Request · body · oneOf 20.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 20.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 20.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 21Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 21.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    1 field

    • Request · body · oneOf 21.inputParameters.promptRequired

      string

      Text prompt for lyrics generation

      Maximum characters: 3000.

  • Request · body · oneOf 21.modelRequired

    "suno/chirp-auk-turbo/text-to-lyrics" | "suno/chirp-auk/text-to-lyrics" | "suno/chirp-bluejay/text-to-lyrics" | "suno/chirp-crow/text-to-lyrics" | "suno/chirp-fenix/text-to-lyrics" | "suno/chirp-goose/text-to-lyrics" | "suno/chirp-hawk-wild/text-to-lyrics" | "suno/chirp-hawk/text-to-lyrics" | "suno/chirp-v4/text-to-lyrics" | "suno/chirp_auk/text-to-lyrics" | "suno/chirp_auk_turbo/text-to-lyrics" | "suno/chirp_bluejay/text-to-lyrics" | "suno/chirp_crow/text-to-lyrics" | "suno/chirp_fenix/text-to-lyrics" | "suno/chirp_v4/text-to-lyrics"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 21.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 21.metadataOptional

    object

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

  • Request · body · oneOf 21.priorityOptional

    number

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

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

  • Request · body · oneOf 21.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 21.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 21.webhookUrlOptional

    string

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

    Format: uri.

• Request · body · oneOf 22Alternative

  object

  Unknown fields are not accepted.

  7 fields

  • Request · body · oneOf 22.inputParametersRequired

    object

    Feature-specific input matching the selected model path.

    3 fields

    • Request · body · oneOf 22.inputParameters.promptRequired

      string

      Text prompt for simple music generation (GPT description)

      Maximum characters: 2000.

    • Request · body · oneOf 22.inputParameters.isInstrumentalOptional

      boolean

      Optional instrumental intent for the derived result.

      Default: false.

    • Request · body · oneOf 22.inputParameters.waitAudioOptional

      boolean

      Whether this model branch waits for playable audio before completion.

      Default: true.

  • Request · body · oneOf 22.modelRequired

    "suno/chirp-auk-turbo/text-to-music-simple" | "suno/chirp-auk/text-to-music-simple" | "suno/chirp-bluejay/text-to-music-simple" | "suno/chirp-crow/text-to-music-simple" | "suno/chirp-fenix/text-to-music-simple" | "suno/chirp-goose/text-to-music-simple" | "suno/chirp-hawk-wild/text-to-music-simple" | "suno/chirp-hawk/text-to-music-simple" | "suno/chirp-v4/text-to-music-simple" | "suno/chirp_auk/text-to-music-simple" | "suno/chirp_auk_turbo/text-to-music-simple" | "suno/chirp_bluejay/text-to-music-simple" | "suno/chirp_crow/text-to-music-simple" | "suno/chirp_fenix/text-to-music-simple" | "suno/chirp_v4/text-to-music-simple"

    Public model path in format "providerCode/modelCode/featureCode".

  • Request · body · oneOf 22.configOptional

    not accepted

    Do not use a top-level config wrapper on generic /tasks; put priority/tags/metadata/webhookUrl at the top level.

    This value is not accepted.

  • Request · body · oneOf 22.metadataOptional

    object

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

  • Request · body · oneOf 22.priorityOptional

    number

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

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

  • Request · body · oneOf 22.tagsOptional

    array<string>

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

    Maximum items: 20.

    1 field

    • Request · body · oneOf 22.tags[]Each item

      string

      Maximum characters: 100.

  • Request · body · oneOf 22.webhookUrlOptional

    string

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

    Format: uri.

Responses

200 OK

application/json

Unknown fields are not accepted.

• Response 200 · creditsRequiredRequired

  number

  Exact credits deducted to start the task

  Minimum: 0.

• Response 200 · linksRequired

  object

  Unknown fields are not accepted.

  4 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

      Final downloadable resource URL when available

    • Response 200 · links.final · anyOf 2Alternative

      null

  • Response 200 · links.resourceRequired

    string | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · links.resource · anyOf 1Alternative

      string

      Product resource URL when the product has a dedicated view endpoint

    • Response 200 · links.resource · anyOf 2Alternative

      null

  • Response 200 · links.streamRequired

    string

    Task SSE stream URL for the created task

  • Response 200 · links.taskRequired

    string

    Task polling URL for the created task

• 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.featureCodeRequired

    string

    Resolved feature code

  • Response 200 · product.modelCodeRequired

    string

    Resolved model code

  • Response 200 · product.providerCodeRequired

    string

    Resolved provider code

  • Response 200 · product.resourceIdRequired

    string | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · product.resourceId · anyOf 1Alternative

      string

      Product resource id when created synchronously

    • Response 200 · product.resourceId · anyOf 2Alternative

      null

  • Response 200 · product.typeRequired

    string

    Product family for this task, e.g. suno, producer, mv

  • Response 200 · product.autoFinalizeOptional

    boolean

    Whether the product should finalize automatically

  • Response 200 · product.deliveryStatusOptional

    string | null

    May be null. Must match at least one alternative.

    2 fields / alternatives

    • Response 200 · product.deliveryStatus · anyOf 1Alternative

      string

      Product-level delivery status when applicable

    • Response 200 · product.deliveryStatus · anyOf 2Alternative

      null

• Response 200 · requestIdRequired

  string | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · requestId · anyOf 1Alternative

    string

    Request id echoed from X-Request-Id or generated by API

  • Response 200 · requestId · anyOf 2Alternative

    null

• Response 200 · statusRequired

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

  Default: "PENDING".

• Response 200 · taskIdRequired

  string

  Task unique identifier

• Response 200 · warningCodesRequired

  array<string>
  1 field

  • Response 200 · warningCodes[]Each item

    string

    Non-fatal request warnings

• Response 200 · estimatedCompletionTimeOptional

  Date | string | number | null

  May be null. Must match at least one alternative.

  2 fields / alternatives

  • Response 200 · estimatedCompletionTime · anyOf 1Alternative

    Date | string | number

    Estimated completion time

    Must match at least one alternative.

    4 fields / alternatives

    • Response 200 · estimatedCompletionTime · anyOf 1 · anyOf 1Alternative

      Date

      Estimated completion time

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

      string

      Format: date-time.

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

      string

      Format: date.

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

      number

  • 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

Response for status 403 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

408 Request Timeout

application/json

• Response 408 · errorRequired

  object
  3 fields

  • Response 408 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 408 · error.messageRequired

    string

    Human readable error message

  • Response 408 · error.detailsOptional

    object

    Additional error details (optional)

• Response 408 · successRequired

  false

  Always false for error responses

413 Payload Too Large

application/json

• Response 413 · errorRequired

  object
  3 fields

  • Response 413 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 413 · error.messageRequired

    string

    Human readable error message

  • Response 413 · error.detailsOptional

    object

    Additional error details (optional)

• Response 413 · 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

502 Bad Gateway

application/json

• Response 502 · errorRequired

  object
  3 fields

  • Response 502 · error.codeRequired

    string

    Application-specific error code (see error catalog)

  • Response 502 · error.messageRequired

    string

    Human readable error message

  • Response 502 · error.detailsOptional

    object

    Additional error details (optional)

• Response 502 · 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/tasks' \
  --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/tasks", {
  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/tasks",
    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