Version 2.0

Get Chatbot Studio 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 a Chatbot Studio 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 a Chatbot Studio Agent created in AIP Chatbot Studio.

agentVersionString

string

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

Query parameters

preview

booleanoptional

Enables the use of preview functionality.

Response body

AgentVersion

object

Hide child attributes

string

string

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

version

object

Semantic version details of the Chatbot Studio Agent.

Show child attributes

Examples

Request

Copied!

curl \
\t-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
  }
}

Error responses

Error Name
`InvalidAgentVersion`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The provided version string is not a valid format for a Chatbot Studio Agent version.
	Parameters	`agentRid, version`
`NoPublishedAgentVersion`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	Failed to retrieve the latest published version of the Chatbot Studio Agent because the Chatbot Studio Agent has no published versions. Try publishing the Chatbot Studio Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Chatbot Studio Agent to use.
	Parameters	`agentRid`
`AgentVersionNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given AgentVersion could not be found.
	Parameters	`agentRid, agentVersionString`
`AgentNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Agent could not be found.
	Parameters	`agentRid`

See Errors for a general overview of errors in the platform.