Saltar al contenido principal
PATCH
Set how often a source syncs

Autorizaciones

Authorization
string
header
requerido

A key from conare.ai/dashboard/keys with full access, some namespaces, or models only (/embed, /rerank, /v1, /v2/rerank, /parse).

Encabezados

Idempotency-Key
string

One key (a UUID) per logical write, sent again on each retry: a repeat within 24 hours replays the first successful answer.

Required string length: 1 - 255
Pattern: ^[\x21-\x7e]+$

Parámetros de ruta

id
string
requerido

The source id, src_….

Cuerpo

application/json
sync_interval_s
integer | null

Seconds between syncs; null or absent is the automatic interval.

Rango requerido: 300 <= x <= 2592000
Ejemplo:

3600

Respuesta

The source.

id
string
requerido
Ejemplo:

"src_2b9c1f"

type
string
requerido
Ejemplo:

"hubspot"

name
string
requerido
Ejemplo:

"HubSpot"

namespace
string
requerido

1-64 characters of a-z 0-9 _ -, starting with a letter or digit.

Pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
Ejemplos:

"docs"

"user-42"

status
enum<string>
requerido

connecting (waiting for sign-in), syncing, ready, or error (see error).

Opciones disponibles:
connecting,
syncing,
ready,
error
error
string | null
requerido
documents
integer
requerido

Documents synced from this source.

last_synced_at
string<date-time> | null
requerido
created_at
string<date-time>
requerido
sync_interval_s
integer | null
requerido

Seconds between syncs in force; null while automatic and before the first sync.

sync_interval_auto
boolean
requerido

True when Conare picks the interval from what each sync reads.

next_sync_at
string<date-time> | null
requerido

When the next sync starts. Null while connecting or syncing.

cost
object
requerido

What the source's syncs read and what each frequency costs a month, at usd_per_million_rows.

progress
object

Only while syncing: the run in flight.