API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Share Links

Share read-only access to predictions and pipeline runs by issuing time-limited links that visitors can open without an API key or, for email-restricted links, after signing in with an allowed email. A share link is scoped to a single workspace and bundles one or more predictions and pipeline runs. The link ID is itself the bearer credential; treat it as a secret. Create, retrieve, and archive require a workspace-scoped API key with read permission on every referenced resource. Retrieving metadata remains available after expiry or archive. Viewing content and listing shared pipeline results are gated by the link ID and the link’s access mode. Archiving a link revokes public access immediately; subsequent content reads return 404. The underlying predictions and pipelines are unaffected and remain accessible through their own authenticated endpoints.

Create a share link

share_links.create(ShareLinkCreateParams**kwargs) -> ShareLinkCreateResponse

POST/compute/v1/share-links

Retrieve a share link

share_links.retrieve(strid) -> ShareLinkRetrieveResponse

GET/compute/v1/share-links/{id}

Archive a share link

share_links.archive(strid) -> ShareLinkArchiveResponse

POST/compute/v1/share-links/{id}/archive

List pipeline results from a share link

share_links.list_pipeline_results(strpipeline_id, ShareLinkListPipelineResultsParams**kwargs) -> SyncCursorPage[ShareLinkListPipelineResultsResponse]

GET/compute/v1/share/{id}/pipelines/{pipelineId}/results

ModelsExpand Collapse

class ShareLinkCreateResponse: …

id: str

Share link ID. This value is the bearer credential used to access the linked resources — treat it as a secret.

access_parameters: AccessParameters

Access-control parameters for the share link. Discriminated by access_mode: public requires no other fields; email requires a non-empty allowed_emails list.

One of the following:

class AccessParametersPublicShareLinkAccessParameters: …

Public access: anyone holding the share link ID can read.

access_mode: Literal["public"]

class AccessParametersEmailShareLinkAccessParameters: …

Email-restricted access: only the addresses in allowed_emails can read the link.

access_mode: Literal["email"]

allowed_emails: List[str]

Email addresses allowed to read the link. Must contain at least one address; up to 100 entries.

archived_at: Optional[datetime]

When the share link was archived, or null if it has never been archived.

formatdate-time

created_at: datetime

When the share link was created.

formatdate-time

expires_at: datetime

When the share link stops granting access.

formatdate-time

pipeline_ids: List[str]

Pipelines exposed by this share link.

prediction_ids: List[str]

Predictions exposed by this share link.

workspace_id: str

Workspace that owns the share link and the referenced resources.

url: Optional[str]

Visitable share link URL for the deployment’s public app. Present when the deployment has a configured app host; otherwise construct as <your-app-host>/share/{id}. Treat as a secret — the {id} segment is the bearer credential.

formaturi

class ShareLinkRetrieveResponse: …

id: str

Share link ID. This value is the bearer credential used to access the linked resources — treat it as a secret.

access_parameters: AccessParameters

Access-control parameters for the share link. Discriminated by access_mode: public requires no other fields; email requires a non-empty allowed_emails list.

One of the following:

class AccessParametersPublicShareLinkAccessParameters: …

Public access: anyone holding the share link ID can read.

access_mode: Literal["public"]

class AccessParametersEmailShareLinkAccessParameters: …

Email-restricted access: only the addresses in allowed_emails can read the link.

access_mode: Literal["email"]

allowed_emails: List[str]

Email addresses allowed to read the link. Must contain at least one address; up to 100 entries.

archived_at: Optional[datetime]

When the share link was archived, or null if it has never been archived.

formatdate-time

created_at: datetime

When the share link was created.

formatdate-time

expires_at: datetime

When the share link stops granting access.

formatdate-time

pipeline_ids: List[str]

Pipelines exposed by this share link.

prediction_ids: List[str]

Predictions exposed by this share link.

workspace_id: str

Workspace that owns the share link and the referenced resources.

url: Optional[str]

Visitable share link URL for the deployment’s public app. Present when the deployment has a configured app host; otherwise construct as <your-app-host>/share/{id}. Treat as a secret — the {id} segment is the bearer credential.

formaturi

