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 the conversation content for a session between the calling user and an 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 Resource Identifier (RID) of the conversation session.
objectlist<SessionExchange>The conversation history for the session, represented as a list of exchanges. Each exchange represents an initiating message from the user and the Agent's response. Exchanges are returned in chronological order, starting with the first exchange.
objectRepresents an individual exchange between a user and an Agent in a conversation session.
objectThe user message that initiated the exchange.
stringThe user message text.
objectAdditional retrieved context that was included in the prompt to the Agent. This may include context that was passed by the client with the user input, or relevant context that was automatically retrieved and added based on available data sources configured on the Agent. Empty if no additional context was included in the prompt.
list<ObjectContext>Relevant object context for the user's message that was included in the prompt to the Agent.
objectDetails of relevant retrieved object instances for a user's message to include as additional context in the prompt to the Agent.
list<ObjectRid>The RIDs of the relevant object instances to include in the prompt.
stringThe Resource Identifier (RID) for an ontology object instance.
list<PropertyTypeRid>The RIDs of the property types for the given objects to include in the prompt.
stringThe RID for a property type from an ontology object.
objectThe final result for the exchange.
stringThe final text response generated by the Agent. Responses are formatted using markdown.
map<ParameterId, ParameterValueUpdate>Any updates to parameters which were generated by the Agent for this exchange.
Updates can only be generated for parameter values that were provided as input to the Agent and that are configured with READ_WRITE access on the Agent in AIP Agent Studio.
stringThe unique identifier for a parameter, as configured in AIP Agent Studio.
unionA value update for a parameter which was generated by the Agent.
For StringParameter parameter types, this will be the updated string value.
For ObjectSetParameter parameter types, this will be a Resource Identifier (RID) for the updated object set.
objectA value passed for StringParameter parameter types.
stringobjectstringThe Resource Identifier (RID) for an object set.
integerTotal tokens used to compute the result. Omitted if token usage information is not supported by the model used for the session.
booleanTrue if the exchange was canceled. In that case, the response (if any) was provided by the client as part of the cancellation request rather than by the Agent.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/sessions/ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6/content?preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
"exchanges": [
{
"result": {
"totalTokensUsed": 6448,
"agentMarkdownResponse": "The status of your order is **In Transit**.",
"interruptedOutput": false
},
"userInput": {
"text": "What is the status of my order?"
},
"contexts": {
"objectContexts": [
{
"objectRids": [
"ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5"
],
"propertyTypeRids": [
"ri.ontology.main.property.7899aeb4-a389-4f2e-a0fd-e7193a4f6cb1"
]
}
]
}
}
]
}