# Agent Response
Source: https://docs.captide.ai/api-reference/endpoint/agent
POST /api/v2/rag/agent-response
Returns cited Markdown responses, sourced exclusively from corporate disclosures, in response to natural language queries.
This endpoint provides AI-generated answers with proper citations to source documents, making it ideal for building Q&A interfaces or research tools.
**Response Behavior:**
- When relevant documents are found: Returns an AI-generated response with citations in the `sourceMap` field
- When no relevant documents are found: Returns an informative message explaining why no documents were found, with an empty `sourceMap` field (HTTP 200 status)
This v2 endpoint supports newer document categories in source mappings (e.g., earnings-presentation, investor-event-presentation, shareholder-meeting-circular, etc.). Agent response quality is exactly the same compared to v1.
# Agent Response (Stream)
Source: https://docs.captide.ai/api-reference/endpoint/agent_stream
POST /api/v2/rag/agent-response-stream
Streams cited Markdown responses, sourced exclusively from corporate disclosures, as server-sent events in response to natural language queries. This endpoint provides real-time streaming of AI-generated answers, making it ideal for interactive chat interfaces where users can see responses as they're generated.
**Server-Sent Events (SSE) Structure:**
- **`data: {"type": "thinking", ...}`** - Agent's thinking process with stage information
- `data: {"type": "thinking", "role": "assistant", "content": "...", "stage": "search"}`
- **`data: {"type": "message", ...}`** - Response content chunks
- `data: {"type": "message", "role": "assistant", "content": "..."}`
- **`data: {"type": "warning", ...}`** - Warning when no documents found
- `data: {"type": "warning", "message": "..."}`
- **`data: {"type": "sources", ...}`** - Source document information
- `data: {"type": "sources", "content": {"#ref_id": {"content": "...", "pageNumber": 123, "excerpt": "...", "documentMetadata": {"id": "...", "title": "...", "documentCategory": "...", "formType": "...", "tickers": ["..."], "companyName": "...", "date": "...", "fiscalQuarter": 1, "fiscalYear": 2025}}}}}` - Document sources and citations
- `data: {"type": "sources", "content": {"#ref_id": {"content": "...", "pageNumber": 123, "excerpt": null, "documentMetadata": {"id": "...", "title": "...", "documentCategory": "...", "formType": "...", "tickers": ["..."], "companyName": "...", "date": "...", "fiscalQuarter": 1, "fiscalYear": 2025}}}}}` - Document sources and citations (with null excerpt, often given before agent response)
- **`data: {"type": "done"}`** - Stream completion
- `data: {"type": "done"}`
This v2 endpoint supports newer document categories in source mappings (e.g., earnings-presentation, investor-event-presentation, shareholder-meeting-circular, etc.). Agent response quality is exactly the same compared to v1.
# Chunk Retrieval
Source: https://docs.captide.ai/api-reference/endpoint/chunks
GET /api/v2/rag/chunks
Search for relevant document chunks based on a query. Under the hood, Captide's RAG system uses a combination of LLMs and vector databases to find the most relevant chunks of text from corporate disclosures that are most relevant to the query.
This endpoint returns chunks of text from corporate disclosures that are most relevant to the query, along with metadata about their source documents. This endpoint is useful for building search interfaces or retrieving specific content from documents.
This v2 endpoint supports newer document categories in source mappings (e.g., earnings-presentation, investor-event-presentation, shareholder-meeting-circular, etc.). Agent response quality is exactly the same compared to v1.
# Find Companies
Source: https://docs.captide.ai/api-reference/endpoint/companies
GET /api/v2/companies/list
Retrieves a list of companies from the Captide database that match user-specified parameters. The response includes key company information such as name, ticker symbol(s) with exchange suffixes, country of domicile, SEC filing status, and the unique company ID assigned by Captide.
# Company Retrieval
Source: https://docs.captide.ai/api-reference/endpoint/company_retrieval
POST /api/v2/rag/company-retrieval
Retrieves a list of companies from the Captide database based on a natural language query.
This endpoint uses Captide's RAG system to understand company names, tickers, or informal references
and returns matching companies with their full details.
**Example queries:**
- "Give me Estee Lauder and Louis Vuitton"
- "Show me Apple and Microsoft"
- "Find companies with tickers AAPL and MSFT"
This v2 endpoint is functionally identical to v1. It is provided for API version consistency.
# Find Documents
Source: https://docs.captide.ai/api-reference/endpoint/documents
GET /api/v1/documents/list
Retrieves a list of financial and corporate disclosures available in Captide that match user-specified parameters. The response includes key document metadata such as the associated company's ticker symbol(s), document type, release date, fiscal year and quarter, the Captide-assigned document ID, and the associated company ID.
# Get Company by ID
Source: https://docs.captide.ai/api-reference/endpoint/get_company
GET /api/v2/companies/{id}
Retrieves a single company from the Captide database by its unique ID. The response includes key company information such as name, ticker symbol(s) with exchange suffixes, country of domicile, and SEC filing status.
# Get Document by ID
Source: https://docs.captide.ai/api-reference/endpoint/get_document
GET /api/v2/documents/{id}
Fetch a document by its ID from the database, including company and ticker info.
This v2 endpoint includes several improvements over v1:
- Supports newer document categories (e.g., earnings-presentation, investor-event-presentation, shareholder-meeting-circular, etc.)
- Renamed fields: tickers → companyTickers, formType → secFormType
- Added fields: companyId, fiscalPeriod, language
# Search Company
Source: https://docs.captide.ai/api-reference/endpoint/search_company
GET /api/v2/companies/search
Type-ahead search for companies by name or ticker symbol. Intended for frontend autocomplete.
Matches company name (case-insensitive substring) or ticker symbol / ticker with exchange suffix (e.g. AAPL or AAPL.US).
# Introduction
Source: https://docs.captide.ai/api-reference/introduction
The Captide API unlocks **structured access to a rich corporate disclosure database**, powered by agentic AI systems. Designed for hedge funds, investment banks, and developers, it enables the creation of RAG-based applications with built-in source attribution.
## API Structure
Endpoints to access Captide’s company database and perform metadata-based screening.
`/api/v1/companies/list`\
Retrieves a list of companies from the Captide database that match user-specified parameters. The response includes key company information such as name, ticker symbol(s), country of domicile, SEC filing status, delisting status, and the unique company ID assigned by Captide.
`/api/v1/companies/{id}`\
Fetches a document by its ID from the database. The response includes key company information such as name, ticker symbol(s), country of domicile, SEC filing status, and delisting status.
Endpoints to access company disclosures in either PDF or LLM-optimized Markdown format.
`/api/v1/document/list`\
Retrieves a list of financial and corporate disclosures available in Captide that match user-specified parameters. The response includes key document metadata such as the associated company’s ticker symbol(s), document type, release date, fiscal year and quarter, the Captide-assigned document ID, and the associated company ID. Results are sorted by `documentDate` in descending order.
`/api/v1/documents/{id}`\
Fetches a document by its ID from the database. The response includes document metadata, associated company information, and the file URLs to access the original file and the pre-processed Markdown file.
Endpoints for leveraging Captide’s agentic AI workflows to programmatically extract insights and data from the document corpus.
`/api/v1/rag/chunk-retrieval`\
Returns the most relevant document excerpts in response to natural language queries.
`/api/v1/rag/agent-response`\
Returns cited Markdown responses, sourced exclusively from corporate disclosures, in response to natural language queries.
`/api/v1/rag/agent-response-stream`\
Streams cited Markdown responses, sourced exclusively from corporate disclosures, as server-sent events in response to natural language queries.
## API Conventions
* All JSON request and response fields use **camelCase** naming (e.g., `sourceType`, `fiscalPeriod`, `documentId`)
* URL paths follow **kebab-case** convention (e.g., `/api/v1/rag/agent-response`)
* Date format: **ISO 8601** (YYYY-MM-DD)
* Authentication: API key via **X-API-Key** header
# Document Coverage
Source: https://docs.captide.ai/coverage
Captide provides **direct and AI access to a wide range of global financial disclosures** published by publicly listed companies across global markets. These documents are essential for investors, analysts, and financial professionals seeking timely, reliable, and comprehensive insights into corporate performance, governance, and strategic direction.
Our **coverage spans multiple categories of disclosures**, from periodic financial statements and event-driven filings to ESG reports and shareholder communications. All documents are sourced from official regulatory filings and investor relations channels across major global markets.
The sections below detail the types of documents available through the Captide API and the geographic regions covered.
## Available Document Categories
`annual-financial-report`
**What is it?**\
The Annual Financial Report is a comprehensive document summarizing a company’s financial performance over the fiscal year. It provides stakeholders with a complete picture of the organization’s profitability, cash flow, and overall financial health.
**What’s inside?**\
It typically includes audited financial statements such as the balance sheet, income statement, and cash flow statement, along with management commentary, notes to the accounts, and disclosures on corporate governance.
**When to expect it?**\
Companies usually publish their Annual Financial Report once a year, shortly after the fiscal year-end—often within three to six months, depending on regulatory requirements.
`interim-financial-report`
**What is it?**\
The Interim Financial Report provides an update on a company’s financial position between annual reports, covering shorter reporting periods like quarterly or half-year results.
**What’s inside?**\
It typically includes complete financial statements with detailed notes, regulatory disclosures, segment analysis, and key metrics. These reports follow standard accounting principles and include detailed tables and footnotes.
**When to expect it?**\
Interim reports are generally released midway through the financial year or quarterly, depending on listing regulations and the company’s reporting practices.
`financial-attachments`
**What is it?**\
Financial Attachments are supporting documents that provides additional financial data and metrics to complement formal financial statements, often tailored for investors and analysts.
**What’s inside?**\
They may include breakdowns of segment performance, non-GAAP/IFRS measures, historical comparisons, reconciliations, KPIs (key performance indicators), and other data visualizations.
**When to expect it?**\
These appendices are released alongside the main financial documents, such as annual or interim reports, or when additional disclosures are required by regulators or auditors.
`annual-activity-report`
**What is it?**\
The Annual Activity Report highlights a company’s operational achievements and key initiatives during the year, focusing on performance beyond just financial results.
**What’s inside?**\
It includes summaries of projects, business developments, sustainability efforts, and management commentary on strategy and future outlook, often paired with visuals and performance metrics.
**When to expect it?**\
It is typically published once per year, around the same time as the Annual Financial Report, to provide a holistic view of the company’s yearly progress.
`interim-activity-report`
**What is it?**\
The Interim Activity Report offers an overview of a company’s key business developments and progress during part of the fiscal year, such as a half-year or quarterly period.
**What’s inside?**\
It contains updates on operations, markets, projects, and strategy execution, along with summarized financial highlights that illustrate mid-year performance trends.
**When to expect it?**\
This report is usually issued midway through the financial year or quarterly, often together with or shortly before the Interim Financial Report.
`compliance-report`
**What is it?**\
The Compliance Report details how a company has met legal, regulatory, and internal policy obligations over the fiscal year. It reflects management’s commitment to transparency and sound governance.
**What’s inside?**\
It typically includes confirmations of compliance with financial, environmental, and labor regulations; disclosures of any breaches or penalties; summaries of internal audits; and certifications by compliance officers.
**When to expect it?**\
Published once a year, often with the Annual or Governance Report, to coincide with year-end filings and corporate governance disclosures.
`historical-performance-summary`
**What is it?**\
The Historical Performance Summary provides a multi-year view of key financial and operational results, allowing investors to assess long-term business trends.
**What’s inside?**\
It features charts and tables comparing revenue, profit, margins, cash flow, returns, and dividends over several years, with brief commentary highlighting major shifts or growth patterns.
**When to expect it?**\
Released annually, often as a section of the Annual Report or Investor Presentation, providing context for the latest results.
`earnings-release`
**What it is**\
The Earnings Release is a brief, high-level summary of a company’s financial results for a given reporting period, intended to quickly inform investors and analysts.
**What’s inside**\
It includes key metrics such as revenue, net income, earnings per share (EPS), and operational highlights, along with commentary on performance drivers and sometimes forward-looking statements.
**When to expect it**\
Earnings releases are typically published quarterly or semi-annually, coinciding with the company’s scheduled reporting calendar and often just before the earnings call or presentation.
`current-report`
**What is it?**\
A Current Report is an official communication used to disclose significant or unexpected events that occur between regular reporting periods or corporate press releases.
**What’s inside?**\
It provides details about material developments such as mergers, leadership changes, legal proceedings, or other events that may affect shareholders or market perception.
**When to expect it?**\
As needed, Companies issue Current Reports on an as-needed basis, immediately following the occurrence of a reportable event, to comply with timely disclosure regulations. significant corporate developments occur.
`letter-to-shareholders`
**What is it?**\
The Letter to Shareholders is a written message from the company’s leadership addressed directly to investors and stakeholders, summarizing the company’s performance and strategic direction.
**What’s inside?**\
It highlights major achievements, challenges, and priorities over the past year, discusses the business outlook, and conveys management’s tone and vision for future growth.
**When to expect it?**\
The letter is published once a year, usually together with the Annual Financial Report.
`earnings-presentation`
**What is it?**\
The Earnings Presentation is a slide deck prepared by management to visually summarize financial and operational performance during an earnings period.
**What’s inside?**\
It features charts, tables, and key performance indicators, often including segment performance, market updates, strategic progress, and guidance for the upcoming period.
**When to expect it?**\
This presentation is usually released alongside the Earnings Release and used during the company’s quarterly or semi-annual earnings call.
`earnings-call-transcript`
**What is it?**\
The Earnings Call Transcript is the written record of the company’s live conference call with investors and analysts following an earnings announcement.
**What’s inside?**\
It includes management’s prepared remarks, financial commentary, and the full Q\&A session, providing transparency on how executives addressed investor questions.
**When to expect it?**\
The transcript is generally published within a few days after the earnings call, either by the company itself or by financial information services.
`investor-event-presentation`
**What is it?**\
The Investor Event Presentation is a detailed visual briefing shared during special meetings or conferences dedicated to investors, analysts, or media.
**What’s inside?**\
It covers business strategy, long-term goals, market opportunities, innovation updates, and financial targets, often designed to reinforce confidence and attract investment.
**When to expect it?**\
These presentations are published in connection with scheduled investor events, such as Capital Markets Days, Investor Days, or sector conferences.
`investor-event-transcript`
**What is it?**\
The Investor Event Transcript provides a verbatim record of discussions, speeches, and Q\&A sessions from an investor-focused event.
**What’s inside?**\
It captures management presentations, analyst questions, and executive responses, offering context to the visual materials and clarifying strategic messaging.
**When to expect it?**\
Transcripts are typically released shortly after the event, often within a few business days, accompanying or following the publication of the event presentation.
`shareholder-meeting-circular`
**What is it?**\
The Shareholder Meeting Circular is an official document distributed to shareholders ahead of a general or special meeting, providing the information needed to make informed voting decisions.
**What’s inside?**\
It contains the meeting agenda, proposed resolutions, details about board nominees, executive compensation, and explanatory notes on each item up for vote.
**When to expect it?**\
The circular is typically published several weeks before the scheduled shareholder meeting, in accordance with legal or regulatory notice requirements.
`shareholder-meeting-resolutions`
**What is it?**\
A Shareholder Meeting Resolution is a formal statement of a decision or action approved by shareholders during a general or special meeting.
**What’s inside?**\
It outlines the exact wording of each motion put to vote—such as approving financial statements, electing directors, or authorizing capital actions—and records the voting results.
**When to expect it?**\
Resolutions are made available after the shareholder meeting, often as part of the official meeting minutes or as a standalone regulatory filing.
`governance-report`
**What is it?**\
The Governance Report provides a comprehensive overview of a company’s corporate governance framework, practices, and compliance with relevant codes or regulations.
**What’s inside?**\
It describes the structure and functioning of the board of directors, committees, internal controls, risk management, and the company’s approach to ethics and transparency.
**When to expect it?**\
It is usually published annually, either as a standalone document or as a section within the Annual Report or Universal Registration Document.
`compensation-report`
**What is it?**\
The Compensation Report details the company’s remuneration policies and the pay awarded to directors and key executives during the reporting year.
**What’s inside?**\
It includes information on fixed and variable pay components, performance criteria, share-based incentives, and alignment of compensation with long-term company performance.
**When to expect it?**\
This report is released annually, typically in conjunction with the Annual Report or before the shareholder meeting where compensation matters are subject to approval.
`governance-policies`
**What is it?**\
Governance Policies and Charters are formal documents that define the principles, responsibilities, and operating guidelines of a company’s board and its committees.
**What’s inside?**\
They set out rules on board structure, independence, ethics, conflicts of interest, audit practices, and other governance standards that ensure accountability and transparency.
**When to expect it?**\
These documents are published or updated as needed, often annually or when governance frameworks evolve.
`esg-report`
**What is it?**\
The ESG Report presents a company’s environmental, social, and governance performance and outlines its commitment to responsible and sustainable business practices.
**What’s inside?**\
It covers topics such as carbon emissions, energy use, diversity, community impact, ethical governance, and progress toward sustainability targets, often aligned with international reporting standards (e.g., GRI, SASB, TCFD).
**When to expect it?**\
This report is usually published annually, either alongside the Annual Report or as a standalone document focused on non-financial performance.
`esg-assessment`
**What is it?**\
An ESG Assessment evaluates a company’s performance across the sustainability pillars to identify strengths, gaps, and risks. It may be conducted internally or externally to inform improvements, ensure compliance, and advance sustainability goals.
**What’s inside?**\
It examines key areas within the sustainability pillars and often includes materiality analysis, benchmarking, and risk evaluation to provide a clear view of sustainability performance.
**When to expect it?**\
An ESG assessment may be required by local regulations or done voluntarily, often conducted annually or before new projects and constructions to evaluate environmental and social impacts prior to approval.
`insider-share-transactions`
**What is it?**\
Insider Share Transactions refer to public disclosures of company share dealings made by directors, executives, or major shareholders with privileged access to non-public information.
**What’s inside?**\
These filings detail the date, type (purchase or sale), volume, and price of the transactions, helping investors monitor insider confidence and potential market signals.
**When to expect it?**\
Such disclosures are made promptly after each transaction—typically within a few business days—according to market regulations and corporate transparency rules.
`shareholder-dealing-disclosure`
**What is it?**\
The Major Shareholder or Dealings Disclosure reports significant changes in ownership or voting rights, ensuring transparency around who controls or influences the company.
**What’s inside?**\
It identifies the shareholders involved, the percentage of capital or votes before and after the change, the transaction type, and the date. It may also cover indirect or group holdings.
**When to expect it?**\
Filed promptly—usually within a few business days—after a shareholder crosses a regulatory threshold or when a major ownership change occurs.
`share-issuance-notice`
**What is it?**\
A Share Issuance Notice formally announces that a company is issuing new shares, either to raise capital, fund an acquisition, or fulfill an employee stock program.
**What’s inside?**\
It specifies the number of shares issued, issue price, purpose of the issuance, subscription terms, and expected impact on share capital and shareholder dilution.
**When to expect it?**\
The notice is published at the time of or immediately following board approval of the issuance, and before or during the subscription period.
`share-buyback-notice`
**What is it?**\
A Share Buyback Notice informs investors that the company intends to repurchase its own shares from the market, signaling capital management or confidence in future performance.
**What’s inside?**\
It provides details such as the total buyback amount, duration of the program, maximum number of shares, and the rationale behind the initiative.
**When to expect it?**\
Buyback notices are released prior to or at the launch of the buyback program, and updates may follow during or after its completion.
`share-capital-disclosure`
**What is it?**\
The Share Capital Disclosure provides an updated summary of the company’s total issued and outstanding shares, capital structure, and ownership distribution.
**What’s inside?**\
It includes information on the number of shares, classes of stock, voting rights, and changes resulting from recent issuances, cancellations, or buybacks.
**When to expect it?**\
This disclosure is published periodically—typically monthly or quarterly—or whenever a material change in the share capital occurs.
`initial-offering-prospectus`
**What is it?**\
The Initial Offering Prospectus is a comprehensive disclosure document issued when a company offers its shares to the public for the first time.
**What’s inside?**\
It includes detailed information about the company’s business model, financial statements, risk factors, management, use of proceeds, and the terms of the offering.
**When to expect it?**\
This document is published prior to the launch of an initial public offering, following regulatory approval, and made available to potential investors during the subscription period.
`follow-on-offering-prospectus`
**What is it?**\
The Follow-on Offering Prospectus is issued when a company that is already publicly listed decides to issue additional shares to raise more capital.
**What’s inside?**\
It outlines the rationale for the new issuance, updated financial data, recent developments, risk disclosures, and details of the offering structure and pricing.
**When to expect it?**\
The document is released shortly before or at the time of the follow-on share offering, once the company has obtained the necessary regulatory clearance.
`merger-offering-prospectus`
**What is it?**\
The Merger or Exchange Offering Prospectus is prepared when a company proposes to acquire or merge with another entity by offering its own shares in exchange.
**What’s inside?**\
It provides background on the transaction, valuation methods, terms of the exchange, strategic rationale, financial effects, and risk factors related to the merger or acquisition.
**When to expect it?**\
This prospectus is issued ahead of the shareholder vote or during the offer period, following regulatory review and approval of the transaction documents.
`employee-share-plan-prospectus`
**What is it?**\
The Employee Share Plan Prospectus explains the terms and conditions under which company employees can acquire or receive shares through a compensation or incentive plan.
**What’s inside?**\
It details eligibility criteria, subscription or grant rules, pricing, vesting periods, tax implications, and the overall objectives of the employee equity program.
**When to expect it?**\
It is typically published at the launch of the plan or whenever a new offering or update to an existing employee share scheme is announced.
`tender-offer-disclosure`
**What is it?**\
The Tender Offer Disclosure is an official statement issued when a company, investor, or group offers to purchase shares of another company—usually to gain control or acquire a significant stake.
**What’s inside?**\
It describes the offer terms, price per share, acceptance conditions, offer period, financing arrangements, and strategic intent behind the acquisition.
**When to expect it?**\
The document is released at the start of the tender offer process, once regulatory authorities have approved its publication, and remains available throughout the offer period.
## Geographical Coverage
Australia, Austria, Belgium, Canada, China, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hong Kong, Hungary, Iceland, Ireland, Isle of Man, Italy, Japan, Jersey, Luxembourg, Netherlands, New Zealand, Norway, Poland, Portugal, Romania, Singapore, South Korea, Spain, Sweden, Switzerland, Taiwan, Türkiye, United Kingdom, United States.
**Coming in Q2 2026:**\
Brazil, Mexico, Chile, Argentina, Colombia.
# FAQs
Source: https://docs.captide.ai/faqs
Explore our frequently asked questions below. If your question isn’t covered, our team is just a message away—feel free to get in touch.
## Company Identification
We define a company as a publicly listed entity that files its financial results independently. In cases where a company files with multiple market regulators or is traded on multiple exchanges, we consider all such filings and listings to belong to the same entity in Captide—provided they refer to the same underlying corporation.
Captide assigns proprietary company identifiers (`companyId`) to uniquely identify each entity. We also capture organizations’ LEIs and Refinitiv PermIDs. Additionally, ticker symbols, when paired with their respective exchanges, serve as reliable identifiers. Users can retrieve the complete list of available companies, including each entity’s `companyId`, `permId`, `lei`, and associated `tickers`, through the `/api/v1/companies/list` endpoint.
## Document Access
New documents from US-listed companies are typically available within 1 minute of release. For non-US-listed companies, documents are available within 12 hours. Earnings call transcripts are generally published 6 to 12 hours after the call concludes.
Annual, interim, and current reports are available for all companies in Captide. Additional document types are provided for companies that have filed them at any point. Note that reporting practices vary by geography (for example, companies in the United States typically file quarterly interim reports, while those in Australia often file semi-annual reports). As a result, the availability and frequency of document types may vary by region, company, and regulatory requirements.
When retrieving documents, the following date-related parameters provide key information:
* `date`: Indicates the date the document refers to (e.g., the press release date for a current report, or the fiscal period end date for annual and interim reports).
* `filingDate`: The date and time the document was made publicly available (useful for point-in-time analysis).
* `fiscalYear` and `fiscalQuarter`: Indicate the fiscal period covered by the document.
* `createdAt`: The date and time the document became available in Captide.
* `updatedAt`: The most recent date and time the document was updated in Captide.
Captide transforms original corporate disclosures into LLM-optimized Markdown files that preserve all information and data points from the source documents in a machine-readable format. This enables efficient and interpretable downstream analysis or AI applications, where documents must be chunked and ingested by large language models.
## Agentic RAG
The only difference between the two endpoints is how they deliver AI-generated responses. The `agent-response` endpoint is optimized for use cases where the full response is only needed after generation is complete (e.g., data extraction or alert systems). In contrast, the `agent-response-stream` endpoint streams the response in real time via server-sent events, making it more suitable for chat interfaces and interactive applications.
The `chunk-retrieval` endpoint is designed for firms that want to retrieve relevant content from corporate disclosures in response to natural language prompts—without involving an LLM, or where greater control over AI-generated responses is required. This is particularly useful for applications that aggregate context from multiple sources, allowing Captide’s retrieved content to be combined with data from other providers or internal systems.
Every API response from the agentic RAG endpoints includes metadata about the sources and document excerpts used to generate the answer. The `agent-response` and `agent-response-stream` endpoints provide sentence-level attribution to excerpts from corporate disclosures. Clients can programmatically access these excerpts and metadata, or use the Captide SDK to easily display sources within a document viewer.
Refer to the Captide [Frontend Integration guide](/integration/frontend) for details on integrating our document viewer for seamless source auditing.
If your question isn’t addressed here, please [contact our support team](mailto:support@captide.co) for assistance.
# Introduction to Captide
Source: https://docs.captide.ai/index
This documentation is your guide to integrating Captide's APIs and leveraging our agentic AI systems for corporate disclosure analysis.
Captide aggregates and processes **corporate disclosures from publicly listed companies across 30 global markets**, transforming them into formats optimized for AI applications. Built on this expansive dataset of global filings, Captide’s agentic retrieval-augmented generation (RAG) systems deliver auditable, high-accuracy outputs in response to natural language queries—unlocking reliable **AI-driven insights grounded exclusively in authorative sources**.
With Captide’s APIs, long/short hedge funds, investment banks, and software companies can **embed AI across their financial workflows**—extracting insights from millions of authoritative documents without the complexity of building or maintaining complex agentic RAG infrastructure.
Captide is designed to augment investment research, enable alternative data extraction, and facilitate feature discovery–while ensuring the **highest levels of confidence and auditability in every output**.
## Core Use Cases
* **Build multi-agent systems** able to analyze and reason from authorative company reports.
* **Power internal RAG systems** with Captide's LLM-ready library of global corporate disclosures.
* Continuously monitor company disclosures to **detect material changes and surface early signals** of potential inflection points or shifts in outlook.
* **Screen companies** using changing disclosure signals to spot potential outliers or themes worth deeper analysis.
* **Extract and standardize hard-to-access data** to power investment models, enable faster benchmarking, and support investment thesis validation.
* Compare metrics, forward-looking guidance, risk language, and tone sentiment to **uncover divergences, outliers, or consensus shifts across custom peer sets.**
* Link key entities across disclosures to **synthesize key information and uncover dependencies across companies.**
## Core Components
* **REST API**:
* **Document Access Endpoint**: Access corporate disclosures from companies across the world optimized for LLM ingestion.
* **Chunk Retrieval Endpoint**: Retrieve relevant document excerpts and metadata tailored to user queries.
* **Agent Response Endpoint**: Receive real-time, AI-generated answers via Server-Sent Events (SSE) with citations that link directly to original document passages.
* **JavaScript/TypeScript SDK**: Quickly integrate Captide components—like document viewers—into your frontend app for streamlined source auditing.
## Getting Started
[Contact our sales team](https://www.captide.ai/contact/api-request) to request a demo and gain access to a trial API key or a hands-on proof of concept (PoC). They’ll support you with any questions or requirements, and provide all necessary materials to help you begin early testing and validation.
Follow our [Quickstart Guide](/integration/quickstart) to begin exploring Captide’s solutions with step-by-step instructions for setup, integration, and initial testing.
Use the [Captide API Dashboard](https://app.captide.co/api-dashboard) to monitor your API usage, costs, and performance at a glance.
[Book a demo](https://www.captide.ai/contact/api-request) to explore how Captide can support your unique workflows and goals.
# Quickstart Guide
Source: https://docs.captide.ai/integration/quickstart
This guide will help you get started with Captide quickly, showing you how to set up both the REST API and the Document Auditing JavaScript SDK to embed corporate disclosure intelligence into your systems.
Before you begin, make sure you [request a Captide test API key](https://www.captide.ai/contact/api-request).
## Using the REST API
### Authentication
All API requests require authentication using your API key in the header:
```bash theme={null}
curl --request GET \
--url 'https://rest-api.captide.co/api/v1/companies/list' \
--header 'X-API-Key: YOUR_API_KEY'
```
### Example 1: Retrieve Company Information
Use the [/companies/list](/api-reference/endpoint/companies) endpoint when you want to search companies in Captide and retrieve their company `id` to use as parameter in other endpoints.
```bash theme={null}
curl --request GET \
--url 'https://rest-api.captide.co/api/v1/companies/list?limit=100&tickers=STO.AX' \
--header 'X-API-Key: YOUR_API_KEY'
```
Use the response to retrieve company information and use the id to retrieve company docs:
```json theme={null}
[
{
"id": "77848abe-a215-41b7-8950-86e89ea1fadc",
"name": "Santos",
"tickers": ["STO.AX"],
"countries": ["AU"],
"filesWithSec": false
}
]
```
### Example 2: Retrieve Company Documents
Use the [/documents/list](/api-reference/endpoint/documents) endpoint to search for company documents by applying filters such as `documentCategories`, `formTypes`, or by specifying a company’s `tickers` or `id`. This allows you to retrieve the metadata of the latest corporate disclosures of publicly listed companies.\
In the example below, we use the `id` of Santos to retrieve its latest `interim-reports`:
```bash theme={null}
curl --request GET \
--url 'https://rest-api.captide.co/api/v1/documents/list?limit=100&companyIds=77848abe-a215-41b7-8950-86e89ea1fadc&documentCategories=interim-report' \
--header 'X-API-Key: YOUR_API_KEY'
```
The response below contains metadata for each document. The document `id` is particularly important, as it is used to retrieve the document file and its formatted Markdown version.
```json theme={null}
[
{
"id": "98381fbb-8d8c-4b47-b31c-819f8aca0690",
"documentCategory": "interim-report",
"formType": null,
"tickers": [
"STO.AX"
],
"companyName": "Santos",
"date": "2025-04-17",
"fiscalQuarter": 1,
"fiscalYear": 2025,
"title": "First Quarter Report for period ending 31 March 2025",
"description": "This document is the First Quarter Report of Santos Limited for the period ending 31 March 2025. It provides a detailed overview of the company's operational and financial performance, including production volumes, sales, revenue, capital expenditure, project updates, and guidance for 2025."
},
{
"id": "095d866c-c6df-4799-bce3-61b60a5d62ea",
"documentCategory": "interim-report",
"formType": null,
"tickers": [
"STO.AX"
],
"companyName": "Santos",
"date": "2025-01-23",
"fiscalQuarter": 4,
"fiscalYear": 2024,
"title": "Fourth Quarter Report for period ending 31 December 2024",
"description": "This document is the Fourth Quarter Report of Santos Limited for the period ending 31 December 2024. It provides a detailed overview of the company's financial and operational performance, including sales revenue, production volumes, capital expenditure, project updates, and carbon capture and storage activities."
},
...
]
```
Once target documents are identified, we can use their `id` with the [/documents/](/api-reference/endpoint/get_document) endpoint to retrieve the URLs for the document files.
```bash theme={null}
curl --request GET \
--url https://rest-api.captide.co/api/v1/documents/98381fbb-8d8c-4b47-b31c-819f8aca0690 \
--header 'X-API-Key: YOUR_API_KEY'
```
```json theme={null}
{
"id": "98381fbb-8d8c-4b47-b31c-819f8aca0690",
"documentCategory": "interim-report",
"formType": null,
"tickers": [
"STO.AX"
],
"companyName": "Santos",
"date": "2025-04-17",
"fiscalQuarter": 1,
"fiscalYear": 2025,
"title": "First Quarter Report for period ending 31 March 2025",
"description": "This document is the First Quarter Report of Santos Limited for the period ending 31 March 2025. It provides a detailed overview of the company's operational and financial performance, including production volumes, sales, revenue, capital expenditure, project updates, and guidance for 2025.",
"originalFileUrl": "https://files.captide.co/original-docs/77848abe-a215-41b7-8950-86e89ea1fadc/2025-Santos-First-Quarter-Report.pdf?se=2025-07-28T17%3A33%3A51Z&sp=r&sv=2025-07-05&sr=b&sig=B6JuHmW4Yoif5tMJItatav/Vwe9IzOoqSaHs%2BZEwbDk%3D",
"markdownFileUrl": "https://files.captide.co/markdown-docs/77848abe-a215-41b7-8950-86e89ea1fadc/2025-Santos-First-Quarter-Report.md?se=2025-07-28T17%3A33%3A51Z&sp=r&sv=2025-07-05&sr=b&sig=umdy9HFMwQykzafdb62ZQAXF/4OXJHKM9Py0dfd2wuA%3D"
}
```
The response includes two additional fields: `originalFileUrl` and `markdownFileUrl`. These provide temporary access to the original document file and its formatted Markdown version, which is optimized for downstream analysis and LLM ingestion.
### Example 3: Prompt-Based Chunk Retrieval
With Captide, you can create RAG-based applications and tools without the need to collect, preprocess, chunk, or store document excerpts yourself. Simply use the [/rag/chunk-retrieval](/api-reference/endpoint/chunks) endpoint to send natural language requests, and you'll receive relevant document excerpts from our database containing all the information needed to fulfill your query.
```bash theme={null}
curl --request POST \
--url 'https://rest-api.captide.co/api/v1/rag/chunks?query=Provide%20the%20net%20dollar%20retention%20of%20ZScaler%20for%20the%20last%20two%20quarters' \
--header 'X-API-Key: YOUR_API_KEY'
```
The response includes a list of relevant document chunks from the Captide database, along with their associated metadata.
```json theme={null}
{
"relevantChunks": [
{
"content": "## 34\n\n### We calculate our dollar-based net retention rate as follows:\n\nTable of Contents\nInvesting in Business Growth\nSince our founding, we have invested significantly in growing our business. We intend to continue (i) investing in our\nresearch and development organization and our development efforts to offer new solutions on our cloud platform and (ii)\ndedicating resources to update and upgrade our existing solutions. In addition, we expect our general and administrative expenses\nto increase in absolute dollars in the foreseeable future, as we continue to operate as a public company, and address any legal\nmatters and related accruals, as further described in Note 11, Commitments and Contingencies, of the unaudited condensed\nconsolidated financial statements included elsewhere in this Quarterly Report on Form 10-Q.\nWe also intend to continue to invest significantly in sales and marketing to grow and train our sales force, broaden our brand\nawareness and expand and deepen our channel partner relationships. While these planned investments will increase our operating\nexpenses in the short term, we believe that over the long term these investments will help us to expand our customer base and\ngrow our business. We also are investing in programs to increase recognition of our brand and solutions, including joint marketing\nactivities with our channel partners and strategic partners.\nWhile we expect our operating expenses to increase in absolute dollars in the foreseeable future as a result of these\nactivities, we intend to balance these investments in future growth with a continued focus on managing our results of operations\nand investing judiciously. In the long term we anticipate that these investments will positively impact our business and results of\noperations.\nKey Business Metrics and Other Financial Measures\nWe review a number of operating and financial metrics, including the following key metrics, to measure our performance,\nidentify trends, formulate business plans and make strategic decisions.\nDollar-Based Net Retention Rate\nWe believe that dollar-based net retention rate is an indicator to measure the long-term value of our customer relationships\nbecause it is driven by our ability to retain and expand the recurring revenue generated from our existing customers. Our dollar-\nbased net retention rate compares the recurring revenue from a set of customers against the same metric for the prior 12-month\nperiod on a trailing basis. Because our customers have repeat buying patterns and the average term of our contracts is more than\n12 months, we measure this metric over a set of customers who were with us as of the last day of the same reporting period in the\nprior fiscal year. For the trailing 12 months ended April 30, 2025 and 2024, the dollar-based net retention rate was 114% and\n116%, respectively.\nWe calculate our dollar-based net retention rate as follows:\nDenominator: To calculate our dollar-based net retention rate as of the end of a reporting period, we first establish the ARR\nfrom all active subscriptions as of the last day of the same reporting period in the prior fiscal year. This effectively represents\nrecurring dollars that we expect in the next 12-month period from the cohort of customers that existed on the last day of the same\nreporting period in the prior fiscal year.\nNumerator: We measure the ARR for that same cohort of customers representing all subscriptions based on confirmed\ncustomer orders booked by us as of the end of the reporting period.\nDollar-based net retention rate is obtained by dividing the numerator by the denominator. Our dollar-based net retention rate\nmay fluctuate due to a number of factors, including the performance of our cloud platform, our success in selling bigger deals,\nincluding deals for all employees with our higher-end bundles, selling multiple-pillars from the start of our contract with new\ncustomers, faster upsells within a year, the timing and the rate of ARR expansion of our existing\n34",
"pageNumber": 45,
"excerpt": null,
"documentMetadata": {
"id": "207db5da-c2bb-42b8-a0d3-1a5d508e723c",
"documentCategory": "interim-report",
"formType": null,
"date": "2025-05-29",
"description": "This document is the Form 10-Q quarterly report filed by Zscaler, Inc. for the third fiscal quarter ended April 30, 2025. It includes unaudited condensed consolidated financial statements such as balance sheets, statements of operations, comprehensive income, stockholders' equity, and cash flows. The report also contains management's discussion and analysis of financial condition and results of operations, quantitative and qualitative disclosures about market risk, controls and procedures, legal proceedings, risk factors, unregistered sales of equity securities, use of proceeds, and other information relevant to the quarter. The filing provides detailed financial data, forward-looking statements, and regulatory compliance information for investors and the SEC.",
"fiscalQuarter": 3,
"fiscalYear": 2025,
"companyName": "Zscaler, Inc.",
"tickers": [
"ZS"
],
"metadata": null
}
},
{
"content": "## 31\n\n### We calculate our dollar-based net retention rate as follows:\n\nTable of Contents\nInvesting in Business Growth\nSince our founding, we have invested significantly in growing our business. We intend to continue (i) investing in our\nresearch and development organization and our development efforts to offer new solutions on our cloud platform and (ii)\ndedicating resources to update and upgrade our existing solutions. In addition, we expect our general and administrative expenses\nto increase in absolute dollars in the foreseeable future, as we continue to operate as a public company, and address any legal\nmatters and related accruals, as further described in Note 10, Commitments and Contingencies, of the unaudited condensed\nconsolidated financial statements included elsewhere in this Quarterly Report on Form 10-Q.\nWe also intend to continue to invest significantly in sales and marketing to grow and train our sales force, broaden our brand\nawareness and expand and deepen our channel partner relationships. While these planned investments will increase our operating\nexpenses in the short term, we believe that over the long term these investments will help us to expand our customer base and\ngrow our business. We also are investing in programs to increase recognition of our brand and solutions, including joint marketing\nactivities with our channel partners and strategic partners.\nWhile we expect our operating expenses to increase in absolute dollars in the foreseeable future as a result of these\nactivities, we intend to balance these investments in future growth with a continued focus on managing our results of operations\nand investing judiciously. In the long term we anticipate that these investments will positively impact our business and results of\noperations.\nKey Business Metrics and Other Financial Measures\nWe review a number of operating and financial metrics, including the following key metrics, to measure our performance,\nidentify trends, formulate business plans and make strategic decisions.\nDollar-Based Net Retention Rate\nWe believe that dollar-based net retention rate is an indicator to measure the long-term value of our customer relationships\nbecause it is driven by our ability to retain and expand the recurring revenue generated from our existing customers. Our dollar-\nbased net retention rate compares the recurring revenue from a set of customers against the same metric for the prior 12-month\nperiod on a trailing basis. Because our customers have repeat buying patterns and the average term of our contracts is more than\n12 months, we measure this metric over a set of customers who were with us as of the last day of the same reporting period in the\nprior fiscal year. For the trailing 12 months ended January 31, 2025 and 2024, the dollar-based net retention rate was 115% and\n117%, respectively.\nWe calculate our dollar-based net retention rate as follows:\nDenominator: To calculate our dollar-based net retention rate as of the end of a reporting period, we first establish the ARR\nfrom all active subscriptions as of the last day of the same reporting period in the prior fiscal year. This effectively represents\nrecurring dollars that we expect in the next 12-month period from the cohort of customers that existed on the last day of the same\nreporting period in the prior fiscal year.\nNumerator: We measure the ARR for that same cohort of customers representing all subscriptions based on confirmed\ncustomer orders booked by us as of the end of the reporting period.\nDollar-based net retention rate is obtained by dividing the numerator by the denominator. Our dollar-based net retention rate\nmay fluctuate due to a number of factors, including the performance of our cloud platform, our success in selling bigger deals,\nincluding deals for all employees with our higher-end bundles, selling multiple-pillars from the start of our contract with new\ncustomers, faster upsells within a year, the timing and the rate of ARR expansion of our existing\n31",
"pageNumber": 41,
"excerpt": null,
"documentMetadata": {
"id": "eaf63939-0da6-4fc7-ba06-adbd46e546a9",
"documentCategory": "interim-report",
"formType": null,
"date": "2025-03-10",
"description": "This document is the Form 10-Q quarterly report filed by Zscaler, Inc. for the second fiscal quarter ended January 31, 2025. It includes unaudited condensed consolidated financial statements such as balance sheets, statements of operations, comprehensive loss, stockholders' equity, and cash flows. The report also contains management's discussion and analysis of financial condition and results of operations, quantitative and qualitative disclosures about market risk, controls and procedures, legal proceedings, risk factors, unregistered sales of equity securities, use of proceeds, and exhibits. The filing provides detailed financial data, forward-looking statements, and regulatory compliance information for the quarter.",
"fiscalQuarter": 2,
"fiscalYear": 2025,
"companyName": "Zscaler, Inc.",
"tickers": [
"ZS"
],
"metadata": null
}
}
]
}
```
You can then use the relevant chunks as context for AI-generated responses, and even combine them with context from other sources—such as internal data or structured databases.
### Example 4: AI Agent Response
Captide enables you to get answers to any question grounded in information from corporate disclosures with full traceability. This allows you to instantly extract insights and metrics from millions of financial filings, or to build multi-agent systems that accelerate and enhance investment research. Below is an example query submitted to Captide’s AI agent.
```bash theme={null}
curl --request POST \
--url 'https://rest-api.captide.co/api/v1/rag/agent-response?query=Provide%20the%20net%20dollar%20retention%20of%20ZScaler%20for%20the%20last%20two%20quarters' \
--header 'X-API-Key: YOUR_API_KEY'
```
The response includes the final answer in the `content` field, along with source identifiers (formatted as `#abcd1234`) embedded within the text. These identifiers link to the `sourceMap`, allowing each part of the answer to be traced back to the original document excerpts used.
```json theme={null}
{
"content": "Zscaler's dollar-based net retention rate for the last two quarters was as follows:\n\n- Q3 2025 (trailing 12 months ended April 30, 2025): **114%** [#207d0044]\n- Q2 2025 (trailing 12 months ended January 31, 2025): **115%** [#eaf60040]\n\nThis indicates a slight sequential decrease in net dollar retention over the past two quarters.",
"sourceMap": {
"#eaf60040": {
"content": "## 31\n\n### We calculate our dollar-based net retention rate as follows:\n\nTable of Contents\nInvesting in Business Growth\nSince our founding, we have invested significantly in growing our business. We intend to continue (i) investing in our\nresearch and development organization and our development efforts to offer new solutions on our cloud platform and (ii)\ndedicating resources to update and upgrade our existing solutions. In addition, we expect our general and administrative expenses\nto increase in absolute dollars in the foreseeable future, as we continue to operate as a public company, and address any legal\nmatters and related accruals, as further described in Note 10, Commitments and Contingencies, of the unaudited condensed\nconsolidated financial statements included elsewhere in this Quarterly Report on Form 10-Q.\nWe also intend to continue to invest significantly in sales and marketing to grow and train our sales force, broaden our brand\nawareness and expand and deepen our channel partner relationships. While these planned investments will increase our operating\nexpenses in the short term, we believe that over the long term these investments will help us to expand our customer base and\ngrow our business. We also are investing in programs to increase recognition of our brand and solutions, including joint marketing\nactivities with our channel partners and strategic partners.\nWhile we expect our operating expenses to increase in absolute dollars in the foreseeable future as a result of these\nactivities, we intend to balance these investments in future growth with a continued focus on managing our results of operations\nand investing judiciously. In the long term we anticipate that these investments will positively impact our business and results of\noperations.\nKey Business Metrics and Other Financial Measures\nWe review a number of operating and financial metrics, including the following key metrics, to measure our performance,\nidentify trends, formulate business plans and make strategic decisions.\nDollar-Based Net Retention Rate\nWe believe that dollar-based net retention rate is an indicator to measure the long-term value of our customer relationships\nbecause it is driven by our ability to retain and expand the recurring revenue generated from our existing customers. Our dollar-\nbased net retention rate compares the recurring revenue from a set of customers against the same metric for the prior 12-month\nperiod on a trailing basis. Because our customers have repeat buying patterns and the average term of our contracts is more than\n12 months, we measure this metric over a set of customers who were with us as of the last day of the same reporting period in the\nprior fiscal year. For the trailing 12 months ended January 31, 2025 and 2024, the dollar-based net retention rate was 115% and\n117%, respectively.\nWe calculate our dollar-based net retention rate as follows:\nDenominator: To calculate our dollar-based net retention rate as of the end of a reporting period, we first establish the ARR\nfrom all active subscriptions as of the last day of the same reporting period in the prior fiscal year. This effectively represents\nrecurring dollars that we expect in the next 12-month period from the cohort of customers that existed on the last day of the same\nreporting period in the prior fiscal year.\nNumerator: We measure the ARR for that same cohort of customers representing all subscriptions based on confirmed\ncustomer orders booked by us as of the end of the reporting period.\nDollar-based net retention rate is obtained by dividing the numerator by the denominator. Our dollar-based net retention rate\nmay fluctuate due to a number of factors, including the performance of our cloud platform, our success in selling bigger deals,\nincluding deals for all employees with our higher-end bundles, selling multiple-pillars from the start of our contract with new\ncustomers, faster upsells within a year, the timing and the rate of ARR expansion of our existing\n31",
"pageNumber": 41,
"excerpt": "For the trailing 12 months ended January 31, 2025 and 2024, the dollar-based net retention rate was 115% and 117%, respectively.",
"documentMetadata": {
"id": "eaf63939-0da6-4fc7-ba06-adbd46e546a9",
"documentCategory": "interim-report",
"formType": null,
"date": "2025-03-10",
"description": "This document is the Form 10-Q quarterly report filed by Zscaler, Inc. for the second fiscal quarter ended January 31, 2025. It includes unaudited condensed consolidated financial statements such as balance sheets, statements of operations, comprehensive loss, stockholders' equity, and cash flows. The report also contains management's discussion and analysis of financial condition and results of operations, quantitative and qualitative disclosures about market risk, controls and procedures, legal proceedings, risk factors, unregistered sales of equity securities, use of proceeds, and exhibits. The filing provides detailed financial data, forward-looking statements, and regulatory compliance information for the quarter.",
"fiscalQuarter": 2,
"fiscalYear": 2025,
"companyName": "Zscaler, Inc.",
"tickers": [
"ZS"
],
"metadata": null
}
},
"#207d0044": {
"content": "## 34\n\n### We calculate our dollar-based net retention rate as follows:\n\nTable of Contents\nInvesting in Business Growth\nSince our founding, we have invested significantly in growing our business. We intend to continue (i) investing in our\nresearch and development organization and our development efforts to offer new solutions on our cloud platform and (ii)\ndedicating resources to update and upgrade our existing solutions. In addition, we expect our general and administrative expenses\nto increase in absolute dollars in the foreseeable future, as we continue to operate as a public company, and address any legal\nmatters and related accruals, as further described in Note 11, Commitments and Contingencies, of the unaudited condensed\nconsolidated financial statements included elsewhere in this Quarterly Report on Form 10-Q.\nWe also intend to continue to invest significantly in sales and marketing to grow and train our sales force, broaden our brand\nawareness and expand and deepen our channel partner relationships. While these planned investments will increase our operating\nexpenses in the short term, we believe that over the long term these investments will help us to expand our customer base and\ngrow our business. We also are investing in programs to increase recognition of our brand and solutions, including joint marketing\nactivities with our channel partners and strategic partners.\nWhile we expect our operating expenses to increase in absolute dollars in the foreseeable future as a result of these\nactivities, we intend to balance these investments in future growth with a continued focus on managing our results of operations\nand investing judiciously. In the long term we anticipate that these investments will positively impact our business and results of\noperations.\nKey Business Metrics and Other Financial Measures\nWe review a number of operating and financial metrics, including the following key metrics, to measure our performance,\nidentify trends, formulate business plans and make strategic decisions.\nDollar-Based Net Retention Rate\nWe believe that dollar-based net retention rate is an indicator to measure the long-term value of our customer relationships\nbecause it is driven by our ability to retain and expand the recurring revenue generated from our existing customers. Our dollar-\nbased net retention rate compares the recurring revenue from a set of customers against the same metric for the prior 12-month\nperiod on a trailing basis. Because our customers have repeat buying patterns and the average term of our contracts is more than\n12 months, we measure this metric over a set of customers who were with us as of the last day of the same reporting period in the\nprior fiscal year. For the trailing 12 months ended April 30, 2025 and 2024, the dollar-based net retention rate was 114% and\n116%, respectively.\nWe calculate our dollar-based net retention rate as follows:\nDenominator: To calculate our dollar-based net retention rate as of the end of a reporting period, we first establish the ARR\nfrom all active subscriptions as of the last day of the same reporting period in the prior fiscal year. This effectively represents\nrecurring dollars that we expect in the next 12-month period from the cohort of customers that existed on the last day of the same\nreporting period in the prior fiscal year.\nNumerator: We measure the ARR for that same cohort of customers representing all subscriptions based on confirmed\ncustomer orders booked by us as of the end of the reporting period.\nDollar-based net retention rate is obtained by dividing the numerator by the denominator. Our dollar-based net retention rate\nmay fluctuate due to a number of factors, including the performance of our cloud platform, our success in selling bigger deals,\nincluding deals for all employees with our higher-end bundles, selling multiple-pillars from the start of our contract with new\ncustomers, faster upsells within a year, the timing and the rate of ARR expansion of our existing\n34",
"pageNumber": 45,
"excerpt": "For the trailing 12 months ended April 30, 2025 and 2024, the dollar-based net retention rate was 114% and 116%, respectively.",
"documentMetadata": {
"id": "207db5da-c2bb-42b8-a0d3-1a5d508e723c",
"documentCategory": "interim-report",
"formType": null,
"date": "2025-05-29",
"description": "This document is the Form 10-Q quarterly report filed by Zscaler, Inc. for the third fiscal quarter ended April 30, 2025. It includes unaudited condensed consolidated financial statements such as balance sheets, statements of operations, comprehensive income, stockholders' equity, and cash flows. The report also contains management's discussion and analysis of financial condition and results of operations, quantitative and qualitative disclosures about market risk, controls and procedures, legal proceedings, risk factors, unregistered sales of equity securities, use of proceeds, and other information relevant to the quarter. The filing provides detailed financial data, forward-looking statements, and regulatory compliance information for investors and the SEC.",
"fiscalQuarter": 3,
"fiscalYear": 2025,
"companyName": "Zscaler, Inc.",
"tickers": [
"ZS"
],
"metadata": null
}
}
}
}
```
The `sourceMap` can be integrated with Captide’s Document Auditing SDK to render relevant content chunks in frontend applications, enabling accurate source auditing.
### Example 5: Streaming AI Agent Response
The [/rag/agent-response-stream](/api-reference/endpoint/agent_stream) endpoint streams Captide’s AI agent responses in real time using Server-Sent Events (SSE). It’s useful in chat interfaces where you want to show the agent’s reasoning steps and display the response as it’s being generated, rather than waiting for the full message.
```bash theme={null}
curl --request POST \
--url 'https://rest-api.captide.co/api/v1/rag/agent-response?query=Provide%20the%20net%20dollar%20retention%20of%20ZScaler%20for%20the%20last%20two%20quarters' \
--header 'X-API-Key: YOUR_API_KEY'
```
The SSE stream response contains the following event types:
* `thinking` events – Indicate the agent’s internal progress and reasoning stages (e.g., searching, analyzing).
* `message/partial` events – Stream the response incrementally, sending words or phrases as they’re generated.
* `metadata` event – Provides associated document metadata, source links, and citations.
```
event: thinking
data: {"type": "message", "role": "assistant", "content": "I'm going to look through 2 documents from Zscaler, Inc.: To find the net dollar retention for the last two quarters, I need to look at the most recent interim (quarterly) reports, as these typically contain key financial metrics such as net dollar retention. The two most recent interim reports are from May 29, 2025, and March 10, 2025, which correspond to the last two reported quarters. These documents are the most likely to contain the requested information.", "stage": "search"}
event: thinking
data: {"type": "message", "role": "assistant", "content": "I'm now analyzing 2 documents to find the most relevant information...", "stage": "document_inspection"}
event: thinking
data: {"type": "message", "role": "assistant", "content": "I found 2 relevant pages from Zscaler, Inc.", "stage": "document_inspection"}
event: message/partial
data: {"type": "message", "role": "assistant", "content": "Z"}
event: message/partial
data: {"type": "message", "role": "assistant", "content": "sc"}
event: message/partial
data: {"type": "message", "role": "assistant", "content": "aler"}
event: message/partial
data: {"type": "message", "role": "assistant", "content": "'s"}
...
event: message/partial
data: {"type": "message", "role": "assistant", "content": "."}
event: metadata
data: {"type": "sources", "content": {"#207d0044": {"content": "## 34\n\n### We calculate our dollar-based net retention rate as follows:\n\nTable of Contents\nInvesting in Business Growth\nSince our founding, we have invested significantly in growing our business. We intend to continue (i) investing in our\nresearch and development organization and our development efforts to offer new solutions on our cloud platform and (ii)\ndedicating resources to update and upgrade our existing solutions. In addition, we expect our general and administrative expenses\nto increase in absolute dollars in the foreseeable future, as we continue to operate as a public company, and address any legal\nmatters and related accruals, as further described in Note 11, Commitments and Contingencies, of the unaudited condensed\nconsolidated financial statements included elsewhere in this Quarterly Report on Form 10-Q.\nWe also intend to continue to invest significantly in sales and marketing to grow and train our sales force, broaden our brand\nawareness and expand and deepen our channel partner relationships. While these planned investments will increase our operating\nexpenses in the short term, we believe that over the long term these investments will help us to expand our customer base and\ngrow our business. We also are investing in programs to increase recognition of our brand and solutions, including joint marketing\nactivities with our channel partners and strategic partners.\nWhile we expect our operating expenses to increase in absolute dollars in the foreseeable future as a result of these\nactivities, we intend to balance these investments in future growth with a continued focus on managing our results of operations\nand investing judiciously. In the long term we anticipate that these investments will positively impact our business and results of\noperations.\nKey Business Metrics and Other Financial Measures\nWe review a number of operating and financial metrics, including the following key metrics, to measure our performance,\nidentify trends, formulate business plans and make strategic decisions.\nDollar-Based Net Retention Rate\nWe believe that dollar-based net retention rate is an indicator to measure the long-term value of our customer relationships\nbecause it is driven by our ability to retain and expand the recurring revenue generated from our existing customers. Our dollar-\nbased net retention rate compares the recurring revenue from a set of customers against the same metric for the prior 12-month\nperiod on a trailing basis. Because our customers have repeat buying patterns and the average term of our contracts is more than\n12 months, we measure this metric over a set of customers who were with us as of the last day of the same reporting period in the\nprior fiscal year. For the trailing 12 months ended April 30, 2025 and 2024, the dollar-based net retention rate was 114% and\n116%, respectively.\nWe calculate our dollar-based net retention rate as follows:\nDenominator: To calculate our dollar-based net retention rate as of the end of a reporting period, we first establish the ARR\nfrom all active subscriptions as of the last day of the same reporting period in the prior fiscal year. This effectively represents\nrecurring dollars that we expect in the next 12-month period from the cohort of customers that existed on the last day of the same\nreporting period in the prior fiscal year.\nNumerator: We measure the ARR for that same cohort of customers representing all subscriptions based on confirmed\ncustomer orders booked by us as of the end of the reporting period.\nDollar-based net retention rate is obtained by dividing the numerator by the denominator. Our dollar-based net retention rate\nmay fluctuate due to a number of factors, including the performance of our cloud platform, our success in selling bigger deals,\nincluding deals for all employees with our higher-end bundles, selling multiple-pillars from the start of our contract with new\ncustomers, faster upsells within a year, the timing and the rate of ARR expansion of our existing\n34", "pageNumber": 45, "excerpt": "For the trailing 12 months ended April 30, 2025 and 2024, the dollar-based net retention rate was 114% and 116%, respectively.", "documentMetadata": {"id": "207db5da-c2bb-42b8-a0d3-1a5d508e723c", "documentCategory": "interim-report", "formType": null, "date": "2025-05-29", "description": "This document is the Form 10-Q quarterly report filed by Zscaler, Inc. for the third fiscal quarter ended April 30, 2025. It includes unaudited condensed consolidated financial statements such as balance sheets, statements of operations, comprehensive income, stockholders' equity, and cash flows. The report also contains management's discussion and analysis of financial condition and results of operations, quantitative and qualitative disclosures about market risk, controls and procedures, legal proceedings, risk factors, unregistered sales of equity securities, use of proceeds, and other information relevant to the quarter. The filing provides detailed financial data, forward-looking statements, and regulatory compliance information for investors and the SEC.", "fiscalQuarter": 3, "fiscalYear": 2025, "companyName": "Zscaler, Inc.", "tickers": ["ZS"], "metadata": null}}, "#eaf60040": {"content": "## 31\n\n### We calculate our dollar-based net retention rate as follows:\n\nTable of Contents\nInvesting in Business Growth\nSince our founding, we have invested significantly in growing our business. We intend to continue (i) investing in our\nresearch and development organization and our development efforts to offer new solutions on our cloud platform and (ii)\ndedicating resources to update and upgrade our existing solutions. In addition, we expect our general and administrative expenses\nto increase in absolute dollars in the foreseeable future, as we continue to operate as a public company, and address any legal\nmatters and related accruals, as further described in Note 10, Commitments and Contingencies, of the unaudited condensed\nconsolidated financial statements included elsewhere in this Quarterly Report on Form 10-Q.\nWe also intend to continue to invest significantly in sales and marketing to grow and train our sales force, broaden our brand\nawareness and expand and deepen our channel partner relationships. While these planned investments will increase our operating\nexpenses in the short term, we believe that over the long term these investments will help us to expand our customer base and\ngrow our business. We also are investing in programs to increase recognition of our brand and solutions, including joint marketing\nactivities with our channel partners and strategic partners.\nWhile we expect our operating expenses to increase in absolute dollars in the foreseeable future as a result of these\nactivities, we intend to balance these investments in future growth with a continued focus on managing our results of operations\nand investing judiciously. In the long term we anticipate that these investments will positively impact our business and results of\noperations.\nKey Business Metrics and Other Financial Measures\nWe review a number of operating and financial metrics, including the following key metrics, to measure our performance,\nidentify trends, formulate business plans and make strategic decisions.\nDollar-Based Net Retention Rate\nWe believe that dollar-based net retention rate is an indicator to measure the long-term value of our customer relationships\nbecause it is driven by our ability to retain and expand the recurring revenue generated from our existing customers. Our dollar-\nbased net retention rate compares the recurring revenue from a set of customers against the same metric for the prior 12-month\nperiod on a trailing basis. Because our customers have repeat buying patterns and the average term of our contracts is more than\n12 months, we measure this metric over a set of customers who were with us as of the last day of the same reporting period in the\nprior fiscal year. For the trailing 12 months ended January 31, 2025 and 2024, the dollar-based net retention rate was 115% and\n117%, respectively.\nWe calculate our dollar-based net retention rate as follows:\nDenominator: To calculate our dollar-based net retention rate as of the end of a reporting period, we first establish the ARR\nfrom all active subscriptions as of the last day of the same reporting period in the prior fiscal year. This effectively represents\nrecurring dollars that we expect in the next 12-month period from the cohort of customers that existed on the last day of the same\nreporting period in the prior fiscal year.\nNumerator: We measure the ARR for that same cohort of customers representing all subscriptions based on confirmed\ncustomer orders booked by us as of the end of the reporting period.\nDollar-based net retention rate is obtained by dividing the numerator by the denominator. Our dollar-based net retention rate\nmay fluctuate due to a number of factors, including the performance of our cloud platform, our success in selling bigger deals,\nincluding deals for all employees with our higher-end bundles, selling multiple-pillars from the start of our contract with new\ncustomers, faster upsells within a year, the timing and the rate of ARR expansion of our existing\n31", "pageNumber": 41, "excerpt": "For the trailing 12 months ended January 31, 2025 and 2024, the dollar-based net retention rate was 115% and 117%, respectively.", "documentMetadata": {"id": "eaf63939-0da6-4fc7-ba06-adbd46e546a9", "documentCategory": "interim-report", "formType": null, "date": "2025-03-10", "description": "This document is the Form 10-Q quarterly report filed by Zscaler, Inc. for the second fiscal quarter ended January 31, 2025. It includes unaudited condensed consolidated financial statements such as balance sheets, statements of operations, comprehensive loss, stockholders' equity, and cash flows. The report also contains management's discussion and analysis of financial condition and results of operations, quantitative and qualitative disclosures about market risk, controls and procedures, legal proceedings, risk factors, unregistered sales of equity securities, use of proceeds, and exhibits. The filing provides detailed financial data, forward-looking statements, and regulatory compliance information for the quarter.", "fiscalQuarter": 2, "fiscalYear": 2025, "companyName": "Zscaler, Inc.", "tickers": ["ZS"], "metadata": null}}}}
```
All `message/partial` events can be combined to reconstruct the full response and, as with the `/rag/agent-response` endpoint, the final `metadata` event can be used with Captide’s Document Auditing SDK to display relevant content chunks in frontend applications, enabling accurate source traceability and auditing.
## Using the Document Auditing JavaScript SDK
### Installation
Install the Captide SDK in your project:
```bash theme={null}
npm install captide
# or
yarn add captide
```
### Integration Example
Here's how to integrate the document viewer into your React application:
```jsx theme={null}
import React from 'react';
import { DocumentViewer, DocumentViewerProvider, useDocumentViewer } from 'captide';
// Function to fetch document content from your backend that calls our API
const fetchDocument = async (sourceLink) => {
const response = await fetch('/your-backend/document', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ source_link: sourceLink })
});
return response.json();
};
// Example component using the DocumentViewer
function App() {
return (
);
}
function DocumentViewerDemo() {
const { loadDocument } = useDocumentViewer();
// IMPORTANT: sourceLink and elementId come from your API response
// - sourceLink: The 'sourceLink' field from the id_mapping in the streaming response
// or the 'source_link' field in the chunks response
// - elementId: The element ID reference (like '#a060daba') from either the streaming
// or chunks response that you want to highlight
const handleSourceLinkClick = async (sourceLink, elementId) => {
// Load document and highlight specific element
await loadDocument(sourceLink, elementId);
};
return (
);
}
export default App;
```
For a live example of Captide in action, visit [app.captide.co/chat](https://app.captide.co/chat).
## Next Steps
* Explore the [API Reference](/api-reference/introduction) for detailed documentation.
* Obtain a liscence for production or commercial use: [Contact our team](https://www.captide.ai/contact/api-request).