Class AgentDispatchClient

Client to access Agent APIs

Hierarchy

ServiceBase
- AgentDispatchClient

Index

Constructors

Methods

authHeader createDispatch deleteDispatch getDispatch listDispatch

Constructors

constructor

new AgentDispatchClient(
    host: string,
    apiKey?: string,
    secret?: string,
    options?: ClientOptions,
): AgentDispatchClient
Parameters
- host: string
  hostname including protocol. i.e. 'https://.livekit.cloud'
- OptionalapiKey: string
  API Key, can be set in env var LIVEKIT_API_KEY
- Optionalsecret: string
  API Secret, can be set in env var LIVEKIT_API_SECRET
- Optionaloptions: ClientOptions
  client options
Returns AgentDispatchClient
Overrides ServiceBase.constructor
- Defined in packages/livekit-server-sdk/src/AgentDispatchClient.ts:35

Methods

authHeader

authHeader(grant: VideoGrant, sip?: SIPGrant): Promise<Record<string, string>>
Parameters
- grant: VideoGrant
- Optionalsip: SIPGrant
Returns Promise<Record<string, string>>
Inherited from ServiceBase.authHeader
- Defined in packages/livekit-server-sdk/src/ServiceBase.ts:28

createDispatch

createDispatch(
    roomName: string,
    agentName: string,
    options?: CreateDispatchOptions,
): Promise<AgentDispatch>
Create an explicit dispatch for an agent to join a room. To use explicit dispatch, your agent must be registered with an agentName.
Parameters
- roomName: string
  name of the room to dispatch to
- agentName: string
  name of the agent to dispatch
- Optionaloptions: CreateDispatchOptions
  optional metadata to send along with the dispatch
Returns Promise<AgentDispatch>
the dispatch that was created
- Defined in packages/livekit-server-sdk/src/AgentDispatchClient.ts:51

deleteDispatch

deleteDispatch(dispatchId: string, roomName: string): Promise<void>
Delete an explicit dispatch for an agent in a room.
Parameters
- dispatchId: string
  id of the dispatch to delete
- roomName: string
  name of the room the dispatch is for
Returns Promise<void>
- Defined in packages/livekit-server-sdk/src/AgentDispatchClient.ts:75

getDispatch

getDispatch(
dispatchId: string,
roomName: string,
): Promise<undefined | AgentDispatch>
Get an Agent dispatch by ID
Parameters
- dispatchId: string
  id of the dispatch to get
- roomName: string
  name of the room the dispatch is for
Returns Promise<undefined | AgentDispatch>
the dispatch that was found, or undefined if not found
- Defined in packages/livekit-server-sdk/src/AgentDispatchClient.ts:94

listDispatch

listDispatch(roomName: string): Promise<AgentDispatch[]>
List all agent dispatches for a room
Parameters
- roomName: string
  name of the room to list dispatches for
Returns Promise<AgentDispatch[]>
the list of dispatches
- Defined in packages/livekit-server-sdk/src/AgentDispatchClient.ts:117