Skip to main content

Class: CortexClient

Shared context passed to all resource managers and live objects.

Implements​

Constructors​

new CortexClient()​

new CortexClient(config): CortexClient

Parameters​

ParameterType
configCortexClientConfig

Returns​

CortexClient

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:97

Properties​

PropertyModifierTypeDescriptionDefined in
httpClientreadonlyClient<paths, `${string}/${string}`>Internalodin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:90

Accessors​

apiKeys​

get apiKeys(): ApiKeyManager

API key management

Returns​

ApiKeyManager

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:271


auth​

get auth(): AuthManager

Authentication operations (login, profile)

Returns​

AuthManager

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:265


me​

get me(): ClientScope

The /client/v1 surface — everything a participant token may read about its own player. Only useful on a client constructed with participantToken; every other credential is rejected by these routes.

Returns​

ClientScope

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:259


pluginCatalog​

get pluginCatalog(): PluginCatalog

Global plugin catalog and annotations

Returns​

PluginCatalog

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:277

Methods​

generateToken()​

generateToken(body): Promise<object>

Generate an access token (legacy)

Parameters​

ParameterTypeDescription
bodyobjectToken generation payload
body.projectIdstringDescription The Project ID (API Key)
body.roomIdstringDescription The Room ID
body.secretstringDescription The Project Secret

Returns​

Promise<object>

Generated token

NameTypeDescriptionDefined in
tokenstringDescription The generated access tokenodin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2826

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:297


getRealtimeConnection()​

getRealtimeConnection(projectId?): RealtimeConnection

Internal

Parameters​

ParameterType
projectId?string

Returns​

RealtimeConnection

Implementation of​

ClientContext.getRealtimeConnection

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:223


handleError()​

handleError(operation, error): never

Internal

Parameters​

ParameterType
operationstring
errorunknown

Returns​

never

Implementation of​

ClientContext.handleError

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:178


healthCheck()​

healthCheck(): Promise<void>

Health check

Returns​

Promise<void>

void — confirms the API is running

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:287


openEventStream()​

openEventStream(projectId, signal): Promise<ReadableStream<Uint8Array>>

Internal

Open a raw event stream for a project (or tenant-wide when projectId is omitted). Streams through the authenticated openapi-fetch client so all auth middleware (API key / Bearer / HMAC) applies. Throws a Cortex*Error on a non-OK response.

Parameters​

ParameterType
projectIdundefined | string
signalAbortSignal

Returns​

Promise<ReadableStream<Uint8Array>>

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:191


project()​

project(projectId): ProjectScope

Scope all project-specific resources to a single project. Returns a new ProjectScope each time (stateless, cheap).

Parameters​

ParameterTypeDescription
projectIdstringProject ID

Returns​

ProjectScope

ProjectScope with access to all project-scoped resource managers

Defined in​

odin-transcription-service/packages/cortex-typescript-sdk/src/client.ts:247