How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nuclia Resources API

Ingest and manage resources - files, text, links and conversations.

Nuclia Resources 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 Resources. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 7 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{zone}.nuclia.cloud/api.

7 operations 5 paths 5 schemas 1 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{zone}.nuclia.cloud/api/v1
Authentication
API Key, HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Nuclia Resources 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 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Resources 7

Ingest and manage resources - files, text, links and conversations.

POST
/v1/kb/{kbid}/resource
Create a resource
createResource 1 param body → 201403
GET
/v1/kb/{kbid}/resources
List resources
listResources 3 params → 200
GET
/v1/kb/{kbid}/resource/{rid}
Get a resource
getResource 3 params → 200404
PATCH
/v1/kb/{kbid}/resource/{rid}
Modify a resource
modifyResource 2 params body → 200403
DELETE
/v1/kb/{kbid}/resource/{rid}
Delete a resource
deleteResource 2 params → 204403
PUT
/v1/kb/{kbid}/resource/{rid}/file/{field}
Upload a file field
uploadFileField 4 params body → 201403
POST
/v1/kb/{kbid}/upload
Upload a binary directly to a Knowledge Box
uploadToKnowledgeBox 2 params body → 201

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Resource (7 properties), CreateResourcePayload (7 properties), ResourceList (2 properties), ResourceCreated (2 properties). Each schema is shown below with its type and property counts.

CreateResourcePayload
object
7 properties
ResourceCreated
object
2 properties
Error
object
1 property
ResourceList
object
2 properties
Resource
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclia-resources-api-openapi.yml Raw ↑

Other APIs Nuclia publishes across the network.

Nuclia Ask API
Nuclia Knowledge Boxes API
Nuclia Predict API
Nuclia Search API
Where this information came from

This is an independent, third-party profile of Nuclia Resources API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.