Quickstart - Neural4D API Docs

This page covers the minimum request flow. You submit a create request, keep the returned uuid, and then query the result or download the generated asset.

Prerequisites

You already have a valid Bearer token from the Neural4D website.
You can send HTTP requests with curl, Postman, or your own client.
For upload endpoints, you already have image files that meet the documented limits.

Request flow

Set the auth header

Every endpoint uses Authorization: Bearer <token>.

curl --header "Authorization: Bearer YOUR_TOKEN"

Submit a create request

Start with a simple create endpoint such as POST /api/generateModelWithText.

curl --location 'https://alb.neural4d.com:3000/api/generateModelWithText' \
  --header 'Content-Type: application/json;charset=utf-8' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data '{
    "prompt": "a cute bird",
    "modelCount": 1,
    "disablePbr": 1
  }'

Store the uuid

Create endpoints usually return uuid or uuids. Keep them for later result queries and downloads.

Query the result or progress

For 3D model tasks, call POST /api/retrieveModel. For picture or video tasks, call POST /api/queryGenerationResult. You can also call POST /api/queryJobProgress for progress polling.

Download or convert the asset

After the model is ready, download it from modelUrl. If you need fbx, obj, stl, blend, or usdz, call POST /api/convertToFormat.

Upload limits

Upload endpoints support JPG, JPEG, PNG, and WEBP
Recommended resolution range: 256x256 to 6048x8064
Recommended file size: under 10 MB
Picture and video generation endpoints accept up to 6 reference images

​Prerequisites

​Request flow

​Upload limits

Prerequisites

Request flow

Upload limits