Skip to main content
POST
Create subscription version

Authorizations

Authorization
string
header
required

API key, not necessarily a JWT. Server derives Organization, permitted actions and Corpus scope; every resource access is authorized.

Path Parameters

subscription_id
string
required
Minimum string length: 1

Body

application/json

New immutable configuration of an existing Subscription. The Saved Query and name are unchanged (rename changes the name); saved_query_version_id is the current Version of that Saved Query.

idempotency_key
string
required
Minimum string length: 1
saved_query_version_id
string
required
Minimum string length: 1
evaluator
object
required

Pins an installed evaluator by plugin id and version, and its configuration. Evaluators are the subscription Contributions of the plugins pinned at startup (Plugin Protocol v0); test deployments may also install the deterministic fixture quivr.fixture@1. The configuration must satisfy the evaluator's declared configuration schema.

destination_id
string
required
Minimum string length: 1

Response

Successful response

Immutable Subscription configuration. Every Version keeps the Subscription's owner, absent for a global Subscription.

subscription_id
string
required
Minimum string length: 1
version_id
string
required
Minimum string length: 1
saved_query_id
string
required
Minimum string length: 1
saved_query_version_id
string
required
Minimum string length: 1
evaluator
object
required

Pins an installed evaluator by plugin id and version, and its configuration. Evaluators are the subscription Contributions of the plugins pinned at startup (Plugin Protocol v0); test deployments may also install the deterministic fixture quivr.fixture@1. The configuration must satisfy the evaluator's declared configuration schema.

destination_id
string
required
Minimum string length: 1
owner
string

Subscription Owner, an opaque end-user reference defined by the client application (for example user-123). Quivr stores, filters and echoes it without interpreting it. At most 128 characters without control characters; none is reserved for the listing filter (422 invalid_owner).

Required string length: 1 - 128