Claim a share token as the signed-in user
Validates an unrevoked, unexpired token without consuming a use, then persists a durable guest grant at the link's access level so the item stays reachable afterward and shows up in shared-with-me, and returns the item, its workspace, and the granted level (plus the public payload when the item is a file). Requires a Clerk session; API keys are rejected. Every invalid, expired, revoked, or exhausted token returns the same opaque not-found response.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/shares/string/resolve"{ "data": { "workspaceId": "string", "workspaceName": "string", "accessLevel": "view", "item": { "id": "0b6f2e6a-9f2c-4e7a-8d31-2c1e7a9f2c4e", "workspaceId": "4b81aa0c-6d2f-4b19-9f0e-1a7c3d5e8b02", "parentItemId": "d3a7f1b8-5c04-4e62-9a11-7b2e6c0d4f39", "kind": "database", "targetId": "9f2c1e7a-3b58-4d0c-8e27-6a1f9d4b3c85", "title": "Launch tasks", "icon": "rocket", "color": "#2f6f4f", "order": 0, "archived": false, "accessMode": "open", "metadata": {}, "createdAt": "2026-07-01T09:12:44.000Z", "updatedAt": "2026-07-14T16:03:10.000Z" }, "publicFile": { "type": "file", "meta": { "kind": "folder", "title": "string", "icon": "string", "color": "string", "allowDownload": true, "accessLevel": "view", "workspaceName": "string" }, "name": "string", "mimeType": "string", "byteSize": 0, "url": "string" } }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Revoke an item share link
Marks one share link revoked so the token stops resolving, and records the revocation on the workspace event log. Revoking is a sharing decision, so it requires full access on the shared item; a link id that does not belong to this workspace is not found. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
Resolve a public share token to its read-only payload
Atomically claims one use of the token and returns a read-only render of the shared item: a surface's manifest and blocks, or a file's name, type, size, and inline capability URL, each with a minimal meta block carrying the title, access level, and workspace name. No authentication; the share token in the path is the credential. A revoked, expired, or use-exhausted token — and an item that is archived or not publicly renderable — all return the same opaque not-found response.