Skip to main content
POST
/
v1
/
worlds:generate
Start a world generation operation
curl --request POST \
  --url https://api.mint.gg/v1/worlds:generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "prompt": "<string>",
  "derivedPrompt": "<string>",
  "generationMode": "auto",
  "generationPreset": "standard",
  "displayName": "<string>",
  "imageUrl": "<string>",
  "sourceImages": [
    "<string>"
  ],
  "sourceUrl": "<string>"
}
'
{
  "object": "<unknown>",
  "id": "<string>",
  "prompt": "<string>",
  "generationModel": "<string>",
  "resource": {
    "id": "<string>"
  },
  "mintUrl": "<string>",
  "assets": {
    "caption": "<string>",
    "colliderMeshUrl": "<string>",
    "panoUrl": "<string>",
    "previewImageUrl": "<string>",
    "radUrl": "<string>",
    "spzUrls": {},
    "thumbnailUrl": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "completedAt": "2023-11-07T05:31:56Z",
  "canceledAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mint.gg/llms.txt

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

Authorizations

Authorization
string
header
required

Mint API key sent as a Bearer token.

Headers

Idempotency-Key
string
required

Unique key for safely retrying a mutating API request. Reusing a key with different parameters returns 409.

Required string length: 1 - 255

Body

application/json
prompt
string
required

Developer-visible generation prompt.

Required string length: 1 - 4000
derivedPrompt
string

Optional Mint-ready prompt when the developer has already transformed user intent.

Required string length: 1 - 4000
generationMode
enum<string>
default:auto

auto continues the workflow without a manual approval pause when policy allows it; review preserves preview approval.

Available options:
auto,
review
generationPreset
enum<string>
default:standard

Mint generation tier. fast favors speed/cost, standard is the default balance, and production favors highest quality.

Available options:
fast,
standard,
production
displayName
string
Required string length: 1 - 120
imageUrl
string<uri>

Optional source image URL for image-guided world or model generation.

sourceImages
string<uri>[]

Optional multi-image source set for world generation. Model generation uses imageUrl.

Maximum array length: 8
sourceUrl
string<uri>

Optional source URL for remix or import context.

Response

Long-running generation operation accepted. Poll the Location URL for status.

object
any
required
id
string
required
type
enum<string>
required
Available options:
world_generation,
model_generation
generationMode
enum<string>
required
Available options:
auto,
review
status
enum<string>
required
Available options:
queued,
running,
preview_ready,
succeeded,
failed,
canceled
prompt
string | null
required

Original developer-visible prompt submitted with the generation request.

generationPreset
enum<string> | null
required

Mint generation tier selected for this operation.

Available options:
fast,
standard,
production,
null
generationModel
string | null
required

Resolved final generation model selected by the generationPreset.

resource
object
required
mintUrl
string<uri> | null
required

Mint app URL for the generated world or model when the operation has a resource.

assets
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
error
object
completedAt
string<date-time> | null
canceledAt
string<date-time> | null