---
title: "Turn a recording public link on or off"
method: PUT
path: "/recordings/{public_id}/public-link"
tags: ["REST API"]
---

# Turn a recording public link on or off

`PUT /recordings/{public_id}/public-link`

## Request

- Base URL: `https://api.supercut.ai/v1`
- URL: `https://api.supercut.ai/v1/recordings/{public_id}/public-link`
- Auth: HTTP bearer

Works with: Personal token

With the public link on, anyone with the recording's URL can watch it without signing in, unless it has a password. Confirm with the user before enabling it. Enabling applies the workspace's default link expiry, if it has one, and the setting covers every version of the recording.

## Path parameters

- `public_id` string, required

## Request body

- object
  - `enabled` boolean, required

## Response `200`

200

- object
  - `data` object, required
    - `public_id` string, required
    - `link` string, required: The recording's page: on the workspace's custom domain when it has one, else on the Supercut app that served the response.
    - `title` string, required
    - `status` 'pending' | 'processing' | 'completed' | 'failed', required: `pending` and `processing` are not final; `completed` and `failed` are.
    - `duration_ms` number, nullable, required
    - `created_at` string, required
    - `owner` object, required
      - `public_id` string, required: Public user id, the same for this person everywhere.
      - `name` string, required
      - `avatar_url` string, nullable, required
    - `analytics` object
      - `visits` object, required
        - `total` number, required
        - `unique` number, required
      - `plays` object, required
        - `total` number, required
        - `unique` number, required
    - `summary` string, nullable, required
    - `chapters` object[], required
      - `title` string, required
      - `summary` string, required
      - `start_ms` number, required
    - `public_link` string, nullable, required: The recording's `link` while its public link is on, otherwise null. Anyone with it can watch the recording while the link is on, unless the recording has a password.
    - `public_link_expires_at` string, nullable, required: When the public link turns itself off, or null when it does not expire or is off.
    - `workspace_access` 'VIEW' | 'EDIT' | 'FULL_ACCESS', nullable, required: What everyone in the workspace can do with the recording ("General access"), or null when it is not shared with the workspace.

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `403`: 403
- `404`: 404
- `409`: 409
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/supercut/apis/supercut-platform-api.md) · [All operations](https://skmtc.dev/supercut/apis/supercut-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/supercut/apis/supercut-platform-api/revisions/66033895a858?raw)