# Sharing

Public read endpoints for a shared session, in both the page and JSON forms.

Playground

Send these requests to your own running server. Values stay in this browser.

Not connected

Base URL  Directory _optional_  Bearer token _optional_ 

 

How this works

Start a server with `nikcli serve --hostname 127.0.0.1 --port 4096`. Requests go straight from this page to that address — the browser allows it because loopback counts as a secure origin, and the server allows it because `nikcli-ai.dev` is in its CORS allowlist.

To try things without touching your real sessions or config, start the server with `NIKCLI_TEST_HOME` pointed at a throwaway directory — see [the guided tour](/docs/guides/api-tour).

## Operations

4 endpoints, generated from the server's own [OpenAPI document](/docs/api). Every path also accepts the `directory` and `workspace` query parameters that select which instance handles the request.

<table class="api-index not-prose"><tbody><tr><td class="api-index-method"><span class="api-method api-method-get">get</span></td><td><a href="#op-get-s-shareID">/s/{shareID}</a></td><td class="api-index-id">getS:shareID</td></tr><tr><td class="api-index-method"><span class="api-method api-method-get">get</span></td><td><a href="#op-get-share-shareID">/share/{shareID}</a></td><td class="api-index-id">getShare:shareID</td></tr><tr><td class="api-index-method"><span class="api-method api-method-get">get</span></td><td><a href="#op-get-api-share-shareID">/api/share/{shareID}</a></td><td class="api-index-id">getApiShare:shareID</td></tr><tr><td class="api-index-method"><span class="api-method api-method-get">get</span></td><td><a href="#op-get-api-share-shareID-data">/api/share/{shareID}/data</a></td><td class="api-index-id">getApiShare:shareIDData</td></tr></tbody></table>

get /s/{shareID} [#](#op-get-s-shareID) `getS:shareID`

Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| shareID | path | string | required |
| directory | query | string | optional |
| workspace | query | string | optional |

Responses

308 308 redirect to /share/:shareID

SDK example

getS:shareID

ts 

1

2

3

4

5

6

```
import { createNikcliClient } from "@nikcli-ai/sdk/httpapi"

const client = createNikcliClient()
await client.getS:shareID({
  ...
})
```

Try it

shareID _path · required_  directory _query_  workspace _query_

---

Source: https://nikcli-ai.dev/docs/api/share