Create a share link

client.shareLinks.create(, ?): ShareLinkCreateResponse { id, access_parameters, archived_at, 6 more }

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.

ParametersExpand Collapse

body: ShareLinkCreateParams { expires_at, access_parameters, pipeline_ids, 2 more }

expires_at: string

formatdate-time-string

access_parameters?: PublicShareLinkAccessParameters { access_mode } | EmailShareLinkAccessParameters { 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 { access_mode }

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

access_mode: "public"

EmailShareLinkAccessParameters { access_mode, allowed_emails }

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

access_mode: "email"

allowed_emails: Array<string>

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

pipeline_ids?: Array<string>

Pipelines to expose through the share link. Must belong to the resolved workspace. Up to 100 entries.

prediction_ids?: Array<string>

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.

ReturnsExpand Collapse

ShareLinkCreateResponse { 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: PublicShareLinkAccessParameters { access_mode } | EmailShareLinkAccessParameters { 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 { access_mode }

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

access_mode: "public"

EmailShareLinkAccessParameters { access_mode, allowed_emails }

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

access_mode: "email"

allowed_emails: Array<string>

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.

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<string>

Pipelines exposed by this share link.

prediction_ids: Array<string>

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 <your-app-host>/share/{id}. Treat as a secret — the {id} segment is the bearer credential.

formaturi

Create a share link

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);

{
  "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"
}

Returns Examples

{
  "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"
}