Skip to main content
PUT
Configure retrieval

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

corpus_id
string
required
Minimum string length: 1

Body

application/json
idempotency_key
string
required
Minimum string length: 1
retrieval
object
required

Pin a plugin-provided profile when resolving config. Explicit fields override default fields by logical name; unmapped source data remains preserved. getCorpus returns the effective resolved fields. The only built-in profile, example.editorial, is illustrative (paired with the example extension namespace), not a product default; an uninstalled profile is 422 unsupported_profile.

Response

Successful response

Administrative execution only. Retries keep identity. Intentional terminal rerun has a new ID and previous_operation_id. Cancellation does not promise universal rollback; already-terminal state and racing completion may win. projection_rebuild and retrieval_configuration Operations require corpus_id; when succeeded they require result naming the activated logical generation. This result shape covers those two command kinds only.

operation_id
string
required
Minimum string length: 1
kind
string
required
Minimum string length: 1
state
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancel_requested,
canceled
counters
object
required
errors
object[]
required
Maximum array length: 20
progress
number

Approximate fraction, omitted when unknown.

Required range: 0 <= x <= 1
previous_operation_id
string
Minimum string length: 1
corpus_id
string
Minimum string length: 1
result
object

Logical generation activated for the requested Corpus. Opaque ID, never a physical search collection name.