Enums
This is an index of helpful enumerations when working with the Neural API.
There are several enums used in the Text to 3D and Image to 3D APIs.
TaskKind
Used to differentiate between a preview task operation and an optimize task operation. This is not used in the Image to 3D API, as all those tasks are of the optimized type.
- Name
preview- Description
A preview task, faster to generate but lower quality output.
- Name
optimize- Description
An optimized generation task, slower but higher quality output.
Typescript Type
type TaskKind = 'preview' | 'optimize';
TaskStatus
Describes the current status of the task, if it is being processed, or if it has finished.
- 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';