Skip to main content
POST
Run AutoRAG agent with streaming response

Authorizations

Authorization
string
header
required

Use a Bearer token for authentication. Submit the token using the Authorization header: Authorization: Bearer <token>.

Body

application/json
username
string
required
namespace
string
required
query
string
required
Example:

"What do llamas drink to cool themselves down?"

helperPrompt
string
Example:

"You're a prophet of the alpacalypse. Your task is to spit the word!"

model
string
provider
string
conversationId
string

Existing conversation to continue. Omit to start a new conversation; the id is returned on the run-started SSE event.

Response

SSE stream of AutoRAG execution events.

SSE event containing the execution plan. Event name is "plan".

steps
string[]
required

List of step descriptions that will be executed.

reasoning
string
required

The reasoning produced by the LLM when generating the plan.