> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novita.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference Overview

## 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:

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

**OpenAI-Compatible Endpoints:**

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

## API Groups

### Basic APIs

Fundamental APIs for authentication, billing, and account management.

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

### Model APIs

#### LLM APIs

Large Language Model APIs with OpenAI compatibility.

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

**Batch Operations:**

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

#### Image, Audio and Video APIs

Multimodal AI APIs for content generation and editing.

**Core Endpoints:**

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

**Image Generation:**

| Endpoint | Description |
| - | - |

**Image Editing:**

| Endpoint | Description |
| - | - |

**Video Generation:**

| Endpoint | Description |
| - | - |

**Audio:**

| Endpoint | Description |
| - | - |
| [Minimax Speech 2.8](/api-reference/model-apis-minimax-speech-2.8-hd) | Minimax 2.8 HD |

### GPU APIs

GPU instance management and serverless GPU endpoints.

#### GPU Instance

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

**Template Management:**

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

**Product & Pricing:**

| Endpoint | Description |
| - | - |
| [List Products](/api-reference/gpu-instance-list-products) | List GPU products |

#### Serverless GPUs

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

## Quick Start

### 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

```bash theme={"system"}
curl --location 'https://api.novita.ai/openai/v1/models' \
  --header 'Authorization: Bearer {{API Key}}'
```

### 3. Explore SDKs

We provide official SDKs for popular languages:

* [Python SDK](/guides/model-apis-sdks#python)
* [JavaScript/TypeScript SDK](/guides/model-apis-sdks#javascripttypescript)

## Authentication

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

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

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

## Error Handling

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

## Common Use Cases

| User Query | Go To |
| - | - |
| "How to get started?" | [Quick Start](#quick-start) + [Authentication](/api-reference/basic-authentication) |
| "API not working, error 401" | [Error Codes](/api-reference/basic-error-code) |
| "Create chatbot with LLM" | [Chat Completion](/api-reference/model-apis-llm-create-chat-completion) |
| "Deploy GPU instance" | [Create Instance](/api-reference/gpu-instance-create-instance) |
| "Check my balance" | [Get User Balance](/api-reference/basic-get-user-balance) |
| "OpenAI compatible API" | [LLM API Guide](/guides/llm-api) |

## Need Help?

* [Discord Community](https://discord.gg/YyPFAzwp7P)
* [Email Support](mailto:support@novita.ai)
* [Console](https://novita.ai/console)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.