Skip to main content
PATCH
Set how often a source syncs

Authorizations

Authorization
string
header
required

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

Headers

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]+$

Path Parameters

id
string
required

The source id, src_….

Body

application/json
sync_interval_s
integer | null

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

Required range: 300 <= x <= 2592000
Example:

3600

Response

The source.

id
string
required
Example:

"src_2b9c1f"

type
string
required
Example:

"hubspot"

name
string
required
Example:

"HubSpot"

namespace
string
required

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

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

"docs"

"user-42"

status
enum<string>
required

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

Available options:
connecting,
syncing,
ready,
error
error
string | null
required
documents
integer
required

Documents synced from this source.

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

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

sync_interval_auto
boolean
required

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

next_sync_at
string<date-time> | null
required

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

cost
object
required

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.