• Knowledge Boxes
  • getGet Knowledge Box
  • delDelete Knowledge Box
  • patchModify Knowledge Box
  • postCreate Ephemeral Token
  • getDownload Logo
  • patchUpload Logo
  • getGet Knowledge Box Permissions
  • getList Knowledge Boxes
  • postCreate Knowledge Box
• Knowledge Box Users
  • postInvite To Knowledge Box
  • delDelete Invite
  • getInvited Users
  • getUsers
  • patchUpdate Users
• Knowledge Box Service Accounts
  • delDelete Service Account
  • delDelete Service Account Key
  • postAdd Service Account Key
  • getList Service Accounts
  • postAdd Service Account
• Nua Client
• Knowledge Box Invites
• NUA Client
  • getGet Nua Client By Id
  • delDelete Nua Client By Id
  • putSet Account Nua Client Key
  • getGet Account Nua Clients
  • postCreate Account Nua Client

API docs by Redocly

Nuclia zone management REST API (v1)

API reference for all zone endpoints to manage kbs, nuakeys and service accounts

Knowledge Boxes

CRUD and other operations related to Knowledge Boxes

Get Knowledge Box

path Parameters

account_id required	string (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...
kb_id required	string (Kb Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}

Response samples

• 200
• 422

Content type

application/json

{

• "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"

  ]

}

Delete Knowledge Box

path Parameters

