Nuclia · Authentication Profile

Nuclia Authentication

Authentication

Nuclia secures its APIs with apiKey and http across 3 declared security schemes, as derived from its OpenAPI definitions.

AIRAGSearchKnowledge BaseUnstructured Data
Methods: apiKey, http Schemes: 3 OAuth flows: API key in: header

Security Schemes

apiKey apiKey
· in: header (X-NUCLIA-SERVICEACCOUNT)
bearerAuth http
scheme: bearer
nuaKey apiKey
· in: header (X-NUCLIA-NUAKEY)

Source

Authentication Profile

Raw ↑
generated: '2026-07-11'
method: derived
source: openapi/nuclia-openapi.yml
summary:
  types:
  - apiKey
  - http
  api_key_in:
  - header
schemes:
- name: apiKey
  type: apiKey
  in: header
  parameter: X-NUCLIA-SERVICEACCOUNT
  description: 'Knowledge Box service account API key. Pass as `X-NUCLIA-SERVICEACCOUNT: Bearer
    <token>`. Reader keys allow search/find/ask, Writer keys allow ingestion and resource modification,
    Manager keys allow administration. Public search endpoints may be called without a key when
    the Knowledge Box is public.'
  sources:
  - openapi/nuclia-openapi.yml
- name: bearerAuth
  type: http
  scheme: bearer
  bearerFormat: JWT
  description: OAuth2 / account bearer token obtained from the Nuclia authentication service,
    used by the dashboard and management endpoints.
  sources:
  - openapi/nuclia-openapi.yml
- name: nuaKey
  type: apiKey
  in: header
  parameter: X-NUCLIA-NUAKEY
  description: 'Nuclia Understanding API (NUA) key. Pass as `X-NUCLIA-NUAKEY: Bearer <token>`
    to call the /v1/predict endpoints.'
  sources:
  - openapi/nuclia-openapi.yml