Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Create Or Update Deployments

Create a new deployment for an agent

post/v1/convai/agents/{agent_id}/deployments

Path parameters

agent_idstring required

The id of an agent. This is returned on agent creation.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

The id of an agent. This is returned on agent creation.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

Example request

{
  "deployment_request": {
    "requests": [
      {
        "branch_id": "agtbrch_8901k4t9z5defmb8vh3e9361y7nj",
        "deployment_strategy": {
          "traffic_percentage": 0.5,
          "type": "percentage"
        }
      }
    ]
  }
}

Response

Successful Response

traffic_percentage_branch_id_mapobject

Map of branch IDs to traffic percentages

Example response

{
  "traffic_percentage_branch_id_map": {
    "agtbrch_8901k4t9z5defmb8vh3e9361y7nj": 0.5
  }
}