Skip to main content
POST
/
contents
/
v1
/
connectors
Create 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": "Broker Research - Daily Reports",
  "description": "Collects daily reports from the broker's research team",
  "share_with_org": false,
  "config": {
    "allowed_emails": [
      "user@example.com",
      "admin@example.com"
    ]
  }
}
EOF
{
  "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": [
      "user@example.com",
      "admin@example.com"
    ],
    "email_hash": "a1b2c3d4e5f6",
    "email": "a1b2c3d4e5f6@bigdata.com"
  },
  "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. A connector is defined by its type and configuration. If type is 'email', an inbox will be created. This inbox will be used to collect emails and automatically extract their content into Bigdata.

Available options:
email
​
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.

​
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

Response

The created connector, including connector_id and (for email) the inbox address in config. New content sent to the connector will be ingested and appear as documents.

An ingestion source (e.g. email inbox). 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 (e.g. email). Determines the configuration and how content is ingested.

Available options:
email
​
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"

​
config
Email · object

Type-specific settings (e.g. in the case of email type,allowed_emails is mandatory)