API

API overview

AI reading link

Give this link to an AI with browsing access. If it cannot reach this site, copy the guide instead.

Preview overview

Paste into an AI assistant to help with integration. Documentation and examples only; no real credentials.

# API overview

Give this guide or its AI reading link to an assistant to find capabilities, endpoints, authentication, and detailed integration instructions for your task.

This platform exposes multiple model protocols through one site, together with account, API key, task result, usage, and pricing endpoints. Choose a protocol for the task, then integrate using its endpoint reference.

Generated from this site's published reference catalog: 109 reference entries. Different protocol uses of one path may have separate entries. This is not a guarantee of runtime availability or successful upstream testing.

API base URL: https://api.tu-zi.com

Guide updated: 2026-11-04

Stable AI reading link: https://api.tu-zi.com/en/docs/api/overview.md

## How to use this guide for a user's task

1. Identify the desired task, inputs, and outputs. Ask for missing requirements when necessary.
2. Use the capability map and workflows below to choose candidates, then consult the complete endpoint index.
3. Read the candidate's AI reference link for authentication, parameters, examples, responses, errors, and constraints before writing code. The index is not a complete request schema; do not invent fields.
4. Check current model availability, supported endpoints, account permissions, and prices. Provider model catalogs do not guarantee availability on this site or for this account.
5. Keep submission, polling, and results within the same protocol. WebSocket, SSE, and ordinary JSON are not interchangeable. Acceptance does not mean generation has completed.
6. If you cannot browse or access a reference, say so and ask the user to copy that endpoint's integration guide. Do not claim to have read inaccessible content.

This is documentation and examples only. Confirm the user's intent before performing paid generation or key mutations. Use environment variables in examples rather than asking for credentials in chat.

## Capability map

