v1

latestOpenAPI 3.1.02026-07-2268276396.6 KB

Connectors

Delete connector by ID

By default, soft-deletes a connector: the connector is marked as archived and will no longer ingest new content; existing documents that were ingested by this connector remain available. The operation is idempotent for an already-archived connector.

To permanently remove the connector and all related data, add the query parameter force_delete=true. This triggers a hard delete flow: all files related to this connector are deleted asynchronously. Once all files are deleted, the connector is removed from the database (final step of the async process). The deletion process is asynchronous.

delete/contents/v1/connectors/{connector_id}

Path parameters

connector_idstring uuid required

Example:019a9612-bfad-758c-884e-37dd8c6ad2cb

UUID of the connector to archive or to hard-delete when force_delete=true.

Query parameters

force_deleteboolean

If true, triggers a hard delete: all files related to this connector are deleted asynchronously, then the connector is removed from the database. If omitted or false, the connector is soft-deleted (archived) and existing documents remain.

Response

Without force_delete: the connector object in its archived state; it will no longer accept new content and existing documents are unchanged. With force_delete=true: the request is accepted and the hard delete runs asynchronously (all related files are deleted, then the connector is removed from the database).

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"
}