3D from text

curl --request POST \
  --url https://api.sigmora.org/v1/3d/from-text \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "prj_9x2a4c",
  "prompt": "A matte black ceramic pour-over coffee dripper with a walnut wood collar.",
  "preset": "turntable",
  "durationSeconds": 6,
  "background": "studio"
}
'

import requests

url = "https://api.sigmora.org/v1/3d/from-text"

payload = {
    "projectId": "prj_9x2a4c",
    "prompt": "A matte black ceramic pour-over coffee dripper with a walnut wood collar.",
    "preset": "turntable",
    "durationSeconds": 6,
    "background": "studio"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: 'prj_9x2a4c',
    prompt: 'A matte black ceramic pour-over coffee dripper with a walnut wood collar.',
    preset: 'turntable',
    durationSeconds: 6,
    background: 'studio'
  })
};

fetch('https://api.sigmora.org/v1/3d/from-text', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "credits": 300,
  "jobId": "job_4k1b7d",
  "status": "queued",
  "projectId": "prj_9x2a4c",
  "creditBalance": 3900
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

POST

from-text

3D from text

curl --request POST \
  --url https://api.sigmora.org/v1/3d/from-text \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "prj_9x2a4c",
  "prompt": "A matte black ceramic pour-over coffee dripper with a walnut wood collar.",
  "preset": "turntable",
  "durationSeconds": 6,
  "background": "studio"
}
'

import requests

url = "https://api.sigmora.org/v1/3d/from-text"

payload = {
    "projectId": "prj_9x2a4c",
    "prompt": "A matte black ceramic pour-over coffee dripper with a walnut wood collar.",
    "preset": "turntable",
    "durationSeconds": 6,
    "background": "studio"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: 'prj_9x2a4c',
    prompt: 'A matte black ceramic pour-over coffee dripper with a walnut wood collar.',
    preset: 'turntable',
    durationSeconds: 6,
    background: 'studio'
  })
};

fetch('https://api.sigmora.org/v1/3d/from-text', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "credits": 300,
  "jobId": "job_4k1b7d",
  "status": "queued",
  "projectId": "prj_9x2a4c",
  "creditBalance": 3900
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

A workspace API key.

Headers

idempotency-key

string

Stable retry key for this logical paid call. Reuse it after a timeout to receive the original result without duplicate work or spend.

Required string length: 1 - 255

x-sigmora-quote-only

string

Send 1 to get the price, balance and budget verdict without running anything.

Allowed value: "1"

x-sigmora-max-credits

string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

Body

application/json

Option 1
Option 2

prompt

string

required

Describe the object, materials, colors, and important details to model and animate.

Required string length: 1 - 2000

callbackUrl

string<uri>

required

An HTTPS URL to POST the terminal job event to. Requires callbackSecret; omit both fields and poll GET /v1/jobs/{jobId} instead.

callbackSecret

string

required

Your secret for verifying X-Sigmora-Signature on callbackUrl deliveries (32 to 512 characters). Required with callbackUrl, never echoed, and never sent to the renderer.

Required string length: 32 - 512

projectId

string

required

The existing project to file this work under. Create it with POST /v1/projects, then reuse its id across related calls. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

preset

enum<string>

Camera/motion preset. Accepted values are listed below; omit to use the service default.

Available options:

turntable,

orbit,

dolly_in,

float_bob,

beauty

durationSeconds

number

Animation length in seconds. 1 to 30.

Required range: 1 <= x <= 30

fps

integer

Frames per second. 8 to 60.

Required range: 8 <= x <= 60

width

integer

Output width in pixels. 128 to 3,840.

Required range: 128 <= x <= 3840

height

integer

Output height in pixels. 128 to 2,160.

Required range: 128 <= x <= 2160

background

enum<string>

Background treatment. Accepted values are listed below.

Available options:

studio,

dark,

white,

gradient

Response

Success.

Option 1
Option 2

success

boolean

required

credits

number

required

What this call actually cost, which is not always what was quoted.

Example:

300

jobId

string

required

Poll GET /v1/jobs/{jobId}. When that job reports status: "done", the finished file is job.artifacts.download. Video renders expose an origin URL; private 3D artifacts expose an authenticated API handoff that redirects to a short-lived origin URL.

Example:

"job_4k1b7d"

status

string

required

Acceptance, not completion. The work has not started when this returns.

Allowed value: "queued"

projectId

string

The existing project this work was filed under. It matches the projectId supplied by the caller after workspace ownership was verified.

Example:

"prj_9x2a4c"

creditBalance

number

Your balance after the charge. Absent when billing is disabled for the workspace.

Example:

3900

{key}

any

Meta

Projects

Sessions

Assets

Jobs

Text

Video

UGC

Editing

3D

Image

Audio

Publishing

Webhooks

Workflows

Agents

Research

Themes

Signals

Discovery

Watchlist

Performance

Autopilot

Campaigns

Brands

Products

3D from text

Authorizations

Headers

Body

Response