# Share Links ## Create a share link `$ boltz-api share-links create` **post** `/compute/v1/share-links` Create an unauthenticated, read-only share link covering one or more predictions and/or pipelines that all live in the same workspace. The returned `id` is the bearer credential — treat it as a secret. ### Parameters - `--expires-at: string` - `--access-parameters: optional 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. - `--pipeline-id: optional array of string` Pipelines to expose through the share link. Must belong to the resolved workspace. Up to 100 entries. - `--prediction-id: optional array of string` Predictions to expose through the share link. Must belong to the resolved workspace. Up to 100 entries. - `--workspace-id: optional string` Workspace ID. Only used with admin API keys. Ignored (or validated) for workspace-scoped keys. ### Returns - `ShareLinkNewResponse: 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. - `PublicShareLinkAccessParameters: object { access_mode }` Public access: anyone holding the share link ID can read. - `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. - `created_at: string` When the share link was created. - `expires_at: string` When the share link stops granting access. - `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 `/share/{id}`. Treat as a secret — the `{id}` segment is the bearer credential. ### Example ```cli boltz-api share-links create \ --api-key 'My API Key' \ --expires-at expires_at ``` #### Response ```json { "id": "shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo", "access_parameters": { "access_mode": "public" }, "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "expires_at": "2019-12-27T18:11:19.117Z", "pipeline_ids": [ "string" ], "prediction_ids": [ "string" ], "workspace_id": "workspace_id", "url": "https://lab.boltz.bio/share/shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo" } ``` ## Retrieve a share link `$ boltz-api share-links retrieve` **get** `/compute/v1/share-links/{id}` Retrieve metadata for a share link owned by the authenticated organization. Archived and expired links remain retrievable. ### Parameters - `--id: string` Share link ID. This value is a bearer credential and is redacted from application logs and traces. ### Returns - `ShareLinkGetResponse: 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. - `PublicShareLinkAccessParameters: object { access_mode }` Public access: anyone holding the share link ID can read. - `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. - `created_at: string` When the share link was created. - `expires_at: string` When the share link stops granting access. - `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 `/share/{id}`. Treat as a secret — the `{id}` segment is the bearer credential. ### Example ```cli boltz-api share-links retrieve \ --api-key 'My API Key' \ --id shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo ``` #### Response ```json { "id": "shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo", "access_parameters": { "access_mode": "public" }, "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "expires_at": "2019-12-27T18:11:19.117Z", "pipeline_ids": [ "string" ], "prediction_ids": [ "string" ], "workspace_id": "workspace_id", "url": "https://lab.boltz.bio/share/shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo" } ``` ## Archive a share link `$ boltz-api share-links archive` **post** `/compute/v1/share-links/{id}/archive` Archive a share link so it no longer grants public access. Metadata remains retrievable and repeated calls preserve the first archive timestamp. ### Parameters - `--id: string` Share link ID. This value is a bearer credential and is redacted from application logs and traces. ### Returns - `ShareLinkArchiveResponse: object { id, archived, archived_at }` - `id: string` - `archived: true` - `archived_at: string` When the share link was first archived. ### Example ```cli boltz-api share-links archive \ --api-key 'My API Key' \ --id shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo ``` #### Response ```json { "id": "shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo", "archived": true, "archived_at": "2019-12-27T18:11:19.117Z" } ``` ## List pipeline results from a share link `$ boltz-api share-links list-pipeline-results` **get** `/compute/v1/share/{id}/pipelines/{pipelineId}/results` Paginated results for one pipeline exposed by a share link. The response shape matches the authed pipeline-results endpoints exactly. Access is gated by the share-link ID and — for email-mode links — a signed compute-API JWT. Pipeline IDs not covered by the link return 404 indistinguishably from unknown links. ### Parameters - `--id: string` Path param: Share link ID. Treat as a secret — it is the bearer credential. - `--pipeline-id: string` Path param: Pipeline ID, which must be covered by the share link. - `--after-id: optional string` Query param: Return results after this ID - `--before-id: optional string` Query param: Return results before this ID - `--ids: optional string` Query param: Comma-separated list of result IDs to filter by (max 200). Only results whose ID matches one of these is returned; missing IDs are silently skipped. Composes with `limit`, `after_id`, and `before_id` — the filter is applied before pagination. - `--limit: optional number` Query param: Max results to return. Defaults to 100. ### Returns - `PipelineResultsResponse: object { data, first_id, has_more, last_id } or object { data, first_id, has_more, last_id } or object { data, first_id, has_more, last_id } or 3 more` - `ProteinDesignResultsResponse: object { data, first_id, has_more, last_id }` - `data: array of object { id, artifacts, created_at, 3 more }` - `id: string` Unique result ID. - `artifacts: object { archive, structure }` - `archive: object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `structure: optional object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `created_at: string` - `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. - `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 - `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 - `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 - `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). - `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). - `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). - `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 - `first_id: string` ID of the first item. Use as before_id for the previous page. - `has_more: boolean` - `last_id: string` ID of the last item. Use as after_id for the next page. - `ProteinRedesignResultsResponse: object { data, first_id, has_more, last_id }` - `data: array of object { id, artifacts, created_at, 3 more }` - `id: string` Unique result ID. - `artifacts: object { archive, structure }` - `archive: object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `structure: optional object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `created_at: string` - `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. - `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 - `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 - `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 - `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). - `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). - `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). - `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 - `first_id: string` ID of the first item. Use as before_id for the previous page. - `has_more: boolean` - `last_id: string` ID of the last item. Use as after_id for the next page. - `ProteinSequenceRedesignResultsResponse: object { data, first_id, has_more, last_id }` - `data: array of object { id, artifacts, created_at, 4 more } or object { id, artifacts, created_at, 4 more }` - `BinderProteinDesignResult: object { id, artifacts, created_at, 4 more }` - `id: string` Unique result ID. - `artifacts: object { archive, structure }` - `archive: object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `structure: optional object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `created_at: string` - `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. - `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 - `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 - `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 - `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). - `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). - `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). - `structure_confidence: number` Confidence in the predicted 3D structure (0-1). - `type: "binder"` - `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 - `GenericProteinDesignResult: object { id, artifacts, created_at, 4 more }` - `id: string` Unique result ID. - `artifacts: object { archive, structure }` - `archive: object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `structure: optional object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `created_at: string` - `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. - `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 - `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 - `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 - `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 { helix_fraction, loop_fraction, sheet_fraction, structure_confidence }` Structure and design-quality metrics for a generic protein design. - `helix_fraction: number` Fraction of the designed sequence forming alpha helices (0-1). - `loop_fraction: number` Fraction of the designed sequence in coil/loop regions (0-1). - `sheet_fraction: number` Fraction of the designed sequence forming beta sheets (0-1). - `structure_confidence: number` Confidence in the predicted 3D structure (0-1). - `type: "generic"` - `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 - `first_id: string` ID of the first item. Use as before_id for the previous page. - `has_more: boolean` - `last_id: string` ID of the last item. Use as after_id for the next page. - `ProteinLibraryScreenResultsResponse: object { data, first_id, has_more, last_id }` - `data: array of object { id, artifacts, created_at, 4 more }` - `id: string` Unique result ID - `artifacts: object { archive, structure }` - `archive: object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `structure: object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `created_at: string` - `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 of the screened complex. Includes both screened and fixed entities from the input. - `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 - `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 - `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 - `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 screened protein - `binding_confidence: number` Confidence that the protein binds the target (0-1). Primary metric for hit discovery. - `helix_fraction: number` Fraction of the sequence forming alpha helices (0-1). - `iptm: number` Interface predicted TM score (0-1). Confidence in the protein-protein interface. - `loop_fraction: number` Fraction of the sequence in coil/loop regions (0-1). - `min_interaction_pae: number` Minimum predicted aligned error at the interface (Angstroms). Lower values indicate higher confidence. - `sheet_fraction: number` Fraction of the sequence forming beta sheets (0-1). - `structure_confidence: number` Confidence in the predicted 3D structure (0-1). - `external_id: optional string` Client-provided identifier for this protein, if provided - `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 - `first_id: string` ID of the first item. Use as before_id for the previous page. - `has_more: boolean` - `last_id: string` ID of the last item. Use as after_id for the next page. - `SmDesignResultsResponse: object { data, first_id, has_more, last_id }` - `data: array of object { id, artifacts, created_at, 4 more }` - `id: string` Unique result ID - `artifacts: object { archive, structure, ligand_structure }` - `archive: object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `structure: object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `ligand_structure: optional object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `created_at: string` - `metrics: object { binding_confidence, complex_iplddt, complex_plddt, 4 more }` Scoring metrics for a designed small molecule - `binding_confidence: number` Confidence that the molecule binds the target (0-1). Primary metric for hit discovery. - `complex_iplddt: number` Interface pLDDT for the complex (0-1 float). Confidence at the binding interface. - `complex_plddt: number` pLDDT for the full complex (0-1 float). - `iptm: number` Interface predicted TM score (0-1). Confidence in relative positioning of ligand and protein. - `optimization_score: number` Binding strength ranking score for lead optimization. Higher values indicate stronger predicted binding. - `ptm: number` Predicted TM score (0-1). Global structure quality metric. - `structure_confidence: number` Confidence in the predicted 3D structure (0-1). - `smiles: string` SMILES string of the designed molecule - `adme: optional object { lipophilicity, permeability, solubility }` Tier 1 ADME summary values for this molecule. - `lipophilicity: number` Lipophilicity score from the internal LogD prediction. - `permeability: number` Permeability score for this molecule. - `solubility: "high-confidence" or "medium-confidence" or "high-risk"` Solubility judgement for this molecule. - `"high-confidence"` - `"medium-confidence"` - `"high-risk"` - `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 - `first_id: string` ID of the first item. Use as before_id for the previous page. - `has_more: boolean` - `last_id: string` ID of the last item. Use as after_id for the next page. - `SmScreenResultsResponse: object { data, first_id, has_more, last_id }` - `data: array of object { id, artifacts, created_at, 5 more }` - `id: string` Unique result ID - `artifacts: object { archive, structure, ligand_structure }` - `archive: object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `structure: object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `ligand_structure: optional object { url, url_expires_at }` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `created_at: string` - `metrics: object { binding_confidence, complex_iplddt, complex_plddt, 4 more }` Scoring metrics for a screened small molecule - `binding_confidence: number` Confidence that the molecule binds the target (0-1). Primary metric for hit discovery. - `complex_iplddt: number` Interface pLDDT for the complex (0-1 float). Confidence at the binding interface. - `complex_plddt: number` pLDDT for the full complex (0-1 float). - `iptm: number` Interface predicted TM score (0-1). Confidence in relative positioning of ligand and protein. - `optimization_score: number` Binding strength ranking score for lead optimization. Higher values indicate stronger predicted binding. - `ptm: number` Predicted TM score (0-1). Global structure quality metric. - `structure_confidence: number` Confidence in the predicted 3D structure (0-1). - `smiles: string` SMILES string of the screened molecule - `adme: optional object { lipophilicity, permeability, solubility }` Tier 1 ADME summary values for this molecule. - `lipophilicity: number` Lipophilicity score from the internal LogD prediction. - `permeability: number` Permeability score for this molecule. - `solubility: "high-confidence" or "medium-confidence" or "high-risk"` Solubility judgement for this molecule. - `"high-confidence"` - `"medium-confidence"` - `"high-risk"` - `external_id: optional string` Client-provided identifier for this molecule, if provided - `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 - `first_id: string` ID of the first item. Use as before_id for the previous page. - `has_more: boolean` - `last_id: string` ID of the last item. Use as after_id for the next page. ### Example ```cli boltz-api share-links list-pipeline-results \ --api-key 'My API Key' \ --id id \ --pipeline-id pipelineId ``` #### Response ```json { "data": [ { "id": "id", "artifacts": { "archive": { "url": "https://example.com", "url_expires_at": "2019-12-27T18:11:19.117Z" }, "structure": { "url": "https://example.com", "url_expires_at": "2019-12-27T18:11:19.117Z" } }, "created_at": "2019-12-27T18:11:19.117Z", "entities": [ { "chain_ids": [ "string" ], "type": "protein", "value": "value", "cyclic": true, "modifications": [ { "residue_index": 0, "type": "ccd", "value": "value" } ] } ], "metrics": { "binding_confidence": 0, "helix_fraction": 0, "iptm": 0, "loop_fraction": 0, "min_interaction_pae": 0, "sheet_fraction": 0, "structure_confidence": 0 }, "warnings": [ { "code": "code", "message": "message" } ] } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ```