Class AgentsResource

AI Agents — dispatch a deployed agent into a room (optionally placing an outbound SIP call). Manage cloud deployments via vsdk.agents.deployment.

Index

Constructors

Properties

Methods

connect deploy dispatch generalDispatch

Constructors

constructor

new AgentsResource(http: HttpClient): AgentsResource
Parameters
- http: HttpClient
Returns AgentsResource

Properties

`Readonly`deployment

deployment: AgentDeploymentResource

Cloud agent deployments.

Methods

connect

connect(options: DispatchAgentOptions): Promise<DispatchResult>
Alias of AgentsResource.dispatch.
Parameters
- options: DispatchAgentOptions
Returns Promise<DispatchResult>

deploy

deploy(options: DeployAgentOptions): Promise<DeployedAgent>
Deploy a pre-built agent image. In a single call this creates the deployment and its (auto-activated) version, plus — when env is set — a secret holding those environment variables.

Returns the deployment (.id) enriched with the created version and secretId.

If a later step fails, an earlier artifact (e.g. the deployment) may already exist — clean up with AgentDeploymentResource.delete.
Parameters
- options: DeployAgentOptions
Returns Promise<DeployedAgent>

dispatch

dispatch(options: DispatchAgentOptions): Promise<DispatchResult>
Dispatch an agent into a room.
Parameters
- options: DispatchAgentOptions
Returns Promise<DispatchResult>

generalDispatch

generalDispatch(options: GeneralDispatchAgentOptions): Promise<DispatchResult>
Dispatch a managed/low-code agent (requires versionId).
Parameters
- options: GeneralDispatchAgentOptions
Returns Promise<DispatchResult>