Skip to main content
POST
Launch a job

Headers

x-project-id
string
required

Project ID to specify the project context

Path Parameters

projectId
string<uuid>
required

Body

application/json
models
string[]
required

Models that answer every selected query, by id or rolling alias

Example:
executionCount
integer
required

How many times each query runs on each model

Required range: 1 <= x <= 100
Example:

3

selection
object

Absent: every query of the project

force
boolean

Launch even if a job started in the last 10 minutes

Example:

true

Response

The job. The body is empty when the selection, or the project, holds no query: nothing runs and nothing is charged.

id
string<uuid>
required

Id of the job, used to poll it and to list its executions

status
enum<string>
required

Where the job stands. syncing: every execution is over and the results are not all readable yet

Available options:
pending,
processing,
syncing,
completed,
failed,
partial_failed
createdBy
object | null
required

Who launched the job; null for a scheduled job or an API key

scheduleId
string<uuid> | null
required

The schedule that launched the job; null for a manual launch or a deleted schedule

spentCredits
integer | null
required

Credits charged at launch, before any refund; null when not recorded

totalExecutionCount
integer
required

Executions the job holds: one per query, model and repeat

pendingExecutionCount
integer
required

Executions with no answer yet

retryingExecutionCount
integer
required

Executions that failed an attempt and wait for another

succeededExecutionCount
integer
required

Executions that came back with an answer

failedExecutionCount
integer
required

Executions that gave up, their attempts spent

themeAnalysis
enum<string> | null
required

Where the theme analysis of the job's answers stands; null when the project runs none

Available options:
pending,
processing,
done
Example:

"done"

createdAt
string<date-time>
required

When the job was launched

updatedAt
string<date-time>
required

When a counter or the status last moved; a poller watches this