# Nusabase API Docs

> Nusabase backend API, relay API, and deployment documentation.

- [Models and Pricing](https://nusabase-a8dcf793.mintlify.app/en/getting-started/pricing.md): USD pricing reference for text, image, video, multimodal, audio, realtime, and third-party models.
- [Billing Rules](https://nusabase-a8dcf793.mintlify.app/en/getting-started/billing-rules.md): The five billing rules used by the API aggregation platform: usage-based, per-call, duration-based, resolution-based, and tiered pricing.
- [Error Codes](https://nusabase-a8dcf793.mintlify.app/en/getting-started/error-codes.md): Response format, HTTP status codes, platform error codes, and handling guidance for failed API calls.
- [Integration Overview](https://nusabase-a8dcf793.mintlify.app/en/guides/agent-integrations.md): Entry page for Claude Code, GitHub Copilot, OpenCode, OpenClaw, and other agent tools with Nusabase API.
- [Integrate Claude Code](https://nusabase-a8dcf793.mintlify.app/en/guides/agent-integrations-claude-code.md): Configure Claude Code through the Nusabase Anthropic Messages-compatible endpoint.
- [Integrate GitHub Copilot](https://nusabase-a8dcf793.mintlify.app/en/guides/agent-integrations-github-copilot.md): How to use Nusabase API in GitHub Copilot workflows, including limitations, BYOK-style setup, validation, and troubleshooting.
- [Integrate GitHub Copilot CLI](https://nusabase-a8dcf793.mintlify.app/en/guides/agent-integrations-github-copilot-cli.md): Use Copilot CLI BYOK environment variables with the Nusabase OpenAI-compatible endpoint.
- [Integrate Kilo Code](https://nusabase-a8dcf793.mintlify.app/en/guides/agent-integrations-kilo-code.md): Use Kilo Code OpenAI-compatible or custom provider settings with Nusabase API.
- [Integrate WorkBuddy/CodeBuddy](https://nusabase-a8dcf793.mintlify.app/en/guides/agent-integrations-workbuddy-codebuddy.md): Configure WorkBuddy/CodeBuddy with a Nusabase OpenAI-compatible model through models.json.
- [Integrate OpenCode](https://nusabase-a8dcf793.mintlify.app/en/guides/agent-integrations-opencode.md): Configure OpenCode with a Nusabase OpenAI-compatible provider.
- [Integrate OpenClaw](https://nusabase-a8dcf793.mintlify.app/en/guides/agent-integrations-openclaw.md): Configure OpenClaw custom model provider with Nusabase API.
- [Integrate Hermes](https://nusabase-a8dcf793.mintlify.app/en/guides/agent-integrations-hermes.md): Configure Hermes Agent model provider with Nusabase API.
- [Integrate CC Switch](https://nusabase-a8dcf793.mintlify.app/en/guides/agent-integrations-ccswitch.md): Use CC Switch to configure Nusabase API for Claude Code, Codex, OpenCode, and other AI coding tools through a graphical interface.
- [Quick Start](https://nusabase-a8dcf793.mintlify.app/en/getting-started/overview.md): Recommended integration path from preparing an API key to making the first model call.
- [Authentication](https://nusabase-a8dcf793.mintlify.app/en/getting-started/authentication.md): Authentication methods, compatibility headers, and common auth failures for public APIs.
- [First Request Example](https://nusabase-a8dcf793.mintlify.app/en/getting-started/first-request.md): Run a minimal working call from model listing to your first Chat Completions request.
- [Compatibility Formats](https://nusabase-a8dcf793.mintlify.app/en/getting-started/compatibility.md): Use the real Claude, Gemini, and provider-specific compatibility endpoints.
- [List Models](https://nusabase-a8dcf793.mintlify.app/api-reference/models/list-models.md): Retrieves the currently available model list. The response format is detected automatically from request headers: - Returns Anthropic format when `x-api-key` and `anthropic-version` headers are present - Returns Gemini format when the `x-goog-api-key` header or `key` query parameter is present - Ret…
- [Generate Gemini Content](https://nusabase-a8dcf793.mintlify.app/api-reference/models/generate-gemini-content.md): Returns available models in Gemini API format
- [Get Models](https://nusabase-a8dcf793.mintlify.app/api-reference/models/get-models.md): Get model details by model ID in OpenAI-compatible format.
- [List Openai Models](https://nusabase-a8dcf793.mintlify.app/api-reference/models/list-openai-models.md): Return model list in OpenAI-compatible format under the v1beta prefix.
- [Create Chat Completion](https://nusabase-a8dcf793.mintlify.app/api-reference/chat/create-chat-completion.md): Creates a model response from conversation history. Supports streaming and non-streaming responses. Compatible with the OpenAI Chat Completions API.
- [Create Completion](https://nusabase-a8dcf793.mintlify.app/api-reference/chat/create-completion.md): Create a text completion from a given prompt
- [Create Response](https://nusabase-a8dcf793.mintlify.app/api-reference/responses/create-response.md): OpenAI Responses API, used to create model responses. Supports multi-turn conversations, tool calls, and reasoning.
- [Compact Conversation](https://nusabase-a8dcf793.mintlify.app/api-reference/responses/compact-conversation.md): OpenAI Responses API, used to compact long conversations.
- [Create Tasks](https://nusabase-a8dcf793.mintlify.app/api-reference/images/create-tasks.md): Submit an asynchronous image generation task. Supports the OpenAI-compatible format (DALL-E) as well as each vendor's native format. Returns a task ID that can be used to query task status with the GET endpoint.
- [Edit Qwen Image](https://nusabase-a8dcf793.mintlify.app/api-reference/images/edit-qwen-image.md): Qwen image generation through Bailian
- [Get Images Generations](https://nusabase-a8dcf793.mintlify.app/api-reference/images/get-images-generations.md): Query the status of an asynchronous image generation task.
- [Create Edits](https://nusabase-a8dcf793.mintlify.app/api-reference/images/create-edits.md): Compatibility endpoint for image editing. Behavior is the same as /v1/images/edits.
- [Create Genbo Tasks](https://nusabase-a8dcf793.mintlify.app/api-reference/images/create-genbo-tasks.md): Submit a Genbo asynchronous image generation task.
- [Get Genbo Tasks Status](https://nusabase-a8dcf793.mintlify.app/api-reference/images/get-genbo-tasks-status.md): Query the status of a Genbo asynchronous image generation task.
- [Create Video](https://nusabase-a8dcf793.mintlify.app/api-reference/video/create-video.md): OpenAI Sora-compatible video generation API. Supports text-to-video and image-to-video (pass a reference image via the input_reference parameter). Reference: https://platform.openai.com/docs/api-reference/videos/create
- [Get Video Task Status](https://nusabase-a8dcf793.mintlify.app/api-reference/video/get-video-task-status.md): OpenAI-compatible video task status endpoint. Returns detailed video task status information.
- [Get Video Content](https://nusabase-a8dcf793.mintlify.app/api-reference/video/get-video-content.md): Gets the video file content for a completed video task. This endpoint proxies and returns the video file stream.
- [Create Video Generation Task](https://nusabase-a8dcf793.mintlify.app/api-reference/video/create-video-generation-task.md): submit a video generation task (General format). Supports multiple Models (Kling, Hailuo, Sora, etc.), selectable via the model parameter. Supports text-to-video (prompt parameter) and image-to-video (image parameter). Returns a task ID that can be used to query task status with the GET endpoint.
- [Get Video Generation Task Status](https://nusabase-a8dcf793.mintlify.app/api-reference/video/get-video-generation-task-status.md): Queries the status and result of a video generation task. Task status: - `queued`: queued - `in_progress`: in progress - `completed`: completed - `failed`: Failed
- [Create Videos Remix](https://nusabase-a8dcf793.mintlify.app/api-reference/video/create-videos-remix.md): Create a remix task based on an existing video task.
- [Create Kling Text-to-Video Task](https://nusabase-a8dcf793.mintlify.app/api-reference/video-kling/create-kling-text-to-video-task.md): Generates a video from a text prompt using a Kling model. Supported models: kling-v1, kling-v1-5, etc.
- [Get Kling Text-to-Video Task Status](https://nusabase-a8dcf793.mintlify.app/api-reference/video-kling/get-kling-text-to-video-task-status.md): Queries the status and result of a Kling text-to-video task.
- [Create Kling Image-to-Video Task](https://nusabase-a8dcf793.mintlify.app/api-reference/video-kling/create-kling-image-to-video-task.md): Generates a video from an image using a Kling model. Supports passing an image URL or Base64-encoded image data through the `image` parameter.
- [Get Kling Image-to-Video Task Status](https://nusabase-a8dcf793.mintlify.app/api-reference/video-kling/get-kling-image-to-video-task-status.md): Queries the status and result of a Kling image-to-video task.
- [Create Jimeng Video](https://nusabase-a8dcf793.mintlify.app/api-reference/video-jimeng/create-jimeng-video.md): Video generation endpoint using the official Jimeng API format. Use the Action parameter to specify the operation type: - `CVSync2AsyncSubmitTask`: submit a video generation task - `CVSync2AsyncGetResult`: get task result Action and Version must be specified as query parameters.
- [Create Claude Message](https://nusabase-a8dcf793.mintlify.app/api-reference/claude/create-claude-message.md): Request in the Anthropic Claude Messages API format. The `anthropic-version` header is required.
- [Create Gemini Embeddings](https://nusabase-a8dcf793.mintlify.app/api-reference/gemini/create-gemini-embeddings.md): Create embeddings using a specific engine/model
- [Gemini API (/v1)](https://nusabase-a8dcf793.mintlify.app/api-reference/gemini/gemini-api-v1.md): Gemini native API (accessed via the /v1 prefix). The path after /v1/models/ is passed through directly (e.g. gemini-2.0-flash:generateContent).
- [Gemini API ()](https://nusabase-a8dcf793.mintlify.app/api-reference/gemini/gemini-api-.md): Gemini native API. The path after /v1beta/models/ is passed through directly (e.g. gemini-2.0-flash:generateContent, gemini-2.0-flash:streamGenerateContent). Supports text generation and image generation (e.g. Nano Banana).
- [Create Embeddings](https://nusabase-a8dcf793.mintlify.app/api-reference/embeddings/create-embeddings.md): Convert text into vector embeddings
- [Create Audio Transcription](https://nusabase-a8dcf793.mintlify.app/api-reference/audio/create-audio-transcription.md): Converts audio to text
- [Create Audio Translation](https://nusabase-a8dcf793.mintlify.app/api-reference/audio/create-audio-translation.md): Translates audio to English text
- [Create Speech](https://nusabase-a8dcf793.mintlify.app/api-reference/audio/create-speech.md): Converts text to audio
- [Rerank Documents](https://nusabase-a8dcf793.mintlify.app/api-reference/rerank/rerank-documents.md): Reranks documents by relevance to the query
- [Create Moderation](https://nusabase-a8dcf793.mintlify.app/api-reference/moderations/create-moderation.md): Checks whether text content violates usage policies

## OpenAPI Specs

- [relay-api.mintlify](/en/openapi/relay-api.mintlify.json)


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