Skip to main content

Nuclia management REST API (v1)

API reference for Nuclia account, covering all the endpoints related to account, user and knowledge box management

Accounts

CRUD and other operations related to Accounts

Delete Invite

Invalidate an invite to join an account


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AMEMBER
  • AOWNER
path Parameters
account_id
required
string <uuid> (Account Id)
email
required
string <email> (Email)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Invited Users

List of users invited to an account, but not yet joined


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AMEMBER
  • AOWNER
path Parameters
account_id
required
string <uuid> (Account Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Account


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AOWNER
  • AMEMBER
path Parameters
account_slug_or_id
required
string (Account Slug Or Id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "slug": "string",
  • "title": "string",
  • "type": "stash-trial",
  • "description": "string",
  • "can_manage_account": true,
  • "current_users": 0,
  • "max_users": 0,
  • "current_kbs": 0,
  • "max_kbs": 0,
  • "blocking_state": "unblocked",
  • "blocked_features": [ ],
  • "limits": {
    },
  • "trial_expiration_date": "2019-08-24T14:15:22Z",
  • "domain": "string",
  • "saml_entity_id": "string",
  • "saml_sso_url": "string",
  • "saml_x509_cert": "string"
}

Delete Account


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AOWNER
path Parameters
account_slug
required
string (Account Slug)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Modify Account


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AOWNER
path Parameters
account_slug
required
string (Account Slug)
Request Body schema: application/json
required
title
string (Title) non-empty
description
string (Description)
object (SAMLConfig)
slug
string (Slug) ^[a-z0-9_-]+$

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "saml": {
    },
  • "slug": "string"
}

Response samples

Content type
application/json
null

Invite To Account

Invite somebody by email


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AMEMBER
  • AOWNER
path Parameters
account_slug
required
string (Account Slug)
Request Body schema: application/json
required
email
required
string (Email)
role
string (AccountRoles)
Default: "AMEMBER"
Enum: "AOWNER" "AMEMBER"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "role": "AMEMBER"
}

Response samples

Content type
application/json
null

Download Account Logo

Account logo


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AOWNER
  • AMEMBER
query Parameters
account_id
required
string (Account Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Upload Account Logo

Account logo


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AOWNER
query Parameters
account_id
required
string (Account Id)
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Account Permissions


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AOWNER
  • AMEMBER
query Parameters
account_id
required
string (Account Id)
stash_id
required
string (Stash Id)

Responses

Response samples

Content type
application/json
null

Processing Stats

Retrive statistics for a knowledgebox or account

path Parameters
account_slug
required
string (Account Slug)
query Parameters
period
string (StatsPeriod)
Default: "day"
Enum: "day" "week" "month" "year"

An enumeration.

knowledgebox
string (Knowledgebox)
stats
string (StatsQueryFields)
Default: "searches"
Enum: "processing_time" "searches" "chars" "media_seconds" "bytes" "resources" "pages" "paragraphs" "train_seconds" "suggestions" "predictions" "docs_no_media" "ai_tokens_used"

An enumeration.

utctime
string <date-time> (Utctime)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List Accounts


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • Authenticated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Account


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • Authenticated
Request Body schema: application/json
required
slug
required
string (Account slug) ^[a-z0-9_-]+$

Identifier to use as the account identifier in all account resources and subresources. This is a mutable field, unique, but independent of the account id

title
required
string (Title) non-empty
description
string (Description)
email
string (Email)
zone
string (Zone)

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "title": "string",
  • "description": "string",
  • "email": "string",
  • "zone": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Account Users

Management of users assigned on an Account

Get Account User Details

Account user


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AMEMBER
  • AOWNER
path Parameters
account_slug
required
string (Account Slug)
user_id
required
string (User Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "string",
  • "role": "AOWNER"
}

List Account Users

Account user


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AOWNER
path Parameters
account_slug
required
string (Account Slug)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Users

Account user modification


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AOWNER
path Parameters
account_slug
required
string (Account Slug)
Request Body schema: application/json
required
Array of objects (Add)
delete
Array of strings (Delete)

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Search Account Users

Search account users


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • AOWNER
  • AMEMBER
path Parameters
account_slug
required
string (Account Slug)
query Parameters
query
required
string (Query)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

User

Operations related to the currently authenticated user

Get Authenticated User

Information about user


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • Authenticated

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "email": "string",
  • "language": "CA",
  • "type": "ROOT",
  • "last_login": "2019-08-24T14:15:22Z",
  • "avatar": "string"
}

Delete Authenticated User

Delete the logged in user


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • Authenticated

Responses

Modify User Profile

Set information about user

Request Body schema: application/json
required
name
string (Name)
avatar
string (Avatar)
email
string (Email)
language
string (Languages)
Enum: "CA" "ES" "EN" "FR" "DE" "PT"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "avatar": "string",
  • "email": "string",
  • "language": "CA"
}

Response samples

Content type
application/json
null

Welcome

Welcome information for a new user


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • Authenticated

Responses

Response samples

Content type
application/json
{
  • "preferences": {
    },
  • "accounts": [
    ],
  • "create": true,
  • "can_be_deleted": true,
  • "dependant_accounts": [
    ]
}

Zone Hub

Async Exchange of data between regional clusters and the global one

Zone API

Management of zones

List Zones

Welcome information for a new user


Authorization roles

Authenticated user needs to fulfill one of this roles, otherwise the request will be rejected with a 403 response.

  • Authenticated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Internal Zone API

Internal api used by the regional clusters for syncronous exchange of information

Knowledge Boxes

Management of zones

Stripe Webhook

header Parameters
stripe-signature
required
string (Stripe-Signature)
Request Body schema: application/json
required
object
required
string (Object)
required
object (StripeObject)
type
required
string (Type)

Responses

Request samples

Content type
application/json
{
  • "object": "string",
  • "data": {
    },
  • "type": "string"
}

Response samples

Content type
application/json
null