# Share Links ## Create a share link `client.shareLinks.create(ShareLinkCreateParamsbody, RequestOptionsoptions?): ShareLinkCreateResponse` **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 - `body: ShareLinkCreateParams` - `expires_at: string` - `access_parameters?: PublicShareLinkAccessParameters | EmailShareLinkAccessParameters` 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` Public access: anyone holding the share link ID can read. - `access_mode: "public"` - `"public"` - `EmailShareLinkAccessParameters` Email-restricted access: only the addresses in `allowed_emails` can read the link. - `access_mode: "email"` - `"email"` - `allowed_emails: Array` Email addresses allowed to read the link. Must contain at least one address; up to 100 entries. - `pipeline_ids?: Array` Pipelines to expose through the share link. Must belong to the resolved workspace. Up to 100 entries. - `prediction_ids?: Array` Predictions to expose through the share link. Must belong to the resolved workspace. Up to 100 entries. - `workspace_id?: string` Workspace ID. Only used with admin API keys. Ignored (or validated) for workspace-scoped keys. ### Returns - `ShareLinkCreateResponse` - `id: string` Share link ID. This value is the bearer credential used to access the linked resources — treat it as a secret. - `access_parameters: PublicShareLinkAccessParameters | EmailShareLinkAccessParameters` 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` Public access: anyone holding the share link ID can read. - `access_mode: "public"` - `"public"` - `EmailShareLinkAccessParameters` Email-restricted access: only the addresses in `allowed_emails` can read the link. - `access_mode: "email"` - `"email"` - `allowed_emails: Array` Email addresses allowed to read the link. Must contain at least one address; up to 100 entries. - `archived_at: string | null` 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` Pipelines exposed by this share link. - `prediction_ids: Array` Predictions exposed by this share link. - `workspace_id: string` Workspace that owns the share link and the referenced resources. - `url?: 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 ```typescript import Boltz from 'boltz-api'; const client = new Boltz({ apiKey: process.env['BOLTZ_API_KEY'], // This is the default and can be omitted }); const shareLink = await client.shareLinks.create({ expires_at: 'expires_at' }); console.log(shareLink.id); ``` #### 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 `client.shareLinks.retrieve(stringid, RequestOptionsoptions?): ShareLinkRetrieveResponse` **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` ### Returns - `ShareLinkRetrieveResponse` - `id: string` Share link ID. This value is the bearer credential used to access the linked resources — treat it as a secret. - `access_parameters: PublicShareLinkAccessParameters | EmailShareLinkAccessParameters` 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` Public access: anyone holding the share link ID can read. - `access_mode: "public"` - `"public"` - `EmailShareLinkAccessParameters` Email-restricted access: only the addresses in `allowed_emails` can read the link. - `access_mode: "email"` - `"email"` - `allowed_emails: Array` Email addresses allowed to read the link. Must contain at least one address; up to 100 entries. - `archived_at: string | null` 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` Pipelines exposed by this share link. - `prediction_ids: Array` Predictions exposed by this share link. - `workspace_id: string` Workspace that owns the share link and the referenced resources. - `url?: 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 ```typescript import Boltz from 'boltz-api'; const client = new Boltz({ apiKey: process.env['BOLTZ_API_KEY'], // This is the default and can be omitted }); const shareLink = await client.shareLinks.retrieve( 'shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo', ); console.log(shareLink.id); ``` #### 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 `client.shareLinks.archive(stringid, RequestOptionsoptions?): ShareLinkArchiveResponse` **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` ### Returns - `ShareLinkArchiveResponse` - `id: string` - `archived: true` - `true` - `archived_at: string` When the share link was first archived. ### Example ```typescript import Boltz from 'boltz-api'; const client = new Boltz({ apiKey: process.env['BOLTZ_API_KEY'], // This is the default and can be omitted }); const response = await client.shareLinks.archive('shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo'); console.log(response.id); ``` #### Response ```json { "id": "shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo", "archived": true, "archived_at": "2019-12-27T18:11:19.117Z" } ``` ## List pipeline results from a share link `client.shareLinks.listPipelineResults(stringpipelineID, ShareLinkListPipelineResultsParamsparams, RequestOptionsoptions?): CursorPage` **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 - `pipelineID: string` - `params: ShareLinkListPipelineResultsParams` - `id: string` Path param: Share link ID. Treat as a secret — it is the bearer credential. - `after_id?: string` Query param: Return results after this ID - `before_id?: string` Query param: Return results before this ID - `ids?: 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?: number` Query param: Max results to return. Defaults to 100. ### Returns - `ShareLinkListPipelineResultsResponse` A single generated protein design - `id: string` Unique result ID. - `artifacts: Artifacts` - `archive: Archive` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `structure?: Structure` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `created_at: string` - `entities: Array` Entities in the designed complex, including designed and fixed input entities. - `ProteinEntity` - `chain_ids: Array` Chain IDs for this entity - `type: "protein"` - `"protein"` - `value: string` Amino acid sequence (one-letter codes) - `cyclic?: boolean` Whether the sequence is cyclic - `modifications?: Array` 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. - `"ccd"` - `value: string` CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine) - `RnaEntity` - `chain_ids: Array` Chain IDs for this entity - `type: "rna"` - `"rna"` - `value: string` RNA nucleotide sequence (A, C, G, U, N) - `cyclic?: boolean` Whether the sequence is cyclic - `modifications?: Array` 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. - `"ccd"` - `value: string` CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine) - `DnaEntity` - `chain_ids: Array` Chain IDs for this entity - `type: "dna"` - `"dna"` - `value: string` DNA nucleotide sequence (A, C, G, T, N) - `cyclic?: boolean` Whether the sequence is cyclic - `modifications?: Array` 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. - `"ccd"` - `value: string` CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine) - `LigandCcdEntity` - `chain_ids: Array` Chain IDs for this ligand - `type: "ligand_ccd"` - `"ligand_ccd"` - `value: string` CCD code (e.g., ATP, ADP) - `LigandSmilesEntity` - `chain_ids: Array` Chain IDs for this ligand - `type: "ligand_smiles"` - `"ligand_smiles"` - `value: string` SMILES string representing the ligand - `metrics: Metrics` 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?: Array` 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 ### Example ```typescript import Boltz from 'boltz-api'; const client = new Boltz({ apiKey: process.env['BOLTZ_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const shareLinkListPipelineResultsResponse of client.shareLinks.listPipelineResults( 'pipelineId', { id: 'id' }, )) { console.log(shareLinkListPipelineResultsResponse.id); } ``` #### 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" } ``` ## Domain Types ### Share Link Create Response - `ShareLinkCreateResponse` - `id: string` Share link ID. This value is the bearer credential used to access the linked resources — treat it as a secret. - `access_parameters: PublicShareLinkAccessParameters | EmailShareLinkAccessParameters` 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` Public access: anyone holding the share link ID can read. - `access_mode: "public"` - `"public"` - `EmailShareLinkAccessParameters` Email-restricted access: only the addresses in `allowed_emails` can read the link. - `access_mode: "email"` - `"email"` - `allowed_emails: Array` Email addresses allowed to read the link. Must contain at least one address; up to 100 entries. - `archived_at: string | null` 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` Pipelines exposed by this share link. - `prediction_ids: Array` Predictions exposed by this share link. - `workspace_id: string` Workspace that owns the share link and the referenced resources. - `url?: 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. ### Share Link Retrieve Response - `ShareLinkRetrieveResponse` - `id: string` Share link ID. This value is the bearer credential used to access the linked resources — treat it as a secret. - `access_parameters: PublicShareLinkAccessParameters | EmailShareLinkAccessParameters` 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` Public access: anyone holding the share link ID can read. - `access_mode: "public"` - `"public"` - `EmailShareLinkAccessParameters` Email-restricted access: only the addresses in `allowed_emails` can read the link. - `access_mode: "email"` - `"email"` - `allowed_emails: Array` Email addresses allowed to read the link. Must contain at least one address; up to 100 entries. - `archived_at: string | null` 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` Pipelines exposed by this share link. - `prediction_ids: Array` Predictions exposed by this share link. - `workspace_id: string` Workspace that owns the share link and the referenced resources. - `url?: 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. ### Share Link Archive Response - `ShareLinkArchiveResponse` - `id: string` - `archived: true` - `true` - `archived_at: string` When the share link was first archived. ### Share Link List Pipeline Results Response - `ShareLinkListPipelineResultsResponse` A single generated protein design - `id: string` Unique result ID. - `artifacts: Artifacts` - `archive: Archive` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `structure?: Structure` - `url: string` URL to download the file - `url_expires_at: string` When the presigned URL expires - `created_at: string` - `entities: Array` Entities in the designed complex, including designed and fixed input entities. - `ProteinEntity` - `chain_ids: Array` Chain IDs for this entity - `type: "protein"` - `"protein"` - `value: string` Amino acid sequence (one-letter codes) - `cyclic?: boolean` Whether the sequence is cyclic - `modifications?: Array` 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. - `"ccd"` - `value: string` CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine) - `RnaEntity` - `chain_ids: Array` Chain IDs for this entity - `type: "rna"` - `"rna"` - `value: string` RNA nucleotide sequence (A, C, G, U, N) - `cyclic?: boolean` Whether the sequence is cyclic - `modifications?: Array` 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. - `"ccd"` - `value: string` CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine) - `DnaEntity` - `chain_ids: Array` Chain IDs for this entity - `type: "dna"` - `"dna"` - `value: string` DNA nucleotide sequence (A, C, G, T, N) - `cyclic?: boolean` Whether the sequence is cyclic - `modifications?: Array` 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. - `"ccd"` - `value: string` CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine) - `LigandCcdEntity` - `chain_ids: Array` Chain IDs for this ligand - `type: "ligand_ccd"` - `"ligand_ccd"` - `value: string` CCD code (e.g., ATP, ADP) - `LigandSmilesEntity` - `chain_ids: Array` Chain IDs for this ligand - `type: "ligand_smiles"` - `"ligand_smiles"` - `value: string` SMILES string representing the ligand - `metrics: Metrics` 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?: Array` 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