Get realtime subscription credentials

GET /v1/me/realtime

• Operation ID: getMyRealtimeAccess
• Tags: Profile
• Base URL: http://localhost:8787

Returns the Mercure hub URL, the caller's topic and a subscriber token scoped to it.

Workflow: Integration guide.

Authentication: Platform user Bearer JWT. Acts only on the caller's own data.

Authentication

• Auth: Platform user Bearer JWT (Authorization: Bearer <access_token>).

Responses

200

Realtime credentials.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object

Field	Type	Required	Description
url	string	yes	Public Mercure hub URL.
topic	string	yes	Topic pattern /users/<userId>/*.
token	string	yes	Subscriber JWT for the hub.

Errors

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

503

realtime_unavailable: the realtime hub is not configured.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "realtime_unavailable"
}

Examples

curl

curl -X GET 'http://localhost:8787/v1/me/realtime' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/me/realtime", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();