---
title: "Preview Live Share Endpoint"
method: POST
path: "/v1/deployments/{deployment_id}/share-links/preview"
tags: ["live-sharing"]
---

# Preview Live Share Endpoint

`POST /v1/deployments/{deployment_id}/share-links/preview`

## Request

- Base URL: `https://api.usekeel.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.usekeel.io/v1/deployments/{deployment_id}/share-links/preview`
- Auth: none declared

Project the exact visitor shape without allocating a capability.

## Path parameters

- `deployment_id` string, required

## Headers

- `Authorization` string, nullable
- `X-Org-Id` string, nullable

## Request body

- PreviewLiveShareRequest: Side-effect-free preview request.
  - `show_dollar_values` boolean
  - `show_positions` boolean
  - `include_strategy_source` boolean
  - `show_creator_profile` boolean
  - `discoverability` 'unlisted' | 'public'
  - `title_override` string, nullable
  - `about_markdown` string, nullable

## Response `200`

Successful Response

- PublicLiveShareV1
  - `schema_version` 1
  - `share_type` 'live'
  - `share_id` string, required
  - `policy_revision` integer, required
  - `is_preview` boolean
  - `title` string, required
  - `about` PublicLiveAbout
    - `markdown` string, required
    - `updated_at` string, required
  - `lifecycle` PublicLiveLifecycle, required
    - `status` 'LIVE' | 'PAUSED' | 'STOPPED', required
    - `deployed_at` string, required
    - `stopped_at` string, nullable
  - `data` PublicLiveDataState, required
    - `as_of` string, nullable
    - `freshness` PublicMoneyFreshness
      - `state` 'COVERED' | 'SYNCING' | 'LEGACY' | 'UNMANAGED', required
      - `fresh_as_of` string, nullable
      - `synced_through` string, nullable
  - `stats` PublicLivePerformanceStats, required
    - `total_return_pct` number, nullable
    - `current_drawdown_pct` number, nullable
    - `max_drawdown_pct` number, nullable
    - `max_drawdown_duration_days` number, nullable
    - `sharpe` number, nullable
    - `sortino` number, nullable
    - `win_rate_pct` number, nullable
    - `profit_factor` number, nullable
    - `total_trades` integer, nullable
    - `winning_trades` integer, nullable
    - `losing_trades` integer, nullable
  - `disclosure` PublicLiveDisclosure, required
    - `show_dollar_values` boolean, required
    - `show_positions` boolean, required
    - `include_strategy_source` boolean, required
    - `show_creator_profile` boolean, required
    - `discoverability` 'unlisted' | 'public', required
    - `approximate_position_notionals_inferable` boolean, required
    - `summary` string[], required
  - `series` PublicLiveSeriesRef, required
    - `url` string, required
    - `ranges` string[]
    - `default_range` 'all'
  - `dollar_values` PublicLiveDollarSummary
    - `state` 'available' | 'unavailable', required
    - `current_account_value` number, nullable
    - `cumulative_pnl` number, nullable
  - `positions` PublicLivePositions
    - `state` 'current' | 'stale' | 'unavailable' | 'final', required
    - `as_of` string, nullable
    - `gross_exposure_pct` number, nullable
    - `long_exposure_pct` number, nullable
    - `short_exposure_pct` number, nullable
    - `items` PublicLivePositionItem[]
      - `symbol` string, required
      - `side` 'LONG' | 'SHORT', required
      - `weight_pct` number, required
  - `strategy` PublicLiveStrategySummary
    - `name` string, required
    - `version_label` string, nullable
    - `component_names` string[]
    - `graph_url` string, required
    - `fork_url` string, required
  - `creator` PublicCreatorSummary
    - `display_name` string, required
    - `avatar_url` string, nullable
    - `bio` string, nullable
    - `profile_url` string, required
  - `card` PublicLiveCardRef, required
    - `url` string, required

## Other responses

- `422`: Validation Error

---

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