Skip to main content
Retrieve filing passages that are conceptually related to a finance question, with hybrid keyword and vector retrieval plus source citation fields on every result row.
Audience: application and coding agent.

Citation fields

Every result row carries seven additive top-level fields: When the validator can’t produce a span (no section text, no query-term match, or offsets out of bounds), char_start/char_end/highlighted_snippet drop to null and _citation_degraded records the reason. Identity fields (accession, section_key, source_url, ticker) are always populated when known. See api conventions → citation + char-range spans for the full contract.

Retrieval and scope

q is required. mode=hybrid is the default and combines keyword and vector retrieval; use keyword or semantic only when intentionally comparing retrieval behavior. Narrow the candidate set with one issuer identifier, form, or filing_year before asking a narrowly scoped question. The result is evidence discovery, not an answer or investment conclusion. Use source_url, accession, section_key, and character offsets to let a downstream reader verify the cited passage in context.

Semantic risk-factor tutorial

Build a source-cited risk-factor retrieval workflow.

Semantic search API guide

Compare query framing and retrieval modes.

Agent mode

Pass ?view=agent to drop score and retrievalMode from each row. The seven citation fields are preserved unconditionally. See api conventions → response formats for the full ?view= contract.

Canonical metadata

  • requestId
  • traceparent

Example request

Example response

About this example

This response uses a synthetic issuer, accession, and example.com URL to illustrate the citation envelope. It does not identify or quote a live SEC filing.

Give this prompt to your agent

Failure posture

  • use only keyword, semantic, or hybrid for mode; invalid values return accepted values in the validation details
  • send ticker or its symbol alias, not conflicting values for both
  • treat missing or degraded citation spans as a reason to verify the linked source, not to fabricate a quote
  • preserve requestId and traceparent when retrying a transient failure