Quantum Nexus BYO Perception API

The BYO-Perception API from Quantum Nexus — 3 operation(s) for byo-perception.

GitHub OpenAPI

Operations 6

GET /api/v1/perception-providers List the firm's BYO Perception engines (OCR/ASR) (owner-only) · 0 credits #
POST /api/v1/perception-providers Register a local BYO Perception engine (owner-only) · 0 credits #
GET /api/v1/perception-providers/{id} BYO Perception engine detail (owner-only) · 0 credits #
PATCH /api/v1/perception-providers/{id} Update a BYO Perception engine (owner-only) · 0 credits #
DELETE /api/v1/perception-providers/{id} Delete a BYO Perception engine (owner-only) · 0 credits #
POST /api/v1/perception-providers/{id}/test Test a BYO Perception engine connection (owner-only) · 0 credits #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nexusquantum-legal:nexusquantum-legal-byo-perception-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nexusquantum-legal-byo-perception-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nexus Legal BYO Perception API
  version: 1.95.0
  description: 'Multi-jurisdictional legal analysis API with a multi-agent architecture and Zero Retention. ## Output language


    `language` (and the language implied by the jurisdiction) sets the language the text is written in. For `es` and `en` the delivered text is also measured: when a substantial part of it came back in the other of the two, a block headed `⚠️ LANGUAGE OF THIS REPORT` (`⚠️ IDIOMA DE ESTE INFORME` when `es` was requested) is added at the end of the text. It works the same with any engine, BYO included. - **When there is no block**: it is not a confirmation. Other languages are not measured, and neither is a text too short or too mixed to tell. - **With BYO**: how closely the output follows the request depends on your engine. - **If the output language is essential to your workflow**: check it on your side against the `analysis` string. ## The verdict travels INSIDE the text — read this before you parse a response


    Every string this API returns that a lawyer reads — `analysis`, `answer`, `report`, `draft`, `synthesisText`, and the string fields of structured results like `applicableLaw[]` — carries the citation verdict **inline**, not only in the `citationChecks` object beside it. **What you will actually see:**


    ```

    An acknowledgement does not revive a claim already barred: section 29(7) of the

    Limitation Act 1980 【✓】. See also [2019] EWHC 3556 (Comm)

    【◻ not checked — the reason is in this citation''s note】. ---

    DETERMINISTIC CITATION CHECK (against the official corpus)

    1 verified · 1 not checked. ◻ **Not checked** — they were not compared against any official corpus…

    ```


    - **Inline marker**: a `【…】` block immediately after each citation, in the response language. The glyph carries the verdict: `✓` verified · `⚠` a warning (e.g. the decision exists but a party you named does not appear in it) · `⛔` broken · `◻` not checked. - **Footer**: a `---` block at the end with the tally and, for anything not clean, the list of citations and why. **Why it is in the text and not only in the JSON.** Whoever copies an answer into an email, a brief or a .docx takes the PROSE. The `citationChecks` object does not travel with it. A verdict that only exists in a field beside the text is a verdict the reader can lose without noticing. **If you parse these strings**: markers are the only `【…】` sequences we emit, so they are safe to strip with a single regex if your pipeline needs the raw prose — but do not strip them from anything a human will read. `citationChecks` remains the machine-readable source of truth for counts and per-citation status; the markers are the same verdict, placed where it cannot get lost. **Idempotent**: annotating an already-annotated text does not duplicate markers or the footer. ## Streaming: `verifiedText` on the `done` event


    On SSE routes the client already holds the raw prose by the time the verifier finishes, so the closing `{type:"done"}` event carries `verifiedText`: the same answer with the verdict already in it. **If it is present, render it in place of the concatenated `text_delta` chunks.** It is omitted when there is nothing to annotate, in which case the deltas are already final. The REST wrappers do this for you — `/v1/consulta`, `/v1/chat` and the rest aggregate server-side and hand you the annotated text — so this only concerns you if you consume the SSE stream directly. ## Base capabilities


    - **Mode=deep**: the Node A (Claude Opus 4.7) + Node B (DeepSeek V4-Pro) chain audits adversarially. 2 credits. Returns an `audit` object with structured findings (hallucinations, false citations, omissions). - **Direct models**: calls through the providers'' own APIs (Anthropic, DeepSeek) with no proxies — lower latency, better rate limits. - **Stable Stripe-style error format**: `error.type`, `error.code`, `error.request_id`, `error.details` + backward-compat aliases. ## Errors and rate limits


    - **Branch on `error.code`.** A code you do not recognise is handled by its `error.type`.'
  contact:
    name: Nexus Legal
    email: support@nexusquantum.legal
    url: https://legal.nexusquantum.legal/developers
  license:
    name: Commercial
    url: https://nexusquantum.legal/terms
