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.
Cancel an in-progress streamed exchange with an Agent which was initiated with streamingContinue.
Canceling an exchange allows clients to prevent the exchange from being added to the session, or to provide a response to replace the Agent-generated response.
Note that canceling an exchange does not terminate the stream returned by streamingContinue; clients should close the stream on triggering the cancellation request to stop reading from the stream.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:aip-agents-write.
stringAn RID identifying an AIP Agent created in AIP Agent Studio.
stringThe Resource Identifier (RID) of the conversation session.
objectstringThe identifier for the in-progress exchange to cancel.
This should match the messageId which was provided when initiating the exchange with streamingContinue.
stringWhen specified, the exchange is added to the session with the client-provided response as the result. When omitted, the exchange is not added to the session.
objectobjectIf the response field was specified, this returns the result that was added to the session for the canceled exchange, with the client-provided response.
If no response was specified in the request, this returns an empty response, as no exchange was added to the session.
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
4
5
curl -X POST \
-H "Content-type: application/json" \
-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/cancel?preview=true" \
-d '{"response":"The status of your order is **In Transit**.","messageId":"00f8412a-c29d-4063-a417-8052825285a5"}'1
2
3
4
5
6
7
{
"result": {
"totalTokensUsed": 6448,
"agentMarkdownResponse": "The status of your order is **In Transit**.",
"interruptedOutput": false
}
}