Skip to main content
POST
Preview subscription

Authorizations

Authorization
string
header
required

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

Body

application/json

A proposed Subscription to preview. Give either definition, an inline Saved Query definition, or saved_query_id with saved_query_version_id, an existing Saved Query Version; not both.

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.

definition
object

Immutable query definition. Expression semantics belong to the evaluator plugin; no core keyword or semantic threshold is implied. All Corpora belong to the authorized Organization.

saved_query_id
string
Minimum string length: 1
saved_query_version_id
string
Minimum string length: 1
limit
integer
default:20

The most Record Versions to judge, newest first. Each one costs an evaluator call.

Required range: 1 <= x <= 50
accepted_after
string<date-time>

Judge only revisions accepted after this instant.

Response

Successful response

What a proposed Subscription would have matched among recent Record Versions.

evaluated
integer
required

Record Versions the evaluator decided.

Required range: x >= 0
matched
integer
required
Required range: x >= 0
not_ready
integer
required

Record Versions the evaluator could not decide yet (for example before enrichment).

Required range: x >= 0
complete
boolean
required

False when the time budget ran out before every listed Record Version was decided.

matches
object[]
required

Most recently accepted first.

Maximum array length: 50
oldest_accepted_at
string<date-time>

When the oldest decided Record Version was accepted; absent when none was decided.