# Neural4D API Docs

> Neural4D API documentation in English and Chinese.

## v1

### Get started

- [Quickstart](https://docs.neural4d.com/en/v1-overview.md): Create a video generation task and retrieve its result.
- [Common headers](https://docs.neural4d.com/en/common-headers.md): Authentication and request tracing headers shared by API v1 endpoints.

### API reference

#### Files

- [Upload a file](https://docs.neural4d.com/en/v1-api-reference/files/upload-a-file.md): Uploads one local image, video, or audio file and returns a reusable file ID.

#### Image generation

- [Create image generation tasks](https://docs.neural4d.com/en/v1-api-reference/image-generation/create-image-generation-tasks.md): Creates asynchronous image generation tasks from a prompt and optional image references supplied by file ID or HTTPS URL.

#### Video generation

- [Create video generation tasks](https://docs.neural4d.com/en/v1-api-reference/video-generation/create-video-generation-tasks.md): Creates asynchronous video generation tasks from a prompt and optional frame or reference assets supplied by file ID or HTTPS URL.

#### Tasks

- [Retrieve a task](https://docs.neural4d.com/en/v1-api-reference/tasks/retrieve-a-task.md): Returns task status and output by batch task ID or child image or video UUID. Provide exactly one of the id or uuid query parameters.

## old

### Get started

- [Quickstart](https://docs.neural4d.com/en/quickstart.md): Call the Neural4D API with a Bearer token and follow the async result workflow.
- [Neural4D API docs](https://docs.neural4d.com/en/old-overview.md): Browse Neural4D management APIs for 3D generation, media generation, model conversion, and balance queries.

### API reference

#### Text to 3D

- [Generate model from text](https://docs.neural4d.com/en/api-reference/text-to-3d/generate-model-from-text.md): Generate 3D models from a text prompt. Supports model count, mesh quality, target face count, and mesh-only output. Existing defaults are preserved when the new options are omitted.

#### Model management

- [Retrieve model](https://docs.neural4d.com/en/api-reference/model-management/retrieve-model.md): Retrieve a generated model by UUID.
- [Convert model format](https://docs.neural4d.com/en/api-reference/model-management/convert-model-format.md): Convert a generated model into a target format and return the download URL. This operation consumes 10 points.
- [Query job progress](https://docs.neural4d.com/en/api-reference/model-management/query-job-progress.md): Query the current progress of a model generation job by UUID.

#### Image to 3D

- [Generate model with image](https://docs.neural4d.com/en/api-reference/image-to-3d/generate-model-with-image.md): Generate 3D models from one uploaded image. Supports model count, mesh quality, target face count, and mesh-only output. Existing defaults are preserved when the new options are omitted.
- [Generate chibi-style model with image](https://docs.neural4d.com/en/api-reference/image-to-3d/generate-chibi-style-model-with-image.md): Generate chibi-style 3D character models from uploaded images and a configured style tag. This operation consumes 30 points. The style tag must be configured in advance.

#### Picture and video generation

- [Generate picture](https://docs.neural4d.com/en/api-reference/media-generation/generate-picture.md): Generate images from a text prompt with optional reference images. You can upload up to 6 reference images and submit 1 to 4 generation jobs in a single request.
- [Generate video](https://docs.neural4d.com/en/api-reference/media-generation/generate-video.md): Generate videos from a text prompt with optional reference images. You can upload 0 to 6 reference images and submit 1 to 4 generation jobs in a single request.
- [Retrieve generation result](https://docs.neural4d.com/en/api-reference/media-generation/retrieve-generation-result.md): Query the generation result by UUID. This is a query-only operation and does not consume points.

#### Account and validation

- [Detect portrait image](https://docs.neural4d.com/en/api-reference/account-and-validation/detect-portrait-image.md): Check whether an uploaded image contains a human portrait.
- [Query remaining balance](https://docs.neural4d.com/en/api-reference/account-and-validation/query-remaining-balance.md): Query the remaining points balance available for later operations.

## OpenAPI Specs

- [openapi](/backups/v1-full-20260721/openapi.json)
- [openapi.zh](/backups/v1-full-20260721/openapi.zh.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Chinese (19 pages)](https://docs.neural4d.com/_llms/zh.md): Documentation for Chinese.


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