API Reference

Get Agent Version

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

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.

Get version details for an AIP Agent.

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.

agentVersionString

string

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

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Response body

AgentVersion

object

Hide 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

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.

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/agentVersions/1.0?preview=true"

Response

Copied!

{
  "string": "1.0",
  "version": {
    "major": 1,
    "minor": 2
  }
}