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 an AIP Agent.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:aip-agents-read.
stringAn RID identifying an AIP Agent created in AIP Agent Studio.
stringThe version of the Agent to retrieve. If not specified, the latest published version will be returned.
booleanEnables the use of preview functionality.
objectstringAn RID identifying an AIP Agent created in AIP Agent Studio.
stringThe version of this instance of the Agent.
objectMetadata for an Agent.
stringThe name of the Agent.
stringThe description for the Agent.
stringThe default text to show as the placeholder input for chats with the Agent.
list<string>Prompts to show to the user as example messages to start a conversation with the Agent.
map<ParameterId, Parameter>The types and names of parameters configured for the Agent in AIP Agent Studio. Parameters are variables in the prompt sent to an Agent that can be used to customize and control the behavior of the Agent.
stringThe unique identifier for a parameter, as configured in AIP Agent Studio.
objectA parameter configured for an Agent in AIP Agent Studio.
unionDetails of the types of values accepted and defaults for this parameter.
objectstringThe default value to use for this parameter.
objectlist<ObjectTypeId>The types of objects that are expected in ObjectSet values passed for this parameter.
stringThe unique identifier (ID) for an object type. This can be viewed in Ontology Manager.
string (enum)The access mode controls how the Agent is able to interact with the parameter.
Enum values: READ_ONLY, READ_WRITE
stringA description to explain the use of this parameter. This description is injected with the parameter value into the Agent's prompt, to provide context for when to use the parameter.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1?preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"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."
}
}
}