Knowledge Box & Zone REST API (v1)
API documentation for managing Knowledge Boxes, NUA keys, and API Keys within designated zones.
Get Knowledge Box
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
Responses
Response samples
- 200
- 422
{- "id": "string",
- "slug": "string",
- "account_id": "string",
- "zone": "string",
- "title": "string",
- "description": "string",
- "state": "PUBLISHED",
- "created": "2019-08-24T14:15:22Z",
- "admin": true,
- "contrib": true,
- "allowed_origins": [
- "string"
], - "search_configs": { },
- "external_index_provider": "string"
}
Modify Knowledge Box
Modifies an existing Knowledge Box.
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
Request Body schema: application/jsonrequired
Slug (string) or Slug (null) (Slug) | |
Title (string) or Title (null) (Title) | |
KbState (string) or null | |
Description (string) or Description (null) (Description) | |
Array of Allowed Origins (strings) or Allowed Origins (null) (Allowed Origins) | |
Search Configs (object) or Search Configs (null) (Search Configs) |
Responses
Request samples
- Payload
{- "slug": "string",
- "title": "string",
- "state": "PUBLISHED",
- "description": "string",
- "allowed_origins": [
- "string"
], - "search_configs": { }
}
Response samples
- 200
- 422
{ }
List Knowledge Boxes
List all region Knowledge Boxes that belongs to an specific account that the authenticated user can see
path Parameters
account_id required | string <uuid> (Account Id) |
Responses
Response samples
- 200
- 422
[- {
- "id": "string",
- "slug": "string",
- "zone": "string",
- "title": "string",
- "state": "PUBLISHED",
- "description": "string",
- "role_on_kb": "SOWNER",
- "allowed_origins": [
- "string"
], - "search_configs": { },
- "external_index_provider": "string"
}
]
Create Knowledge Box
Creates a new Knowledge Box. The accepted values for the learning_configuration
are dynamic and may be dependant of the account used. Accepted field values needs to be checked on the 'Learning configuration schema' endpoint
path Parameters
account_id required | string <uuid> (Account Id) |
Request Body schema: application/jsonrequired
slug | string (Slug) |
title | string (Title) |
Description (string) or Description (null) (Description) | |
Sentence Embedder (string) or Sentence Embedder (null) (Sentence Embedder) Deprecated | |
Anonymization (string) or Anonymization (null) (Anonymization) Deprecated | |
learning_configuration | object (Learning Configuration) |
Array of Allowed Origins (strings) or Allowed Origins (null) (Allowed Origins) | |
PineoneKBIndexProvider (object) or External index provider (null) (External index provider) External index provider configuration for the Knowledge Box. If not set, the default NucliaDB's index will be used. | |
search_configs | object (Search Configs) Default: {} |
Responses
Request samples
- Payload
{- "slug": "string",
- "title": "string",
- "description": "string",
- "sentence_embedder": "string",
- "anonymization": "string",
- "learning_configuration": { },
- "allowed_origins": [
- "string"
], - "external_index_provider": {
- "api_key": "<my-pinecone-api-key>",
- "serverless_cloud": "aws_us_east_1",
- "type": "pinecone"
}, - "search_configs": { }
}
Response samples
- 201
- 422
{- "id": "string"
}
Update Users
Assign or remove users from a Knowledge Box
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
Request Body schema: application/jsonrequired
Array of Add (objects) or Add (null) (Add) | |
Array of Update (objects) or Update (null) (Update) | |
Array of Delete (strings) or Delete (null) (Delete) |
Responses
Request samples
- Payload
{- "add": [
- {
- "id": "string",
- "role": "SOWNER"
}
], - "update": [
- {
- "id": "string",
- "role": "SOWNER"
}
], - "delete": [
- "string"
]
}
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
Invite To Knowledge Box
Send an invitation to join a Knowledge Box via email.
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
Request Body schema: application/jsonrequired
email required | string <email> (Email) |
role required | string (KbRole) Enum: "SOWNER" "SMEMBER" "SCONTRIBUTOR" |
Responses
Request samples
- Payload
{- "email": "user@example.com",
- "role": "SOWNER"
}
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
Delete Invite
Invalidate an invite to join a Knowledge Box
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
query Parameters
email required | string <email> (Email) |
Responses
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
Invited Users
List of users invited to a Knowledge Box, but not yet joined
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
Responses
Response samples
- 200
- 422
[- {
- "email": "string",
- "role": "SOWNER",
- "expires": "2019-08-24T14:15:22Z"
}
]
Delete Service Account
Delete a new Service Account for a Knowledge Box
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
sa_id required | string <uuid> (Sa Id) |
Responses
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
Delete Api Key
Delete an API Key of a Knowledge Box
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
sa_id required | string <uuid> (Sa Id) |
sa_key_id required | string <uuid> (Sa Key Id) |
Responses
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
Add Service Account Key
Create an API Key for a Service Account of a Knowledge Box
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
sa_id required | string <uuid> (Sa Id) |
Request Body schema: application/jsonrequired
expires required | string <date-time> (Expires) |
Responses
Request samples
- Payload
{- "expires": "2019-08-24T14:15:22Z"
}
Response samples
- 201
- 422
{- "id": "string",
- "token": "string"
}
List Service Accounts
List of Service Accounts of a Knowledge Box
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
Responses
Response samples
- 200
- 422
[- {
- "id": "string",
- "title": "string",
- "role": "SOWNER",
- "keys": [
- {
- "id": "string",
- "created": "2019-08-24T14:15:22Z",
- "expires": "2019-08-24T14:15:22Z"
}
]
}
]
Add Service Account
Create a new Service Account for a Knowledge Box
path Parameters
account_id required | string <uuid> (Account Id) |
kb_id required | string <uuid> (Kb Id) |
Request Body schema: application/jsonrequired
title | string (Title) |
role required | string (KbRole) Enum: "SOWNER" "SMEMBER" "SCONTRIBUTOR" |
Responses
Request samples
- Payload
{- "title": "string",
- "role": "SOWNER"
}
Response samples
- 201
- 422
{- "id": "string"
}
Delete Nua Client By Id
Deletes an existing Nuclia Understanding API client
path Parameters
account_id required | string <uuid> (Account Id) |
client_id required | string (Client Id) ^[a-z0-9_-]+$ |
Responses
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
Get Nua Client By Id
Gets the metadata of an existing Nuclia Understanding API
path Parameters
account_id required | string <uuid> (Account Id) |
client_id required | string (Client Id) ^[a-z0-9_-]+$ |
Responses
Response samples
- 200
- 422
{- "title": "string",
- "description": "",
- "contact": "string",
- "created": "2019-08-24T14:15:22Z",
- "partitions": 0,
- "client_id": "string",
- "account_id": "string",
- "processing_webhook": {
- "uri": "string",
- "headers": { }
}
}
Set Account Nua Client Key
Recreates a new session key for an existing Nuclia Understanding API client
path Parameters
account_id required | string <uuid> (Account Id) |
client_id required | string (Client Id) ^[a-z0-9_-]+$ |
Responses
Response samples
- 201
- 422
{- "token": "string",
- "client_id": "string"
}
Get Account Nua Clients
Gets the list of Nuclia Understanding API clients of an account
path Parameters
account_id required | string <uuid> (Account Id) |
query Parameters
Client Id (string) or Client Id (null) (Client Id) |
Responses
Response samples
- 200
- 422
{- "clients": [
- {
- "title": "string",
- "description": "",
- "contact": "string",
- "created": "2019-08-24T14:15:22Z",
- "partitions": 0,
- "client_id": "string",
- "account_id": "string",
- "processing_webhook": {
- "uri": "string",
- "headers": { }
}
}
]
}
Create Account Nua Client
Create a new Nuclia Understanding API client for an account
path Parameters
account_id required | string <uuid> (Account Id) |
Request Body schema: application/jsonrequired
contact required | string (Contact) |
title | string (Title) |
Description (string) or Description (null) (Description) Default: "" | |
Client Id (string) or Client Id (null) (Client Id) | |
ProcessingWebhook (object) or null | |
allow_kb_management | boolean (Allow Kb Management) Default: false |
Responses
Request samples
- Payload
{- "contact": "string",
- "title": "string",
- "description": "",
- "client_id": "string",
- "processing_webhook": {
- "uri": "string",
- "headers": { }
}, - "allow_kb_management": false
}
Response samples
- 201
- 422
{- "token": "string",
- "client_id": "string"
}