数据源

数据源将一个应用同步到一个命名空间：新增和变更的记录会被写入，已删除的记录会被删除。数据源需要完全访问权限的密钥；存储桶请参阅 Google Cloud Storage。

连接数据源

POST /sources

curl https://api.conare.ai/sources \
  -H "Authorization: Bearer $CONARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type": "hubspot", "namespace": "crm", "redirect_url": "https://yourapp.com/settings"}'

const { source, connectUrl } = await conare.sources.connect({
  type: "hubspot",
  namespace: "crm",
  redirectUrl: "https://yourapp.com/settings",
});

Response

{
  "source": {
    "id": "src_1cff2c6ea888bbc8343b6e38",
    "type": "hubspot",
    "name": "HubSpot",
    "namespace": "crm",
    "status": "connecting",
    "error": null,
    "documents": 0,
    "last_synced_at": null,
    "created_at": "2026-10-21T21:40:39.704618Z",
    "sync_interval_s": null,
    "sync_interval_auto": true,
    "next_sync_at": null,
    "cost": { "rows_billed": true, "usd_per_million_rows": 100, "options": [ ... ] }
  },
  "connect_url": "https://..."
}

将应用的所有者引导至 connect_url（7 天内有效）；对方完成连接后即开始首次同步。

选项	类型	作用
`type`	string，必填	应用，取自列表
`namespace`	string，必填	要同步到的命名空间
`name`	string	显示名称，最多 100 个字符
`redirect_url`	string	用户连接后跳转的地址
`sync_interval_s`	integer	同步间隔秒数，300 到 2,592,000（30 天）；省略时由 Conare 选择
`config`	object	用于通过密钥连接的应用（Twenty、Granola、GitHub）：`api_key`，自托管 Twenty 还需 `base_url`；这些应用会立即同步，没有 `connect_url`

要连接你的用户的应用，请为每个用户分配一个命名空间，例如 user-42。完整 schema：连接数据源。

同步的文档


Id	`<source id>:<schema>:<record key>`
元数据	`source`、`source_id`、`schema`、`title`，以及记录中存在时的 `url`、`author`、`created_at`、`updated_at`
搜索单个数据源	按 `source_id` 过滤

获取数据源

GET /sources/:id

curl

curl https://api.conare.ai/sources/src_1cff2c6ea888bbc8343b6e38 \
  -H "Authorization: Bearer $CONARE_API_KEY"

字段	含义
`id`, `type`, `name`, `namespace`	与连接时一致
`status`	`connecting`（等待登录）、`syncing`、`ready` 或 `error`
`error`	失败原因，或 `null`
`documents`	已同步的文档数
`progress`	同步期间，目前的 `records_pulled`
`created_at`, `last_synced_at`, `next_sync_at`	连接时间、上次同步时间和下次同步时间
`sync_interval_s`, `sync_interval_auto`	同步间隔秒数，以及是否由 Conare 选择
`cost`	一次同步读取的内容，以及各同步频率每月的费用

完整 schema：获取数据源。

列出数据源

GET /sources 返回 sources，每项与“获取”返回的格式相同；带有 kind（如 files 或 gcs）的数据源则改为包含 sync 对象。

选项	类型	作用
`namespace`, `user`, `type`	string	仅返回该字段等于指定值的数据源，例如 `?namespace=crm&type=hubspot`

完整 schema：列出数据源。

立即同步

POST /sources/:id/sync 在几秒内开始同步并返回数据源；仍处于 connecting 的数据源返回 409 conflict。

选项	类型	作用
`full`	boolean，默认 `false`	重新读取全部内容，而不只是变更（Gmail、Twenty、Granola、GitHub）；Gmail 的完整同步按首次同步计费，`resync` 会注明这一点

完整 schema：立即同步数据源。

更改同步间隔

PATCH /sources/:id

选项	类型	作用
`sync_interval_s`	integer 或 null	300 到 2,592,000 秒；`null` 表示由 Conare 选择

返回数据源。完整 schema：设置数据源的同步频率。

断开数据源

DELETE /sources/:id 停止同步并返回 { "deleted": true }。

选项	类型	作用
`delete_documents`	boolean，默认 `false`	同时删除其同步的文档

完整 schema：断开数据源。

列出应用

GET /sources/types

Response

{
  "types": [
    { "type": "affinity", "name": "Affinity", "logo_url": "https://..." },
    { "type": "airtable", "name": "Airtable", "logo_url": "https://..." }
  ]
}

每项包含用于连接的 type、其 name 和 logo_url，通过 config 连接的应用还带有 auth: "api_key"。
当只能列出这些应用时，partial 为 true：请稍后重试。

完整 schema：列出数据源类型。

快速开始

核心

文件

同步

模型

工具

连接数据源

同步的文档

获取数据源

列出数据源

立即同步

更改同步间隔

断开数据源

列出应用

​连接数据源

​同步的文档

​获取数据源

​列出数据源

​立即同步

​更改同步间隔

​断开数据源

​列出应用

连接数据源

同步的文档

获取数据源

列出数据源

立即同步

更改同步间隔

断开数据源

列出应用