# shares.preview

`GET /api/public/v1/profiles/{id}/share`

What a copy of this profile would carry: the committed revision it is pinned to, which data categories that revision holds, which ones your rights allow, and whether a machine can prepare it now.

- Capability: `share.manage`
- Command: no
- MCP tool: `shares_preview`

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string (uuid) | yes | Profile id |

## Response

`200` with `{ data, correlation_id }`.

| Field | Type | Always present | Description |
|---|---|---|---|
| `data` | object | yes |  |
| `data.profile` | object | yes |  |
| `data.profile.id` | string (uuid) | yes |  |
| `data.profile.name` | string | yes |  |
| `data.profile.os` | "windows" \| "linux" | yes |  |
| `data.profile.network_mode` | string | yes |  |
| `data.profile.has_proxy` | boolean | yes |  |
| `data.revision` | integer | yes | Latest committed revision (0 = never synced: only the configuration can be shared) (min -9007199254740991, max 9007199254740991) |
| `data.categories` | array<"cookies" \| "local_storage" \| "indexed_db" \| "service_workers" \| "extensions" \| "bookmarks" \| "history" \| "open_tabs" \| …> | yes | Categories that revision holds |
| `data.open` | boolean | yes |  |
| `data.allowed` | object | yes |  |
| `data.allowed.session` | boolean | yes |  |
| `data.allowed.saved_passwords` | boolean | yes |  |
| `data.machines` | integer | yes | Machines of this workspace whose worker can prepare a copy now (min -9007199254740991, max 9007199254740991) |
| `correlation_id` | string (uuid) | yes |  |

New fields can appear at any time; ignore the ones you do not know.

## Errors

| Code | HTTP | Retryable |
|---|---|---|
| `UNAUTHENTICATED` | 401 | no |
| `FORBIDDEN` | 403 | no |
| `RATE_LIMITED` | 429 | yes |
| `VALIDATION_FAILED` | 422 | no |
| `NOT_FOUND` | 404 | no |
| `DEPENDENCY_UNAVAILABLE` | 503 | yes |
| `UNKNOWN` | 500 | no |

## Example (curl)

```bash
curl "https://browlix.com/api/public/v1/profiles/<id>/share" \
  -H "Authorization: Bearer $BROWLIX_API_KEY"
```

## Example (TypeScript SDK)

```ts
import { Browlix } from "@browlix/sdk";

const bx = new Browlix({ apiKey: process.env.BROWLIX_API_KEY! });
const reply = await bx.call("shares.preview", { path: { id: "<id>" } });
console.log(reply.data);
```

## Example (Python)

```python
import os
import requests

r = requests.get(
    "https://browlix.com/api/public/v1/profiles/<id>/share",
    headers={"Authorization": f"Bearer {os.environ['BROWLIX_API_KEY']}"},
    timeout=60,
)
print(r.status_code, r.json())
```

## Example (MCP)

```json
{
  "method": "tools/call",
  "params": {
    "name": "shares_preview",
    "arguments": {
      "id": "<id>"
    }
  }
}
```