Ask Stream

Stream AI response for the given input.

This endpoint accepts a conversational input and streams the AI-generated
response in chunks as they become available.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Takes a conversational input and streams the agent's answer in chunks as they become available.

When to use it

Use it when your application shows the answer while it is generated, such as a chat interface. For one complete response, use Ask an agent.

Required parameters

  • id (path): the application worker ID of the agent.

When the agent has authentication enabled, pass its API token in the x-api-token header.

Response

A successful call returns 200 OK and streams the answer. The stream format is not documented.

Related: Ask an agent, Send feedback on an agent answer, Stream a playground answer

Path Params
string
required

Application worker ID

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Bad Request

500

Internal Server Error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json