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

POST/compute/v1/share-links

Retrieve a share link

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

Archive a share link

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

List pipeline results from a share link

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

ModelsExpand Collapse

ShareLinkCreateResponse object { id, access_parameters, archived_at, 6 more }

id: string

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

access_parameters: object { access_mode } or object { access_mode, allowed_emails }

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:

PublicShareLinkAccessParameters object { access_mode }

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

access_mode: "public"

EmailShareLinkAccessParameters object { access_mode, allowed_emails }

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

access_mode: "email"

allowed_emails: array of string

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

archived_at: string

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

formatdate-time

created_at: string

When the share link was created.

formatdate-time

expires_at: string

When the share link stops granting access.

formatdate-time

pipeline_ids: array of string

Pipelines exposed by this share link.

prediction_ids: array of string

Predictions exposed by this share link.

workspace_id: string

Workspace that owns the share link and the referenced resources.

url: optional string

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

ShareLinkRetrieveResponse object { id, access_parameters, archived_at, 6 more }

id: string

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

access_parameters: object { access_mode } or object { access_mode, allowed_emails }

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:

PublicShareLinkAccessParameters object { access_mode }

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

access_mode: "public"

EmailShareLinkAccessParameters object { access_mode, allowed_emails }

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

access_mode: "email"

allowed_emails: array of string

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

archived_at: string

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

formatdate-time

created_at: string

When the share link was created.

formatdate-time

expires_at: string

When the share link stops granting access.

formatdate-time

pipeline_ids: array of string

Pipelines exposed by this share link.

prediction_ids: array of string

Predictions exposed by this share link.

workspace_id: string

Workspace that owns the share link and the referenced resources.

url: optional string

formaturi

ShareLinkArchiveResponse object { id, archived, archived_at }

id: string

archived: true

archived_at: string

When the share link was first archived.

formatdate-time

ShareLinkListPipelineResultsResponse object { id, artifacts, created_at, 3 more }

A single generated protein design

id: string

Unique result ID.

artifacts: object { archive, structure }

archive: object { url, url_expires_at }

url: string

URL to download the file

formaturi

url_expires_at: string

When the presigned URL expires

formatdate-time

structure: optional object { url, url_expires_at }

url: string

URL to download the file

formaturi

url_expires_at: string

When the presigned URL expires

formatdate-time

created_at: string

formatdate-time

entities: array of object { chain_ids, type, value, 2 more } or object { chain_ids, type, value, 2 more } or object { chain_ids, type, value, 2 more } or 2 more

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

One of the following:

ProteinEntity object { chain_ids, type, value, 2 more }

chain_ids: array of string

Chain IDs for this entity

type: "protein"

value: string

Amino acid sequence (one-letter codes)

cyclic: optional boolean

Whether the sequence is cyclic

modifications: optional array of object { residue_index, type, value }

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

residue_index: number

0-based index of the residue to modify

minimum0

type: "ccd"

Modification format. Only CCD polymer modifications are supported.

value: string

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

RnaEntity object { chain_ids, type, value, 2 more }

chain_ids: array of string

Chain IDs for this entity

type: "rna"

value: string

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

cyclic: optional boolean

Whether the sequence is cyclic

modifications: optional array of object { residue_index, type, value }

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

residue_index: number

0-based index of the residue to modify

minimum0

type: "ccd"

Modification format. Only CCD polymer modifications are supported.

value: string

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

DnaEntity object { chain_ids, type, value, 2 more }

chain_ids: array of string

Chain IDs for this entity

type: "dna"

value: string

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

cyclic: optional boolean

Whether the sequence is cyclic

modifications: optional array of object { residue_index, type, value }

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

residue_index: number

0-based index of the residue to modify

minimum0

type: "ccd"

Modification format. Only CCD polymer modifications are supported.

value: string

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

LigandCcdEntity object { chain_ids, type, value }

chain_ids: array of string

Chain IDs for this ligand

type: "ligand_ccd"

value: string

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

LigandSmilesEntity object { chain_ids, type, value }

chain_ids: array of string

Chain IDs for this ligand

type: "ligand_smiles"

value: string

SMILES string representing the ligand

metrics: object { binding_confidence, helix_fraction, iptm, 4 more }

Structural and binding quality metrics for a designed protein binder

binding_confidence: number

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

helix_fraction: number

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

minimum0

maximum1

iptm: number

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

loop_fraction: number

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

minimum0

maximum1

min_interaction_pae: number

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

sheet_fraction: number

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

minimum0

maximum1

structure_confidence: number

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

warnings: optional array of object { code, message }

Warnings about potential quality issues with this result.

code: string

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

message: string

Human-readable description of the warning