Create a company

curl --request POST \
  --url https://paradigm.lighton.ai/api/v3/instance/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://paradigm.lighton.ai/api/v3/instance/companies"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://paradigm.lighton.ai/api/v3/instance/companies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 123,
  "name": "<string>",
  "allow_company_admins_to_manage_sso": true,
  "created_at": "2023-11-07T05:31:56Z",
  "dpo_email": "jsmith@example.com",
  "max_users": -1,
  "auto_provision_external_users": true,
  "storage_limit_company_ws": -1,
  "storage_limit_personal_ws": -1,
  "storage_limit_custom_ws": -1,
  "login_method": "password",
  "kg_tags_enabled": true,
  "kg_summaries_enabled": true,
  "kg_queries_enabled": true,
  "tier": "free"
}

{
  "id": null,
  "code": 403,
  "error": "insufficient_permissions",
  "detail": "You do not have permission to perform this action.",
  "doc_url": "https://developers.lighton.ai/errors#insufficient_permissions"
}

{
  "id": null,
  "code": 409,
  "error": "conflict",
  "detail": "A resource with this name already exists.",
  "doc_url": "https://developers.lighton.ai/errors#conflict"
}

{
  "id": null,
  "code": 422,
  "error": "validation_error",
  "detail": "One or more fields failed validation.",
  "doc_url": "https://developers.lighton.ai/errors#validation_error",
  "fields": {
    "<field_name>": [
      {
        "error": "required",
        "detail": "This field is required."
      }
    ]
  }
}

{
  "detail": "System is under maintenance.",
  "error": "service_maintenance",
  "mode": "full_shutdown",
  "reason": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "endpoint_category_names": [
    "<string>"
  ]
}

POST

api

instance

companies

Create a company

curl --request POST \
  --url https://paradigm.lighton.ai/api/v3/instance/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://paradigm.lighton.ai/api/v3/instance/companies"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://paradigm.lighton.ai/api/v3/instance/companies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 123,
  "name": "<string>",
  "allow_company_admins_to_manage_sso": true,
  "created_at": "2023-11-07T05:31:56Z",
  "dpo_email": "jsmith@example.com",
  "max_users": -1,
  "auto_provision_external_users": true,
  "storage_limit_company_ws": -1,
  "storage_limit_personal_ws": -1,
  "storage_limit_custom_ws": -1,
  "login_method": "password",
  "kg_tags_enabled": true,
  "kg_summaries_enabled": true,
  "kg_queries_enabled": true,
  "tier": "free"
}

{
  "id": null,
  "code": 403,
  "error": "insufficient_permissions",
  "detail": "You do not have permission to perform this action.",
  "doc_url": "https://developers.lighton.ai/errors#insufficient_permissions"
}

{
  "id": null,
  "code": 409,
  "error": "conflict",
  "detail": "A resource with this name already exists.",
  "doc_url": "https://developers.lighton.ai/errors#conflict"
}

{
  "id": null,
  "code": 422,
  "error": "validation_error",
  "detail": "One or more fields failed validation.",
  "doc_url": "https://developers.lighton.ai/errors#validation_error",
  "fields": {
    "<field_name>": [
      {
        "error": "required",
        "detail": "This field is required."
      }
    ]
  }
}

{
  "detail": "System is under maintenance.",
  "error": "service_maintenance",
  "mode": "full_shutdown",
  "reason": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "endpoint_category_names": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

name

string

required

Company name (max 32 characters, alphanumeric + spaces/hyphens/underscores)

Maximum string length: 32

Pattern: ^[a-zA-Z0-9 \-_]+$

dpo_email

string<email> | null

DPO contact email

max_users

integer | null

Maximum allowed active users for this company

allow_company_admins_to_manage_sso

boolean

default:false

Whether company admins can manage SSO configuration

auto_provision_external_users

boolean

default:false

Automatically create user accounts when users log in via external auth (SSO/LDAP) for the first time.

storage_limit_company_ws

integer | null

Company workspace storage limit in MB

storage_limit_personal_ws

integer | null

Personal workspace storage limit in MB

storage_limit_custom_ws

integer | null

Custom workspace storage limit in MB

kg_tags_enabled

boolean

default:true

Enable automatic document tagging using Knowledge Graph (requires global setting also enabled)

kg_summaries_enabled

boolean

default:true

Enable automatic document summarization using Knowledge Graph (requires global setting also enabled)

kg_queries_enabled

boolean

default:true

Enable automatic query suggestion generation using Knowledge Graph (requires global setting also enabled)

Response

Company created successfully

Serializer for company creation response

integer

required

read-only

name

string

required

The name of the company registered in the instance.

Maximum string length: 255

allow_company_admins_to_manage_sso

boolean

required

If the company admins of this company can create & manage their SSO configuration.

created_at

string<date-time>

required

read-only

dpo_email

string<email> | null

Contact email displayed in user profiles for data privacy inquiries.

Maximum string length: 254

max_users

integer

Maximum allowed active users for this company license.

Required range: -2147483648 <= x <= 2147483647

auto_provision_external_users

boolean

Automatically create user accounts when users log in via external auth (SSO/LDAP) for the first time.

storage_limit_company_ws

integer | null

Total storage ceiling for all workspace uploads combined (personal + all shared workspaces), in MB. Leave blank to use the default value. Use 0 to disable uploads.

Required range: -2147483648 <= x <= 2147483647

storage_limit_personal_ws

integer | null

Limit for all combined personal workspaces in this company, in MB. Leave blank to use the default value. Use 0 to disable uploads.

Required range: -2147483648 <= x <= 2147483647

storage_limit_custom_ws

integer | null

Limit for all combined shared workspaces in this company (including the company workspace), in MB. Leave blank to use the default value. Use 0 to disable uploads.

Required range: -2147483648 <= x <= 2147483647

Authentication method(s) allowed for users in this company.

password - Password
sso - Single Sign On
ldap - LDAP

Available options:

password,

sso,

ldap

kg_tags_enabled

boolean

Enable automatic document tagging using Knowledge Graph. Disabling this prevents token consumption for LLM-based tagging. Global setting must also be enabled.

kg_summaries_enabled

boolean

Enable automatic document summarization using Knowledge Graph. Disabling this prevents token consumption for LLM-based summaries. Global setting must also be enabled.

kg_queries_enabled

boolean

Enable automatic query suggestion generation using Knowledge Graph. Disabling this prevents token consumption for LLM-based query suggestions. Global setting must also be enabled.

tier

enum<string>

Commercial tier for this company. Drives entitlements and billing posture.

free - Free
pay-as-you-go - Pay-as-you-go
business - Business

Available options:

free,

pay-as-you-go,

business

Usage

Models

Workspaces

Users

User Groups

Companies

Create a company

Authorizations

Body

Response