Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Get Agent Version Metadata

Get metadata for a specific agent version

get/v1/convai/agents/{agent_id}/versions/{version_id}

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.

version_idstring required

Unique identifier for the version.

Example:agtvrsn_0901k4aafjxxfxt93gd841r7tv5t

Unique identifier for the version.

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

idstring required
agent_idstring required
branch_idstring required
version_descriptionstring required
seq_no_in_branchinteger required
time_committed_secsinteger required

Example response

{
  "access_info": {
    "access_source": "creator",
    "creator_email": "john.doe@example.com",
    "creator_name": "John Doe",
    "is_creator": true,
    "role": "admin"
  }
}