# API Reference Overview - Documentation

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown is available with `Accept: text/markdown` and `.md` URL variants.

Source: /docs/api-reference/api-reference-overview

# API Reference Overview

##

[​](#welcome-to-novita-ai-api-reference)

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)

Base URLs

All API requests should be made to:

```
https://api.novita.ai
```

OpenAI-Compatible Endpoints:

```
https://api.novita.ai/openai
```

##

[​](#api-groups)

API Groups

###

[​](#basic-apis)

Basic APIs

Fundamental APIs for authentication, billing, and account management.

EndpointDescription[Authentication](/docs/api-reference/basic-authentication)API key authentication[Error Codes](/docs/api-reference/basic-error-code)Unified error response format[Get User Balance](/docs/api-reference/basic-get-user-balance)Query account balance[Query Monthly Bill](/docs/api-reference/basic-query-monthly-bill)Query monthly billing[Query Usage-Based Billing](/docs/api-reference/basic-query-usage-based-billing)Query usage-based billing[Query Fixed-Term Billing](/docs/api-reference/basic-query-fixed-term-billing)Query fixed-term billing

###

[​](#model-apis)

Model APIs

####

[​](#llm-apis)

LLM APIs

Large Language Model APIs with OpenAI compatibility.

EndpointDescription[Create Chat Completion](/docs/api-reference/model-apis-llm-create-chat-completion)Create a chat completion[Create Completion](/docs/api-reference/model-apis-llm-create-completion)Create a completion[Create Embeddings](/docs/api-reference/model-apis-llm-create-embeddings)Create embeddings[Create Rerank](/docs/api-reference/model-apis-llm-create-rerank)Rerank search results[List Models](/docs/api-reference/model-apis-llm-list-models)List available models[Retrieve Model](/docs/api-reference/model-apis-llm-retrieve-model)Get model details

Batch Operations:

EndpointDescription[Create Batch](/docs/api-reference/model-apis-llm-create-batch)Create a batch job[Retrieve Batch](/docs/api-reference/model-apis-llm-retrieve-batch)Get batch job status[Cancel Batch](/docs/api-reference/model-apis-llm-cancel-batch)Cancel a batch job[List Batches](/docs/api-reference/model-apis-llm-list-batches)List all batch jobs[Upload Batch Input File](/docs/api-reference/model-apis-llm-upload-batch-input-file)Upload file for batch[List Files](/docs/api-reference/model-apis-llm-list-files)List uploaded files[Query File](/docs/api-reference/model-apis-llm-query-file)Get file metadata[Delete File](/docs/api-reference/model-apis-llm-delete-file)Delete a file[Retrieve File Content](/docs/api-reference/model-apis-llm-retrieve-file-content)Get file content

####

[​](#image-audio-and-video-apis)

Image, Audio and Video APIs

Multimodal AI APIs for content generation and editing.
Core Endpoints:

EndpointDescription[Webhook](/docs/api-reference/model-apis-webhook)Webhook configuration[Get Model](/docs/api-reference/model-apis-get-model)Query available models[Task Result](/docs/api-reference/model-apis-task-result)Get async task results

Image Generation:

EndpointDescription[Text to Image](/docs/api-reference/model-apis-txt2img)Generate images from text[Image to Image](/docs/api-reference/model-apis-img2img)Transform existing images[Reimagine](/docs/api-reference/model-apis-reimagine)Reimagine compositions[FLUX.1 Schnell](/docs/api-reference/model-apis-flux-1-schnell)Fast image generation[Seedream 3.0](/docs/api-reference/model-apis-seedream-3-0-t2i)High-quality generation[Seedream 4.0](/docs/api-reference/model-apis-seedream-4-0)Advanced generation[Qwen Image](/docs/api-reference/model-apis-qwen-image-txt2img)Qwen image generation

Image Editing:

EndpointDescription[Upscale](/docs/api-reference/model-apis-upscale)Image upscaling[Remove Background](/docs/api-reference/model-apis-remove-background)Background removal[Replace Background](/docs/api-reference/model-apis-replace-background)Background replacement[Inpainting](/docs/api-reference/model-apis-inpainting)Image inpainting[Image to Prompt](/docs/api-reference/model-apis-image-to-prompt)Reverse engineering

Video Generation:

EndpointDescription[Text to Video](/docs/api-reference/model-apis-txt2video)Generate videos from text[Image to Video](/docs/api-reference/model-apis-img2video)Animate images[Hunyuan Video Fast](/docs/api-reference/model-apis-hunyuan-video-fast)Fast video generation[Wan 2.5 T2V Preview](/docs/api-reference/model-apis-wan-2.5-t2v-preview)Wan 2.5 preview[Kling V2.1 Master](/docs/api-reference/model-apis-kling-v2.1-t2v-master)Kling V2.1 master[Minimax Hailuo 02](/docs/api-reference/model-apis-minimax-hailuo-02)Minimax Hailuo[Vidu Q1](/docs/api-reference/model-apis-vidu-q1-text2video)Vidu Q1 generation

Audio:

EndpointDescription[Minimax Speech 02](/docs/api-reference/model-apis-minimax-speech-02-hd)Minimax TTS HD[Minimax Speech 2.8](/docs/api-reference/model-apis-minimax-speech-2.8-hd)Minimax 2.8 HD[GLM TTS](/docs/api-reference/model-apis-glm-tts)GLM text-to-speech[GLM ASR](/docs/api-reference/model-apis-glm-asr)GLM speech recognition

###

[​](#gpu-apis)

GPU APIs

GPU instance management and serverless GPU endpoints.

####

[​](#gpu-instance)

GPU Instance

EndpointDescription[Create Instance](/docs/api-reference/gpu-instance-create-instance)Create GPU instance[List Instances](/docs/api-reference/gpu-instance-list-instances)List all instances[Get Instance](/docs/api-reference/gpu-instance-get-instance)Get instance details[Start Instance](/docs/api-reference/gpu-instance-start-instance)Start instance[Stop Instance](/docs/api-reference/gpu-instance-stop-instance)Stop instance[Delete Instance](/docs/api-reference/gpu-instance-delete-instance)Delete instance

Template Management:

EndpointDescription[Create Template](/docs/api-reference/gpu-instance-create-template)Create template[List Templates](/docs/api-reference/gpu-instance-list-templates)List templates[Get Template](/docs/api-reference/gpu-instance-get-template)Get template details

Product & Pricing:

EndpointDescription[List Products](/docs/api-reference/gpu-instance-list-products)List GPU products

####

[​](#serverless-gpus)

Serverless GPUs

EndpointDescription[Create Endpoint](/docs/api-reference/serverless-create-endpoint)Create endpoint[List Endpoint](/docs/api-reference/serverless-list-endpoint)List endpoints[Get Endpoint](/docs/api-reference/serverless-get-endpoint)Get endpoint details[Update Endpoint](/docs/api-reference/serverless-update-endpoint)Update endpoint[Delete Endpoint](/docs/api-reference/serverless-delete-endpoint)Delete endpoint

##

[​](#quick-start)

Quick Start

###

[​](#1-get-your-api-key)

1. Get Your API Key

Visit the [settings page](https://novita.ai/settings/key-management) to create and manage your API keys.

###

[​](#2-make-your-first-request)

2. Make Your First Request

```
curl --location 'https://api.novita.ai/v1/models' \
--header 'Authorization: Bearer {{API Key}}'
```

###

[​](#3-explore-sdks)

3. Explore SDKs

We provide official SDKs for popular languages:

- [Python SDK](/docs/guides/model-apis-sdks#python)

- [JavaScript/TypeScript SDK](/docs/guides/model-apis-sdks#javascripttypescript)

##

[​](#authentication)

Authentication

All API requests require authentication using Bearer tokens. Include your API key in the Authorization header:

```
Authorization: Bearer {{API Key}}
```

See [Authentication](/docs/api-reference/basic-authentication) for details.

##

[​](#error-handling)

Error Handling

Novita AI uses standard HTTP status codes and returns errors in a unified format. See [Error Codes](/docs/api-reference/basic-error-code) for complete error reference.

##

[​](#common-use-cases)

Common Use Cases

User QueryGo To”How to get started?”[Quick Start](#quick-start) + [Authentication](/docs/api-reference/basic-authentication)”API not working, error 401”[Error Codes](/docs/api-reference/basic-error-code)”Generate images from text”[Text to Image](/docs/api-reference/model-apis-txt2img)”Create chatbot with LLM”[Chat Completion](/docs/api-reference/model-apis-llm-create-chat-completion)”Generate videos”[Text to Video](/docs/api-reference/model-apis-txt2video)”Deploy GPU instance”[Create Instance](/docs/api-reference/gpu-instance-create-instance)”Check my balance”[Get User Balance](/docs/api-reference/basic-get-user-balance)”OpenAI compatible API”[LLM API Guide](/docs/guides/llm-api)

##

[​](#need-help)

Need Help?

- [Discord Community](https://discord.gg/YyPFAzwp7P)

- [Email Support](mailto:support@novita.ai)

- [Console](https://novita.ai/console)

Last modified on April 3, 2026
