API Docs

Call every model over HTTP: endpoints, supported parameters and request examples.
Quick start

Base URL

All API requests are relative to this host.

https://api.flowmuse.ai/v1

Authentication

Create an API key on the API Keys page, then send it as a Bearer token with every request.

Request headers
Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json

Endpoints

  • POST/v1/task/createCreate an async generation task; returns a taskId.
  • GET/v1/task/status?taskId=…Poll the task status.
  • GET/v1/model/listList all available models.
  • GET/v1/model/details?modelId=…Get the parameter schema of one model.
  • POST/v1/chat/completionsCreate a chat completion (OpenAI-compatible); supports streaming.
  • GET/v1/modelsList available text models (OpenAI-compatible).

Quick start

Create a task, then poll until it completes.

Create a task
curl -X POST "https://api.flowmuse.ai/v1/task/create" \
  -H "Authorization: Bearer $FLOWMUSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"modelId":"seedance-2.0","prompt":"a woman walks in the park","duration":5,"quality":"480p","frameMode":"none"}'
Create task response202 Accepted
  • taskId·string—ID of the created task; use it to poll status.
  • error·string—Error message; present on failure instead of taskId.
Poll a task
curl "https://api.flowmuse.ai/v1/task/status?taskId=<taskId>" \
  -H "Authorization: Bearer $FLOWMUSE_API_KEY"
Poll task response200 OK
  • taskId·string—Task ID returned by create.
  • status·processing | completed | failed—Task lifecycle; keep polling while processing.
  • model_id·string—Model ID used by this task.
  • urls·string[]—Output file URLs; only present when completed.
  • error·string—Failure reason; only present when failed.
  • createdAt·ISO 8601—Task creation time.
  • updatedAt·ISO 8601—Last update time.