account_id required	string (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...
kb_id required	string (Kb Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Modify Knowledge Box

Modifies an existing Knowledge Box.

path Parameters

account_id required	string (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...
kb_id required	string (Kb Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

Request Body schema: application/json

required

slug	string (Slug) ^[a-z0-9_-]+$
title	string (Title) non-empty
state	string (KbState) Enum: "PUBLISHED" "PRIVATE" An enumeration.
description	string (Description)
allowed_origins	Array of strings (Allowed Origins) non-empty unique

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}

Request samples

• Payload

Content type

application/json

{

• "slug": "string",
• "title": "string",
• "state": "PUBLISHED",
• "description": "string",
• "allowed_origins": [

  • "string"

  ]

}

Response samples

• 200
• 422

Content type

application/json

{ }

Create Ephemeral Token

Create an ephemeral token to access the Knowledge Box

path Parameters

account_id required	string (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...
kb_id required	string (Kb Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/ephemeral_tokens

Response samples

• 201
• 422

Content type

application/json

null

Download Logo

Knowledge Box logo

path Parameters

account_id required	string (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...
kb_id required	string (Kb Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/logo.png

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Upload Logo

Knowledge box logo

path Parameters

account_id required	string (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...
kb_id required	string (Kb Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/logo.png

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Get Knowledge Box Permissions

path Parameters

account_id required	string (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...
kb_id required	string (Kb Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/permissions

Response samples

• 200
• 422

Content type

application/json

null

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 (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kbs

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "id": "string",
  • "slug": "string",
  • "zone": "string",
  • "title": "string",
  • "state": "PUBLISHED",
  • "description": "string",
  • "role_on_kb": "SOWNER",
  • "allowed_origins": [

    • "string"

    ]

  }

]

Create Knowledge Box

Creates a new Knowledge Box. The accepted values for the learning_configuration ara 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 (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

Request Body schema: application/json

required

slug required	string (Slug) ^[a-z0-9_-]+$
title required	string (Title) non-empty
description	string (Description)
sentence_embedder	string (Sentence Embedder)
anonymization	string (Anonymization)
	object (Learning Configuration) Default: {}
allowed_origins	Array of strings (Allowed Origins) non-empty unique

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kbs

Request samples

• Payload

Content type

application/json

{

• "slug": "string",
• "title": "string",
• "description": "string",
• "sentence_embedder": "string",
• "anonymization": "string",
• "learning_configuration": { },
• "allowed_origins": [

  • "string"

  ]

}

Response samples

• 201
• 422

Content type

application/json

{

• "id": "string"

}

Knowledge Box Users

Management of users assigned on a Knowledge Box

Invite To Knowledge Box

Invite somebody to join a Knowledge Box by email

path Parameters

account_id required	string (Account Id)
kb_id required	string (Kb Id)

Request Body schema: application/json

required

email required	string <email> (Email)
role required	string (KbRole) Enum: "SOWNER" "SMEMBER" "SCONTRIBUTOR" An enumeration.

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/invite

Request samples

• Payload

Content type

application/json

{

• "email": "user@example.com",
• "role": "SOWNER"

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Delete Invite

Invalidate an invite to join a Knowledge Box

path Parameters

account_id required	string (Account Id)
kb_id required	string (Kb Id)

query Parameters

email required

string <email> (Email)

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/invite

Response samples

• 422

Content type

application/json

{

• "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 (Account Id)
kb_id required	string (Kb Id)

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/invites

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "email": "string",
  • "role": "SOWNER",
  • "expires": "2019-08-24T14:15:22Z"

  }

]

Users

List of users of a Knowledge Box

path Parameters

account_id required	string (Account Id)
kb_id required	string (Kb Id)

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/users

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "role": "SOWNER"

  }

]

Update Users

Assign or remove users from a Knowledge Box

path Parameters

account_id required	string (Account Id)
kb_id required	string (Kb Id)

Request Body schema: application/json

required

	Array of objects (Add)
	Array of objects (Update)
delete	Array of strings (Delete)

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/users

Request samples

• Payload

Content type

application/json

{

• "add": [

  • {

    • "id": "string",
    • "role": "SOWNER"

    }

  ],
• "update": [

  • {

    • "id": "string",
    • "role": "SOWNER"

    }

  ],
• "delete": [

  • "string"

  ]

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Knowledge Box Service Accounts

Management of api keys assigned on a Knowledge Box

Delete Service Account

Delete a new Service Account for a Knowledge Box

path Parameters

account_id required	string (Account Id)
kb_id required	string (Kb Id)
sa_id required	string (Sa Id)

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/service_account/{sa_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Delete Service Account Key

Delete a key of a Knowledge Box Service Account

path Parameters

account_id required	string (Account Id)
kb_id required	string (Kb Id)
sa_id required	string (Sa Id)
sa_key_id required	string (Sa Key Id)

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/service_account/{sa_id}/key/{sa_key_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Add Service Account Key

Create a key for a Service Account of a Knowledge Box

path Parameters

account_id required	string (Account Id)
kb_id required	string (Kb Id)
sa_id required	string (Sa Id)

Request Body schema: application/json

required

expires required

string <date-time> (Expires)

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/service_account/{sa_id}/keys

Request samples

• Payload

Content type

application/json

{

• "expires": "2019-08-24T14:15:22Z"

}

Response samples

• 201
• 422

Content type

application/json

{

• "id": "string",
• "token": "string"

}

List Service Accounts

List of Service Accounts of a Knowledge Box

path Parameters

account_id required	string (Account Id)
kb_id required	string (Kb Id)

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/service_accounts

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "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 (Account Id)
kb_id required	string (Kb Id)

Request Body schema: application/json

required

title required	string (Title) non-empty
role required	string (KbRole) Enum: "SOWNER" "SMEMBER" "SCONTRIBUTOR" An enumeration.

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/kb/{kb_id}/service_accounts

Request samples

• Payload

Content type

application/json

{

• "title": "string",
• "role": "SOWNER"

}

Response samples

• 201
• 422

Content type

application/json

{

• "id": "string"

}

Nua Client

Management of keys to access the NUA api

Knowledge Box Invites

Management of Invites to a knowledgebox

NUA Client

Get Nua Client By Id

Gets the metadata of an existing Nuclia Understanding API

path Parameters

account_id required	string (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...
client_id required	string (Client Id) ^[a-z0-9_-]+$

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/nua_client/{client_id}

Response samples

• 200
• 422

Content type

application/json

{

• "title": "string",
• "description": "",
• "contact": "string",
• "created": "2019-08-24T14:15:22Z",
• "partitions": 0,
• "client_id": "string",
• "account_id": "string",
• "processing_webhook": {

  • "uri": "string",
  • "headers": { }

  }

}

Delete Nua Client By Id

Deletes an existing Nuclia Understanding API client

path Parameters

account_id required	string (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...
client_id required	string (Client Id) ^[a-z0-9_-]+$

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/nua_client/{client_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Set Account Nua Client Key

Recreates a new session key for an existing Nuclia Understanding API client

path Parameters

account_id required	string (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...
client_id required	string (Client Id) ^[a-z0-9_-]+$

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/nua_client/{client_id}/key

Response samples

• 201
• 422

Content type

application/json

{

• "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 (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

query Parameters

client_id

string (Client Id)

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/nua_clients

Response samples

• 200
• 422

Content type

application/json

{

• "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 (Account Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[08...

Request Body schema: application/json

required

contact required	string (Contact)
title required	string (Title) non-empty
description	string (Description) Default: ""
client_id	string (Client Id) ^[a-z0-9_-]+$
	object (ProcessingWebhook)
allow_kb_management	boolean (Allow Kb Management) Default: false

Responses

Production server

https://docs.nuclia.dev/redocusaurus/region-x.stashify.cloud/account/{account_id}/nua_clients

Request samples

• Payload

Content type

application/json

{

• "contact": "string",
• "title": "string",
• "description": "",
• "client_id": "string",
• "processing_webhook": {

  • "uri": "string",
  • "headers": { }

  },
• "allow_kb_management": false

}

Response samples

• 201
• 422

Content type

application/json

{

• "token": "string",
• "client_id": "string"

}