Object Tools
Connect to tool output stream (WebSocket)
Changed onWebSocket endpoint for receiving streaming output from an object tool execution. The token is obtained from POST /v1/object-tools/{tool-id}/execute with stream=true. Token is single-use and expires after 30 seconds. Tool execution starts when the connection is established; if client does not connect within token validity period, tool execution is cancelled.
Server sends JSON text frames:
- {"type":"output","data":"..."} - output chunk
- {"type":"result","data":"..."} - script return value (server-script tools only)
- {"type":"completed"} - execution finished successfully
- {"type":"error","message":"..."} - execution failed
Server closes the connection after completed or error message.
get/v1/object-tools/output/{token}
Request
- Base URLhttp://127.0.0.1:8000
- URLhttp://127.0.0.1:8000/v1/object-tools/output/{token}
- Authnone required
Path parameters
tokenstring uuid required
Single-use token from the streaming execute response
Changes
- info
added the non-success response with the status
- info
- info
api operation id
connectObjectToolOutputwas added
- info