Connectors

Create connector

Create a Connector Instance bound to exactly one authorized Corpus and one Source Namespace. Kind-specific config and credential secret are validated against the kind's JSON Schema (see listConnectorKinds); a failure is 422 invalid_config or invalid_credential with field pointing at the offending member. Replaying the same idempotency key and request returns the same instance (without re-enabling a disabled one); a different request under the same key is 409 idempotency_conflict. Another enabled instance on the same Corpus and Source Namespace is 409 source_namespace_in_use. The interval defaults per kind and is refused below the deployment floor (30 s by default) with 422 invalid_interval. Deposited credentials are write-only and never returned. A deployment without a credential key refuses any request carrying a credential with 503 credentials_unavailable (retryable false) before storing or digesting it; instances without a credential are unaffected. Commits connector.created in the change feed.

post/v0/connectors

Request

  • Base URL
    https://docs.quivr.thevibecompany.co (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

idempotency_keystring required
corpus_idstring required
source_namespacestring required
kindstring required

Connector kind, provided by a pinned connector plugin; listConnectorKinds lists the kinds this deployment accepts. First-party connector plugins provide rss (RSS 2.0, RSS 1.0, Atom and JSON Feed documents; config url, optional honor_ttl; optional credential username+password or token), x_list (an X list) and m365_mail (Microsoft 365 mailboxes). Another kind is refused with 422 unsupported_connector_kind.

work_queue'live' | 'bulk'

Workload class for scheduled acquisition and its documents. Push deliveries always use live.

configobject required

Kind-specific configuration validated by the kind's JSON Schema. Holds no secret.

Response

Successful response

connector_idstring required
corpus_idstring required
source_namespacestring required
kindstring required

Connector kind, provided by a pinned connector plugin; listConnectorKinds lists the kinds this deployment accepts. First-party connector plugins provide rss (RSS 2.0, RSS 1.0, Atom and JSON Feed documents; config url, optional honor_ttl; optional credential username+password or token), x_list (an X list) and m365_mail (Microsoft 365 mailboxes). Another kind is refused with 422 unsupported_connector_kind.

work_queue'live' | 'bulk'

Workload class for scheduled acquisition; push deliveries stay live.

configobject required
enabledboolean required
created_atstring date-time required
disabled_atstring date-time
paused_atstring date-time

Present while scheduled acquisition is paused. Inbound push routes remain available.

webhook_urlstring uri

Public address of the instance's webhook route, present when its kind declares the push mode and the deployment sets public_url. The kind's plugin registers it with the source.

Changes

No recorded changes to this operation across all 1 revision of this API.