Docs

Running a model

Tripo AIText to 3D

Tripo AI 3D v3.1

High-fidelity 3D asset generation with enhanced geometry and texture precision

POSTauray-serverless/tripo/v3-1-0
openapi.jsonllms.txt

One of Auray's catalogue models: the same key, the same credits, the same job lifecycle as every other address.

Its request shape is published below. Whether it runs right now is GET /v1/catalogue's word, with no key needed: its addresses say connected for an address that runs, and a submit to any other is refused before anything is charged — described answers 501 model_not_connected, paused 503 model_disabled.

Category text-to-3d · Scope 3d:write (or external:write on an older key) · Price Credits per call: 33.3334 for settings.pbr=false, settings.texture=false; 42 for settings.pbr=false, settings.texture=true; settings.pbr=true, settings.texture=false; settings.pbr=true, settings.texture=true. Quoted when you submit, at the most the request can cost; the charge settles to what the job cost and never above the quote. The submit's answer carries the quote as credits_quoted, and credits_charged says what has been taken.

#Input

FieldTypeRequiredDefaultDescription
outputFormatstringno"GLB"Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities. - `JPG`: Best for photorealistic images with smaller file sizes (no transparency). - `PNG`: Lossless compression, supports high quality and transparency (alpha channel). - `WEBP`: Modern format providing superior compression and transparency support. - `MP4`: Widely supported video container (H.264), recommended for general use. - `WEBM`: Optimized for web delivery. - `MOV`: QuickTime format, common in professional workflows (Apple ecosystem). - `GIF`: Animated image format (no audio), suitable for short loops or previews. - `MP3`: Compressed audio, smaller file size. - `WAV`: Uncompressed, high-quality audio. - `FLAC`: Lossless compression. - `OGG`: Open-source compressed audio format (Vorbis codec). - `SVG`: Scalable Vector Graphics. - `TIFF`: High-quality output supporting layers. - `GLB`: Binary glTF format for 3D models, including geometry, textures, and PBR materials. > [!NOTE] > **Transparency**: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., `PNG`, `WEBP`, `TIFF`). `JPG` does not support transparency. One of "GLB", "FBX".
inputsobjectno—
inputs.imagesstring[]no—Image inputs for image-to-3D or multiview-to-3D generation (an http(s) URL; upload a local file first and send its read URL). Documented range: 1 to 4.
positivePromptstringno—Text prompt describing elements to include in the generated output. Documented range: up to 1,024 characters.
negativePromptstringno—Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1). Documented range: up to 255 characters.
seedintegerno—Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range. Documented range: 1 to 20,240,919.
settingsobjectno—
settings.autoSizebooleanno—Scales the model to real-world dimensions in meters.
settings.compressstringno"meshopt"Compression method for the output mesh. One of "geometry", "meshopt".
settings.exportUvbooleannotrueEnables UV unwrapping on the output mesh.
settings.faceLimitintegerno—Maximum number of faces (polygons) in the output mesh. If not set, determined adaptively. Range depends on mode: 1000–20000 for low-poly, 500–10000 for quad. Documented range: 500 to 20,000.
settings.generatePartsbooleanno—Generates segmented 3D models with individually editable parts.
settings.geometryQualitystringno"standard"Controls the geometric detail level of the output mesh. One of "standard", "detailed".
settings.imageAutoFixbooleanno—Optimizes the input image for better 3D generation results.
settings.orientationstringno"default"Controls model orientation. One of "default", "align_image".
settings.pbrbooleannotrueEnables physically-based rendering materials.
settings.quadbooleanno—Enables quad mesh output.
settings.smartLowPolybooleanno—Generates low-poly meshes optimized for simple inputs. May fail on complex models.
settings.texturebooleannotrueEnables texturing on the generated model. Set to false for a base model without textures.
settings.textureAlignmentstringno—Controls texture alignment priority. One of "original_image", "geometry".
settings.textureQualitystringno"standard"Resolution quality for generated textures. One of "standard", "detailed".
settings.textureSeedintegerno—Seed for texture generation reproducibility. Documented range: 0 to 20,240,919.
outputTypestringno"URL"3D output type. One of "URL".
idempotency_keystringno—Your own name for this request. Send the same one twice and the second call is answered with the first request rather than charged again. Idempotency-Key: as a header is accepted as an alias — that is the spelling a retrying proxy replays, and the one to use when running a model on auray.run, where a request that outlives its connection is answered 504 and recovered by replay. Omit it and the platform mints one. 1 to 64 characters.

#Rules

Across fields, as the model's documentation states them. Each is judged before anything is charged — warned with a Deprecation header until enforcement starts — and listed as JSON Schema under x-auray-rules in the openapi.json.

  • Do not send negativePrompt together with inputs.images.
  • When settings.generateParts is true, do not send a request where settings.texture is true, or where settings.pbr is true, or where settings.quad is true.
  • When settings.pbr is true, settings.texture must be true.
  • When settings.imageAutoFix is sent, inputs.images is required.
  • When settings.orientation is "align_image", inputs.images is required.
  • When settings.quad is true, outputFormat must be "FBX". Otherwise, outputFormat must be "GLB".
  • Send exactly one of positivePrompt or inputs.images.

#Example

curl -X POST https://queue.auray.run/auray-serverless/tripo/v3-1-0 \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left"
}'

The same body on https://auray.run runs synchronously and answers the result — unless it usually takes longer than a run may hold its connection, which is refused 400 model_not_synchronous before anything is charged. Options — ?webhook=, ?wait=, priority and timeout headers — are on Submit a request.

#Machine contracts

  • openapi.json — this page as an OpenAPI 3.1 document, public.
  • llms.txt — the same, written for an agent.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close