Sign in

v1

latestOpenAPI 3.1.02026-07-2268276396.6 KB
Connectors

Create connector

We recommend using Bigdata Connectors Management on the Developer Platform—the guided experience sets up connectors in four simple steps. You can also call this endpoint to register connectors programmatically.

Provide the connector type, label, and type-specific config.

For email connectors, an inbox is created and its address is returned; forward emails from allowed senders to that address to ingest, process and index incoming content.

For investment_research connectors, provide broker credentials and the platform will sync research documents from the broker feed.

For sharepoint (Microsoft SharePoint) connectors, set "type": "sharepoint" and supply config.session_id only. Contact support@bigdata.com to know more about how to generate this parameter.

post/contents/v1/connectors

Request body

type'email' | 'investment_research' | 'sharepoint' required

Type of the connector. If type is email, an inbox is created for forwarding messages into Bigdata. If type is investment_research, provide broker credentials in config for automated sync of research documents.

labelstring required

Display name for the connector (e.g. for admin UIs or List connectors).

descriptionstring

Optional short description of what this connector is used for.

share_with_orgboolean

If true, all members of your organization can access the processed content. If false, only you can access the processed content.

Example request

{
  "label": "Broker Research - Daily Reports",
  "description": "Collects daily reports from the broker's research team",
  "config": {
    "allowed_emails": [
      "user@example.com",
      "admin@example.com"
    ],
    "email_hash": "a1b2c3d4e5f6",
    "email": "connector@bigdata.com"
  }
}

Response

The created connector. Email and investment_research responses include the non-secret fields described for each type. Sharepoint responses return **config as {}

connector_idstring uuid required

Unique identifier for the connector. Use when updating, deleting, or filtering documents by connector.

user_idstring required

ID of the user who owns the connector.

org_idstring required

ID of the organization the connector belongs to.

share_with_orgboolean required

If true, all members of your organization can access the processed content. If false, only you can access the processed content.

labelstring required

Display name for the connector (e.g. for UI or admin lists).

type'email' | 'investment_research' | 'sharepoint' required

Connector type. Determines the configuration and how content is ingested.

descriptionstring

Optional human-readable description of what the connector is used for.

files_countinteger

Number of files ingested through this connector, when tracked (e.g. investment research sync).

last_sync_atstring date-time nullable

Timestamp of the last sync from the external source, when applicable.

last_sync_statusstring nullable

Outcome of the last sync (e.g. SUCCESS), when applicable.

last_sync_error_msgstring nullable

Error message from the last sync when it failed; null on success.

last_sync_countinteger nullable

Number of items processed in the last sync, when applicable.

created_atstring date-time required

Timestamp when the connector was created.

updated_atstring date-time required

Timestamp when the connector was last updated.

archivedboolean required

Whether the connector is archived.

Example response

{
  "connector_id": "019a9612-bfad-758c-884e-37dd8c6ad2cb",
  "user_id": "user_id_001",
  "org_id": "org_id_001",
  "share_with_org": true,
  "label": "Broker Research - Daily Reports",
  "description": "Collects daily reports from the broker's research team",
  "config": {
    "allowed_emails": [
      "user@example.com",
      "admin@example.com"
    ],
    "email_hash": "a1b2c3d4e5f6",
    "email": "connector@bigdata.com"
  },
  "files_count": 10,
  "last_sync_at": "2026-04-07T09:36:34.195040Z",
  "last_sync_status": "SUCCESS",
  "last_sync_count": 3200,
  "created_at": "2026-02-11T11:01:09.574095Z",
  "updated_at": "2026-02-11T11:01:09.574102Z"
}