Version 2.0

Get Chatbot Studio Agent

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

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

Query parameters

version

stringoptional

The version of the Chatbot Studio Agent to retrieve. If not specified, the latest published version will be returned.

preview

booleanoptional

Enables the use of preview functionality.

Response body

Agent

object

Hide child attributes

rid

string

An RID identifying a Chatbot Studio Agent created in AIP Chatbot Studio.

version

string

The version of this instance of the Chatbot Studio Agent.

metadata

object

Metadata for a Chatbot Studio Agent.

Show child attributes

parameters

map<ParameterId, Parameter>optional

The types and names of variables configured for the Chatbot Studio Agent in AIP Chatbot Studio in the application state. These variables can be used to send custom values in prompts sent to a Chatbot Studio Agent to customize and control the Chatbot Studio Agent's behavior.

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?preview=true"

Response

Copied!

{
  "metadata": {
    "displayName": "Supply Chain Support Agent",
    "suggestedPrompts": [
      "What is the status of my order?",
      "How do I track my shipment?"
    ],
    "description": "An intelligent assistant to help answer questions about supply chain operations.",
    "inputPlaceholder": "Ask about supply chain operations..."
  },
  "rid": "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1",
  "version": "1.0",
  "parameters": {
    "customerName": {
      "access": "READ_ONLY",
      "description": "The name of the customer to answer supply chain-related questions for."
    }
  }
}

Error responses

Error Name
`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`
`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`
`AgentNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Agent could not be found.
	Parameters	`agentRid`
`AgentVersionNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given AgentVersion could not be found.
	Parameters	`agentRid, agentVersionString`

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