BYO-Perception

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

Registers a LOCAL OCR/ASR engine for the firm. The credential (bearer) is OPTIONAL and WRITE-ONLY (encrypted, never returned). base_url is validated against SSRF. With an engine registered, that firm's perception goes to ITS engine; without one, it uses the platform engines with a ZERO_RETENTION_EXTERNAL_PERCEPTION notice (a warning, NOT a block). Per-firm limit. Scope: mcp | * (NOT cases).

post/api/v1/perception-providers

Request

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

Request body

labelstring required

1–120 characters.

capability'ocr' | 'asr' required
adapterstring

Default nexus_http.

base_urlstring required

Required; validated against SSRF (422 INVALID_PROVIDER_URL).

credentialsstring nullable

WRITE-ONLY. Bearer token of the local engine; optional. Encrypted server-side and never returned.

extra_headersobject

Optional additional headers (string→string map).

enabledboolean

Default true.

Response

Config created (no credential in the response).

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.