Nuclia management REST API (v1)
API reference for Nuclia account, covering all the endpoints related to account, user and knowledge box management
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
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
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
- 200
- 422
[- {
- "email": "user@example.com",
- "role": "AOWNER",
- "expires": "2019-08-24T14:15:22Z"
}
]
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
- 200
- 422
{- "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": {
- "upload": {
- "upload_limit_max_media_file_size": 0,
- "upload_limit_max_non_media_file_size": 0
}, - "usage": {
- "monthly_limit_paragraphs_processed": 0,
- "monthly_limit_docs_no_media_processed": 0,
- "monthly_limit_media_seconds_processed": 0,
- "monthly_limit_paragraphs_stored": 0,
- "monthly_limit_hosted_searches_performed": 0,
- "monthly_limit_hosted_answers_generated": 0,
- "monthly_limit_self_hosted_searches_performed": 0,
- "monthly_limit_self_hosted_answers_generated": 0,
- "monthly_limit_non_media_files_processed": 0,
- "monthly_limit_chars_processed": 0
}, - "processing": {
- "monthly_limit_paragraphs_processed": 0,
- "monthly_limit_docs_no_media_processed": 0,
- "monthly_limit_media_seconds_processed": 0,
- "monthly_limit_paragraphs_stored": 0,
- "monthly_limit_hosted_searches_performed": 0,
- "monthly_limit_hosted_answers_generated": 0,
- "monthly_limit_self_hosted_searches_performed": 0,
- "monthly_limit_self_hosted_answers_generated": 0,
- "monthly_limit_non_media_files_processed": 0,
- "monthly_limit_chars_processed": 0
}
}, - "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
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
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/jsonrequired
title | string (Title) non-empty |
description | string (Description) |
object (SAMLConfig) | |
slug | string (Slug) ^[a-z0-9_-]+$ |
Responses
Request samples
- Payload
{- "title": "string",
- "description": "string",
- "saml": {
- "domain": "string",
- "sso_url": "string",
- "entity_id": "string",
- "x509_cert": "string"
}, - "slug": "string"
}
Response samples
- 200
- 422
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/jsonrequired
email required | string (Email) |
role | string (AccountRoles) Default: "AMEMBER" Enum: "AOWNER" "AMEMBER" An enumeration. |
Responses
Request samples
- Payload
{- "email": "string",
- "role": "AMEMBER"
}
Response samples
- 200
- 422
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
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
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-datarequired
file required | string <binary> (File) |
Responses
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
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
- 200
- 422
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
- 200
- 422
{- "data": [
- {
- "time_period": "2019-08-24T14:15:22Z",
- "stats": 0
}
]
}
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/jsonrequired
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) |
string (Email) | |
zone | string (Zone) |
Responses
Request samples
- Payload
{- "slug": "string",
- "title": "string",
- "description": "string",
- "email": "string",
- "zone": "string"
}
Response samples
- 201
- 422
{- "id": "string"
}
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
- 200
- 422
{- "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
- 200
- 422
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "email": "string",
- "role": "AOWNER"
}
]
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/jsonrequired
Array of objects (Add) | |
delete | Array of strings (Delete) |
Responses
Request samples
- Payload
{- "add": [
- {
- "id": "string",
- "role": "AOWNER"
}
], - "delete": [
- "string"
]
}
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
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
- 200
- 422
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "email": "string",
- "role": "AOWNER"
}
]
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
- 200
{- "id": "string",
- "name": "string",
- "email": "string",
- "language": "CA",
- "type": "ROOT",
- "last_login": "2019-08-24T14:15:22Z",
- "avatar": "string"
}
Modify User Profile
Set information about user
Request Body schema: application/jsonrequired
name | string (Name) |
avatar | string (Avatar) |
string (Email) | |
language | string (Languages) Enum: "CA" "ES" "EN" "FR" "DE" "PT" An enumeration. |
Responses
Request samples
- Payload
{- "name": "string",
- "avatar": "string",
- "email": "string",
- "language": "CA"
}
Response samples
- 200
- 422
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
- 200
{- "preferences": {
- "last_login": "2019-08-24T14:15:22Z",
- "email": "string",
- "name": "string",
- "type": "ROOT",
- "language": "CA"
}, - "accounts": [
- "string"
], - "create": true,
- "can_be_deleted": true,
- "dependant_accounts": [
- {
- "id": "string",
- "slug": "string"
}
]
}
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
- 200
[- {
- "id": "string",
- "slug": "string",
- "title": "string",
- "cloud_provider": "AWS",
- "subdomain": "string"
}
]
Stripe Webhook
header Parameters
stripe-signature required | string (Stripe-Signature) |
Request Body schema: application/jsonrequired
object required | string (Object) |
required | object (StripeObject) |
type required | string (Type) |
Responses
Request samples
- Payload
{- "object": "string",
- "data": {
- "object": {
- "id": "string",
- "object": "subscription",
- "customer": "string",
- "status": "incomplete",
- "metadata": { }
}, - "previous_attributes": { }
}, - "type": "string"
}
Response samples
- 200
- 422
null