Organization

Manage AquilaX Organization via APIs

Get Organizations

This API endpoint retrieves a list of organizations associated with the user. By providing the user ID, users can fetch all the organizations associated with the user. The endpoint returns a JSON object containing the list of organizations along with their details. If no organizations are found, the endpoint returns an empty list.

GEThttps://app.aquilax.ai/api/v1/organization

Authorization

Personal Access Token

Response

200

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get Organization

This API endpoint retrieves the details of a specific organization. By providing the organization ID, users can fetch the details of the organization. The endpoint returns a JSON object containing the organization details. If the organization is not found, the endpoint raises an exception with an appropriate error message.

GEThttps://app.aquilax.ai/api/v1/organization/{org_id}

Authorization

Personal Access Token

Path parameters

org_id*Org Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Update Organization

This API endpoint allows users to update the details of an existing organization. By providing the organization ID and the updated organization details, users can modify the organization information. The endpoint returns a success message upon successful completion of the operation. In case of an error, the endpoint raises an exception with an appropriate error message.

PATCHhttps://app.aquilax.ai/api/v1/organization/{org_id}

Authorization

Personal Access Token

Path parameters

org_id*Org Id

Body

application/x-www-form-urlencoded

nameName

descriptionDescription

business_nameBusiness Name

websiteWebsite

org_picOrg Pic

usageUsage

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Delete Organization

This API endpoint allows users to delete an existing organization. By providing the organization ID, users can delete the organization. The endpoint returns a success message upon successful deletion of the organization. In case of an error, the endpoint raises an exception with an appropriate error message.

DELETEhttps://app.aquilax.ai/api/v1/organization/{org_id}

Authorization

Personal Access Token

Path parameters

org_id*Org Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Create Organization

This API endpoint allows users to create a new organization. By providing the organization details, users can create a new organization. The endpoint returns the organization ID upon successful creation of the organization. In case of an error, the endpoint raises an exception with an appropriate error message.

POSThttps://app.aquilax.ai/api/v1/organization

Authorization

Personal Access Token

Body

application/x-www-form-urlencoded

name*Name

descriptionDescription

business_nameBusiness Name

websiteWebsite

org_picOrg Pic

usageUsage

license_keyLicense Key

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": "text"
}