| User need | Capabilities and guides |
| --- | --- |
| Chat, writing, coding, text reasoning | [Guide](https://api.tu-zi.com/en/docs/use-cases/text-reasoning.md) · text |
| Generate or edit images | [Guide](https://api.tu-zi.com/en/docs/use-cases/image-generation.md) · images |
| Generate video, image to video | [Guide](https://api.tu-zi.com/en/docs/use-cases/video-generation.md) · video |
| Speech synthesis, transcription, realtime audio, interpretation, music | [Guide](https://api.tu-zi.com/en/docs/use-cases/audio.md) · speech / realtime / music |
| Knowledge bases, embeddings, reranking | [Guide](https://api.tu-zi.com/en/docs/use-cases/rag.md) · retrieval |
| Tool use and application orchestration | [Guide](https://api.tu-zi.com/en/docs/use-cases/agents.md) · text |

Applications still compose these capabilities: a knowledge base needs data processing and retrieval orchestration, rather than an undocumented turnkey endpoint. Account, key, usage, pricing, and top-up record endpoints are indexed below.

## Integration and authentication

- Inference calls use inference API keys; account management uses account system tokens. Do not interchange them. Read each reference for exact headers and exceptions.
- With a system token, bootstrap identity to obtain the user ID; subsequent account endpoints usually also require New-Api-User. Bootstrap does not accept inference keys or browser cookies instead of a system token.
- Anonymous endpoints may return different data when authenticated. Check model access, groups, and prices for the actual account.
- JSON, multipart, and WebSocket in the index describe request transport. Read details for streaming responses and asynchronous completion.

## Common workflows

- Integrate chat or text generation：[List callable models](https://api.tu-zi.com/en/docs/api/reference-models-list.md) → [OpenAI Chat Completions](https://api.tu-zi.com/en/docs/api/reference-relay-openai.md)
- Standard video tasks: submit, poll, download：[OpenAI Video](https://api.tu-zi.com/en/docs/api/reference-relay-openai-video.md) → [Retrieve a unified video or image task](https://api.tu-zi.com/en/docs/api/reference-relay-video-fetch.md) → [Download video task content](https://api.tu-zi.com/en/docs/api/reference-relay-video-content.md)
- Kling image to video: submit and poll：[Kling Image to Video](https://api.tu-zi.com/en/docs/api/reference-relay-kling-video-image.md) → [Retrieve a Kling videos task](https://api.tu-zi.com/en/docs/api/reference-relay-kling-videos-fetch.md)
- Generate music and retrieve results：[Suno Music Generation](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-music.md) → [Retrieve a Suno v2 task](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-fetch.md)
- Bootstrap identity, create an inference key, inspect usage：[Bootstrap account identity](https://api.tu-zi.com/en/docs/api/reference-account-bootstrap.md) → [Create an API key](https://api.tu-zi.com/en/docs/api/reference-token-create.md) → [List usage logs](https://api.tu-zi.com/en/docs/api/reference-usage-logs.md)

Do not mix task IDs, polling paths, or result fields across providers. Read the chosen reference for image input formats, models, task states, and polling intervals.

## Complete endpoint index

### Text generation (6)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Anthropic Messages](https://api.tu-zi.com/en/docs/api/reference-relay-anthropic) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-anthropic.md) | `POST /v1/messages` · json | Inference API key | Anthropic Messages |
| [Gemini Generate Content](https://api.tu-zi.com/en/docs/api/reference-relay-gemini) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-gemini.md) | `POST /v1beta/models/{model}:generateContent` · json | Inference API key | Gemini Generate Content |
| [JEV SystemOne](https://api.tu-zi.com/en/docs/api/reference-relay-systemone) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-systemone.md) | `POST /v1/systemone` · json | Inference API key | JEV SystemOne |
| [OpenAI Chat Completions](https://api.tu-zi.com/en/docs/api/reference-relay-openai) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-openai.md) | `POST /v1/chat/completions` · json | Inference API key | OpenAI Chat Completions |
| [OpenAI Responses](https://api.tu-zi.com/en/docs/api/reference-relay-openai-response) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-openai-response.md) | `POST /v1/responses` · json | Inference API key | OpenAI Responses |
| [OpenAI Responses Compact](https://api.tu-zi.com/en/docs/api/reference-relay-openai-response-compact) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-openai-response-compact.md) | `POST /v1/responses/compact` · json | Inference API key | Responses context compaction for existing conversations. Returns reusable output items and does not support streaming. |

### Images (7)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Asynchronous image generation](https://api.tu-zi.com/en/docs/api/reference-relay-image-generation-async) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-image-generation-async.md) | `POST /v1/videos` · json | Inference API key | Gateway asynchronous image extension: create a task with image parameters, then poll for the image. The /v1/videos path does not make this a video task. |
| [Black Forest Labs FLUX](https://api.tu-zi.com/en/docs/api/reference-relay-bfl-image) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-bfl-image.md) | `POST /flux/v1/flux-3-image` · json | Inference API key | Gateway FLUX native compatibility route, restricted to flux-3-image. Use the listed model protocols for other FLUX models. |
| [Gemini Image Generation](https://api.tu-zi.com/en/docs/api/reference-relay-gemini-image) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-gemini-image.md) | `POST /v1beta/models/{model}:generateContent` · json | Inference API key | Generate images through Gemini generateContent; responses may contain both text and image parts. |
| [Image Generation](https://api.tu-zi.com/en/docs/api/reference-relay-image-generation) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-image-generation.md) | `POST /v1/images/generations` · json | Inference API key | Image Generation |
| [Kling Image Generation](https://api.tu-zi.com/en/docs/api/reference-relay-kling-image) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-kling-image.md) | `POST /kling/v1/images/generations` · json | Inference API key | Kling Image Generation |
| [OpenAI Image Edit](https://api.tu-zi.com/en/docs/api/reference-relay-image-edit) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-image-edit.md) | `POST /v1/images/edits` · multipart | Inference API key | OpenAI Image Edit |
| [Submit a Midjourney imagine task](https://api.tu-zi.com/en/docs/api/reference-relay-midjourney) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-midjourney.md) | `POST /mj/submit/imagine` · json | Inference API key | Create an image task through the gateway compatibility endpoint. |

### Video generation (3)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Kling Image to Video](https://api.tu-zi.com/en/docs/api/reference-relay-kling-video-image) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-kling-video-image.md) | `POST /kling/v1/videos/image2video` · json | Inference API key | Kling Image to Video |
| [Kling Text to Video](https://api.tu-zi.com/en/docs/api/reference-relay-kling-video-text) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-kling-video-text.md) | `POST /kling/v1/videos/text2video` · json | Inference API key | Kling Text to Video |
| [OpenAI Video](https://api.tu-zi.com/en/docs/api/reference-relay-openai-video) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-openai-video.md) | `POST /v1/videos` · json | Inference API key | OpenAI Video |

### Speech (3)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [OpenAI Audio Transcription](https://api.tu-zi.com/en/docs/api/reference-relay-audio-transcription) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-audio-transcription.md) | `POST /v1/audio/transcriptions` · multipart | Inference API key | OpenAI Audio Transcription |
| [OpenAI Audio Translation](https://api.tu-zi.com/en/docs/api/reference-relay-audio-translation) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-audio-translation.md) | `POST /v1/audio/translations` · multipart | Inference API key | OpenAI Audio Translation |
| [OpenAI Text to Speech](https://api.tu-zi.com/en/docs/api/reference-relay-audio-speech) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-audio-speech.md) | `POST /v1/audio/speech` · json | Inference API key | OpenAI Text to Speech |

### Realtime (2)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Gemini Live WebSocket](https://api.tu-zi.com/en/docs/api/reference-relay-gemini-live) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-gemini-live.md) | `GET /v1beta/live?model={model}` · websocket | Inference API key | Gemini Live WebSocket |
| [Interpretation WebSocket](https://api.tu-zi.com/en/docs/api/reference-relay-seed-interpretation) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-seed-interpretation.md) | `GET /v1/realtime?model={model}` · websocket | Inference API key | Simultaneous interpretation over Protobuf binary WebSocket frames. |

### Music and sound (27)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Suno Add Instrumental](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-add-instrumental) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-add-instrumental.md) | `POST /suno/v2/add-instrumental` · json | Inference API key | Suno Add Instrumental: suno/add-instrumental. |
| [Suno Add Vocals](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-add-vocals) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-add-vocals.md) | `POST /suno/v2/add-vocals` · json | Inference API key | Suno Add Vocals: suno/add-vocals. |
| [Suno Audio Upload](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-upload) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-upload.md) | `POST /suno/v2/upload` · json | Inference API key | Suno Audio Upload: suno/upload. |
| [Suno Cover](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-cover) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-cover.md) | `POST /suno/v2/cover` · json | Inference API key | Suno Cover: suno/cover. |
| [Suno Extension](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-extend) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-extend.md) | `POST /suno/v2/extend` · json | Inference API key | Suno Extension: suno/extend. |
| [Suno Full Stem Separation](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-stems-all) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-stems-all.md) | `POST /suno/v2/stems-all` · json | Inference API key | Suno Full Stem Separation: suno/stems-all. |
| [Suno Lyric Timings](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-aligned-lyrics) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-aligned-lyrics.md) | `POST /suno/v2/aligned-lyrics` · json | Inference API key | Suno Lyric Timings: suno/aligned-lyrics. |
| [Suno Lyric Writing](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-lyrics) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-lyrics.md) | `POST /suno/v2/lyrics` · json | Inference API key | Suno Lyric Writing: suno/lyrics. |
| [Suno MIDI Export](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-gen-midi) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-gen-midi.md) | `POST /suno/v2/gen-midi` · json | Inference API key | Suno MIDI Export: suno/gen-midi. |
| [Suno Mashup](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-mashup) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-mashup.md) | `POST /suno/v2/mashup` · json | Inference API key | Suno Mashup: suno/mashup. |
| [Suno Model Training](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-create-model) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-create-model.md) | `POST /suno/v2/create-model` · json | Inference API key | Suno Model Training: suno/create-model. |
| [Suno Multi-format Export](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-download) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-download.md) | `POST /suno/v2/download` · json | Inference API key | Suno Multi-format Export: suno/download. |
| [Suno Music Generation](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-music) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-music.md) | `POST /suno/v2/music` · json | Inference API key | Suno Music Generation: suno/music. |
| [Suno Reference Generation](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-inspo) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-inspo.md) | `POST /suno/v2/inspo` · json | Inference API key | Suno Reference Generation: suno/inspo. |
| [Suno Remaster](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-remaster) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-remaster.md) | `POST /suno/v2/remaster` · json | Inference API key | Suno Remaster: suno/remaster. |
| [Suno Sample Rework](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-sample) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-sample.md) | `POST /suno/v2/sample` · json | Inference API key | Suno Sample Rework: suno/sample. |
| [Suno Section Rewrite](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-replace-section) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-replace-section.md) | `POST /suno/v2/replace-section` · json | Inference API key | Suno Section Rewrite: suno/replace-section. |
| [Suno Segment Merge](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-concat) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-concat.md) | `POST /suno/v2/concat` · json | Inference API key | Suno Segment Merge: suno/concat. |
| [Suno Sound Effects](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-sounds) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-sounds.md) | `POST /suno/v2/sounds` · json | Inference API key | Suno Sound Effects: suno/sounds. |
| [Suno Speed Adjustment](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-adjust-speed) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-adjust-speed.md) | `POST /suno/v2/adjust-speed` · json | Inference API key | Suno Speed Adjustment: suno/adjust-speed. |
| [Suno Stem Layering](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-add-stem) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-add-stem.md) | `POST /suno/v2/add-stem` · json | Inference API key | Suno Stem Layering: suno/add-stem. |
| [Suno Style Expansion](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-upsample-tags) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-upsample-tags.md) | `POST /suno/v2/upsample-tags` · json | Inference API key | Suno Style Expansion: suno/upsample-tags. |
| [Suno Upload & Cover](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-upload-cover) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-upload-cover.md) | `POST /suno/v2/upload-cover` · json | Inference API key | Suno Upload & Cover: suno/upload-cover. |
| [Suno Upload & Extend](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-upload-extend) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-upload-extend.md) | `POST /suno/v2/upload-extend` · json | Inference API key | Suno Upload & Extend: suno/upload-extend. |
| [Suno Vocal Separation](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-stems) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-stems.md) | `POST /suno/v2/stems` · json | Inference API key | Suno Vocal Separation: suno/stems. |
| [Suno Voice Capture](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-persona) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-persona.md) | `POST /suno/v2/persona` · json | Inference API key | Suno Voice Capture: suno/persona. |
| [Suno Voice Cloning](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-create-voice) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-create-voice.md) | `POST /suno/v2/create-voice` · json | Inference API key | Suno Voice Cloning: suno/create-voice. |

