Skip to navigation
API ReferenceWorkspaces

Create Presence Token

Beta

Admin only. Mint a short-lived, read-only Keryx token for a workspace’s live presence feed (the awareness room the People page renders). The token is bound to the calling user, so Keryx narrows every frame to the documents that user may open; it can never publish presence or write document content. Requires the presence roster to be enabled for the deployment and opted in for the workspace. Computer-asset sandbox credentials are refused: call with the viewing user’s own token.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

workspace_idstringRequired1-128 characters
The workspace whose presence feed to read.

Headers

X-Athena-Session-CredentialstringOptional

Response

Successful Response
access_type"r"

Always r: subscribe only. The app never publishes a slot.

doc_idstring

Keryx document id within the org: awareness.

expires_at_msinteger

Token expiry in epoch milliseconds. Re-mint before this passes; the @athenaintel/react presence client does so automatically.

orgstring

Keryx org (room namespace): the workspace id.

tokenstring

Keryx capability token (yauth). Pass as the yauth query parameter on the WebSocket upgrade. Read-only and bound to this workspace’s awareness room; Keryx narrows every frame to what the token’s user may open.

ws_urlstring

WebSocket base URL. Connect to {ws_url}/{org}/{doc_id}?yauth={token}.

branchstringOptionalDefaults to main
Document branch.

Errors

422
Unprocessable Entity Error