Abort a stream
/ai/streams/{streamId}/stopThe inflight provider call may run a moment longer until the abort marker is observed. The assistant message that gets saved at the end of the message-POST may still contain partial content.
Authorization
apiKey Issued to you when your integration is provisioned. Determines which catalogue resources are visible and which AI tools are available.
In: header
Path Parameters
Response Body
application/json
curl -X POST "https://example.com/ai/streams/string/stop"{ "success": true, "status": "success", "message": "Success", "data": {}}Initialise a stream POST
Creates a stream bound to a chat. Pass the returned `streamId` on `POST /ai/chats/{ref}/messages` and poll `GET /ai/streams/{streamId}` from a separate connection. Note: the message POST is synchronous and won't release until the AI finishes. Polling **must** happen on a different connection (a separate thread / async task in your client).
Remove a resource from a collection DELETE
Removes the resource from the collection (the resource itself is untouched). Requires the `write` scope and modify access to the collection. Returns 404 when the resource is not in the collection, so retries of an already-applied delete fail loudly rather than silently — treat 404 after a retry as "already removed".