eyevinn-ephtoken-svc

Namespace

eyevinn-ephtoken-svc

Description:
  • Seamlessly integrate with client-side apps by generating ephemeral API tokens for the OpenAI Realtime API. Simplify authentication and enhance security with this easy-to-install solution today!

Author:

Methods

(async, static) createEyevinnEphtokenSvcInstance(context, body) → {EyevinnEphtokenSvc}

Description:
  • Create a new Ephmeral Token Service instance

Example
import { Context } from '@osaas/client-core';
import { createEyevinnEphtokenSvcInstance } from '@osaas/client-services';

const ctx = new Context();
const body: EyevinnEphtokenSvcConfig = { name: 'myinstance', ... };
const instance = await createEyevinnEphtokenSvcInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

body EyevinnEphtokenSvcConfig

Service instance configuration

Returns:
  • Service instance
Type
EyevinnEphtokenSvc

(async, static) getEyevinnEphtokenSvcInstance(context, name) → {EyevinnEphtokenSvc}

Description:
  • Get a Ephmeral Token Service instance

Example
import { Context } from '@osaas/client-core';
import { getEyevinnEphtokenSvcInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getEyevinnEphtokenSvcInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the tokenservice to be retrieved

Returns:
  • Service instance
Type
EyevinnEphtokenSvc

(async, static) removeEyevinnEphtokenSvcInstance(context, name)

Description:
  • Remove a Ephmeral Token Service instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the tokenservice to be removed