servers:
- url: https://legal.nexusquantum.legal
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: BYO-Perception
paths:
  /api/v1/perception-providers:
    get:
      tags:
      - BYO-Perception
      summary: List the firm's BYO Perception engines (OCR/ASR) (owner-only) · 0 credits
      description: 'Lists YOUR firm''s BYO Perception configs. It NEVER returns credentials — only `key_fingerprint` and non-secret fields. Twin of `GET /api/v1/llm-providers`. Owner-only firm-scoped. Scope: mcp | * (NOT cases).'
      responses:
        '200':
          description: List of perception configs.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PerceptionProvider'
      operationId: getApiV1PerceptionProviders
      x-operation-id-source: derived
    post:
      tags:
      - BYO-Perception
      summary: Register a local BYO Perception engine (owner-only) · 0 credits
      description: '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).'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePerceptionProviderRequest'
      responses:
        '201':
          description: Config created (no credential in the response).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerceptionProvider'
        '400':
          description: VALIDATION_ERROR (label/capability/base_url)
        '409':
          description: PROVIDER_LIMIT_REACHED (firm provider limit)
        '422':
          description: INVALID_PROVIDER_URL (base_url fails SSRF)
      operationId: postApiV1PerceptionProviders
      x-operation-id-source: derived
  /api/v1/perception-providers/{id}:
    get:
      tags:
      - BYO-Perception
      summary: BYO Perception engine detail (owner-only) · 0 credits
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Config (no credential).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerceptionProvider'
        '404':
          description: NOT_FOUND (does not exist or does not belong to your firm)
      operationId: getApiV1PerceptionProvidersById
      x-operation-id-source: derived
    patch:
      tags:
      - BYO-Perception
      summary: Update a BYO Perception engine (owner-only) · 0 credits
      description: Partial update. `credentials` remains WRITE-ONLY (encrypted, never returned); `base_url` is re-validated against SSRF.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePerceptionProviderRequest'
      responses:
        '200':
          description: Config updated (no credential).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerceptionProvider'
        '404':
          description: NOT_FOUND
        '422':
          description: INVALID_PROVIDER_URL
      operationId: patchApiV1PerceptionProvidersById
      x-operation-id-source: derived
    delete:
      tags:
      - BYO-Perception
      summary: Delete a BYO Perception engine (owner-only) · 0 credits
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Deleted.
        '404':
          description: NOT_FOUND
      operationId: deleteApiV1PerceptionProvidersById
      x-operation-id-source: derived
  /api/v1/perception-providers/{id}/test:
    post:
      tags:
      - BYO-Perception
      summary: Test a BYO Perception engine connection (owner-only) · 0 credits
      description: 'Perception engine health check: resolves + decrypts the config (firm-scoped) and runs a MINIMAL synthetic ping through the adapter (1×1 PNG for `ocr`, minimal WAV for `asr`), short timeout. Returns `{ ok, latency_ms, error? }`. The error is sanitized — it NEVER echoes the credential. No charge. Scope: mcp | * (NOT cases).'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Health check result (ok=true|false, sanitized error on failure).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerceptionProviderTestResult'
        '404':
          description: NOT_FOUND
        '409':
          description: PROVIDER_NOT_RESOLVABLE (config disabled/not resolvable)
        '422':
          description: INVALID_PROVIDER_URL
        '500':
          description: PROVIDER_RESOLVE_FAILED
      operationId: postApiV1PerceptionProvidersByIdTest
      x-operation-id-source: derived
components:
  schemas:
    UpdatePerceptionProviderRequest:
      type: object
      description: Partial update (PATCH). Same fields as creation, all optional; `credentials` remains WRITE-ONLY.
      properties:
        label:
          type: string
        adapter:
          type: string
        base_url:
          type: string
        credentials:
          type:
          - string
          - 'null'
        extra_headers:
          type: object
          additionalProperties:
            type: string
        enabled:
          type: boolean
    PerceptionProviderTestResult:
      type: object
      description: 'Perception engine health-check result (synthetic ping: 1×1 PNG for `ocr`, minimal WAV for `asr`). `error` is sanitized; it never echoes the credential.'
      properties:
        ok:
          type: boolean
          description: true if the adapter completed without throwing (engine returned 2xx).
        latency_ms:
          type: integer
          description: Ping latency in milliseconds.
        error:
          type: string
          description: Sanitized error message (only when ok=false).
    PerceptionProvider:
      type: object
      description: 'BYO Perception config (the firm''s LOCAL OCR/ASR engine). Non-secret twin of `LlmProvider`: it NEVER returns the credential — only `key_fingerprint` and non-secret fields. Firm-scoped, bound to the key''s `firm_owner_id`.'
      properties:
        id:
          type: string
          format: uuid
        label:
          type: string
          description: Human-readable label (1–120).
        capability:
          type: string
          enum:
          - ocr
          - asr
          description: OCR (image/scanned PDF) or ASR (audio/video).
        adapter:
          type: string
          description: Adapter for the local contract. Default `nexus_http` (POST {base_url}/ocr|/asr).
        base_url:
          type: string
          description: Local engine endpoint (validated against SSRF).
        key_fingerprint:
          type:
          - string
          - 'null'
          description: NON-reversible hash of the credential (e.g. `sha256:a1b2c3d4`); null if the engine uses no credential. The credential NEVER leaves.
        enabled:
          type: boolean
        created_at:
          type: string
          format: date-time
    CreatePerceptionProviderRequest:
      type: object
      required:
      - label
      - capability
      - base_url
      description: Creates a BYO Perception config. `credentials` (the local engine's bearer token) is OPTIONAL and WRITE-ONLY (encrypted AES-256-GCM and never returned).
      properties:
        label:
          type: string
          description: 1–120 characters.
        capability:
          type: string
          enum:
          - ocr
          - asr
        adapter:
          type: string
          description: Default `nexus_http`.
        base_url:
          type: string
          description: Required; validated against SSRF (422 INVALID_PROVIDER_URL).
        credentials:
          type:
          - string
          - 'null'
          description: WRITE-ONLY. Bearer token of the local engine; optional. Encrypted server-side and never returned.
        extra_headers:
          type: object
          additionalProperties:
            type: string
          description: Optional additional headers (string→string map).
        enabled:
          type: boolean
          description: Default true.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: nlk_...