Build on your research workspace.

Endpoints and access

• GET /api/v1/usage — plan, used, limit, remaining and resetAt for your workspace.
• GET /api/v1/reports?page=1&q=company — saved reports, 20 per page. Returns reports, total, page and pages. A report contains id, query, answer, tools and created_at.
• GET /api/v1/reports/:id — read one saved report by ID. Returns report and financialStatements, with separate datasets, five-year period columns, every returned field, reporting metadata and coverage warnings. Requires a valid read or research key for the report’s workspace.
• POST /api/v1/research — JSON with a query of 3–3,000 characters. Requires a key with research access. Returns a server-sent event stream.

Research events

Read status, text and tool_result events as they arrive. The final complete event contains id and charged. An error event means the request did not complete; do not treat partial text as a completed report. A request without a verified financial tool result emits an error and is not charged.

Usage and security

Platform and workspace API research share your plan’s allowance. Read requests do not consume searches. Keys expire after 30, 90 or 365 days and can be revoked by a workspace owner or admin. Each key is limited to 60 requests per minute; a 429 response can also indicate a depleted monthly allowance.

Keep the key on your server, never in public browser code. A 401 response indicates a missing, invalid, revoked or expired key. A 403 response indicates insufficient scope. A 502 or 503 response indicates a temporary service problem.