Skip to main content
POST
/
v1
/
structure-predictions
Submit a structure prediction job
curl --request POST \
  --url https://api.example.com/v1/structure-predictions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variant_id": "11112222-3333-4444-5555-666677778888"
}
'
{
  "completed_at": "2026-04-22T14:16:10+00:00",
  "created_at": "2026-04-22T14:15:00+00:00",
  "credit_cost": 2,
  "id": "aaaa1111-bbbb-2222-cccc-333344445555",
  "inputs": {
    "variant_id": "11112222-3333-4444-5555-666677778888"
  },
  "object": "structure_prediction",
  "results": {
    "confidence_score": 0.87,
    "model_used": "ABodyBuilder2",
    "pdb_url": "https://<project>.supabase.co/storage/v1/object/sign/structures/...?token=...",
    "pdb_url_expires_at": "2026-04-22T15:16:10+00:00"
  },
  "started_at": "2026-04-22T14:15:02+00:00",
  "status": "completed"
}

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/structure-predictions.

​
variant_id
string
required

UUID of the variant to predict a structure for. Must belong to the caller's org. scFv and Fc-fusion constructs are not supported — those return status=failed from the executor.

Example:

"11112222-3333-4444-5555-666677778888"

Response

Successful Response

Structure prediction job envelope — pipeline status + typed result.

​
id
string
required

Opaque structure-prediction identifier (UUID).

Example:

"aaaa1111-bbbb-2222-cccc-333344445555"

​
status
enum<string>
required

Lifecycle state. pending → running → completed | failed. canceled is terminal and only reachable via POST /v1/structure-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-22T14:15:00+00:00"

​
credit_cost
integer
required

Credits debited at submission for this job type.

Example:

2

​
inputs
StructurePredictionInputs · object
required

Echo of the caller's submit body.

​
object
string
default:structure_prediction

Polymorphic discriminator. Always structure_prediction.

Allowed value: "structure_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
StructurePredictionError · object

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

​
results
StructurePredictionResult · object

Structure-prediction output. null until status=completed.