Skip to main content
POST
Submit a queued job

Authorizations

Authorization
string
header
default:default
required

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

Body

application/json

Job request

Request to submit a job to the queue.

model
string
required

Required model identifier

Example:

"my-queue-model"

payload
object
required

Freeform model input. Passed unchanged to the model. Contents are model-specific.

info
object

Arbitrary JSON metadata stored with the job. Returned in status responses, where the model and system may have added or modified keys (e.g. progress).

priority
integer
default:0

Job priority. Higher values are processed first (strict priority ordering). Jobs with equal priority are processed in submission order (FIFO).

Response

Successfully queued request

Response returned after queueing a job.

requestId
string
required

Unique identifier for the submitted job. Use this to poll status or cancel.