Struct AgentDispatchClient 

pub struct AgentDispatchClient { /* private fields */ }

Implementations

impl AgentDispatchClient

pub fn with_api_key(host: &str, api_key: &str, api_secret: &str) -> Self

Authenticates with an API key and secret, signing a short-lived token per request.

pub fn with_token(host: &str, token: &str) -> Self

Authenticates with a pre-signed token, sent verbatim on every request.

pub fn new(host: &str) -> ServiceResult<Self>

Reads the API key and secret from the LIVEKIT_API_KEY and LIVEKIT_API_SECRET environment variables.

pub fn with_failover(self, enabled: bool) -> Self

Enables or disables region failover (enabled by default). Failover only engages for LiveKit Cloud hosts.

pub fn with_request_timeout(self, timeout: Duration) -> Self

Overrides the default per-request timeout (10s) for calls on this client.

pub async fn create_dispatch( &self, req: CreateAgentDispatchRequest, ) -> ServiceResult<AgentDispatch>

Creates an explicit dispatch for an agent to join a room.

To use explicit dispatch, your agent must be registered with an agent_name.

Arguments

• req - Request containing dispatch creation parameters. The request can include an optional deployment field to target a specific agent deployment. Leave empty to target the production deployment.

Returns

The created agent dispatch object

pub async fn delete_dispatch( &self, dispatch_id: impl Into<String>, room_name: impl Into<String>, ) -> ServiceResult<AgentDispatch>

Deletes an explicit dispatch for an agent in a room.

Arguments

• dispatch_id - ID of the dispatch to delete
• room_name - Name of the room containing the dispatch

Returns

The deleted agent dispatch object

pub async fn list_dispatch( &self, room_name: impl Into<String>, ) -> ServiceResult<Vec<AgentDispatch>>

Lists all agent dispatches in a room.

Arguments

• room_name - Name of the room to list dispatches from

Returns

List of dispatch objects in the room

pub async fn get_dispatch( &self, dispatch_id: impl Into<String>, room_name: impl Into<String>, ) -> ServiceResult<Option<AgentDispatch>>

Gets an agent dispatch by ID.

Arguments

• dispatch_id - ID of the dispatch to retrieve
• room_name - Name of the room containing the dispatch

Returns

Requested dispatch object if found, None otherwise

Trait Implementations

impl Debug for AgentDispatchClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.