Skip to main content
POST
/
v1
/
jobs
Submit a pipeline job
curl --request POST \
  --url https://api.example.com/v1/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "job_type": "humanization",
  "variant_id": "11112222-3333-4444-5555-666677778888"
}
'
{
  "created_at": "2026-04-21T14:15:00+00:00",
  "id": "dddd1111-eeee-2222-ffff-333344445555",
  "job_type": "humanization",
  "status": "pending",
  "variant_id": "11112222-3333-4444-5555-666677778888"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Body for POST /v1/jobs.

​
variant_id
string
required

UUID of the variant to run the job against. Must belong to the caller's org.

Example:

"11112222-3333-4444-5555-666677778888"

​
job_type
string
required

Pipeline to run. One of: humanization, structure, stability, immunogenicity. Complex prediction and codon export are not exposed on this endpoint — they ship with Phase 3 resource-per-job-type endpoints.

Example:

"humanization"

Response

Successful Response

A pipeline job's status envelope.

​
id
string
required

Opaque job identifier (UUID).

Example:

"dddd1111-eeee-2222-ffff-333344445555"

​
variant_id
string
required

Variant this job is running against.

Example:

"11112222-3333-4444-5555-666677778888"

​
job_type
string
required

One of: humanization, structure, stability, immunogenicity.

Example:

"humanization"

​
status
string
required

One of: pending, running, completed, failed.

Example:

"pending"

​
created_at
string
required

ISO-8601 timestamp when the job was submitted.

Example:

"2026-04-21T14:15:00+00:00"

​
started_at
string | null

ISO-8601 timestamp when execution started. null while pending.

Example:

"2026-04-21T14:15:02+00:00"

​
completed_at
string | null

ISO-8601 timestamp when execution finished. null until completed or failed.

Example:

null

​
error_message
string | null

Human-readable failure reason. Populated only when status=failed.

Example:

null