Skip to content
KortexyaKortexyaReasoning Layer SDK

Interface: VocabularyMutationOptions

@kortexya/reasoninglayer

@kortexya/reasoninglayer / VocabularyMutationOptions

Interface: VocabularyMutationOptions

Section titled “Interface: VocabularyMutationOptions”

Defined in: src/types/vocabulary.ts:286

The per-call options of a vocabulary mutation.

Remarks

Section titled “Remarks”

idempotencyKey is required and is never generated by the SDK: keep it across retries of the same request. The engine scopes it to (tenant, actor, operation, key):

  • an identical repeat answers the committed outcome with replayed: true and writes nothing;
  • the same key with a different request is refused (IdempotencyKeyReusedError, 422 idempotency_key_reused);
  • a refusal stores nothing, so a repeat is evaluated again.

A key is 1 to 128 characters of [A-Za-z0-9._:-]; any other value is refused 400 idempotency_key_malformed. The acting user is the client’s authenticatedUser (X-Authenticated-User: user:<uuid>).

Extends

Section titled “Extends”

Extended by

Section titled “Extended by”

Properties

Section titled “Properties”

causal?

Section titled “causal?”

optional causal?: AuditCausalHeaders

Defined in: src/types/common.ts:97

Causal assertions for the audit ledger, sent as the x-osfkb-* request headers. See AuditCausalHeaders.

Inherited from

Section titled “Inherited from”

RequestOptions.causal

idempotencyKey

Section titled “idempotencyKey”

idempotencyKey: string

Defined in: src/types/vocabulary.ts:288

The Idempotency-Key header.

namespaceId?

Section titled “namespaceId?”

optional namespaceId?: string

Defined in: src/types/common.ts:84

Override the namespace for this request (X-Namespace-Id header).

Inherited from

Section titled “Inherited from”

RequestOptions.namespaceId

retries?

Section titled “retries?”

optional retries?: number

Defined in: src/types/common.ts:92

Number of retry attempts for this request. Set to 0 to disable retries.

Inherited from

Section titled “Inherited from”

RequestOptions.retries

signal?

Section titled “signal?”

optional signal?: AbortSignal

Defined in: src/types/common.ts:88

AbortSignal for request cancellation.

Inherited from

Section titled “Inherited from”

RequestOptions.signal

timeoutMs?

Section titled “timeoutMs?”

optional timeoutMs?: number

Defined in: src/types/common.ts:90

Per-call timeout in milliseconds. Overrides the client-level timeoutMs default.

Inherited from

Section titled “Inherited from”

RequestOptions.timeoutMs

userId?

Section titled “userId?”

optional userId?: string

Defined in: src/types/common.ts:86

Override the user ID for this request (X-User-Id header). Used for admin impersonation.

Inherited from

Section titled “Inherited from”

RequestOptions.userId