• Accounts
  • getGet Usage
  • getGet Account
  • patchModify Account
  • delDelete Account
  • patchUpload Account Logo
  • getDownload Account Logo
  • getGet Account Permissions
  • getList Accounts
  • postCreate Account
• Authenticated User
  • getGet Authenticated User
  • delDelete Authenticated User
  • patchModify User Profile
  • getWelcome
• Users
  • getGet Account User Details
  • getList Account Users
  • patchUpdate Users
  • getSearch Account Users
• Zones
  • getList Zones
• Invites
  • delDelete Invite
  • getInvited Users
  • postInvite To Account

API docs by Redocly

Account REST API (v1)

API documentation for managing Nuclia accounts, including all related endpoints.

Accounts

Operations for creating, reading, updating, and deleting accounts.

Get Usage

Retrive statistics for a knowledgebox or account

path Parameters

account_id required

string <uuid> (Account Id)

query Parameters

aggregation	string (Aggregation) Enum: "hour" "day" "week" "month" "quarter" "year" "millennium"
	Knowledgebox (string) or Knowledgebox (null) (Knowledgebox)
from required	string <date-time> (From)
	To (string) or To (null) (To) Default: "2024-11-18T14:09:40.227558"

Responses

Production server

https://nuclia.cloud/api/v1/account/{account_id}/usage

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "timestamp": "2019-08-24T14:15:22Z",
  • "metrics": [

    • {

      • "name": "pre_processing_time",
      • "value": 0,
      • "details": [ ]

      }

    ]

  }

]

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

Production server

https://nuclia.cloud/api/v1/account/{account_slug_or_id}

Response samples

• 200
• 422

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": {

  • "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,
    • "storage_limit_max_bytes_per_kb": 0,
    • "storage_limit_max_resources_per_kb": 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,
    • "storage_limit_max_bytes_per_kb": 0,
    • "storage_limit_max_resources_per_kb": 0,
    • "monthly_limit_non_media_files_processed": 0,
    • "monthly_limit_chars_processed": 0

    }

  },
• "creation_date": "2019-08-24T14:15:22Z",
• "trial_expiration_date": "2019-08-24T14:15:22Z",
• "domain": "string",
• "saml_entity_id": "string",
• "saml_sso_url": "string",
• "saml_x509_cert": "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/json

required

	Title (string) or Title (null) (Title)
	Description (string) or Description (null) (Description)
	SAMLConfig (object) or null
	Slug (string) or Slug (null) (Slug)

Responses

Production server

https://nuclia.cloud/api/v1/account/{account_slug}

Request samples

• Payload

Content type

application/json

{

• "title": "string",
• "description": "string",
• "saml": {

  • "domain": "string",
  • "sso_url": "string",
  • "entity_id": "string",
  • "x509_cert": "string"

  },
• "slug": "string"

}

Response samples

• 200
• 422

Content type

application/json

null

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

Production server

https://nuclia.cloud/api/v1/account/{account_slug}

Response samples

• 422

Content type

application/json

{

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

required

file required

string <binary> (File)

Responses

Production server

https://nuclia.cloud/api/v1/account/{account_slug}/logo.png

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

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

    }

  ]

}

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 <uuid> (Account Id)

Responses

Production server

https://nuclia.cloud/api/v1/account/{account_slug}/logo.png

Response samples

• 422

Content type

application/json

{

• "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 <uuid> (Account Id)
stash_id required	string (Stash Id)

Responses

Production server

https://nuclia.cloud/api/v1/account/{account_slug}/permissions

Response samples

• 200
• 422

Content type

application/json

null

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

Production server

https://nuclia.cloud/api/v1/accounts

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "slug": "string",
  • "title": "string",
  • "type": "stash-trial"

  }

]

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	string (Title)
	Description (string) or Description (null) (Description)
	Email (string) or Email (null) (Email)
	Zone (string) or Zone (null) (Zone)

Responses

Production server

https://nuclia.cloud/api/v1/accounts

Request samples

• Payload

Content type

application/json

{

• "slug": "string",
• "title": "string",
• "description": "string",
• "email": "user@example.com",
• "zone": "string"

}

Response samples

• 201
• 422

Content type

application/json

{

• "id": "string"

}

Authenticated 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

Production server

https://nuclia.cloud/api/v1/user

Response samples

• 200

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

Production server

https://nuclia.cloud/api/v1/user

Modify User Profile

Set information about user

Request Body schema: application/json

required

	Name (string) or Name (null) (Name)
	Avatar (string) or Avatar (null) (Avatar)
	Email (string) or Email (null) (Email)
	Languages (string) or null

Responses

Production server

https://nuclia.cloud/api/v1/user

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "avatar": "string",
• "email": "user@example.com",
• "language": "CA"

}

Response samples

• 200
• 422

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

Production server

https://nuclia.cloud/api/v1/user/welcome

Response samples

• 200

Content type

application/json

{

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

    }

  ]

}

Users

Management of users assigned to 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 <uuid> (User Id)

Responses

Production server

https://nuclia.cloud/api/v1/account/{account_slug}/user/{user_id}

Response samples

• 200
• 422

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

Production server

https://nuclia.cloud/api/v1/account/{account_slug}/users

Response samples

• 200
• 422

Content type

application/json

[

• {

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

required

	Array of Add (objects) or Add (null) (Add)
	Array of Delete (strings) or Delete (null) (Delete)

Responses

Production server

https://nuclia.cloud/api/v1/account/{account_slug}/users

Request samples

• Payload

Content type

application/json

{

• "add": [

  • {

    • "id": "string",
    • "role": "AOWNER"

    }

  ],
• "delete": [

  • "string"

  ]

}

Response samples

• 422

Content type

application/json

{

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

Production server

https://nuclia.cloud/api/v1/account/{account_slug}/users/search

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "string",
  • "role": "AOWNER"

  }

]

Zones

Management of zones.

List Zones

List available zones

---

Authorization roles

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

• Authenticated

Responses

Production server

https://nuclia.cloud/api/v1/zones

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "slug": "string",
  • "title": "string",
  • "cloud_provider": "AWS",
  • "subdomain": "string"

  }

]

Invites

Manage inviting users to an account, list and invalidate invites

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

Production server

https://nuclia.cloud/api/v1/account/{account_id}/invite/{email}

Response samples

• 422

Content type

application/json

{

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

Production server

https://nuclia.cloud/api/v1/account/{account_id}/invites

Response samples

• 200
• 422

Content type

application/json

[

• {

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

  }

]

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> (Email)
role	string (AccountRoles) Enum: "AOWNER" "AMEMBER"

Responses

Production server

https://nuclia.cloud/api/v1/account/{account_slug}/invite

Request samples

• Payload

Content type

application/json

{

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

}

Response samples

• 200
• 422

Content type

application/json

null