Fontes

Uma fonte sincroniza um app com um namespace: registros novos e alterados são gravados, e os excluídos são excluídos. Fontes exigem uma chave com acesso Full; para um bucket, veja Google Cloud Storage.

Conectar uma fonte

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://..."
}

Envie o dono do app para a connect_url (válida por 7 dias); a primeira sincronização começa quando ele se conecta.

Opção	Tipo	O que faz
`type`	string, obrigatório	O app, da lista
`namespace`	string, obrigatório	O namespace a sincronizar
`name`	string	Um nome de exibição, de até 100 caracteres
`redirect_url`	string	Para onde enviar o usuário depois que ele se conecta
`sync_interval_s`	integer	Segundos entre sincronizações, de 300 a 2.592.000 (30 dias); a Conare escolhe um se omitido
`config`	object	Para apps que se conectam com uma chave (Twenty, Granola, GitHub): `api_key`, e `base_url` para um Twenty auto-hospedado; estes sincronizam na hora, sem `connect_url`

Para conectar os apps dos seus usuários, dê a cada usuário um namespace, como user-42. Schema completo: Conectar uma fonte.

Documentos sincronizados


Id	`<source id>:<schema>:<record key>`
Metadados	`source`, `source_id`, `schema`, `title`, e `url`, `author`, `created_at`, `updated_at` quando o registro os tem
Buscar em uma fonte	Filtre por `source_id`

Obter uma fonte

GET /sources/:id

curl

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

Campo	Significado
`id`, `type`, `name`, `namespace`	Como conectado
`status`	`connecting` (aguardando login), `syncing`, `ready` ou `error`
`error`	O que falhou, ou `null`
`documents`	Documentos que ela sincronizou
`progress`	Durante a sincronização, `records_pulled` até o momento
`created_at`, `last_synced_at`, `next_sync_at`	Quando foi conectada, sincronizada pela última vez e quando sincroniza de novo
`sync_interval_s`, `sync_interval_auto`	Segundos entre sincronizações, e se a Conare os escolhe
`cost`	O que uma sincronização lê, e quanto cada frequência de sincronização custa por mês

Schema completo: Obter uma fonte.

Listar fontes

GET /sources Retorna sources, cada uma como o Get a retorna; uma fonte com um kind, como files ou gcs, tem um objeto sync no lugar.

Opção	Tipo	O que faz
`namespace`, `user`, `type`	string	Apenas fontes cujo campo é igual ao valor, como `?namespace=crm&type=hubspot`

Schema completo: Listar fontes.

Sincronizar agora

POST /sources/:id/sync Inicia uma sincronização em segundos e retorna a fonte; uma fonte ainda em connecting retorna 409 conflict.

Opção	Tipo	O que faz
`full`	boolean, padrão `false`	Lê tudo de novo, não só as alterações (Gmail, Twenty, Granola, GitHub); uma sincronização completa do Gmail é cobrada como uma primeira sincronização, e `resync` indica isso

Schema completo: Sincronizar uma fonte agora.

Alterar o intervalo de sincronização

PATCH /sources/:id

Opção	Tipo	O que faz
`sync_interval_s`	integer ou null	De 300 a 2.592.000 segundos; `null` deixa a Conare escolher

Retorna a fonte. Schema completo: Definir a frequência de sincronização de uma fonte.

Desconectar uma fonte

DELETE /sources/:id Para a sincronização e retorna { "deleted": true }.

Opção	Tipo	O que faz
`delete_documents`	boolean, padrão `false`	Também exclui os documentos que ela sincronizou

Schema completo: Desconectar uma fonte.

Listar os apps

GET /sources/types

Response

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

Cada um tem o type para conectar, seu name e logo_url, e auth: "api_key" para apps que se conectam com config.
partial é true quando só esses apps puderam ser listados: tente de novo mais tarde.

Schema completo: Listar tipos de fonte.

Primeiros passos

Essencial

Arquivos

Sincronização

Modelos

Ferramentas

Conectar uma fonte

Documentos sincronizados

Obter uma fonte

Listar fontes

Sincronizar agora

Alterar o intervalo de sincronização

Desconectar uma fonte

Listar os apps

​Conectar uma fonte

​Documentos sincronizados

​Obter uma fonte

​Listar fontes

​Sincronizar agora

​Alterar o intervalo de sincronização

​Desconectar uma fonte

​Listar os apps

Conectar uma fonte

Documentos sincronizados

Obter uma fonte

Listar fontes

Sincronizar agora

Alterar o intervalo de sincronização

Desconectar uma fonte

Listar os apps