Submit Task

post

https://api.topview.ai/v1/common_task/ai_music/task/submit

Submit an asynchronous AI music generation task. Returns a taskId for polling results via the Query Task API.Models: Supports Topview Music and Minimax Music 2.6 (pass the displayName; case-insensitive).Parameter rules:- When instrumental=true (instrumental only), styles is required and lyrics is ignored and not sent to the backend- When instrumental=false (with vocals), at least one of lyrics or styles must be provided- When enhancePrompt=true, styles is required; the system asynchronously enhances the style description before submitting generation- When referenceAudio is provided, audio format and duration are validated before generation is submittedCredits: Charged after task completion. Use costCredit in the query response to check consumption.Common error codes:- 4012: Invalid model- 4013: styles is required when instrumental=true- 4014: At least one of lyrics or styles is required when instrumental=false- 4015: lyrics exceeds maximum length- 4016: styles exceeds maximum length- 4017~4021: Invalid referenceAudio parameter/format/duration/size/clip range- 4022: Non-empty styles is required when enhancePrompt is enabled- 4100: Insufficient credits

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

model

string

enum

required

AI music model name (required). Allowed values: Topview Music, Minimax Music 2.6 (case-insensitive)

Allowed:

instrumental

boolean

Whether to generate instrumental music (no vocals). When true, styles is required and lyrics is ignored. When false or omitted, at least one of lyrics or styles must be provided

lyrics

string

Lyrics text (conditionally required). When instrumental=false, at least one of lyrics or styles must be non-empty; ignored when instrumental=true. Max length varies by model: Topview Music 5000 chars, Minimax Music 2.6 3500 chars

styles

string

Music style description (conditionally required). Required when instrumental=true; when instrumental=false, at least one of lyrics or styles must be non-empty; required when enhancePrompt=true. Max length varies by model: Topview Music 1000 chars, Minimax Music 2.6 2000 chars

enhancePrompt

boolean

Whether to asynchronously enhance the styles description. When enabled, the system calls an LLM to optimize the style text before submitting generation; requires non-empty styles

referenceAudio

object

Reference audio (optional). When provided, audio format, duration, and size are validated before the generation task is submitted

boardId

string

Associated Board ID (optional). When provided, a corresponding boardTask is created in aigc-backend; the response may include boardId and boardTaskIds

noticeUrl

string

Callback URL on task completion (optional). When configured, the response includes noticeUuid and the system sends a notification to this URL when the task finishes

Headers

Topview-Uid

string

required

Defaults to uid

User ID

Authorization

string

required

Defaults to Bearer apiKey

API key for authentication. Format: Bearer {apiKey}

Response

200Accepted successfully (task created and queued; poll the query API for execution result)