Джерела

Джерело синхронізує застосунок з одним простором імен: нові та змінені записи записуються, видалені — видаляються. Джерелам потрібен ключ з повним доступом; для бакета дивіться 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`, а також `base_url` для self-hosted Twenty; вони синхронізуються одразу, без `connect_url`

Щоб підключати застосунки своїх користувачів, дайте кожному користувачу простір імен, як-от user-42. Повна схема: Підключити джерело.

Синхронізовані документи


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`	Що читає синхронізація і скільки коштує кожна частота синхронізації на місяць

Повна схема: Отримати джерело.

Перелік джерел

GET /sources Повертає sources, кожне в тому вигляді, що й Get; джерело з kind, як-от files чи gcs, натомість має об’єкт sync.

Параметр	Тип	Що робить
`namespace`, `user`, `type`	string	Лише джерела, у яких поле дорівнює значенню, як-от `?namespace=crm&type=hubspot`

Повна схема: Перелік джерел.

Синхронізуйте зараз

POST /sources/:id/sync Запускає синхронізацію за кілька секунд і повертає джерело; джерело, яке ще в стані connecting, повертає 409 conflict.

Параметр	Тип	Що робить
`full`	boolean, за замовчуванням `false`	Прочитати все знову, а не лише зміни (Gmail, Twenty, Granola, GitHub); повна синхронізація Gmail тарифікується як перша, і `resync` про це повідомляє

Повна схема: Синхронізувати джерело зараз.

Змініть інтервал синхронізації

PATCH /sources/:id

Параметр	Тип	Що робить
`sync_interval_s`	integer або null	Від 300 до 2 592 000 секунд; `null` дозволяє Conare обрати

Повертає джерело. Повна схема: Налаштувати частоту синхронізації джерела.

Відключіть джерело

DELETE /sources/:id Зупиняє синхронізацію і повертає { "deleted": true }.

Параметр	Тип	Що робить
`delete_documents`	boolean, за замовчуванням `false`	Також видалити документи, які воно синхронізувало

Повна схема: Відключити джерело.

Перелік застосунків

GET /sources/types

Response

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

Кожен має type для підключення, свої name і logo_url, а також auth: "api_key" для застосунків, що підключаються через config.
partial дорівнює true, коли вдалося отримати лише ці застосунки: спробуйте пізніше.

Повна схема: Перелік типів джерел.

Початок роботи

Основне

Файли

Синхронізація

Моделі

Інструменти

Джерела

Підключіть джерело

Синхронізовані документи

Отримайте джерело

Перелік джерел

Синхронізуйте зараз

Змініть інтервал синхронізації

Відключіть джерело

Перелік застосунків

​Підключіть джерело

​Синхронізовані документи

​Отримайте джерело

​Перелік джерел

​Синхронізуйте зараз

​Змініть інтервал синхронізації

​Відключіть джерело

​Перелік застосунків

Підключіть джерело

Синхронізовані документи

Отримайте джерело

Перелік джерел

Синхронізуйте зараз

Змініть інтервал синхронізації

Відключіть джерело

Перелік застосунків