Stream agent response (v2)

curl --request POST \
  --url https://rest-api.captide.co/api/v2/rag/agent-response-stream \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "query": "<string>",
  "documentIds": "<string>"
}
'

{
  "detail": "<string>"
}

Agentic RAG

Agent Response (Stream)

Streams cited Markdown responses, sourced exclusively from corporate disclosures, as server-sent events in response to natural language queries. This endpoint provides real-time streaming of AI-generated answers, making it ideal for interactive chat interfaces where users can see responses as they’re generated.

Server-Sent Events (SSE) Structure:

data: {"type": "thinking", ...} - Agent’s thinking process with stage information
- data: {"type": "thinking", "role": "assistant", "content": "...", "stage": "search"}
data: {"type": "message", ...} - Response content chunks
- data: {"type": "message", "role": "assistant", "content": "..."}
data: {"type": "warning", ...} - Warning when no documents found
- data: {"type": "warning", "message": "..."}
data: {"type": "sources", ...} - Source document information
- data: {"type": "sources", "content": {"#ref_id": {"content": "...", "pageNumber": 123, "excerpt": "...", "documentMetadata": {"id": "...", "title": "...", "documentCategory": "...", "formType": "...", "tickers": ["..."], "companyName": "...", "date": "...", "fiscalQuarter": 1, "fiscalYear": 2025}}}}} - Document sources and citations
- data: {"type": "sources", "content": {"#ref_id": {"content": "...", "pageNumber": 123, "excerpt": null, "documentMetadata": {"id": "...", "title": "...", "documentCategory": "...", "formType": "...", "tickers": ["..."], "companyName": "...", "date": "...", "fiscalQuarter": 1, "fiscalYear": 2025}}}}} - Document sources and citations (with null excerpt, often given before agent response)
data: {"type": "done"} - Stream completion
- data: {"type": "done"}

This v2 endpoint supports newer document categories in source mappings (e.g., earnings-presentation, investor-event-presentation, shareholder-meeting-circular, etc.). Agent response quality is exactly the same compared to v1.

POST

api

rag

agent-response-stream

Stream agent response (v2)

curl --request POST \
  --url https://rest-api.captide.co/api/v2/rag/agent-response-stream \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "query": "<string>",
  "documentIds": "<string>"
}
'

{
  "detail": "<string>"
}

Authorizations

X-API-Key

string

header

required

Body

application/json

Request model for agent queries.

query

string

required

The natural language query

Minimum string length: 1

documentIds

string | null

Comma-separated string of document file IDs. If provided and non-empty, skips document and company selection and goes directly to retrieval.

Response

Stream started successfully

Agent Response