Agentic Answer (Streaming)

Same retrieval pipeline as POST /answer, but streams the GPT-4o response token-by-token via Server-Sent Events.

Filtering options (mutually exclusive; most specific wins):

• accession_number — pin to a single SEC filing
• transcript_doc_id — pin to a single earnings call transcript
• exhibit_doc_id — pin to a single press release or investor exhibit
• cik / company_name — scope to all filings for a company

When a document-scope filter is set, web/news retrieval is skipped.

Event types (each line: data: <JSON>):

• {"type": "sources", "sources": [...]} — emitted first, before any tokens
• {"type": "token", "token": "..."} — one per GPT-4o output token
• {"type": "done"} — signals end of stream
• {"type": "error", "detail": "..."} — if something goes wrong mid-stream

Set Accept: text/event-stream and read the response as an SSE stream.

POST /v1/rag/answer/stream

Agentic LLM response (streaming)

cURL

curl --request POST \
  --url https://api.ivory.finance/v1/rag/answer/stream \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "query": "<string>",
  "company_name": "<string>",
  "cik": "<string>",
  "accession_number": "<string>",
  "transcript_doc_id": "<string>",
  "exhibit_doc_id": "<string>",
  "llm_provider": "bedrock",
  "llm_model": "deepseek.v3.2"
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key · string · header · required

Body

application/json

query · string · required

company_name · string | null

cik · string | null

accession_number · string | null

transcript_doc_id · string | null

exhibit_doc_id · string | null

llm_provider · string · default: bedrock

llm_model · string · default: deepseek.v3.2

Response

200

Successful Response