Nuclia Ask API
Generative RAG answers, chat and summarization grounded in a Knowledge Box.
Nuclia Ask API is one of 5 APIs that Nuclia publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Ask. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://{zone}.nuclia.cloud/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Nuclia Ask API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as X-NUCLIA-SERVICEACCOUNT (apiKey).
It accepts HTTP bearer tokens (JWT) (bearerAuth).
An API key is passed in the header as X-NUCLIA-NUAKEY (nuaKey).
By default, every request must be authenticated.
apiKey— Knowledge Box service account API key. Pass as X-NUCLIA-SERVICEACCOUNT: Bearer . Reader keys allow search/find/ask, Writer keys allow ingestion and resource mo…bearerAuth— OAuth2 / account bearer token obtained from the Nuclia authentication service, used by the dashboard and management endpoints.nuaKey— Nuclia Understanding API (NUA) key. Pass as X-NUCLIA-NUAKEY: Bearer to call the /v1/predict endpoints.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
Generative RAG answers, chat and summarization grounded in a Knowledge Box.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are AskRequest (9 properties), AskResponse (6 properties), FindResults (4 properties), SummarizeRequest (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nuclia 4
Other APIs Nuclia publishes across the network.