## 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 `<your-app-host>/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"
}
```