The Pieces Copilot (QGPT) streaming channel. The client opens this
on-device WebSocket and sends question and/or relevance input; the server
streams incremental answer chunks back until the exchange completes.
Send a question and/or relevance payload to the on-device QGPT engine.
subscribe
receiveQGPTStreamOutput
Receive streamed Copilot answer chunks from the on-device QGPT engine.
Messages
QGPTStreamInput
Client-to-server message carrying a question and/or relevance payload.
Content-Type: application/json
QGPTStreamOutput
Server-to-client streamed answer chunk.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.