Skip to main content

​
Overview

The Bigdata Content API lets you manage and query content that you or your organization uploads to Bigdata. Use it to configure connectors (ingestion sources such as Email or SharePoint), so your private content is available for search and chat.

​
Connectors

Connectors are the entry point for ingesting private content into Bigdata.
  • You create a connector with a type, label, and type-specific configuration. Supported connector types include Email Inbox and coming soon, Microsoft Sharepoint.
    • For Email, the API returns an inbox address; you forward messages from allowed senders to that address.
  • The service ingests content from the connector and turns it into documents you can manage and use via Search and Research Services.
  • Example: an email inbox labeled Broker Research - Daily Reports that receives daily reports from the research team. You can configure the connector to share content across the organization so your team can use Bigdata Search and Research Services on the same data.
Typical operations:
  • Create connector: Register a new ingestion source. For email connectors, the response includes a connector ID and an inbox address; forward messages from allowed senders to that address to ingest content into Bigdata.
  • List connectors: List all connectors you can access; use connector IDs to filter documents or to update/delete.
  • Get connector: Fetch full details for one connector (config, share settings, timestamps).
  • Update connector: Change label, description, sharing, or configuration of the connector.
  • Delete connector: Soft-delete (archive) a connector; it stops ingesting new content but existing documents remain.
Once a connector is set up, documents are ingested according to its configuration.

​
Documents

Documents are the ingested items (e.g. email bodies, attachments, files from SharePoint) that Bigdata has processed and made available for search and analysis.
  • List documents: Paginated list of documents you can access. Supports filtering and sorting; each item includes a content ID for use with the other document endpoints.
  • Get document: Return metadata for one document by content ID (status, file name, connector, tags, timestamps). Use this to check processing status before downloading content.
  • Get annotated document: Return a time-limited pre-signed URL. GET that URL to download the document as structured JSON (metadata, title, body blocks, entities, sentences with sentiment). Use for search indexing, entity extraction, or structured display.
  • Get original document: Return a time-limited pre-signed URL. GET that URL to download the original file in its native format (e.g. .eml, .pdf).
Documents can be tagged (e.g. by sender/recipient for emails). Use List tags to discover tag names and List documents with the tags parameter to filter by them.

​
Typical flow

  1. Create a connector (e.g. email) with type, label, and config; for email, use the returned inbox address to forward messages.
  2. Optional: Check that your files have been processed by listing your recent documents (List documents).
  3. Interact with your content via the Search Service or Research Service. In the playgrounds below, use the source selector and filter by the My Files category to query only your uploaded content.

Search Service Playground

Search across your private content and other sources. In the playground, open the source selector and choose My Files to limit results to your uploaded documents.

Research Agent Playground

Run research over your private content and real-time data. In the playground, use the source selector and filter by My Files to ground answers in your documents.

​
Authentication and reference

All endpoints require an API key sent in the X-API-KEY header. See Authentication for details. Use the API reference (endpoints listed in this section) for request/response schemas, parameters, and examples. You can try the API from the Developer Platform playgrounds.