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

# Create Live Share Endpoint

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

## 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`
- Auth: none declared

## Path parameters

- `deployment_id` string, required

## Headers

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

## Request body

- CreateLiveShareRequest: Create request. Every disclosure defaults off and unlisted.
  - `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 `201`

Successful Response

- LiveShareLinkResponse
  - `share_id` string, required
  - `share_type` 'live'
  - `deployment_id` string, required
  - `strategy_id` string, required
  - `commit_id` string, required
  - `deployed_version_string` string, nullable, required
  - `deployment_status` string, required
  - `effective_title` string, required
  - `title_override` string, nullable, required
  - `about_markdown` string, nullable, required
  - `show_dollar_values` boolean, required
  - `show_positions` boolean, required
  - `include_strategy_source` boolean, required
  - `show_creator_profile` boolean, required
  - `discoverability` 'unlisted' | 'public', required
  - `policy_schema_version` integer, required
  - `policy_revision` integer, required
  - `permission` 'view' | 'fork', required
  - `created_by_principal_id` string, required
  - `updated_by_principal_id` string, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `revoked_at` string, date-time, nullable, required
  - `view_count` integer, required
  - `fork_count` integer, required
  - `last_accessed_at` string, date-time, nullable, required
  - `artifacts_status` string, required
  - `url` string, required
  - `disclosure_summary` 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)