API reference

API reference · API

Make a 3D model as a job

POST/v1/meshesAPI key

Validated, priced at exactly the options sent and held at that worst case with the margin, then submitted to the cheapest provider for those options (fal, Replicate, or the model's maker bought direct); answers the queued job at once. Paid from a balance, never the free allowance. Stopped past 30 minutes. Models: tencent/hunyuan3d-v3, tencent/hunyuan3d-2, microsoft/trellis. A 404 while the media jobs are off.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
modelrequiredstringA model this door serves; /videos, /sounds and /meshes list them, and GET /v1/stills names the stills. At most 200 characters.
promptstringWhat to make. Optional only for a 3D model made from image_url. At most 20000 characters.
secondsnumber or stringThe length asked for, a number or a numeric string as OpenAI sends it.
sizestringVideos only: WIDTHxHEIGHT, read as a resolution and an aspect ratio.
resolutionstringAt most 10 characters.
aspect_ratiostringAt most 8 characters.
audiobooleanWhether a video model that can make sound does; its own default unless set.
image_urlstringAn https picture a 3D model starts from. Sent, never kept.
reference_imagesarray of stringPictures a model keeps a subject from, or a still is made from, as many as the model takes. Sent, never kept.
end_image_urlstringThe last frame, for a model that starts from a picture and takes one. Sent, never kept.
lyricsstringThe words a model that sings is given. At most 3000 characters.
negative_promptstringAt most 2000 characters.
seedintegerFrom 0 to 2147483647.

Example

{
  "model": "antimatter/auto",
  "prompt": "Say hello in five words."
}

Answer 200

The job, queued.

Headers: x-antimatter-hold-micros

Fields of the 200 answer
FieldTypeWhat it is
idrequiredstringvideo_, sound_, mesh_ or still_ then 24 hex digits.
objectrequiredstringOne of "video", "sound", "mesh", "still".
modelrequiredstring
statusrequiredstringOne of "queued", "in_progress", "completed", "failed", "cancelled".
progressinteger0 until completed, then 100.
created_atrequiredinteger
completed_atinteger or null
expires_atinteger or nullWhen the file stops being fetchable: 60 minutes after completion.
promptstring or null
secondsstring
sizestring
resolutionstring
aspect_ratiostring
audioboolean
reference_countintegerHow many reference pictures it was sent; the pictures are not kept.
content_typestring or null
hold_microsrequiredintegerThe worst case held while it runs.
cost_microsinteger or nullWhat it was billed, never past the hold.
cancel_requestedboolean
errorobject or nullgeneration_failed, deadline_exceeded, provider_unanswered (billed its hold), submit_lost or model_unavailable.
error.codestring
error.messagestring

Errors

  • 400OpenAI shaped error.
  • 402OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 429OpenAI shaped error.
  • 502OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter