paper

Preview Paper Share Endpoint

The link a create would write, without allocating a capability.

The source resolves under {'practice'}: a real id is the typed 404 an unknown id gets (AC-05-25).

post/v1/paper/{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/paper/{deployment_id}/share-links/preview
  • Auth: none declared

Path parameters

deployment_idstring required

Headers

Authorizationstring nullable
X-Org-Idstring nullable

Request body

show_dollar_valuesboolean
show_positionsboolean
include_strategy_sourceboolean
show_creator_profileboolean
discoverability'unlisted' | 'public'
title_overridestring nullable
about_markdownstring nullable

Response

Successful Response

share_type'paper'
deployment_idstring required
strategy_idstring required
commit_idstring required
deployed_version_stringstring nullable required
deployment_statusstring required
effective_titlestring required
title_overridestring nullable required
about_markdownstring nullable required
show_dollar_valuesboolean required
show_positionsboolean required
include_strategy_sourceboolean required
show_creator_profileboolean required
discoverability'unlisted' | 'public' required
policy_schema_versioninteger required
policy_revisioninteger required
permission'view' | 'fork' required
disclosure_summarystring[] required

Changes

No recorded changes to this operation across all 2 revisions of this API.