Search documentation
karat

+

K

User Documentation ↗

List Agent Versions

GET/api/v2/aipAgents/agents/{agentRid}/agentVersions
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

List all versions for an AIP Agent. Versions are returned in descending order, by most recent versions first.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:aip-agents-read.

Path parameters

agentRid
string

An RID identifying an AIP Agent created in AIP Agent Studio.

Query parameters

pageSize
integer
optional

The page size to use for the endpoint.

pageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

preview
boolean
optional

Enables the use of preview functionality.

Response body

ListAgentVersionsResponse
object
Hide child attributes

Hide child attributes

data
list<AgentVersion>
optional
Show child attributes

Show child attributes

AgentVersion
object
Show child attributes

Show child attributes

string
string

The semantic version of the Agent, formatted as "majorVersion.minorVersion".

version
object

Semantic version details of the Agent.

Show child attributes

Show child attributes

major
integer

The major version of the Agent. Incremented every time the Agent is published.

minor
integer

The minor version of the Agent. Incremented every time the Agent is saved.

nextPageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/agentVersions?pageSize=100&pageToken=v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z&preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 { "data": [ { "string": "1.0", "version": { "major": 1, "minor": 2 } } ], "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z" }