curl.
1. Set Your API Key
Set your key as an environment variable:X-API-Key header.
2. Send a Query
Send a natural-language question to the/query endpoint:
mode: "basic" and effort: "medium".
3. Read the Response
A successful default response includes arequest_id, rendered evidence, evidence_instructions, and summary. It does not include answer unless you opt in to answer generation.
summary.evidence_count is the number of retrieved evidence paths used as grounding for the response. It is not a count of SEC filings; one evidence path can include multiple filing statements.
To request a generated answer from the API, set include.answer to true:
answer.text.
4. Discover Metadata Filters
UseGET /metadata-filters to inspect the supported metadata-filter fields, operators, limits, and optional categorical values.
By default, research and agentic_research attempt to infer relevant metadata filters from the natural-language query. You can also provide metadata_filters explicitly when you know exact constraints, such as sec_ticker, sec_form_type, sec_fiscal_year, or sec_item_tag. Caller-provided metadata filters are treated as constraints, and the API may add filters inferred from the query.
5. Send a Query with Metadata Filters
Useresearch or agentic_research when you pass metadata filters. basic mode rejects non-empty metadata filters.