Skip to main content
GET
Generate Schema
Machine-readable required / optional / example for each Generate task. The same content, written out per task, is on Generate tasks. Legacy model names (chirp-v55 and older) are still accepted and always auto-converted to v6 Pro. For task=create, example is a map: custom / simple_idea / simple_audio_refs. Simple = omit prompt + no persona + at least one of gpt_description_prompt / audio_refs / attached_styles / attached_lyrics / image_urls / video_url. attached_lyrics pins full lyrics while prompt stays empty. image_urls is 1–5 jpeg or png URLs. video_url is one mp4 URL (at most 500MB). All three are Simple only. audio_refs is ByModel (no same-account / ById requirement). replace_simple = replace_section where the server computes infill_context_range / mode / lyrics from clip_id + range. Schema examples include replaceSection / replaceSimple.
Recommended Workflow: Before calling /generate, first call this endpoint with your desired task type to understand exactly which fields to include in your request.

Query Parameters

string
The task type to get schema for. If not provided, returns schemas for all tasks.

Response

Returns an array of task schema objects containing:
string
The task type identifier.
string
Human-readable description of the task.
array
List of required fields with their descriptions, types, and examples.
array
List of optional fields with their descriptions, types, and examples.
array
List of fields that will be ignored for this task type.
object
A complete request example for this specific task.

Example

Response Example

Task Types Overview

All tasks require task and model fields. Use this endpoint to get the complete list of required and optional fields for each specific task type.