> ## Documentation Index
> Fetch the complete documentation index at: https://novita.ai/docs/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](/docs/ja/api-reference/basic-authentication)                       | API key authentication        |
| [Error Codes](/docs/ja/api-reference/basic-error-code)                              | Unified error response format |
| [Get User Balance](/docs/ja/api-reference/basic-get-user-balance)                   | Query account balance         |
| [Query Monthly Bill](/docs/ja/api-reference/basic-query-monthly-bill)               | Query monthly billing         |
| [Query Usage-Based Billing](/docs/ja/api-reference/basic-query-usage-based-billing) | Query usage-based billing     |
| [Query Fixed-Term Billing](/docs/ja/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](/docs/ja/api-reference/model-apis-llm-create-chat-completion) | Create a chat completion |
| [Create Completion](/docs/ja/api-reference/model-apis-llm-create-completion)           | Create a completion      |
| [Create Embeddings](/docs/ja/api-reference/model-apis-llm-create-embeddings)           | Create embeddings        |
| [Create Rerank](/docs/ja/api-reference/model-apis-llm-create-rerank)                   | Rerank search results    |
| [List Models](/docs/ja/api-reference/model-apis-llm-list-models)                       | List available models    |
| [Retrieve Model](/docs/ja/api-reference/model-apis-llm-retrieve-model)                 | Get model details        |

**Batch Operations:**

| Endpoint                                                                            | Description           |
| ----------------------------------------------------------------------------------- | --------------------- |
| [Create Batch](/docs/ja/api-reference/model-apis-llm-create-batch)                       | Create a batch job    |
| [Retrieve Batch](/docs/ja/api-reference/model-apis-llm-retrieve-batch)                   | Get batch job status  |
| [Cancel Batch](/docs/ja/api-reference/model-apis-llm-cancel-batch)                       | Cancel a batch job    |
| [List Batches](/docs/ja/api-reference/model-apis-llm-list-batches)                       | List all batch jobs   |
| [Upload Batch Input File](/docs/ja/api-reference/model-apis-llm-upload-batch-input-file) | Upload file for batch |
| [List Files](/docs/ja/api-reference/model-apis-llm-list-files)                           | List uploaded files   |
| [Query File](/docs/ja/api-reference/model-apis-llm-query-file)                           | Get file metadata     |
| [Delete File](/docs/ja/api-reference/model-apis-llm-delete-file)                         | Delete a file         |
| [Retrieve File Content](/docs/ja/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](/docs/ja/api-reference/model-apis-webhook)         | Webhook configuration  |
| [Get Model](/docs/ja/api-reference/model-apis-get-model)     | Query available models |
| [Task Result](/docs/ja/api-reference/model-apis-task-result) | Get async task results |

**Image Generation:**

| Endpoint                                                      | Description           |
| ------------------------------------------------------------- | --------------------- |
| [Seedream 4.0](/docs/ja/api-reference/model-apis-seedream-4-0)     | Advanced generation   |
| [Qwen Image](/docs/ja/api-reference/model-apis-qwen-image-txt2img) | Qwen image generation |

**Image Editing:**

| Endpoint | Description |
| -------- | ----------- |

**Video Generation:**

| Endpoint                                                                | Description     |
| ----------------------------------------------------------------------- | --------------- |
| [Wan 2.5 T2V Preview](/docs/ja/api-reference/model-apis-wan-2.5-t2v-preview) | Wan 2.5 preview |

**Audio:**

| Endpoint                                                                 | Description    |
| ------------------------------------------------------------------------ | -------------- |
| [Minimax Speech 2.8](/docs/ja/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](/docs/ja/api-reference/gpu-instance-create-instance) | Create GPU instance  |
| [List Instances](/docs/ja/api-reference/gpu-instance-list-instances)   | List all instances   |
| [Get Instance](/docs/ja/api-reference/gpu-instance-get-instance)       | Get instance details |
| [Start Instance](/docs/ja/api-reference/gpu-instance-start-instance)   | Start instance       |
| [Stop Instance](/docs/ja/api-reference/gpu-instance-stop-instance)     | Stop instance        |
| [Delete Instance](/docs/ja/api-reference/gpu-instance-delete-instance) | Delete instance      |

**Template Management:**

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

**Product & Pricing:**

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

#### Serverless GPUs

| Endpoint                                                        | Description          |
| --------------------------------------------------------------- | -------------------- |
| [Create Endpoint](/docs/ja/api-reference/serverless-create-endpoint) | Create endpoint      |
| [List Endpoint](/docs/ja/api-reference/serverless-list-endpoint)     | List endpoints       |
| [Get Endpoint](/docs/ja/api-reference/serverless-get-endpoint)       | Get endpoint details |
| [Update Endpoint](/docs/ja/api-reference/serverless-update-endpoint) | Update endpoint      |
| [Delete Endpoint](/docs/ja/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/v1/models' \
  --header 'Authorization: Bearer {{API Key}}'
```

### 3. Explore SDKs

We provide official SDKs for popular languages:

* [Python SDK](/docs/ja/guides/model-apis-sdks#python)
* [JavaScript/TypeScript SDK](/docs/ja/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](/docs/ja/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](/docs/ja/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](/docs/ja/api-reference/basic-authentication) |
| "API not working, error 401" | [Error Codes](/docs/ja/api-reference/basic-error-code)                                      |
| "Create chatbot with LLM"    | [Chat Completion](/docs/ja/api-reference/model-apis-llm-create-chat-completion)             |
| "Deploy GPU instance"        | [Create Instance](/docs/ja/api-reference/gpu-instance-create-instance)                      |
| "Check my balance"           | [Get User Balance](/docs/ja/api-reference/basic-get-user-balance)                           |
| "OpenAI compatible API"      | [LLM API Guide](/docs/ja/guides/llm-api)                                                    |

## Need Help?

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