FishSpeech Docs
API ReferenceImages

Images

Image generation capability status for overseas docs.

Images

Image generation is represented in the docs navigation so overseas docs keep the same product map as the CN docs. Public overseas endpoint availability is schema-driven. Check GET /api/openapi.json before calling image endpoints from production code.

Request

When image endpoints are enabled, expect an async task model: create a task with a prompt and model options, then poll for completion. Requests still use bearer authentication:

Authorization: Bearer YOUR_API_TOKEN

Do not infer overseas paths from CN docs. Use only paths present in the overseas OpenAPI schema for the deployed environment.

Response

Image task responses typically include task id, status, result image URL on success, and an error code on failure. Store the task id before polling so users can recover the result after page refresh or worker restart.

Billing And Credits

Image generation may charge by model, resolution, reference images, or successful task. Validate prompt size and input media before creating a task, and check Profile before large batches.

Errors

Handle unsupported model, invalid reference image, insufficient credits, and processing failure separately. If image endpoints are absent from GET /api/openapi.json, treat the capability as not publicly available for the account.

On this page