Enums

Documentation for enums used in the Neural API.

Task Status

These are the possible values for the Task resource status property.

Name
queued
Description
The task will begin processing soon.
Name
in_progress
Description
The task is being processed now.
Name
succeeded
Description
The generation is completed and you can access the output assets.
Name
failed
Description
Something went wrong on our end, or your task has been rejected for some reason. If this happens consistently, please contact support.

Typescript Type

type TaskStatus = 'queued' | 'in_progress' | 'failed' | 'succeeded';

Task Type

The possible values for the type property of the Task resource. The keys present in the output property object will differ based on this type.

Typescript Type

type TaskType =
  | 'inpainting'
  | 'text-to-image'
  | 'premium-text-to-3d'
  | 'subnet-text-to-3d'
  | 'comfy-text-to-3d'
  | 'premium-image-to-3d'
  | 'comfy-image-to-3d'
  | 'fast-image-to-3d'
  | 'terrain-heightmap'
  | 'terrain-map'
  | 'material-generation'
  | 'autorig'
  | 'sketch-to-image'
  | 'text-to-skybox'
  | 'skybox-cube'
  | 'flux-kontext'
  | 'comfy-parts-crafter'
  | 'unirig'
  | 'seamless'

Asset Type

The type of the asset.

Name
model
Description
A model asset.
Name
image
Description
An image asset.
Name
terrain
Description
A terrain asset.
Name
character
Description
A rigged character asset. Characters without rigging are tagged as model.

Typescript Type

type AssetDataType = "model" | "image" | "terrain" | "character"

Image Ratio

The aspect ratio of the output image used in Text to Image tasks. Must be one of the enum values.

Name
1:1 square 1024x1024
Description
1:1 square 1024x1024
Name
3:4 portrait 896x1152
Description
3:4 portrait 896x1152
Name
9:16 portrait 768x1344
Description
9:16 portrait 768x1344
Name
4:3 landscape 1152x896
Description
4:3 landscape 1152x896
Name
3:2 landscape 1216x832
Description
3:2 landscape 1216x832
Name
16:9 landscape 1344x768
Description
16:9 landscape 1344x768

Typescript Type

type TextToImageRatio =
  | '1:1 square 1024x1024'
  | '3:4 portrait 896x1152'
  | '9:16 portrait 768x1344'
  | '4:3 landscape 1152x896'
  | '3:2 landscape 1216x832'
  | '16:9 landscape 1344x768'