### Embeddings and retrieval (2)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Embeddings](https://api.tu-zi.com/en/docs/api/reference-relay-embeddings) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-embeddings.md) | `POST /v1/embeddings` · json | Inference API key | Embeddings |
| [Jina Rerank](https://api.tu-zi.com/en/docs/api/reference-relay-jina-rerank) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-jina-rerank.md) | `POST /v1/rerank` · json | Inference API key | Jina Rerank |

### Available models (5)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Get paginated marketplace model information](https://api.tu-zi.com/en/docs/api/reference-models-pricing-paged) · [AI](https://api.tu-zi.com/en/docs/api/reference-models-pricing-paged.md) | `GET /api/pricing/models` · json | Anonymous; may vary when authenticated | Get paginated marketplace model information. Returns data visible to the current account. |
| [List callable models](https://api.tu-zi.com/en/docs/api/reference-models-list) · [AI](https://api.tu-zi.com/en/docs/api/reference-models-list.md) | `GET /v1/models` · json | Inference API key | List callable models. Fields and permissions follow this gateway implementation. |
| [List models in Gemini format](https://api.tu-zi.com/en/docs/api/reference-models-gemini) · [AI](https://api.tu-zi.com/en/docs/api/reference-models-gemini.md) | `GET /v1beta/models` · json | Inference API key | List models in Gemini format within the current credential scope. |
| [List models through the Gemini compatible endpoint](https://api.tu-zi.com/en/docs/api/reference-models-gemini-openai) · [AI](https://api.tu-zi.com/en/docs/api/reference-models-gemini-openai.md) | `GET /v1beta/openai/models` · json | Inference API key | List models through the Gemini compatible endpoint within the current credential scope. |
| [Retrieve model metadata](https://api.tu-zi.com/en/docs/api/reference-model-detail) · [AI](https://api.tu-zi.com/en/docs/api/reference-model-detail.md) | `GET /v1/models/{model}` · json | Inference API key | List callable models. Fields and permissions follow this gateway implementation. |

### Image and video tasks (7)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Download video task content](https://api.tu-zi.com/en/docs/api/reference-relay-video-content) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-video-content.md) | `GET /v1/videos/{task_id}/content` · json | Inference API key | Download video task content. The following is this gateway’s public contract. |
| [Retrieve a Kling images task](https://api.tu-zi.com/en/docs/api/reference-relay-kling-images-fetch) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-kling-images-fetch.md) | `GET /kling/v1/images/{kind}/{task_id}` · json | Inference API key | Retrieve a Kling images task. The following is this gateway’s public contract. |
| [Retrieve a Kling videos task](https://api.tu-zi.com/en/docs/api/reference-relay-kling-videos-fetch) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-kling-videos-fetch.md) | `GET /kling/v1/videos/{kind}/{task_id}` · json | Inference API key | Retrieve a Kling videos task. The following is this gateway’s public contract. |
| [Retrieve a Midjourney task](https://api.tu-zi.com/en/docs/api/reference-relay-midjourney-fetch) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-midjourney-fetch.md) | `GET /mj/task/{task_id}/fetch` · json | Inference API key | Retrieve a Midjourney task. The following is this gateway’s public contract. |
| [Retrieve a native FLUX image task](https://api.tu-zi.com/en/docs/api/reference-relay-flux-fetch) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-flux-fetch.md) | `GET /flux/v1/get_result` · json | Inference API key | Retrieve a native FLUX image task. The following is this gateway’s public contract. |
| [Retrieve a unified video or image task](https://api.tu-zi.com/en/docs/api/reference-relay-video-fetch) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-video-fetch.md) | `GET /v1/videos/{task_id}` · json | Inference API key | Retrieve a unified video or image task. The following is this gateway’s public contract. |
| [Retrieve image results by request ID](https://api.tu-zi.com/en/docs/api/reference-relay-image-result) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-image-result.md) | `GET /v1/images/generations/result` · json | Inference API key | Retrieve image results by request ID. The following is this gateway’s public contract. |

### Music tasks (2)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Retrieve Suno v2 tasks in a batch](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-fetch-batch) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-fetch-batch.md) | `POST /suno/v2/fetch` · json | Inference API key | Retrieve Suno v2 tasks in a batch. The following is this gateway’s public contract. |
| [Retrieve a Suno v2 task](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-fetch) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-suno-v2-fetch.md) | `GET /suno/v2/fetch/{task_id}` · json | Inference API key | Retrieve a Suno v2 task. The following is this gateway’s public contract. |

### Other tasks and results (2)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [List current account task records](https://api.tu-zi.com/en/docs/api/reference-task-list) · [AI](https://api.tu-zi.com/en/docs/api/reference-task-list.md) | `GET /api/task/self` · json | System token + user ID, or session | List current account task records within the current credential scope. |
| [Retrieve a Kling audio task](https://api.tu-zi.com/en/docs/api/reference-relay-kling-audio-fetch) · [AI](https://api.tu-zi.com/en/docs/api/reference-relay-kling-audio-fetch.md) | `GET /kling/v1/audio/{kind}/{task_id}` · json | Inference API key | Retrieve a Kling audio task. The following is this gateway’s public contract. |

### Account (8)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Bootstrap account identity](https://api.tu-zi.com/en/docs/api/reference-account-bootstrap) · [AI](https://api.tu-zi.com/en/docs/api/reference-account-bootstrap.md) | `GET /api/user/self/bootstrap` · json | Account system token only | Call this first when you have a system token but do not know the account ID. |
| [Get current account](https://api.tu-zi.com/en/docs/api/reference-account-self) · [AI](https://api.tu-zi.com/en/docs/api/reference-account-self.md) | `GET /api/user/self` · json | System token + user ID, or session | Get current account. Fields and permissions follow this gateway implementation. |
| [List account groups and multipliers](https://api.tu-zi.com/en/docs/api/reference-account-groups) · [AI](https://api.tu-zi.com/en/docs/api/reference-account-groups.md) | `GET /api/user/self/groups` · json | System token + user ID, or session | List account groups and multipliers within the current credential scope. |
| [List account model choices](https://api.tu-zi.com/en/docs/api/reference-account-models) · [AI](https://api.tu-zi.com/en/docs/api/reference-account-models.md) | `GET /api/user/models` · json | System token + user ID, or session | List account model choices within the current credential scope. |
| [Patch the current profile](https://api.tu-zi.com/en/docs/api/reference-account-patch) · [AI](https://api.tu-zi.com/en/docs/api/reference-account-patch.md) | `PATCH /api/user/self` · json | System token + user ID, or session | Patch the current profile. The following is this gateway’s public contract. |
| [Read current system token](https://api.tu-zi.com/en/docs/api/reference-account-system-token-current) · [AI](https://api.tu-zi.com/en/docs/api/reference-account-system-token-current.md) | `GET /api/user/token/current` · json | System token + user ID, or session | Read current system token. Returns data visible to the current account. |
| [Retrieve account level limits](https://api.tu-zi.com/en/docs/api/reference-account-level-limits) · [AI](https://api.tu-zi.com/en/docs/api/reference-account-level-limits.md) | `GET /api/user/self/level_limits` · json | System token + user ID, or session | Retrieve account level limits within the current credential scope. |
| [Rotate system token](https://api.tu-zi.com/en/docs/api/reference-account-system-token-rotate) · [AI](https://api.tu-zi.com/en/docs/api/reference-account-system-token-rotate.md) | `GET /api/user/token` · json | System token + user ID, or session | Rotate system token. Returns data visible to the current account. |

### API keys (14)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Create API keys in a batch](https://api.tu-zi.com/en/docs/api/reference-token-batch-create) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-batch-create.md) | `POST /api/token/batch/create` · json | System token + user ID, or session | Create an API key. Fields and permissions follow this gateway implementation. |
| [Create an API key](https://api.tu-zi.com/en/docs/api/reference-token-create) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-create.md) | `POST /api/token/` · json | System token + user ID, or session | Create an API key. Fields and permissions follow this gateway implementation. |
| [Delete API keys in a batch](https://api.tu-zi.com/en/docs/api/reference-token-batch-delete) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-batch-delete.md) | `POST /api/token/batch` · json | System token + user ID, or session | Delete API keys in a batch within the current credential scope. |
| [Delete an API key](https://api.tu-zi.com/en/docs/api/reference-token-delete) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-delete.md) | `DELETE /api/token/{id}` · json | System token + user ID, or session | Delete an API key. Fields and permissions follow this gateway implementation. |
| [Get API key details](https://api.tu-zi.com/en/docs/api/reference-token-detail) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-detail.md) | `GET /api/token/{id}` · json | System token + user ID, or session | Get API key details. Fields and permissions follow this gateway implementation. |
| [Get current key usage](https://api.tu-zi.com/en/docs/api/reference-token-usage) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-usage.md) | `GET /api/usage/token/` · json | Inference API key | Get current key usage. Fields and permissions follow this gateway implementation. |
| [List API keys](https://api.tu-zi.com/en/docs/api/reference-token-list) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-list.md) | `GET /api/token/` · json | System token + user ID, or session | List API keys. Fields and permissions follow this gateway implementation. |
| [List assignable API key groups](https://api.tu-zi.com/en/docs/api/reference-token-groups) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-groups.md) | `GET /api/token/group` · json | System token + user ID, or session | List assignable API key groups. The following is this gateway’s public contract. |
| [Patch an API key](https://api.tu-zi.com/en/docs/api/reference-token-patch) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-patch.md) | `PATCH /api/token/{id}` · json | System token + user ID, or session | Only explicitly supplied fields are updated. Omitted fields stay unchanged; 0 and false are preserved. |
| [Reveal API keys in a batch](https://api.tu-zi.com/en/docs/api/reference-token-batch-reveal) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-batch-reveal.md) | `POST /api/token/batch/keys` · json | System token + user ID, or session | Reveal API keys in a batch within the current credential scope. |
| [Reveal an API key](https://api.tu-zi.com/en/docs/api/reference-token-reveal) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-reveal.md) | `POST /api/token/{id}/key` · json | System token + user ID, or session | Reveal an API key. Fields and permissions follow this gateway implementation. |
| [Search API keys](https://api.tu-zi.com/en/docs/api/reference-token-search) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-search.md) | `GET /api/token/search` · json | System token + user ID, or session | List API keys. Fields and permissions follow this gateway implementation. |
| [Update API keys in a batch](https://api.tu-zi.com/en/docs/api/reference-token-batch-update) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-batch-update.md) | `POST /api/token/batch/update` · json | System token + user ID, or session | Update API keys in a batch within the current credential scope. |
| [Update an API key](https://api.tu-zi.com/en/docs/api/reference-token-update) · [AI](https://api.tu-zi.com/en/docs/api/reference-token-update.md) | `PUT /api/token/` · json | System token + user ID, or session | Update an API key. Fields and permissions follow this gateway implementation. |

### Usage and logs (19)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Compatible cumulative usage](https://api.tu-zi.com/en/docs/api/reference-legacy-billing-usage) · [AI](https://api.tu-zi.com/en/docs/api/reference-legacy-billing-usage.md) | `GET /v1/dashboard/billing/usage` · json | Inference API key | Compatible cumulative usage. Read-only compatibility for legacy clients. |
| [Compatible quota information](https://api.tu-zi.com/en/docs/api/reference-legacy-billing-subscription) · [AI](https://api.tu-zi.com/en/docs/api/reference-legacy-billing-subscription.md) | `GET /v1/dashboard/billing/subscription` · json | Inference API key | Compatible quota information. Read-only compatibility for legacy clients. |
| [Export account task records as CSV](https://api.tu-zi.com/en/docs/api/reference-task-export) · [AI](https://api.tu-zi.com/en/docs/api/reference-task-export.md) | `GET /api/task/self/export` · json | System token + user ID, or session | Export account task records as CSV. Returns data visible to the current account. |
| [Export account usage CSV](https://api.tu-zi.com/en/docs/api/reference-usage-export) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-export.md) | `GET /api/log/self/export` · json | System token + user ID, or session | Export account usage CSV within the current credential scope. |
| [Export current key usage CSV](https://api.tu-zi.com/en/docs/api/reference-usage-token-export) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-token-export.md) | `GET /api/log/token/export` · json | Inference API key | Export current key usage CSV within the current credential scope. |
| [Get account dashboard consumption statistics](https://api.tu-zi.com/en/docs/api/reference-usage-dashboard-stats) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-dashboard-stats.md) | `GET /api/data/dashboard_consumption_stats` · json | System token + user ID, or session | Get account dashboard consumption statistics. Returns data visible to the current account. |
| [Get account logs by request ID](https://api.tu-zi.com/en/docs/api/reference-usage-request-logs) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-request-logs.md) | `GET /api/log/self/request/{request_id}` · json | System token + user ID, or session | Get account logs by request ID. Returns data visible to the current account. |
| [Get account quota history](https://api.tu-zi.com/en/docs/api/reference-usage-quota-history) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-quota-history.md) | `GET /api/data/self` · json | System token + user ID, or session | Get account quota history. Returns data visible to the current account. |
| [Get consumption statistics by source](https://api.tu-zi.com/en/docs/api/reference-usage-consumption-stats) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-consumption-stats.md) | `GET /api/data/consumption_stats` · json | System token + user ID, or session | Get consumption statistics by source. Returns data visible to the current account. |
| [Get detailed account usage statistics](https://api.tu-zi.com/en/docs/api/reference-usage-advanced-statistics) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-advanced-statistics.md) | `GET /api/log/self/advanced_stat` · json | System token + user ID, or session | Get detailed account usage statistics. Returns data visible to the current account. |
| [Get usage statistics](https://api.tu-zi.com/en/docs/api/reference-usage-statistics) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-statistics.md) | `GET /api/log/self/stat` · json | System token + user ID, or session | Get usage statistics. Fields and permissions follow this gateway implementation. |
| [Get usage summary](https://api.tu-zi.com/en/docs/api/reference-usage-summary) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-summary.md) | `GET /api/log/self/stat` · json | System token + user ID, or session | Aggregate the current account’s recorded requests, errors, tokens and quota. |
| [Legacy log search (deprecated)](https://api.tu-zi.com/en/docs/api/reference-usage-search-deprecated) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-search-deprecated.md) | `GET /api/log/self/search` · json | System token + user ID, or session | Deprecated endpoint; do not use for new integrations. |
| [List account Midjourney task records](https://api.tu-zi.com/en/docs/api/reference-task-midjourney-list) · [AI](https://api.tu-zi.com/en/docs/api/reference-task-midjourney-list.md) | `GET /api/mj/self` · json | System token + user ID, or session | List account Midjourney task records. Returns data visible to the current account. |
| [List account monthly log archives](https://api.tu-zi.com/en/docs/api/reference-usage-monthly-archives) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-monthly-archives.md) | `GET /api/log/self/archive` · json | System token + user ID, or session | List account monthly log archives. Returns data visible to the current account. |
| [List usage logs](https://api.tu-zi.com/en/docs/api/reference-usage-logs) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-logs.md) | `GET /api/log/self` · json | System token + user ID, or session | List usage logs. Fields and permissions follow this gateway implementation. |
| [Manually refresh a not-started task](https://api.tu-zi.com/en/docs/api/reference-task-poll) · [AI](https://api.tu-zi.com/en/docs/api/reference-task-poll.md) | `POST /api/task/{task_id}/poll` · json | System token + user ID, or session | Manually refresh a not-started task. Returns data visible to the current account. |
| [Retrieve request image or task results](https://api.tu-zi.com/en/docs/api/reference-usage-request-result) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-request-result.md) | `GET /api/log/get-request` · json | Inference API key | Retrieve image results by request ID. The following is this gateway’s public contract. |
| [Retrieve usage logs for the current API key](https://api.tu-zi.com/en/docs/api/reference-usage-token-logs) · [AI](https://api.tu-zi.com/en/docs/api/reference-usage-token-logs.md) | `GET /api/log/token` · json | Inference API key | List usage logs. Fields and permissions follow this gateway implementation. |

### Pricing and top-ups (2)

| Endpoint and docs | Method, path, transport | Authentication | Purpose |
| --- | --- | --- | --- |
| [Get model pricing](https://api.tu-zi.com/en/docs/api/reference-model-pricing) · [AI](https://api.tu-zi.com/en/docs/api/reference-model-pricing.md) | `GET /api/pricing` · json | Anonymous; may vary when authenticated | Get model pricing. Fields and permissions follow this gateway implementation. |
| [List top-up records](https://api.tu-zi.com/en/docs/api/reference-topup-records) · [AI](https://api.tu-zi.com/en/docs/api/reference-topup-records.md) | `GET /api/user/topup/self` · json | System token + user ID, or session | List top-up records. Fields and permissions follow this gateway implementation. |

## Models, pricing, and errors

- [Model marketplace](https://api.tu-zi.com/pricing): check model IDs, endpoints, and displayed prices; authenticated queries determine account access.
- [Getting started](https://api.tu-zi.com/en/docs/use-cases/getting-started.md), [protocol and endpoint selection](https://api.tu-zi.com/en/docs/use-cases/endpoint-matrix.md), [troubleshooting](https://api.tu-zi.com/en/docs/use-cases/troubleshooting.md).
- Check HTTP status and protocol-specific business status. Back off on 429; do not blindly retry paid generation, task creation, or key mutations.
- This index only covers published integration references. It does not expose internal admin routes, real credentials, account data, or user requests.
- AI reading links require network access and permission to view this site. External assistants usually cannot reach private test addresses; copy the overview and the relevant endpoint guide instead.

Content revision: ec691266958f26bb509b85546c18c99f8876ec057fed4685ed83a734b5a847f6

Updated 2026-11-04 · Reviewed 2026-11-04

Give this guide or its AI reading link to an assistant to find capabilities, endpoints, authentication, and detailed integration instructions for your task.

This platform exposes multiple model protocols through one site, together with account, API key, task result, usage, and pricing endpoints. Choose a protocol for the task, then integrate using its endpoint reference.

Generated from this site's published reference catalog: 109 reference entries. Different protocol uses of one path may have separate entries. This is not a guarantee of runtime availability or successful upstream testing.

API base URL: https://api.tu-zi.com

Guide updated: 2026-11-04

Stable AI reading link: https://api.tu-zi.com/en/docs/api/overview.md

How to use this guide for a user's task

Identify the desired task, inputs, and outputs. Ask for missing requirements when necessary.
Use the capability map and workflows below to choose candidates, then consult the complete endpoint index.
Read the candidate's AI reference link for authentication, parameters, examples, responses, errors, and constraints before writing code. The index is not a complete request schema; do not invent fields.
Check current model availability, supported endpoints, account permissions, and prices. Provider model catalogs do not guarantee availability on this site or for this account.
Keep submission, polling, and results within the same protocol. WebSocket, SSE, and ordinary JSON are not interchangeable. Acceptance does not mean generation has completed.
If you cannot browse or access a reference, say so and ask the user to copy that endpoint's integration guide. Do not claim to have read inaccessible content.

This is documentation and examples only. Confirm the user's intent before performing paid generation or key mutations. Use environment variables in examples rather than asking for credentials in chat.

Capability map

User need	Capabilities and guides
Chat, writing, coding, text reasoning	Guide · text
Generate or edit images	Guide · images
Generate video, image to video	Guide · video
Speech synthesis, transcription, realtime audio, interpretation, music	Guide · speech / realtime / music
Knowledge bases, embeddings, reranking	Guide · retrieval
Tool use and application orchestration	Guide · text

Applications still compose these capabilities: a knowledge base needs data processing and retrieval orchestration, rather than an undocumented turnkey endpoint. Account, key, usage, pricing, and top-up record endpoints are indexed below.

Integration and authentication

Inference calls use inference API keys; account management uses account system tokens. Do not interchange them. Read each reference for exact headers and exceptions.
With a system token, bootstrap identity to obtain the user ID; subsequent account endpoints usually also require New-Api-User. Bootstrap does not accept inference keys or browser cookies instead of a system token.
Anonymous endpoints may return different data when authenticated. Check model access, groups, and prices for the actual account.
JSON, multipart, and WebSocket in the index describe request transport. Read details for streaming responses and asynchronous completion.

Common workflows

Integrate chat or text generation：List callable models → OpenAI Chat Completions
Standard video tasks: submit, poll, download：OpenAI Video → Retrieve a unified video or image task → Download video task content
Kling image to video: submit and poll：Kling Image to Video → Retrieve a Kling videos task
Generate music and retrieve results：Suno Music Generation → Retrieve a Suno v2 task
Bootstrap identity, create an inference key, inspect usage：Bootstrap account identity → Create an API key → List usage logs

Do not mix task IDs, polling paths, or result fields across providers. Read the chosen reference for image input formats, models, task states, and polling intervals.

Complete endpoint index

Text generation (6)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Anthropic Messages · AI	`POST /v1/messages` · json	Inference API key	Anthropic Messages
Gemini Generate Content · AI	`POST /v1beta/models/{model}:generateContent` · json	Inference API key	Gemini Generate Content
JEV SystemOne · AI	`POST /v1/systemone` · json	Inference API key	JEV SystemOne
OpenAI Chat Completions · AI	`POST /v1/chat/completions` · json	Inference API key	OpenAI Chat Completions
OpenAI Responses · AI	`POST /v1/responses` · json	Inference API key	OpenAI Responses
OpenAI Responses Compact · AI	`POST /v1/responses/compact` · json	Inference API key	Responses context compaction for existing conversations. Returns reusable output items and does not support streaming.

Images (7)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Asynchronous image generation · AI	`POST /v1/videos` · json	Inference API key	Gateway asynchronous image extension: create a task with image parameters, then poll for the image. The /v1/videos path does not make this a video task.
Black Forest Labs FLUX · AI	`POST /flux/v1/flux-3-image` · json	Inference API key	Gateway FLUX native compatibility route, restricted to flux-3-image. Use the listed model protocols for other FLUX models.
Gemini Image Generation · AI	`POST /v1beta/models/{model}:generateContent` · json	Inference API key	Generate images through Gemini generateContent; responses may contain both text and image parts.
Image Generation · AI	`POST /v1/images/generations` · json	Inference API key	Image Generation
Kling Image Generation · AI	`POST /kling/v1/images/generations` · json	Inference API key	Kling Image Generation
OpenAI Image Edit · AI	`POST /v1/images/edits` · multipart	Inference API key	OpenAI Image Edit
Submit a Midjourney imagine task · AI	`POST /mj/submit/imagine` · json	Inference API key	Create an image task through the gateway compatibility endpoint.

Video generation (3)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Kling Image to Video · AI	`POST /kling/v1/videos/image2video` · json	Inference API key	Kling Image to Video
Kling Text to Video · AI	`POST /kling/v1/videos/text2video` · json	Inference API key	Kling Text to Video
OpenAI Video · AI	`POST /v1/videos` · json	Inference API key	OpenAI Video

Speech (3)

Endpoint and docs	Method, path, transport	Authentication	Purpose
OpenAI Audio Transcription · AI	`POST /v1/audio/transcriptions` · multipart	Inference API key	OpenAI Audio Transcription
OpenAI Audio Translation · AI	`POST /v1/audio/translations` · multipart	Inference API key	OpenAI Audio Translation
OpenAI Text to Speech · AI	`POST /v1/audio/speech` · json	Inference API key	OpenAI Text to Speech

Realtime (2)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Gemini Live WebSocket · AI	`GET /v1beta/live?model={model}` · websocket	Inference API key	Gemini Live WebSocket
Interpretation WebSocket · AI	`GET /v1/realtime?model={model}` · websocket	Inference API key	Simultaneous interpretation over Protobuf binary WebSocket frames.

Music and sound (27)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Suno Add Instrumental · AI	`POST /suno/v2/add-instrumental` · json	Inference API key	Suno Add Instrumental: suno/add-instrumental.
Suno Add Vocals · AI	`POST /suno/v2/add-vocals` · json	Inference API key	Suno Add Vocals: suno/add-vocals.
Suno Audio Upload · AI	`POST /suno/v2/upload` · json	Inference API key	Suno Audio Upload: suno/upload.
Suno Cover · AI	`POST /suno/v2/cover` · json	Inference API key	Suno Cover: suno/cover.
Suno Extension · AI	`POST /suno/v2/extend` · json	Inference API key	Suno Extension: suno/extend.
Suno Full Stem Separation · AI	`POST /suno/v2/stems-all` · json	Inference API key	Suno Full Stem Separation: suno/stems-all.
Suno Lyric Timings · AI	`POST /suno/v2/aligned-lyrics` · json	Inference API key	Suno Lyric Timings: suno/aligned-lyrics.
Suno Lyric Writing · AI	`POST /suno/v2/lyrics` · json	Inference API key	Suno Lyric Writing: suno/lyrics.
Suno MIDI Export · AI	`POST /suno/v2/gen-midi` · json	Inference API key	Suno MIDI Export: suno/gen-midi.
Suno Mashup · AI	`POST /suno/v2/mashup` · json	Inference API key	Suno Mashup: suno/mashup.
Suno Model Training · AI	`POST /suno/v2/create-model` · json	Inference API key	Suno Model Training: suno/create-model.
Suno Multi-format Export · AI	`POST /suno/v2/download` · json	Inference API key	Suno Multi-format Export: suno/download.
Suno Music Generation · AI	`POST /suno/v2/music` · json	Inference API key	Suno Music Generation: suno/music.
Suno Reference Generation · AI	`POST /suno/v2/inspo` · json	Inference API key	Suno Reference Generation: suno/inspo.
Suno Remaster · AI	`POST /suno/v2/remaster` · json	Inference API key	Suno Remaster: suno/remaster.
Suno Sample Rework · AI	`POST /suno/v2/sample` · json	Inference API key	Suno Sample Rework: suno/sample.
Suno Section Rewrite · AI	`POST /suno/v2/replace-section` · json	Inference API key	Suno Section Rewrite: suno/replace-section.
Suno Segment Merge · AI	`POST /suno/v2/concat` · json	Inference API key	Suno Segment Merge: suno/concat.
Suno Sound Effects · AI	`POST /suno/v2/sounds` · json	Inference API key	Suno Sound Effects: suno/sounds.
Suno Speed Adjustment · AI	`POST /suno/v2/adjust-speed` · json	Inference API key	Suno Speed Adjustment: suno/adjust-speed.
Suno Stem Layering · AI	`POST /suno/v2/add-stem` · json	Inference API key	Suno Stem Layering: suno/add-stem.
Suno Style Expansion · AI	`POST /suno/v2/upsample-tags` · json	Inference API key	Suno Style Expansion: suno/upsample-tags.
Suno Upload & Cover · AI	`POST /suno/v2/upload-cover` · json	Inference API key	Suno Upload & Cover: suno/upload-cover.
Suno Upload & Extend · AI	`POST /suno/v2/upload-extend` · json	Inference API key	Suno Upload & Extend: suno/upload-extend.
Suno Vocal Separation · AI	`POST /suno/v2/stems` · json	Inference API key	Suno Vocal Separation: suno/stems.
Suno Voice Capture · AI	`POST /suno/v2/persona` · json	Inference API key	Suno Voice Capture: suno/persona.
Suno Voice Cloning · AI	`POST /suno/v2/create-voice` · json	Inference API key	Suno Voice Cloning: suno/create-voice.

Embeddings and retrieval (2)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Embeddings · AI	`POST /v1/embeddings` · json	Inference API key	Embeddings
Jina Rerank · AI	`POST /v1/rerank` · json	Inference API key	Jina Rerank

Available models (5)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Get paginated marketplace model information · AI	`GET /api/pricing/models` · json	Anonymous; may vary when authenticated	Get paginated marketplace model information. Returns data visible to the current account.
List callable models · AI	`GET /v1/models` · json	Inference API key	List callable models. Fields and permissions follow this gateway implementation.
List models in Gemini format · AI	`GET /v1beta/models` · json	Inference API key	List models in Gemini format within the current credential scope.
List models through the Gemini compatible endpoint · AI	`GET /v1beta/openai/models` · json	Inference API key	List models through the Gemini compatible endpoint within the current credential scope.
Retrieve model metadata · AI	`GET /v1/models/{model}` · json	Inference API key	List callable models. Fields and permissions follow this gateway implementation.

Image and video tasks (7)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Download video task content · AI	`GET /v1/videos/{task_id}/content` · json	Inference API key	Download video task content. The following is this gateway’s public contract.
Retrieve a Kling images task · AI	`GET /kling/v1/images/{kind}/{task_id}` · json	Inference API key	Retrieve a Kling images task. The following is this gateway’s public contract.
Retrieve a Kling videos task · AI	`GET /kling/v1/videos/{kind}/{task_id}` · json	Inference API key	Retrieve a Kling videos task. The following is this gateway’s public contract.
Retrieve a Midjourney task · AI	`GET /mj/task/{task_id}/fetch` · json	Inference API key	Retrieve a Midjourney task. The following is this gateway’s public contract.
Retrieve a native FLUX image task · AI	`GET /flux/v1/get_result` · json	Inference API key	Retrieve a native FLUX image task. The following is this gateway’s public contract.
Retrieve a unified video or image task · AI	`GET /v1/videos/{task_id}` · json	Inference API key	Retrieve a unified video or image task. The following is this gateway’s public contract.
Retrieve image results by request ID · AI	`GET /v1/images/generations/result` · json	Inference API key	Retrieve image results by request ID. The following is this gateway’s public contract.

Music tasks (2)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Retrieve Suno v2 tasks in a batch · AI	`POST /suno/v2/fetch` · json	Inference API key	Retrieve Suno v2 tasks in a batch. The following is this gateway’s public contract.
Retrieve a Suno v2 task · AI	`GET /suno/v2/fetch/{task_id}` · json	Inference API key	Retrieve a Suno v2 task. The following is this gateway’s public contract.

Other tasks and results (2)

Endpoint and docs	Method, path, transport	Authentication	Purpose
List current account task records · AI	`GET /api/task/self` · json	System token + user ID, or session	List current account task records within the current credential scope.
Retrieve a Kling audio task · AI	`GET /kling/v1/audio/{kind}/{task_id}` · json	Inference API key	Retrieve a Kling audio task. The following is this gateway’s public contract.

Account (8)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Bootstrap account identity · AI	`GET /api/user/self/bootstrap` · json	Account system token only	Call this first when you have a system token but do not know the account ID.
Get current account · AI	`GET /api/user/self` · json	System token + user ID, or session	Get current account. Fields and permissions follow this gateway implementation.
List account groups and multipliers · AI	`GET /api/user/self/groups` · json	System token + user ID, or session	List account groups and multipliers within the current credential scope.
List account model choices · AI	`GET /api/user/models` · json	System token + user ID, or session	List account model choices within the current credential scope.
Patch the current profile · AI	`PATCH /api/user/self` · json	System token + user ID, or session	Patch the current profile. The following is this gateway’s public contract.
Read current system token · AI	`GET /api/user/token/current` · json	System token + user ID, or session	Read current system token. Returns data visible to the current account.
Retrieve account level limits · AI	`GET /api/user/self/level_limits` · json	System token + user ID, or session	Retrieve account level limits within the current credential scope.
Rotate system token · AI	`GET /api/user/token` · json	System token + user ID, or session	Rotate system token. Returns data visible to the current account.

API keys (14)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Create API keys in a batch · AI	`POST /api/token/batch/create` · json	System token + user ID, or session	Create an API key. Fields and permissions follow this gateway implementation.
Create an API key · AI	`POST /api/token/` · json	System token + user ID, or session	Create an API key. Fields and permissions follow this gateway implementation.
Delete API keys in a batch · AI	`POST /api/token/batch` · json	System token + user ID, or session	Delete API keys in a batch within the current credential scope.
Delete an API key · AI	`DELETE /api/token/{id}` · json	System token + user ID, or session	Delete an API key. Fields and permissions follow this gateway implementation.
Get API key details · AI	`GET /api/token/{id}` · json	System token + user ID, or session	Get API key details. Fields and permissions follow this gateway implementation.
Get current key usage · AI	`GET /api/usage/token/` · json	Inference API key	Get current key usage. Fields and permissions follow this gateway implementation.
List API keys · AI	`GET /api/token/` · json	System token + user ID, or session	List API keys. Fields and permissions follow this gateway implementation.
List assignable API key groups · AI	`GET /api/token/group` · json	System token + user ID, or session	List assignable API key groups. The following is this gateway’s public contract.
Patch an API key · AI	`PATCH /api/token/{id}` · json	System token + user ID, or session	Only explicitly supplied fields are updated. Omitted fields stay unchanged; 0 and false are preserved.
Reveal API keys in a batch · AI	`POST /api/token/batch/keys` · json	System token + user ID, or session	Reveal API keys in a batch within the current credential scope.
Reveal an API key · AI	`POST /api/token/{id}/key` · json	System token + user ID, or session	Reveal an API key. Fields and permissions follow this gateway implementation.
Search API keys · AI	`GET /api/token/search` · json	System token + user ID, or session	List API keys. Fields and permissions follow this gateway implementation.
Update API keys in a batch · AI	`POST /api/token/batch/update` · json	System token + user ID, or session	Update API keys in a batch within the current credential scope.
Update an API key · AI	`PUT /api/token/` · json	System token + user ID, or session	Update an API key. Fields and permissions follow this gateway implementation.

Usage and logs (19)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Compatible cumulative usage · AI	`GET /v1/dashboard/billing/usage` · json	Inference API key	Compatible cumulative usage. Read-only compatibility for legacy clients.
Compatible quota information · AI	`GET /v1/dashboard/billing/subscription` · json	Inference API key	Compatible quota information. Read-only compatibility for legacy clients.
Export account task records as CSV · AI	`GET /api/task/self/export` · json	System token + user ID, or session	Export account task records as CSV. Returns data visible to the current account.
Export account usage CSV · AI	`GET /api/log/self/export` · json	System token + user ID, or session	Export account usage CSV within the current credential scope.
Export current key usage CSV · AI	`GET /api/log/token/export` · json	Inference API key	Export current key usage CSV within the current credential scope.
Get account dashboard consumption statistics · AI	`GET /api/data/dashboard_consumption_stats` · json	System token + user ID, or session	Get account dashboard consumption statistics. Returns data visible to the current account.
Get account logs by request ID · AI	`GET /api/log/self/request/{request_id}` · json	System token + user ID, or session	Get account logs by request ID. Returns data visible to the current account.
Get account quota history · AI	`GET /api/data/self` · json	System token + user ID, or session	Get account quota history. Returns data visible to the current account.
Get consumption statistics by source · AI	`GET /api/data/consumption_stats` · json	System token + user ID, or session	Get consumption statistics by source. Returns data visible to the current account.
Get detailed account usage statistics · AI	`GET /api/log/self/advanced_stat` · json	System token + user ID, or session	Get detailed account usage statistics. Returns data visible to the current account.
Get usage statistics · AI	`GET /api/log/self/stat` · json	System token + user ID, or session	Get usage statistics. Fields and permissions follow this gateway implementation.
Get usage summary · AI	`GET /api/log/self/stat` · json	System token + user ID, or session	Aggregate the current account’s recorded requests, errors, tokens and quota.
Legacy log search (deprecated) · AI	`GET /api/log/self/search` · json	System token + user ID, or session	Deprecated endpoint; do not use for new integrations.
List account Midjourney task records · AI	`GET /api/mj/self` · json	System token + user ID, or session	List account Midjourney task records. Returns data visible to the current account.
List account monthly log archives · AI	`GET /api/log/self/archive` · json	System token + user ID, or session	List account monthly log archives. Returns data visible to the current account.
List usage logs · AI	`GET /api/log/self` · json	System token + user ID, or session	List usage logs. Fields and permissions follow this gateway implementation.
Manually refresh a not-started task · AI	`POST /api/task/{task_id}/poll` · json	System token + user ID, or session	Manually refresh a not-started task. Returns data visible to the current account.
Retrieve request image or task results · AI	`GET /api/log/get-request` · json	Inference API key	Retrieve image results by request ID. The following is this gateway’s public contract.
Retrieve usage logs for the current API key · AI	`GET /api/log/token` · json	Inference API key	List usage logs. Fields and permissions follow this gateway implementation.

Pricing and top-ups (2)

Endpoint and docs	Method, path, transport	Authentication	Purpose
Get model pricing · AI	`GET /api/pricing` · json	Anonymous; may vary when authenticated	Get model pricing. Fields and permissions follow this gateway implementation.
List top-up records · AI	`GET /api/user/topup/self` · json	System token + user ID, or session	List top-up records. Fields and permissions follow this gateway implementation.

Models, pricing, and errors

Model marketplace: check model IDs, endpoints, and displayed prices; authenticated queries determine account access.
Getting started, protocol and endpoint selection, troubleshooting.
Check HTTP status and protocol-specific business status. Back off on 429; do not blindly retry paid generation, task creation, or key mutations.
This index only covers published integration references. It does not expose internal admin routes, real credentials, account data, or user requests.
AI reading links require network access and permission to view this site. External assistants usually cannot reach private test addresses; copy the overview and the relevant endpoint guide instead.

Content revision: ec691266958f26bb509b85546c18c99f8876ec057fed4685ed83a734b5a847f6

Use cases

Choose endpoints for a task
AI-assisted integration

API protocols

/docs/api/overview.md

FAQ

What should I give an AI?

Copy the overview text or give its AI reading link to an assistant with browsing access, then read the relevant endpoint references for integration.

Does documentation guarantee availability?

No. Availability depends on configured channels, models, account permissions, and balance. Check live lists and endpoint requirements.

What if the AI cannot open a link?

Copy the overview, then copy the integration guide from the chosen endpoint page. Do not share real credentials with the assistant.

Official sources

new-api · QuantumNous Official