Create connector

We recommend using Bigdata Connectors Management on the Developer Platform. 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. Optionally set config.date_limit as the lower bound for the initial sync and config.rolling_history_days to keep only a rolling window of ingested research.

POST /contents/v1/connectors

cURL

email_connector

curl --request POST \
  --url https://api.bigdata.com/contents/v1/connectors \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data @- <<EOF
{
  "type": "email",
  "label": "Analyst Research - Daily Reports",
  "description": "Collects daily reports from the analyst's research team",
  "share_with_org": false,
  "enrichments": [
    "translation"
  ],
  "config": {
    "allowed_emails": [
      "[e-mail]",
      "[e-mail]"
    ]
  }
}
EOF

200

{
  "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",
  "type": "email",
  "description": "Collects daily reports from the broker's research team",
  "config": {
    "allowed_emails": [
      "[e-mail]",
      "[e-mail]"
    ],
    "email_hash": "a1b2c3d4e5f6",
    "email": "[e-mail]"
  },
  "created_at": "2026-02-11T11:01:09.574095Z",
  "updated_at": "2026-02-11T11:01:09.574102Z",
  "archived": false
}

Authorizations

X-API-KEY · string · header · required

Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.

Body

application/json

Payload for creating a new connector.

type · enum<string> · 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.

Available options: email, investment_research, sharepoint

label · string · required

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

Example:

"Broker Research - Daily Reports"

config · Email · object · required

Connector-specific configuration. The structure depends on the connector type.

Email

Investment research

SharePoint

Show child attributes

description · string

Optional short description of what this connector is used for.

Example:

"Collects daily reports from the broker's research team"

share_with_org · boolean · default: false

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

Example:

false

enrichments · enum<string>[]

Optional list of enrichments to apply to content ingested through this connector. Each value configures the processing pipeline to run an additional step on the content.

Supported enrichments:

• reporting_entities: Identifies the document's reporting company, using the same concept as the ReportingEntity reporting detail in Search. This keeps the reporting entity consistent with the rest of the Bigdata corpus, so you can reliably filter private content, transcripts and filings together.
• translation: Translates the document content so non-English material can be searched and analyzed alongside the rest of your corpus. Supports more than 70 languages.

Available options: reporting_entities, translation

Example:

["translation"]

Response

200

application/json

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

An ingestion source (e.g. email inbox, investment research / broker feed, or Microsoft SharePoint). Returned by Create/Get/Update connector and List connectors.

connector_id · string<uuid> · required

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

Example:

"019a9612-bfad-758c-884e-37dd8c6ad2cb"

user_id · string · required

ID of the user who owns the connector.

Example:

"user_id_001"

org_id · string · required

ID of the organization the connector belongs to.

Example:

"org_id_001"

share_with_org · boolean · required

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

Example:

true

label · string · required

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

Example:

"Broker Research - Daily Reports"

type · enum<string> · required

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

Available options: email, investment_research, sharepoint

created_at · string<date-time> · required

Timestamp when the connector was created.

Example:

"2026-02-11T11:01:09.574095Z"

updated_at · string<date-time> · required

Timestamp when the connector was last updated.

Example:

"2026-02-11T11:01:09.574102Z"

archived · boolean · required

Whether the connector is archived.

Example:

false

description · string

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

Example:

"Collects daily reports from the broker's research team"

enrichments · enum<string>[]

Enrichments applied to content ingested through this connector. Each value adds a step to the processing pipeline.

Supported enrichments:

• reporting_entities: Identifies the document's reporting company, using the same concept as the ReportingEntity reporting detail in Search. This keeps the reporting entity consistent with the rest of the Bigdata corpus, so you can reliably filter private content, transcripts and filings together.
• translation: Translates the document content so non-English material can be searched and analyzed alongside the rest of your corpus. Supports more than 70 languages.

Available options: reporting_entities, translation

Example:

["translation"]

config · Email · object

Type-specific settings. Email connectors return inbox and allowed senders; investment research connectors return user_id and rolling_history_days (null when not set), never user_password; SharePoint connectors return config as {}.

Email

Investment research

SharePoint

Show child attributes

files_count · integer

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

Example:

10

last_sync_at · string<date-time> | null

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

Example:

"2026-04-07T09:36:34.195040Z"

last_sync_status · string | null

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

Example:

"SUCCESS"

last_sync_error_msg · string | null

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

Example:

null

last_sync_count · integer | null

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

Example:

3200