We’re making an important update to how Agent Builder invocation responses are structured. This change improves flexibility for future enhancements and ensures consistency across all endpoints.
We don’t expect this update to impact most users, but we’re sharing details so you can confirm your integrations continue to work as expected. These updates will go live within the next few days — by Monday at the latest.
What’s Changing
Non-Streaming Endpoints
Response objects are being simplified.
Previously, responses were wrapped in a response parent field with a list of choices.
Now, the response root has been removed, and choices has been replaced with an output array that contains either TextOutput or ToolOutput items.
The customOutputs field remains the same, now located at the root level.
Example response:
{ "createdAt": 1741705447, "model": "amazon.nova-micro-v1:0", "object": "response", "output": [ { "content": [ { "text": "Detailed information about the company's sick leave policy...", "type": "text" } ], "role": "assistant", "status": "completed", "type": "message" }, { "type": "function_call", "status": "completed", "arguments": "{\"a\": 5, \"b\": 5}", "callId": "tooluse_gRPgrZ4XRxaUN2L2xXR6ZA", "name": "multiply" } ], "customOutputs": { "ragMode": "normal", "sourceNodes": [ { "chunkId": "b9f622c9-7a62-46fc-8cf1-0d1f4d3c35d7", "id": "1d2da9c7-56f1-46a2-b308-07c9e58fbc1a", "objectId": "6e4a7f58-13f1-4d3f-83b9-ec86c5b7df60", "score": 0.95, "text": "<source-text>" } ] } }
OnBase AI Agent Interaction Client
If you are using the AI Agent Interaction Client in your OnBase solution, you will need to upgrade the script. Please download the most current file here.
Streaming Endpoints
If you’re using streaming endpoints — which we believe most users aren’t yet — please note that the structure has changed significantly.
Streaming now includes clear “start” and “end” events (CreatedChunk and CompletedChunk) with a response id to link chunks together. Any sourceNodes will appear in customOutputs on the completed chunk.
Example (simplified):
{"type": "response.created", "response": {"id": "2a7e7893-ee4e-4171-874d-80904a223157"}} {"type": "response.output_text.delta", "delta": "Here is the result of multipl"} {"type": "response.function_call_arguments.done", "arguments": "{\"a\":5,\"b\":5}", "name": "multiply"} {"type": "response.output_text.delta", "delta": "5 x 5 = 25"} {"type": "response.completed", "response": {"id": "2a7e7893-ee4e-4171-874d-80904a223157"}}
Looking Ahead
We’re introducing versioning for endpoints going forward, so this should be the last time you’ll experience a breaking change. Future updates will be released as new versions, allowing for smooth transitions.
If you experience any issues or need clarification, please reach out via your usual support channels or community thread.
