Skip to navigation
API Reference

Generate protein designs

View as Markdown

Authentication

AuthorizationBearer

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

Headers

X-Include-Runtime-MetricsbooleanOptionalDefaults to false

When true, each design carries a per-stage timing breakdown in runtime_metrics: pre-process / model forward / post-process / metrics / total. Off by default. The stages are measured either way, so turning this on does not change the latency it reports. Same header name and same key names as the OpenFold2 and OpenFold3 NIMs, so one benchmark client reads all three.

Request

This endpoint expects an object.
taskenumRequired
Which design task to run. Selects the sampler path and the validation rules.
inputobjectRequired
Input specification in one of the three supported dialects.
samplingobjectOptional
Rollout controls.
partialobject or nullOptional

Start times, required by partial_diffusion and rejected for every other task.

searchobject or nullOptional

Reward-guided search. Absent means plain sampling.

metricsobjectOptional
Metric families to report.
outputobjectOptional
Response content controls.

Response

Successful Response
request_idstring

Server-assigned id, also logged on every line for this request.

taskenum
Task that ran.
modelobject
Weights and device that produced the designs.
runtimeobject
Software stack and acceleration settings that ran them.
scheduleobject
Sampler configuration actually integrated.
designslist of objects

Generated designs. Equals num_replicates for plain sampling. Under search it can be larger (kept intermediates) or smaller (pruned branches), so read the count, do not assume it.

duration_msdouble
Wall time for the whole request.
searchobject or nullOptional
Search behaviour, when a search block was sent.
aggregated_metricslist of objectsOptional

Per-design metrics reduced across the request. Empty when no metrics were requested. Rows whose key ends in ‘.pass’ carry the in-silico success rate.

warningslist of stringsOptional

Non-fatal conditions: designs dropped by a filter, requested metrics that did not apply.

Errors

400
Bad Request Error
413
Content Too Large Error
422
Unprocessable Entity Error
499
Client Closed Request Error
500
Internal Server Error
503
Service Unavailable Error
504
Gateway Timeout Error