Base URL
Endpoints
Minimal Query
mode: "basic" and effort: "medium". It returns rendered evidence, evidence_instructions, evidence_budget, and summary by default.
Response Shape
/query returns a response with a stable request_id and optional top-level sections:
| Section | Contains |
|---|---|
evidence | Grounding text selected by include.evidence_format; rendered evidence includes a source-key footer, while XML evidence omits it. |
evidence_instructions | Guidance for downstream LLMs on how to use the returned evidence. Returned by default when evidence is included. |
agent_context | Derived Markdown context block for direct handoff to another LLM or agent. |
metadata_distribution | Metadata distribution keyed by canonical field names, with readable display names and metric values inside each entry. |
metadata_dashboard | Rendered ASCII summary of the metadata distribution. |
summary | Selected mode, effort, filters, warnings, and evidence-path count. |
coverage | Task-aware requirement coverage for agentic_research, including missing or budget-omitted inputs. |
evidence_budget | Deterministic evidence token estimate, optional requested cap, available and returned chain counts, and truncation status. |
retrieval_plan | Retrieval query plan for agentic_research. |
Example Response Sections
Responses always includerequest_id. By default, /query returns rendered evidence, evidence_instructions, evidence_budget, and summary. Other top-level sections are returned when enabled by include or by the selected query mode. The examples below are abbreviated to show their structure.
request_id
evidence
The API returns evidence as a string. With evidence_format: "rendered", the formatted evidence includes a trailing <source_key> quick reference. relevance_score is a system-derived integer from 0 to 10 that indicates how closely the evidence chain matches the query. confidence_score reflects the system’s confidence in the specific fact captured by that entry. An entry can cite multiple sources: all cited sources support the shared <consensus> claim, while each source can contribute distinct <observed_epistemic_statuses> and <additional_context>.
Returned JSON field:
evidence_instructions
evidence_instructions is returned by default when evidence is included. This top-level string contains guidance for how a downstream LLM should use the returned evidence to generate a grounded answer. It is separate from the evidence content itself. Set include.evidence_instructions to false to omit it.
agent_context
Set include.agent_context to true to return agent_context. This top-level object is intended for direct handoff to another LLM or agent. It is a derived convenience payload, not the canonical evidence contract. Clients building custom prompts or UIs should use evidence and evidence_instructions directly.
Request agent_context without duplicating the raw top-level evidence fields:
content_type is currently always "text/markdown". text combines the evidence-use instructions with the selected evidence format. With evidence_format: "rendered", the context includes rendered evidence; with evidence_format: "xml", it includes XML evidence with the same public XML formatting behavior as top-level evidence. For agentic_research, the context also contains the coverage assessment and source_fields includes "coverage".
metadata_distribution
This abbreviated example shows two distribution metrics keyed by canonical field names. evidence_paths is the evidence-path count. Metric entries include display_name plus values for distributions, or value for text summaries. The ... entry marks omitted metrics and is not returned literally.
metadata_dashboard
The API returns metadata_dashboard as a string.
Returned JSON field:
summary
coverage
coverage is returned for agentic_research. It compares the independently required retrieval inputs with the evidence chains actually delivered to the caller.
complete, partial, none, or not_assessed. Requirement status is covered, missing, or omitted_by_budget. Coverage means at least one complete delivered chain is associated with each planned requirement; it does not independently verify the contents of that chain.
evidence_budget
evidence_budget is returned whenever evidence or agent_context is requested. requested_max_tokens is null when no token cap was supplied, which is the default.
retrieval.max_evidence_tokens. The estimator is ceil(projected evidence characters / 4) and is not provider-exact. Budgeting keeps complete chains and includes their regenerated source registry in the estimate.