Nuix

Nuix Resources API

The Resources API from Nuix — 18 operation(s) for resources.

GitHub OpenAPI

Operations 23

GET /kinds Returns all item kinds #
GET /searchMacros Returns all search macros names and expansions #
GET /shingleLists Returns all shingle list names and expansions #
GET /wordLists Returns all word list names #
GET /fuzzyHashLists Returns all fuzzy hash list names #
GET /metadataProfiles Returns all metadata profile names #
GET /types Returns all item types #
GET /configurationProfiles Returns all configuration profile names #
GET /digestLists Returns all digest list names #
POST /digestLists Uploads a digest list to a user data directory #
GET /imagingProfiles Returns all imaging profile names #
POST /imagingProfiles Upload an imaging profile #
GET /imagingProfiles/{name} Downloads an imaging profile by name #
GET /productionProfiles Returns all production profile names #
POST /productionProfiles Upload a production profile #
GET /productionProfiles/{name} Downloads a production profile by name #
GET /processingProfiles Returns all processing profile names #
POST /processingProfiles Upload a processing profile #
GET /processingProfiles/{name} Downloads a processing profile by name #
GET /ocrProfiles Returns all OCR profile names #
POST /ocrProfiles Upload an OCR profile #
GET /ocrProfiles/{name} Downloads an OCR profile by name #
GET /ocrProfiles/{name}/details Returns the OCR profile template details #

Documentation

📖
APIReference
https://developer.nuix.com/latest/reference/restapireference.html
📖
Documentation
https://developer.nuix.com/latest/engine/rest/home.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/nuix/openapi/nuix-resources-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/nuix/json-schema/nuix-ocr-template-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/nuix/json-schema/nuix-search-macro-structured-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nuix/json-schema/nuix-nuix-item-type-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nuix/json-schema/nuix-nuix-item-kind-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/nuix/json-schema/nuix-file-upload-response-schema.json

Other Resources

🔗
PostmanCollection
https://artifacts.apis.io/nuix/collections/nuix-nuix-core-engine-rest-api.postman_collection.json

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/nuix:nuix-resources-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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

nuix-resources-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nuix REST-API Reference Resources API
  description: 'Welcome to the Nuix REST API documentation. From here you can access all available REST APIs and execute queries against your running REST instance.


    # Authentication Changes


    The `nuix-auth-token` header is being deprecated in favor of standard JWT. The header will be removed in a

    future release. Until the removal of the header, the Nuix REST API will accept the JWT in either the

    `nuix-auth-token` header field or the `Authorization` header field prefixed by `Bearer`.'
  contact:
    name: Nuix
    url: http://forums.nuix.com/
  license:
    name: Licence
    url: https://www.nuix.com/sites/default/files/2023-03/End%20User%20License%20Agreement%20%28Effective%20December%2014%2C%202022%29_1.pdf
  version: ${customer.version}
servers:
- url: /nuix-restful-service/svc
- url: http://localhost:8080/svc
security:
- ApiKeyAuth: []
- bearerAuth: []
tags:


# --- truncated at 32 KB (40 KB total) ---
# Full source: https://artifacts.apis.io/nuix/openapi/nuix-resources-api-openapi.yml