---
title: "Launch a Frame Link"
method: POST
path: "/v1/spaces/{spaceId}/share-links/{linkId}/frame-session"
tags: ["Access"]
---

# Launch a Frame Link

`POST /v1/spaces/{spaceId}/share-links/{linkId}/frame-session`

## Request

- Base URL: `https://api.spacefast.com`
- URL: `https://api.spacefast.com/v1/spaces/{spaceId}/share-links/{linkId}/frame-session`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Spends one Link use and returns a short-lived origin-bound frame session. Public pages keep a clean shared-cache URL; private pages receive a scoped runtime proof.

## Path parameters

- `spaceId` string, required
- `linkId` string, required

## Request body

- object
  - `path` string
  - `target` object: The immutable Version to launch when the Link targets all Versions.
    - `kind` 'version', required
    - `versionId` string, required
  - `surface` 'wordpress.editor' | 'wordpress.preview'

## Response `200`

Response for status 200

- object
  - `$schema` string, uri: Canonical JSON Schema URL for this response body. The server also sends it in the `Link: rel="describedby"` response header.
  - `data` object, required
    - `spaceId` string, required
    - `linkId` string, required
    - `linkRevision` integer, required
    - `parentOrigin` string, uri, required
    - `path` string, required
    - `target` union, required
      - object
        - `kind` 'live', required
        - `versionId` string, required
        - `routeRevision` string, required
      - object
        - `kind` 'version', required
        - `versionId` string, required
      - object
        - `kind` 'branch', required
        - `branch` string, required
        - `versionId` string, required
        - `branchRevision` string, required
    - `surface` 'wordpress.editor' | 'wordpress.preview', required
    - `access` 'public' | 'private', required
    - `url` string, uri, required
    - `sessionToken` string, required
    - `expiresAt` string, date-time, required

## Other responses

- `default`: Problem details (RFC 9457). Any 4xx/5xx response is one `application/problem+json` document.

---

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