Method: brands.agents.requestLaunch

  • An agent becomes available to users after it launches.

  • An agent can only have one active launch instance at a time.

  • The requestLaunch method initiates the launch process for an agent.

  • The request requires the unique identifier of the agent in the name parameter.

  • The request body includes the agentLaunch object to define the launch details.

Begins the launch process for an agent. An agent is available to users after it launches. An agent can only have one instance of launch at a time.

HTTP request

POST https://businesscommunications.googleapis.com/v1/{name=brands/*/agents/*}:requestLaunch

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The unique identifier of the agent. If the brand identifier is "1234" and the agent identifier is "5678", this parameter resolves to "brands/1234/agents/5678".

Request body

The request body contains data with the following structure:

JSON representation 
{
  "agentLaunch": {
    object (AgentLaunch)
  }
}
Fields
agentLaunch

object (AgentLaunch)

Required. The agent launch to create. Name and Launch status are ignored.

Response body

If successful, the response body contains an instance of AgentLaunch.