Welcome to Novita AI API Reference
This documentation provides comprehensive reference for all Novita AI APIs. Our APIs are organized into several categories:Base URLs
All API requests should be made to:API Groups
Basic APIs
Fundamental APIs for authentication, billing, and account management.| Endpoint | Description | File Path |
|---|---|---|
| Authentication | API key authentication | api-reference/basic-authentication.mdx |
| Error Codes | Unified error response format | api-reference/basic-error-code.mdx |
| Get User Balance | Query account balance | api-reference/basic-get-user-balance.mdx |
| Query Monthly Bill | Query monthly billing | api-reference/basic-query-monthly-bill.mdx |
| Query Usage-Based Billing | Query usage-based billing | api-reference/basic-query-usage-based-billing.mdx |
| Query Fixed-Term Billing | Query fixed-term billing | api-reference/basic-query-fixed-term-billing.mdx |
Model APIs
LLM APIs
Large Language Model APIs with OpenAI compatibility.| Endpoint | Description | File Path |
|---|---|---|
| Create Chat Completion | Create a chat completion | api-reference/model-apis-llm-create-chat-completion.mdx |
| Create Completion | Create a completion | api-reference/model-apis-llm-create-completion.mdx |
| Create Embeddings | Create embeddings | api-reference/model-apis-llm-create-embeddings.mdx |
| Create Rerank | Rerank search results | api-reference/model-apis-llm-create-rerank.mdx |
| List Models | List available models | api-reference/model-apis-llm-list-models.mdx |
| Retrieve Model | Get model details | api-reference/model-apis-llm-retrieve-model.mdx |
| Endpoint | Description | File Path |
|---|---|---|
| Create Batch | Create a batch job | api-reference/model-apis-llm-create-batch.mdx |
| Retrieve Batch | Get batch job status | api-reference/model-apis-llm-retrieve-batch.mdx |
| Cancel Batch | Cancel a batch job | api-reference/model-apis-llm-cancel-batch.mdx |
| List Batches | List all batch jobs | api-reference/model-apis-llm-list-batches.mdx |
| Upload Batch Input File | Upload file for batch | api-reference/model-apis-llm-upload-batch-input-file.mdx |
| List Files | List uploaded files | api-reference/model-apis-llm-list-files.mdx |
| Query File | Get file metadata | api-reference/model-apis-llm-query-file.mdx |
| Delete File | Delete a file | api-reference/model-apis-llm-delete-file.mdx |
| Retrieve File Content | Get file content | api-reference/model-apis-llm-retrieve-file-content.mdx |
Image, Audio and Video APIs
Multimodal AI APIs for content generation and editing. Core Endpoints:| Endpoint | Description | File Path |
|---|---|---|
| Webhook | Webhook configuration | api-reference/model-apis-webhook.mdx |
| Get Model | Query available models | api-reference/model-apis-get-model.mdx |
| Task Result | Get async task results | api-reference/model-apis-task-result.mdx |
| Endpoint | Description | File Path |
|---|---|---|
| Text to Image | Generate images from text | api-reference/model-apis-txt2img.mdx |
| Image to Image | Transform existing images | api-reference/model-apis-img2img.mdx |
| Reimagine | Reimagine compositions | api-reference/model-apis-reimagine.mdx |
| FLUX.1 Schnell | Fast image generation | api-reference/model-apis-flux-1-schnell.mdx |
| Seedream 3.0 | High-quality generation | api-reference/model-apis-seedream-3-0-t2i.mdx |
| Seedream 4.0 | Advanced generation | api-reference/model-apis-seedream-4-0.mdx |
| Qwen Image | Qwen image generation | api-reference/model-apis-qwen-image-txt2img.mdx |
| Endpoint | Description | File Path |
|---|---|---|
| Upscale | Image upscaling | api-reference/model-apis-upscale.mdx |
| Remove Background | Background removal | api-reference/model-apis-remove-background.mdx |
| Replace Background | Background replacement | api-reference/model-apis-replace-background.mdx |
| Inpainting | Image inpainting | api-reference/model-apis-inpainting.mdx |
| Image to Prompt | Reverse engineering | api-reference/model-apis-image-to-prompt.mdx |
| Endpoint | Description | File Path |
|---|---|---|
| Text to Video | Generate videos from text | api-reference/model-apis-txt2video.mdx |
| Image to Video | Animate images | api-reference/model-apis-img2video.mdx |
| Hunyuan Video Fast | Fast video generation | api-reference/model-apis-hunyuan-video-fast.mdx |
| Wan 2.5 T2V Preview | Wan 2.5 preview | api-reference/model-apis-wan-2.5-t2v-preview.mdx |
| Kling V2.1 Master | Kling V2.1 master | api-reference/model-apis-kling-v2.1-t2v-master.mdx |
| Minimax Hailuo 02 | Minimax Hailuo | api-reference/model-apis-minimax-hailuo-02.mdx |
| Vidu Q1 | Vidu Q1 generation | api-reference/model-apis-vidu-q1-text2video.mdx |
| Endpoint | Description | File Path |
|---|---|---|
| Minimax Speech 02 | Minimax TTS HD | api-reference/model-apis-minimax-speech-02-hd.mdx |
| Minimax Speech 2.8 | Minimax 2.8 HD | api-reference/model-apis-minimax-speech-2.8-hd.mdx |
| Fish Audio TTS | Fish Audio TTS | api-reference/model-apis-fish-audio-text-to-speech.mdx |
| GLM TTS | GLM text-to-speech | api-reference/model-apis-glm-tts.mdx |
| GLM ASR | GLM speech recognition | api-reference/model-apis-glm-asr.mdx |
GPU APIs
GPU instance management and serverless GPU endpoints.GPU Instance
| Endpoint | Description | File Path |
|---|---|---|
| Create Instance | Create GPU instance | api-reference/gpu-instance-create-instance.mdx |
| List Instances | List all instances | api-reference/gpu-instance-list-instances.mdx |
| Get Instance | Get instance details | api-reference/gpu-instance-get-instance.mdx |
| Start Instance | Start instance | api-reference/gpu-instance-start-instance.mdx |
| Stop Instance | Stop instance | api-reference/gpu-instance-stop-instance.mdx |
| Delete Instance | Delete instance | api-reference/gpu-instance-delete-instance.mdx |
| Endpoint | Description | File Path |
|---|---|---|
| Create Template | Create template | api-reference/gpu-instance-create-template.mdx |
| List Templates | List templates | api-reference/gpu-instance-list-templates.mdx |
| Get Template | Get template details | api-reference/gpu-instance-get-template.mdx |
| Endpoint | Description | File Path |
|---|---|---|
| List Products | List GPU products | api-reference/gpu-instance-list-products.mdx |
Serverless GPUs
| Endpoint | Description | File Path |
|---|---|---|
| Create Endpoint | Create endpoint | api-reference/serverless-create-endpoint.mdx |
| List Endpoint | List endpoints | api-reference/serverless-list-endpoint.mdx |
| Get Endpoint | Get endpoint details | api-reference/serverless-get-endpoint.mdx |
| Update Endpoint | Update endpoint | api-reference/serverless-update-endpoint.mdx |
| Delete Endpoint | Delete endpoint | api-reference/serverless-delete-endpoint.mdx |
Quick Start
1. Get Your API Key
Visit the settings page to create and manage your API keys.2. Make Your First Request
3. Explore SDKs
We provide official SDKs for popular languages:Authentication
All API requests require authentication using Bearer tokens. Include your API key in the Authorization header:Error Handling
Novita AI uses standard HTTP status codes and returns errors in a unified format. See Error Codes for complete error reference.Common Use Cases
| User Query | Go To |
|---|---|
| ”How to get started?” | Quick Start + Authentication |
| ”API not working, error 401” | Error Codes |
| ”Generate images from text” | Text to Image |
| ”Create chatbot with LLM” | Chat Completion |
| ”Generate videos” | Text to Video |
| ”Deploy GPU instance” | Create Instance |
| ”Check my balance” | Get User Balance |
| ”OpenAI compatible API” | LLM API Guide |