Skip to main content

Interface: CortexClientConfig

Properties​

PropertyTypeDescriptionDefined in
accessToken?stringJWT bearer token for authenticationodin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:37
apiKey?stringAPI key for authentication (prefix: ots_live_)odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:35
baseUrlstringBase URL of the Cortex API (e.g. "https://cortex.odin.4players.io")odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:33
debug?booleanEnable debug logging — logs method, URL, status, and response body for every requestodin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:67
fetch?(input: RequestInfo | URL, init?: RequestInit) => Promise<Response>(input: string | Request | URL, init?: RequestInit) => Promise<Response>Custom fetch implementationodin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:55
followRedirects?booleanFollow HTTP redirects manually, preserving the request method, body, and auth headers (including Authorization and HMAC signature headers) across origins. Defaults to true. The platform fetch strips Authorization on cross-origin redirects and downgrades POST→GET on 301/302, which breaks authenticated calls when the API host redirects (e.g. an ots. → cortex. migration). Prefer pointing baseUrl at the final host; this is a safety net. Set to false to use the platform's native redirect handling.odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:65
participantToken?stringA participant token, as returned by project.participants.issueToken(). This is the game-client mode: the token speaks for one player and only opens the /client/v1/* routes, reachable through CortexClient.me. Project-scoped calls (client.project(id)…) will be rejected by the server, which is the point — a client never holds a project-wide credential. Tokens expire after at most 15 minutes; construct a new client (or keep one and rebuild it) when your backend hands you a fresh token.odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:53
projectId?stringProject ID (required for HMAC auth, will be used more broadly in future)odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:39
projectSecret?stringProject secret for HMAC-SHA256 authentication (used by ODIN platform services)odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:41
realtime?objectReal-time (SSE) tuning for watch() subscriptionsodin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:69
realtime.idleTimeoutMs?numberIdle/stall timeout in milliseconds for event streams. If no bytes (events or heartbeats) arrive within this window, the connection is reconnected and resynced — a defense against half-open sockets. The backend sends a heartbeat every ~15s. Defaults to 45000 (3 missed heartbeats). Set to 0 to disable.odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:77