class ShareLinkArchiveResponse: …

id: str

archived: Literal[true]

archived_at: datetime

When the share link was first archived.

formatdate-time

class ShareLinkListPipelineResultsResponse: …

A single generated protein design

id: str

Unique result ID.

artifacts: Artifacts

archive: ArtifactsArchive

url: str

URL to download the file

formaturi

url_expires_at: datetime

When the presigned URL expires

formatdate-time

structure: Optional[ArtifactsStructure]

url: str

URL to download the file

formaturi

url_expires_at: datetime

When the presigned URL expires

formatdate-time

created_at: datetime

formatdate-time

entities: List[Entity]

Entities in the designed complex, including designed and fixed input entities.

One of the following:

class EntityProteinEntity: …

chain_ids: List[str]

Chain IDs for this entity

type: Literal["protein"]

value: str

Amino acid sequence (one-letter codes)

cyclic: Optional[bool]

Whether the sequence is cyclic

modifications: Optional[List[EntityProteinEntityModification]]

CCD post-translational modifications. Optional; defaults to an empty list when omitted. SMILES modifications are not supported.

residue_index: int

0-based index of the residue to modify

minimum0

type: Literal["ccd"]

Modification format. Only CCD polymer modifications are supported.

value: str

CCD code from RCSB PDB (e.g. ‘MSE’ for selenomethionine, ‘SEP’ for phosphoserine)

class EntityRnaEntity: …

chain_ids: List[str]

Chain IDs for this entity

type: Literal["rna"]

value: str

RNA nucleotide sequence (A, C, G, U, N)

cyclic: Optional[bool]

Whether the sequence is cyclic

modifications: Optional[List[EntityRnaEntityModification]]

CCD chemical modifications. Optional; defaults to an empty list when omitted. SMILES modifications are not supported.

residue_index: int

0-based index of the residue to modify

minimum0

type: Literal["ccd"]

Modification format. Only CCD polymer modifications are supported.

value: str

CCD code from RCSB PDB (e.g. ‘MSE’ for selenomethionine, ‘SEP’ for phosphoserine)

class EntityDnaEntity: …

chain_ids: List[str]

Chain IDs for this entity

type: Literal["dna"]

value: str

DNA nucleotide sequence (A, C, G, T, N)

cyclic: Optional[bool]

Whether the sequence is cyclic

modifications: Optional[List[EntityDnaEntityModification]]

CCD chemical modifications. Optional; defaults to an empty list when omitted. SMILES modifications are not supported.

residue_index: int

0-based index of the residue to modify

minimum0

type: Literal["ccd"]

Modification format. Only CCD polymer modifications are supported.

value: str

CCD code from RCSB PDB (e.g. ‘MSE’ for selenomethionine, ‘SEP’ for phosphoserine)

class EntityLigandCcdEntity: …

chain_ids: List[str]

Chain IDs for this ligand

type: Literal["ligand_ccd"]

value: str

CCD code (e.g., ATP, ADP)

class EntityLigandSmilesEntity: …

chain_ids: List[str]

Chain IDs for this ligand

type: Literal["ligand_smiles"]

value: str

SMILES string representing the ligand

metrics: Metrics

Structural and binding quality metrics for a designed protein binder

binding_confidence: float

Confidence that the designed binder binds the target (0-1). Primary metric for hit discovery.

helix_fraction: float

Fraction of the designed sequence forming alpha helices (0-1).

minimum0

maximum1

iptm: float

Interface predicted TM score (0-1). Confidence in the protein-protein interface.

loop_fraction: float

Fraction of the designed sequence in coil/loop regions (0-1).

minimum0

maximum1

min_interaction_pae: float

Minimum predicted aligned error at the interface (Angstroms). Lower values indicate higher confidence.

sheet_fraction: float

Fraction of the designed sequence forming beta sheets (0-1).

minimum0

maximum1

structure_confidence: float

Confidence in the predicted 3D structure (0-1).

warnings: Optional[List[Warning]]

Warnings about potential quality issues with this result.

code: str

Machine-readable warning code (e.g. “low_confidence”, “unusual_geometry”)

message: str

Human-readable description of the warning