Documentation Index
Fetch the complete documentation index at: https://apixo.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
What this model is for
Use this page after trying Seedream 5.0 in the APIXO playground. It shows the model ID, request body, result format, and the shared async workflow links you need for API integration.Model ID, endpoint, and auth
- Model ID:
seedream-5-0 - Base URL:
https://api.apixo.ai/api/v1
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/generateTask/seedream-5-0 | Create generation task |
| GET | /api/v1/statusTask/seedream-5-0 | Query task status |
Authentication
All requests require an API Key in the header:Request Body
Parameters
async (polling) or callback (webhook)
Callback URL, required when request_type=callback (conditional)
Routing strategy: auto, value, or official
Model input parameters
text-to-image— Generate from text descriptionimage-to-image— Generate with reference images
disabled— Generate independent images, no relation between themauto— Intelligently generate sequential images based on max_images, with continuity and coherence
Copy-paste quickstart
Text-to-ImageResponse and result format
POST /api/v1/generateTask/seedream-5-0
ReturnstaskId on success for subsequent status queries.
Success:
GET /api/v1/statusTask/seedream-5-0
Query task execution status and results viataskId.
Polling result fields
Unique task identifier.
Current task state:
pending, processing, success, or failed.JSON string containing
resultUrls array. Only present on success. Parse with JSON.parse().Error code. Only present when
state is failed. See Error Codes.Human-readable error message. Only present when
state is failed.Task creation timestamp (Unix milliseconds).
Task completion timestamp (Unix milliseconds).
Processing duration in milliseconds.
Polling and webhook result retrieval
Userequest_type: "async" with the status endpoint when your app wants to poll for completion. Use request_type: "callback" with callback_url when your production service should receive the final result automatically. See Webhooks for delivery details.
Common errors
| Code | Description |
|---|---|
| 400 | Invalid parameters or request error |
| 401 | Invalid or missing API Key |
| 429 | Rate limit exceeded |
| Fail Code | Description |
|---|---|
CONTENT_VIOLATION | Content violates safety guidelines |
INVALID_IMAGE_URL | Cannot access provided image URL |
Rate Limits
| Limit | Value |
|---|---|
| Requests | 60 / minute |
| Concurrent tasks | 10 |
429 error. Wait and retry.
Tips
- Generation time:
- 2K resolution: ~25-35 seconds
- 3K resolution: ~35-50 seconds
- Submit task, wait 20 seconds, then poll every 3 seconds
- Callback mode: For high-concurrency or high-resolution generation, use
callbackmode. - Image expiration: Result URLs are valid for 15 days. Download and store important outputs promptly.
- Content moderation: Prompts must comply with content safety guidelines. Violations return
CONTENT_VIOLATION. - Resolution selection: Seedream 5.0 supports 2K and 3K. Balance speed and quality based on your needs.
- Web search: Set
web_search: trueto enable real-time web search, ideal for prompts referencing trending topics, latest products, or current events. - Output format:
output_formatsupportsjpeg(default) andpng. Choose based on downstream requirements. - Batch generation:
max_imagessupports 1-10 images. Billed per image actually generated. - Sequential images:
disabled: Generate independent images, no relationauto: Intelligently generate sequential images with continuity and coherence
- Multiple reference fusion:
image-to-imagemode supports up to 14 reference images- Model intelligently combines style, composition, and color
- Aspect ratio suggestions:
16:9/21:9: Landscape, for banners and desktop wallpapers9:16: Portrait, for mobile wallpapers and short video covers1:1: Square, for social media
- Image formats:
image_urlssupports JPG, PNG, WebP, and GIF, max 10MB per image.