Skip to main content
POST
/
v1
/
complex-predictions
/
{complex_prediction_id}
/
cancel
Cancel a pending complex prediction
curl --request POST \
  --url https://api.example.com/v1/complex-predictions/{complex_prediction_id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "completed_at": "2026-04-23T14:42:10+00:00",
  "created_at": "2026-04-23T14:15:00+00:00",
  "credit_cost": 25,
  "id": "cccc3333-dddd-4444-eeee-555566667777",
  "inputs": {
    "antigen_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "variant_id": "11112222-3333-4444-5555-666677778888"
  },
  "object": "complex_prediction",
  "results": {
    "confidence_score": 0.82,
    "iptm": 0.71,
    "model_used": "boltz2",
    "pdb_url": "https://<project>.supabase.co/storage/v1/object/sign/structures/...?token=...",
    "pdb_url_expires_at": "2026-04-23T15:42:10+00:00"
  },
  "started_at": "2026-04-23T14:15:05+00:00",
  "status": "completed"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

complex_prediction_id
string<uuid>
required

Response

Successful Response

Complex prediction job envelope — pipeline status + typed result.

id
string
required

Opaque complex-prediction identifier (UUID).

Example:

"cccc3333-dddd-4444-eeee-555566667777"

status
enum<string>
required

Lifecycle state. pendingrunningcompleted | failed. canceled is terminal and only reachable via POST /v1/complex-predictions/{id}/cancel on a still-pending job.

Available options:
pending,
running,
completed,
failed,
canceled
Example:

"pending"

created_at
string
required

ISO-8601 timestamp (UTC) when the job was submitted.

Example:

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

credit_cost
integer
required

Credits debited at submission for this job type.

Example:

25

inputs
ComplexPredictionInputs · object
required

Echo of the caller's submit body.

object
string
default:complex_prediction

Polymorphic discriminator. Always complex_prediction.

Allowed value: "complex_prediction"
started_at
string | null

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

completed_at
string | null

ISO-8601 timestamp when the job completed successfully.

failed_at
string | null

ISO-8601 timestamp when the job failed. null unless status=failed.

canceled_at
string | null

ISO-8601 timestamp when the job was canceled. null unless status=canceled.

error
ComplexPredictionError · object

Populated only when status=failed. Same shape as problem+json.

results
ComplexPredictionResult · object

Complex-prediction output. null until status=completed.