Interface ILiveKitAgentDispatchService

Namespace

LiveKit.Services

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

Service for managing agent dispatches to rooms.

Provides methods for dispatching AI agents to rooms based on room configuration or on-demand. See Agent Dispatch Documentation for more information.

public interface ILiveKitAgentDispatchService

Methods

CreateDispatchAsync(CreateAgentDispatchRequest, CancellationToken)

Creates a new agent dispatch for a room.

Task<AgentDispatch> CreateDispatchAsync(CreateAgentDispatchRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateAgentDispatchRequest

cancellationToken CancellationToken

Returns

Task<AgentDispatch>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

DeleteDispatchAsync(DeleteAgentDispatchRequest, CancellationToken)

Deletes an agent dispatch.

Task<AgentDispatch> DeleteDispatchAsync(DeleteAgentDispatchRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteAgentDispatchRequest

cancellationToken CancellationToken

Returns

Task<AgentDispatch>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

ListDispatchAsync(ListAgentDispatchRequest, CancellationToken)

Lists agent dispatches for a room.

Task<ListAgentDispatchResponse> ListDispatchAsync(ListAgentDispatchRequest request, CancellationToken cancellationToken = default)

Parameters

request ListAgentDispatchRequest

cancellationToken CancellationToken

Returns

Task<ListAgentDispatchResponse>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.