BYO-Perception

Update a BYO Perception engine (owner-only) · 0 credits

Partial update. credentials remains WRITE-ONLY (encrypted, never returned); base_url is re-validated against SSRF.

patch/api/v1/perception-providers/{id}

Request

  • Base URL: https://legal.nexusquantum.legal
  • URL: https://legal.nexusquantum.legal/api/v1/perception-providers/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

labelstring
adapterstring
base_urlstring
credentialsstring nullable
extra_headersobject
enabledboolean

Response

Config updated (no credential).

idstring uuid
labelstring

Human-readable label (1–120).

capability'ocr' | 'asr'

OCR (image/scanned PDF) or ASR (audio/video).

adapterstring

Adapter for the local contract. Default nexus_http (POST {base_url}/ocr|/asr).

base_urlstring

Local engine endpoint (validated against SSRF).

key_fingerprintstring nullable

NON-reversible hash of the credential (e.g. sha256:a1b2c3d4); null if the engine uses no credential. The credential NEVER leaves.

enabledboolean
created_atstring date-time

Changes

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