Skip to main content
POST
Sync a source now

Authorizations

Authorization
string
header
required

An API key from conare.ai/console/keys. It can read and write every namespace in its organization.

Path Parameters

id
string
required

The source id, src_….

Response

The source, now syncing.

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 the app owner to sign in. syncing: a sync is running. ready: synced; the next sync runs on schedule. 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