Skip to main content
POST
/
v1
/
three-d
Generate a 3D model (async)
curl --request POST \
  --url https://api.rimp.io/v1/three-d \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "prompt": "<string>",
  "image_url": "<string>",
  "rigged": true,
  "seed": 123
}
'
{
  "id": "<string>",
  "prompt": "<string>",
  "params": {},
  "reserved_credits": 123,
  "charged_credits": 123,
  "refunded_credits": 123,
  "cache_hit": true,
  "outputs": [
    {
      "id": "<string>",
      "mime": "<string>",
      "width": 123,
      "height": 123,
      "duration_s": "<string>",
      "url": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://rimp.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
model
string
required
prompt
string
required
Maximum string length: 4000
image_url
string<uri>
texture_size
enum<string>
Available options:
1024,
2048,
4096
mesh_complexity
enum<string>
Available options:
low,
medium,
high
rigged
boolean
seed
integer

Response

202 - application/json

3D generation queued. Poll /v1/generations/{id} or subscribe via webhook.

id
string
object
enum<string>
Available options:
generation
status
enum<string>
Available options:
queued,
running,
succeeded,
failed,
canceled
modality
enum<string>
Available options:
image,
video,
voice,
music,
avatar,
chat,
3d,
upscale
prompt
string
params
object
reserved_credits
integer
charged_credits
integer
refunded_credits
integer
cache_hit
boolean
outputs
object[]