Agents Platform

List Agent Deployments

List the traffic split history of an agent, newest first

get/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.

Query parameters

pageinteger

Page number, starting at 1

Page number, starting at 1

page_sizeinteger

How many results at most should be returned

How many results at most should be returned

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.

Response

Successful Response

Example response

{
  "results": [
    {
      "traffic_percentage_branch_id_map": {
        "agtbrch_8901k4t9z5defmb8vh3e9361y7nj": 50
      },
      "access_info": {
        "access_source": "creator",
        "creator_email": "john.doe@example.com",
        "creator_name": "John Doe",
        "is_creator": true,
        "role": "admin"
      }
    }
  ]
}

Changes

Changed in 1 of the 55 revisions of this API.1