# LightOn Documentation: English Paradigm API API References

## API References

- [English / Paradigm API / API References / API V3 (142 pages)](https://docs.lighton.ai/_llms/en/paradigm-api/api-references/api-v3.md): Documentation for English / Paradigm API / API References / API V3.

### API V3 - Company level

#### Usage

- [Get your company's activity metrics](https://docs.lighton.ai/api-reference-v3-company/usage/get-your-companys-activity-metrics.md): Return activity metrics for the authenticated user's own company: number of workspaces, number of indexed (embedded) documents, and the count of search + ask (RAG) calls across all of the company's API keys over the last 30 days (served from the cached usage histogram).

#### Models

- [Set company external API key](https://docs.lighton.ai/api-reference-v3-company/models/set-company-external-api-key.md): Creates or replaces the active company-level API key for the given provider. The previous key (if any) is deactivated. Key value is never returned. Requires company admin permission.
- [Deactivate company external API key](https://docs.lighton.ai/api-reference-v3-company/models/deactivate-company-external-api-key.md): Soft-deletes the active company-level API key for the given provider. Requires company admin permission.
- [List catalogued provider models](https://docs.lighton.ai/api-reference-v3-company/models/list-catalogued-provider-models.md): Return the known models for a SaaS provider, to populate the model picker in the custom-model create flow. Derived from LiteLLM's published model cost map, refreshed daily, and filtered to models that are registrable as custom models and not past their published deprecation date. The catalogue is a…
- [Export company model configuration](https://docs.lighton.ai/api-reference-v3-company/models/export-company-model-configuration.md): Returns the list of models assigned to the authenticated user's company as a JSON config. API keys are never included.
- [Import company model configuration](https://docs.lighton.ai/api-reference-v3-company/models/import-company-model-configuration.md): Assign models to the authenticated user's company from a JSON config. Idempotent: existing assignments are skipped. Unknown model UUIDs are reported as errors.
- [List custom models](https://docs.lighton.ai/api-reference-v3-company/models/list-custom-models.md): List all custom ML models registered by the authenticated user's company. Visible to all authenticated company members.
- [Create a custom model](https://docs.lighton.ai/api-reference-v3-company/models/create-a-custom-model.md): Register a new custom ML model for the authenticated user's company. The litellm_model field is immutable after creation. For OpenAI-compatible endpoints (LM Studio, Ollama), prefix with 'openai/' (e.g. 'openai/llama3'). An optional temperature is applied to every request sent to this model, in plac…
- [Get a custom model](https://docs.lighton.ai/api-reference-v3-company/models/get-a-custom-model.md): Retrieve a single custom ML model by UUID. Only returns models belonging to the authenticated user's company.
- [Delete a custom model](https://docs.lighton.ai/api-reference-v3-company/models/delete-a-custom-model.md): Delete a custom ML model and immediately deregister it from LiteLLM. Requires company admin role.
- [Update a custom model](https://docs.lighton.ai/api-reference-v3-company/models/update-a-custom-model.md): Update a custom ML model's name or temperature, or promote it to the company default. Everything else is fixed at creation: the litellm_model, the model type, the endpoint, and the API key cannot be changed, because the credential is write-only in the gateway and cannot be rewritten without first be…

#### Workspaces

- [List workspaces in your company](https://docs.lighton.ai/api-reference-v3-company/workspaces/list-workspaces-in-your-company.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Create a workspace in your company](https://docs.lighton.ai/api-reference-v3-company/workspaces/create-a-workspace-in-your-company.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Test datasource credentials](https://docs.lighton.ai/api-reference-v3-company/workspaces/test-datasource-credentials.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Retrieve a company workspace](https://docs.lighton.ai/api-reference-v3-company/workspaces/retrieve-a-company-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Delete a company workspace](https://docs.lighton.ai/api-reference-v3-company/workspaces/delete-a-company-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Update a company workspace](https://docs.lighton.ai/api-reference-v3-company/workspaces/update-a-company-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Retrieve workspace members](https://docs.lighton.ai/api-reference-v3-company/workspaces/retrieve-workspace-members.md): Returns the list of members linked to a workspace in the authenticated user's company. This endpoint can only be used by company-level admins or higher.
- [Bulk replace workspace members](https://docs.lighton.ai/api-reference-v3-company/workspaces/bulk-replace-workspace-members.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Add a member to a workspace of your company](https://docs.lighton.ai/api-reference-v3-company/workspaces/add-a-member-to-a-workspace-of-your-company.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Remove a group from a workspace of your company](https://docs.lighton.ai/api-reference-v3-company/workspaces/remove-a-group-from-a-workspace-of-your-company.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Remove a user from a workspace of your company](https://docs.lighton.ai/api-reference-v3-company/workspaces/remove-a-user-from-a-workspace-of-your-company.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.

#### Users

- [List company users](https://docs.lighton.ai/api-reference-v3-company/users/list-company-users.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.

#### User Groups

- [List the groups in your company](https://docs.lighton.ai/api-reference-v3-company/user-groups/list-the-groups-in-your-company.md): List the groups in your company. This endpoint is available to company-level and instance-level administrators.
- [Create a new custom group in your company](https://docs.lighton.ai/api-reference-v3-company/user-groups/create-a-new-custom-group-in-your-company.md): Create a new custom group in your company. This endpoint is available to company-level and instance-level administrators.
- [Retrieve the information of a group in your company](https://docs.lighton.ai/api-reference-v3-company/user-groups/retrieve-the-information-of-a-group-in-your-company.md): Retrieve the information of a group in your company. This endpoint is available to company-level and instance-level administrators.
- [Delete a custom group in your company](https://docs.lighton.ai/api-reference-v3-company/user-groups/delete-a-custom-group-in-your-company.md): Delete a custom group in your company. This endpoint is available to company-level and instance-level administrators.
- [Partially update a custom group in your company](https://docs.lighton.ai/api-reference-v3-company/user-groups/partially-update-a-custom-group-in-your-company.md): Partially update a custom group in your company. This endpoint is available to company-level and instance-level administrators.
- [Get the list of members for a group](https://docs.lighton.ai/api-reference-v3-company/user-groups/get-the-list-of-members-for-a-group.md): Get the list of members for a group in your company. This endpoint is available to company-level and instance-level administrators.
- [Bulk replace all members for a custom group](https://docs.lighton.ai/api-reference-v3-company/user-groups/bulk-replace-all-members-for-a-custom-group.md): Bulk replace the entire list of members for a custom group in your company. This endpoint is available to company-level and instance-level administrators.
- [Add a member to a custom group](https://docs.lighton.ai/api-reference-v3-company/user-groups/add-a-member-to-a-custom-group.md): Add a new member to a custom group in your company. This endpoint is available to company-level and instance-level administrators.
- [Remove a user from a custom group](https://docs.lighton.ai/api-reference-v3-company/user-groups/remove-a-user-from-a-custom-group.md): Remove a user from a custom group in your company. This endpoint is available to company-level and instance-level administrators.

#### Companies

- [Partially update your company (PATCH)](https://docs.lighton.ai/api-reference-v3-company/companies/partially-update-your-company-patch.md): This endpoint partially updates the authenticated user's own company.

### API V3 - Instance level

#### Usage

- [Get company activity metrics](https://docs.lighton.ai/api-reference-v3-instance/usage/get-company-activity-metrics.md): Return company-wide activity metrics: number of workspaces, number of indexed (embedded) documents, and the count of search + ask (RAG) calls across all of the company's API keys over the last 30 days (served from the cached usage histogram).
- [Get a company's month-to-date storage cost](https://docs.lighton.ai/api-reference-v3-instance/usage/get-a-companys-month-to-date-storage-cost.md): Instance-admin view of `GET /api/v3/storage/cost` for a specific company: the storage charge accrued so far this month, the quantities behind it (`peak_bytes`, `free_gib`, `billable_gib`), and the same footprint priced at the pay-as-you-go allowance.
- [Get 30-day usage histogram for a company](https://docs.lighton.ai/api-reference-v3-instance/usage/get-30-day-usage-histogram-for-a-company.md): Return a per-day breakdown of metered usage over the last 30 days (oldest first) for a given company, aggregated across all non-revoked API keys of every user in that company. Includes a `total_cost` field with the cumulative spend.
- [Get a company's spend for the open billing period](https://docs.lighton.ai/api-reference-v3-instance/usage/get-a-companys-spend-for-the-open-billing-period.md): Instance-admin view of `GET /api/v3/usage/current-period` for a specific company: `total_cost` for the billing period now open plus a per-feature breakdown, highest cost first.

#### Models

- [List managed ML models (instance admin)](https://docs.lighton.ai/api-reference-v3-instance/models/list-managed-ml-models-instance-admin.md): List every managed (non-custom) model instance-wide, with full lighton_* metadata. Reserved to Sys Admin / Admin roles.
- [Create a managed ML model (instance admin)](https://docs.lighton.ai/api-reference-v3-instance/models/create-a-managed-ml-model-instance-admin.md): Register a new instance-wide managed model. Reserved to Sys Admin / Admin roles.
- [Get a managed ML model (instance admin)](https://docs.lighton.ai/api-reference-v3-instance/models/get-a-managed-ml-model-instance-admin.md): Retrieve a single managed model by UUID, with full lighton_* metadata. Reserved to Sys Admin / Admin roles.
- [Delete a managed ML model (instance admin)](https://docs.lighton.ai/api-reference-v3-instance/models/delete-a-managed-ml-model-instance-admin.md): Delete a managed model and deregister it from LiteLLM. Reserved to Sys Admin / Admin roles.
- [Update a managed ML model (instance admin)](https://docs.lighton.ai/api-reference-v3-instance/models/update-a-managed-ml-model-instance-admin.md): Update a managed model. Applied as a delete+recreate under the hood (LiteLLM's native update endpoint is unreliable). Reserved to Sys Admin / Admin roles.
- [List ML models](https://docs.lighton.ai/api-reference-v3-instance/models/list-ml-models.md): List all ML models available for the authenticated user's company.
- [Get ML model details](https://docs.lighton.ai/api-reference-v3-instance/models/get-ml-model-details.md): Retrieve a single ML model by UUID with linked aliases.

#### Workspaces

- [List instance workspaces](https://docs.lighton.ai/api-reference-v3-instance/workspaces/list-instance-workspaces.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Create a new instance workspace](https://docs.lighton.ai/api-reference-v3-instance/workspaces/create-a-new-instance-workspace.md): Create a new instance workspace.
- [Retrieve instance workspace](https://docs.lighton.ai/api-reference-v3-instance/workspaces/retrieve-instance-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Partially update a workspace](https://docs.lighton.ai/api-reference-v3-instance/workspaces/partially-update-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Get the list of members for any workspace. This endpoint can only be used by instance level admins.](https://docs.lighton.ai/api-reference-v3-instance/workspaces/get-the-list-of-members-for-any-workspace-this-endpoint-can-only-be-used-by-instance-level-admins.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Replace all workspace members](https://docs.lighton.ai/api-reference-v3-instance/workspaces/replace-all-workspace-members.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Add a member to a workspace](https://docs.lighton.ai/api-reference-v3-instance/workspaces/add-a-member-to-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Remove a group from a workspace](https://docs.lighton.ai/api-reference-v3-instance/workspaces/remove-a-group-from-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Delete a user from a workspace](https://docs.lighton.ai/api-reference-v3-instance/workspaces/delete-a-user-from-a-workspace.md): Remove a user from a custom workspace. This endpoint can only be used by instance level admins.

#### Users

- [List instance users](https://docs.lighton.ai/api-reference-v3-instance/users/list-instance-users.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.

#### User Groups

- [List the groups on the instance](https://docs.lighton.ai/api-reference-v3-instance/user-groups/list-the-groups-on-the-instance.md): Get the list of every existing group on the instance. This endpoint can only be used by instance level admins.
- [Create instance group](https://docs.lighton.ai/api-reference-v3-instance/user-groups/create-instance-group.md): Create a new custom group for a company. This endpoint can only be used by instance level admins.
- [Retrieve instance group](https://docs.lighton.ai/api-reference-v3-instance/user-groups/retrieve-instance-group.md): Retrieve the information of a given group. This endpoint can only be used by instance level admins. To retrieve one of your groups, please use the GET /api/v3/groups/{id} endpoint.
- [Delete a custom instance group](https://docs.lighton.ai/api-reference-v3-instance/user-groups/delete-a-custom-instance-group.md): Delete a custom group. This endpoint can only be used by instance level admins.
- [Partially update instance group](https://docs.lighton.ai/api-reference-v3-instance/user-groups/partially-update-instance-group.md): Partially update a custom group. This endpoint can only be used by instance level admins.
- [Get the list of members for a group](https://docs.lighton.ai/api-reference-v3-instance/user-groups/get-the-list-of-members-for-a-group.md): Get the list of members for any group. This endpoint can only be used by instance level admins.
- [Bulk replace all members for a group](https://docs.lighton.ai/api-reference-v3-instance/user-groups/bulk-replace-all-members-for-a-group.md): Bulk replace the entire list of members for a group. This endpoint can only be used by instance level admins.
- [Add a new member to a group](https://docs.lighton.ai/api-reference-v3-instance/user-groups/add-a-new-member-to-a-group.md): Add a new member to a group. This endpoint can only be used by instance level admins.
- [Remove a user from a group](https://docs.lighton.ai/api-reference-v3-instance/user-groups/remove-a-user-from-a-group.md): Remove a user from a group. This endpoint can only be used by instance level admins.

#### Companies

- [List companies](https://docs.lighton.ai/api-reference-v3-instance/companies/list-companies.md): This endpoint allows users to list companies based on their permissions.
- [Create a company](https://docs.lighton.ai/api-reference-v3-instance/companies/create-a-company.md): This endpoint allows authorized users to create a new company.
- [Get company details](https://docs.lighton.ai/api-reference-v3-instance/companies/get-company-details.md): This endpoint allows users to retrieve details of a specific company.
- [Delete a company](https://docs.lighton.ai/api-reference-v3-instance/companies/delete-a-company.md): This endpoint allows authorized users to delete a company.
- [Partially update a company (PATCH)](https://docs.lighton.ai/api-reference-v3-instance/companies/partially-update-a-company-patch.md): This endpoint allows partially updating a company's details.

### API V2

#### Files Search

- [Filter most relevant chunks](https://docs.lighton.ai/api-reference-v2/files-search/filter-most-relevant-chunks.md): **Deprecated — this endpoint will be removed in a future release. Use `POST /api/v3/search` instead, which handles retrieval and reranking in a single call.**
- [Extract chunks from knowledge base](https://docs.lighton.ai/api-reference-v2/files-search/extract-chunks-from-knowledge-base.md): **Deprecated — this endpoint will be removed in a future release. Use `POST /api/v3/search` instead.**
- [Reformulate an extraction query](https://docs.lighton.ai/api-reference-v2/files-search/reformulate-an-extraction-query.md): **Deprecated — this endpoint will be removed in a future release.**

#### Models

- [Generate a chat completion (V2 — deprecated)](https://docs.lighton.ai/api-reference-v2/models/generate-a-chat-completion-v2-—-deprecated.md): **Deprecated — this endpoint will be removed in a future release. Use `POST /api/v3/chat/completions` instead.**
- [Generate a text completion](https://docs.lighton.ai/api-reference-v2/models/generate-a-text-completion.md): **Deprecated — this endpoint will be removed in a future release. Use `POST /api/v3/chat/completions` instead.**
- [List available models](https://docs.lighton.ai/api-reference-v2/models/list-available-models.md): **Deprecated — this endpoint will be removed in a future release. Use `GET /api/v3/models` instead.**
- [Create text tokens](https://docs.lighton.ai/api-reference-v2/models/create-text-tokens.md): **Deprecated — this endpoint will be removed in a future release.**

#### Files

- [List available documents](https://docs.lighton.ai/api-reference-v2/files/list-available-documents.md): **Deprecated — this endpoint will be removed in a future release. Use `GET /api/v3/files` instead.**
- [Upload a document](https://docs.lighton.ai/api-reference-v2/files/upload-a-document.md): **Deprecated — this endpoint will be removed in a future release. Use `POST /api/v3/files` instead.**
- [Retrieve a document](https://docs.lighton.ai/api-reference-v2/files/retrieve-a-document.md): **Deprecated — this endpoint will be removed in a future release. Use `GET /api/v3/files/{id}` instead.**
- [Delete a document](https://docs.lighton.ai/api-reference-v2/files/delete-a-document.md): **Deprecated — this endpoint will be removed in a future release. Use `DELETE /api/v3/files/{id}` instead.**
- [Generate an answer with a single document](https://docs.lighton.ai/api-reference-v2/files/generate-an-answer-with-a-single-document.md): **Deprecated — this endpoint will be removed in a future release. Use `POST /api/v3/ask` instead.**
- [Retrieve chunks from a document](https://docs.lighton.ai/api-reference-v2/files/retrieve-chunks-from-a-document.md): **Deprecated — this endpoint will be removed in a future release. Use the V3 retrieve endpoint instead.**

#### Workspaces

- [List workspaces of a company](https://docs.lighton.ai/api-reference-v2/workspaces/list-workspaces-of-a-company.md): This endpoint allows you to create a workspace within a specific company.
- [Create a workspace](https://docs.lighton.ai/api-reference-v2/workspaces/create-a-workspace.md): This endpoint allows you to create a workspace within a specific company.
- [Retrieve a workspace](https://docs.lighton.ai/api-reference-v2/workspaces/retrieve-a-workspace.md): This endpoint allows to retrieve a workspace with his relations (members and collections).
- [Update workspace members](https://docs.lighton.ai/api-reference-v2/workspaces/update-workspace-members.md): This endpoint allows you to update the members of a workspace.
- [Update a workspace](https://docs.lighton.ai/api-reference-v2/workspaces/update-a-workspace.md): This endpoint allows you to update a workspace within a company.

#### Upload Sessions

- [Create an upload session](https://docs.lighton.ai/api-reference-v2/upload-sessions/create-an-upload-session.md): **Deprecated — this endpoint will be removed in a future release. Use `POST /api/v3/files` instead, which automatically creates an upload session.**
- [Deactivate upload sessions](https://docs.lighton.ai/api-reference-v2/upload-sessions/deactivate-upload-sessions.md): **Deprecated — this endpoint will be removed in a future release. Use `POST /api/v3/files` instead, which automatically manages upload sessions.**
- [Retrieve an upload session](https://docs.lighton.ai/api-reference-v2/upload-sessions/retrieve-an-upload-session.md): **Deprecated — this endpoint will be removed in a future release. Use `GET /api/v3/files` with upload session filtering instead.**
- [Add a file to an upload session](https://docs.lighton.ai/api-reference-v2/upload-sessions/add-a-file-to-an-upload-session.md): **Deprecated — this endpoint will be removed in a future release. Use `POST /api/v3/files` instead, which automatically manages upload sessions.**
- [Delete an upload session](https://docs.lighton.ai/api-reference-v2/upload-sessions/delete-an-upload-session.md): **Deprecated — this endpoint will be removed in a future release. Use `GET /api/v3/files` to list files by upload session, then `POST /api/v3/files/bulk-delete` to remove them.**

#### Users

- [Create a company member](https://docs.lighton.ai/api-reference-v2/users/create-a-company-member.md): This endpoint allows to create a company member.
- [List company members](https://docs.lighton.ai/api-reference-v2/users/list-company-members.md): This endpoint allows you to list all members of the requested user's company.
- [Retrieve a company member](https://docs.lighton.ai/api-reference-v2/users/retrieve-a-company-member.md): This endpoint allows you to retrieve the details of a company member.
- [Update groups of a company member](https://docs.lighton.ai/api-reference-v2/users/update-groups-of-a-company-member.md): Warning: This endpoint will be deleted in the future, use the /users/<int:id>/roles/update/ instead.This endpoint allows you to update the groups of a company member.
- [Update roles of a company member](https://docs.lighton.ai/api-reference-v2/users/update-roles-of-a-company-member.md): This endpoint allows you to update the roles of a company member.
- [Update a company member](https://docs.lighton.ai/api-reference-v2/users/update-a-company-member.md): This endpoint allows you to update the details of a company member.
- [Update workspaces of a company member](https://docs.lighton.ai/api-reference-v2/users/update-workspaces-of-a-company-member.md): This endpoint allows you to update the workspaces of a company member.

#### Companies

- [Create a company](https://docs.lighton.ai/api-reference-v2/companies/create-a-company.md): This endpoint allows you to create a new company.
- [Retrieve a company](https://docs.lighton.ai/api-reference-v2/companies/retrieve-a-company.md): This endpoint allows you to retrieve detailed information about a specific company.
- [Update a company](https://docs.lighton.ai/api-reference-v2/companies/update-a-company.md): This endpoint allows you to update the details of an existing company.

#### SCIM

- [List or Retrieve a group](https://docs.lighton.ai/api-reference-v2/scim/list-or-retrieve-a-group.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() We disable PUT as Microsoft does not need it
- [Create a group](https://docs.lighton.ai/api-reference-v2/scim/create-a-group.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() We disable PUT as Microsoft does not need it
- [Delete a group](https://docs.lighton.ai/api-reference-v2/scim/delete-a-group.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() We disable PUT as Microsoft does not need it
- [Update a group](https://docs.lighton.ai/api-reference-v2/scim/update-a-group.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter() We disable PUT as Microsoft does not need it
- [List or Retrieve resource types](https://docs.lighton.ai/api-reference-v2/scim/list-or-retrieve-resource-types.md)
- [List or Retrieve schemas](https://docs.lighton.ai/api-reference-v2/scim/list-or-retrieve-schemas.md)
- [Retrieve Service Provider Configuration](https://docs.lighton.ai/api-reference-v2/scim/retrieve-service-provider-configuration.md)
- [List or Retrieve users](https://docs.lighton.ai/api-reference-v2/scim/list-or-retrieve-users.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter()
- [Replace a user](https://docs.lighton.ai/api-reference-v2/scim/replace-a-user.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter()
- [Create a user](https://docs.lighton.ai/api-reference-v2/scim/create-a-user.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter()
- [Delete a user](https://docs.lighton.ai/api-reference-v2/scim/delete-a-user.md): Override default SCIM delete to anonymize immediately without soft/hard delete.
- [Update a user](https://docs.lighton.ai/api-reference-v2/scim/update-a-user.md): Automatic filtering on company defined in get_extra_model_filter_kwargs_getter()

#### Feedbacks

- [List feedback types](https://docs.lighton.ai/api-reference-v2/feedbacks/list-feedback-types.md): API endpoint for viewing and editing feedback types.
- [List feedback types](https://docs.lighton.ai/api-reference-v2/feedbacks/list-feedback-types-1.md): API endpoint for viewing and editing feedback types.
- [Create a completion feedback](https://docs.lighton.ai/api-reference-v2/feedbacks/create-a-completion-feedback.md): Log a feedback of a given type and linked to an existing completion.

#### Reporting

- [Get company chat sessions report](https://docs.lighton.ai/api-reference-v2/reporting/get-company-chat-sessions-report.md): This endpoint allows retrieving company chat sessions report.
- [Get feedbacks report](https://docs.lighton.ai/api-reference-v2/reporting/get-feedbacks-report.md): This endpoint allows retrieving company chats feedback report.
- [Get company tools report](https://docs.lighton.ai/api-reference-v2/reporting/get-company-tools-report.md): This endpoint allows you to retrieve a company's tools and third-party tools report.
- [Get documents usage report](https://docs.lighton.ai/api-reference-v2/reporting/get-documents-usage-report.md): This endpoint allows retrieving company used documents report.
- [Get company members report](https://docs.lighton.ai/api-reference-v2/reporting/get-company-members-report.md): This endpoint allows you to retrieve a company's members report.

#### Platform Status

- [Get platform load status](https://docs.lighton.ai/api-reference-v2/platform-status/get-platform-load-status.md): Returns the current platform load status including whether any models are experiencing high load.

## OpenAPI Specs

- [openapi-v3](/api-reference/openapi-v3.yaml)
- [openapi-v3-company](/api-reference/openapi-v3-company.yaml)
- [openapi-v3-instance](/api-reference/openapi-v3-instance.yaml)
- [openapi-v2](/api-reference/openapi-v2.yaml)