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.
Continue a conversation session with an Agent, or add the first exchange to a session after creation.
Adds a new exchange to the session with the provided inputs, and generates a response from the Agent.
Blocks on returning the result of the added exchange until the response is fully generated.
Streamed responses are also supported; see streamingContinue for details.
Concurrent requests to continue the same session are not supported.
Clients should wait to receive a response before sending the next message.
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.
objectobjectThe user message for the Agent to respond to.
map<ParameterId, ParameterValue>Any supplied parameter values to pass to the Agent for the exchange.
list<InputContext>If set, automatic context retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session.
objectThe result of the added exchange for 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.
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/blockingContinue?preview=true" \
-d '{"userInput":{"text":"What is the status of my order?"}}'1
2
3
4
5
{
"totalTokensUsed": 6448,
"agentMarkdownResponse": "The status of your order is **In Transit**.",
"interruptedOutput": false
}