# LightOn Developers

## Docs

- [Introduction](https://developers.lighton.ai/index.md): Upload a PDF. Search it in milliseconds. Parse any document to clean Markdown.
- [Quickstart](https://developers.lighton.ai/quickstart.md): Get a search result in under 5 minutes.
- [Authentication](https://developers.lighton.ai/authentication.md): Authenticate API requests with a bearer token.
- [Prompting](https://developers.lighton.ai/prompting/index.md): Best practices for writing effective prompts with LightOn APIs.
- [API Reference](https://developers.lighton.ai/api-reference/introduction.md): Complete schema for the LightOn REST API.
- [API Errors](https://developers.lighton.ai/api-reference/v3-error-codes.md): Error codes, response format, and troubleshooting for the LightOn API.
- [Ask a question over your documents](https://developers.lighton.ai/api-reference/ask/ask-a-question-over-your-documents.md): Retrieval-augmented generation: searches your indexed corpus, then generates an LLM answer grounded in the retrieved passages.
- [Search document chunks](https://developers.lighton.ai/api-reference/search/search-document-chunks.md): Embedding → hybrid vector search → optional reranking, returning ranked chunks with provenance. No LLM generation is performed.
- [List files accessible to the authenticated user](https://developers.lighton.ai/api-reference/files/list-files-accessible-to-the-authenticated-user.md): Retrieve a paginated list of files (documents) accessible to the authenticated user. Results are ordered by upload date (newest first) by default. When using the `search` parameter, results are ordered by relevance.
- [Upload a file](https://developers.lighton.ai/api-reference/files/upload-a-file.md): Upload a file to a workspace.
- [Delete multiple files in a single request](https://developers.lighton.ai/api-reference/files/delete-multiple-files-in-a-single-request.md): Permanently delete multiple files in a single request.
- [Retrieve a single file by ID](https://developers.lighton.ai/api-reference/files/retrieve-a-single-file-by-id.md): Retrieve detailed information for a single file by its ID. Only files that the authenticated user is authorized to access will be returned. Returns 404 if the file does not exist or the user does not have access.
- [Update file metadata](https://developers.lighton.ai/api-reference/files/update-file-metadata.md): Update mutable fields of a file (document).
- [Delete a file](https://developers.lighton.ai/api-reference/files/delete-a-file.md): Permanently delete a file and all associated data.
- [Download a document file](https://developers.lighton.ai/api-reference/files/download-a-document-file.md): Download a document file. Returns the original file by default. Use the purpose parameter to request a specific version (e.g. rendered_pdf for frontend viewers).
- [List content types](https://developers.lighton.ai/api-reference/facets/list-content-types.md): List your classification trees: the content types you've adopted from the starter templates or created from scratch. This is where you see what's available to classify your documents with.
- [Define content types and attributes](https://developers.lighton.ai/api-reference/facets/define-content-types-and-attributes.md): Create, modify, and organise your company's content-type trees and their attributes. Every action is idempotent, safe to re-run.
- [Batch define content types and attributes](https://developers.lighton.ai/api-reference/facets/batch-define-content-types-and-attributes.md): Execute multiple content-type actions in a single request.
- [Resolve search scope](https://developers.lighton.ai/api-reference/facets/resolve-search-scope.md): Resolves content type and attribute filters from a natural-language query. Call this **before** `/search`, `/ask`, or `/files` to narrow results by domain. Pass the inferred `content_type` and `attribute` directly to those endpoints.
- [List content type templates](https://developers.lighton.ai/api-reference/facets/list-content-type-templates.md): Browse the platform's **starter-kit templates** for content types. These are ready-made taxonomies (legal, finance, healthcare, tech, manufacturing) you can adopt to quickly organise your documents, no manual setup required.
- [List file classifications and attribute values](https://developers.lighton.ai/api-reference/facets/list-file-classifications-and-attribute-values.md): See what content types a file is classified under and what attribute values have been set on it.
- [Classify file and set attribute values](https://developers.lighton.ai/api-reference/facets/classify-file-and-set-attribute-values.md): Apply content-type classifications to a file and set attribute values (metadata) on it. This is how you tag a document with structured metadata from your content-type schema.
- [Batch classify and set attribute values](https://developers.lighton.ai/api-reference/facets/batch-classify-and-set-attribute-values.md): Execute multiple file facet actions in a single request.
- [List all tags for the authenticated user's company](https://developers.lighton.ai/api-reference/tags/list-all-tags-for-the-authenticated-users-company.md): Retrieve a list of tags for the authenticated user's company. Results are ordered by creation date (newest first).
- [Create a new tag for the company](https://developers.lighton.ai/api-reference/tags/create-a-new-tag-for-the-company.md): Create a new tag for the authenticated user's company. The auto_assign flag determines if the tag can be automatically assigned by the system (True) or only manually (False). Requires tag creation permission.
- [Delete a company tag](https://developers.lighton.ai/api-reference/tags/delete-a-company-tag.md): Delete a company tag. This will also remove all Document-Tag associations with this tag. Requires tag deletion permission.
- [Add tags to a file](https://developers.lighton.ai/api-reference/files/add-tags-to-a-file.md): Add one or more tags to a file without affecting existing tags.
- [Remove a tag from a file](https://developers.lighton.ai/api-reference/files/remove-a-tag-from-a-file.md): Remove a specific tag from a file.
- [List workspaces](https://developers.lighton.ai/api-reference/workspaces/list-workspaces.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Create a workspace](https://developers.lighton.ai/api-reference/workspaces/create-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Retrieve a workspace](https://developers.lighton.ai/api-reference/workspaces/retrieve-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Update a workspace](https://developers.lighton.ai/api-reference/workspaces/update-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Delete a workspace](https://developers.lighton.ai/api-reference/workspaces/delete-a-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Browse datasource folders](https://developers.lighton.ai/api-reference/workspaces/browse-datasource-folders.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Test datasource credentials](https://developers.lighton.ai/api-reference/workspaces/test-datasource-credentials.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Parse a document to Markdown](https://developers.lighton.ai/api-reference/parse/parse-a-document-to-markdown.md): Convert a document into readable, structured Markdown content.
- [Get the status and result of an async parse job](https://developers.lighton.ai/api-reference/parse/get-the-status-and-result-of-an-async-parse-job.md): Poll for the status and result of an async parse job submitted via `POST /api/v3/parse` with `options.async=true`. Returns the same envelope shape as the synchronous parse endpoint once `status` is `completed`.
- [Render a document as PDF](https://developers.lighton.ai/api-reference/parse/render-a-document-as-pdf.md): Convert a document into a PDF suitable for inline preview.
- [Extract structured data from a document](https://developers.lighton.ai/api-reference/extract/extract-structured-data-from-a-document.md): Pull specific fields from a document into a typed schema.
- [Get the status and result of an async extract job](https://developers.lighton.ai/api-reference/extract/get-the-status-and-result-of-an-async-extract-job.md): Poll for the status and result of an async extract job submitted via `POST /api/v3/extract` with `options.async=true`. Returns the same envelope shape as the synchronous extract endpoint once `status` is `completed`.
- [List API keys](https://developers.lighton.ai/api-reference/api-keys/list-api-keys.md): List all API keys belonging to the authenticated user.
- [Create API key](https://developers.lighton.ai/api-reference/api-keys/create-api-key.md): Create a new API key for the authenticated user.
- [Retrieve API key](https://developers.lighton.ai/api-reference/api-keys/retrieve-api-key.md): Retrieve a single API key belonging to the authenticated user, including its workspace scope.
- [Update API key](https://developers.lighton.ai/api-reference/api-keys/update-api-key.md): Update an existing API key.
- [Revoke API key](https://developers.lighton.ai/api-reference/api-keys/revoke-api-key.md): Revoke an API key. Revoked keys can no longer be used to authenticate requests.
- [Get company budget](https://developers.lighton.ai/api-reference/budget/get-company-budget.md): Return the company's monthly budget configuration, current spend, and alert thresholds.
- [Create or update company budget](https://developers.lighton.ai/api-reference/budget/create-or-update-company-budget.md): Set or update the company's monthly spend budget. Requires CompanyAdmin role. Creates the budget on first call; updates it on subsequent calls.
- [Delete company budget](https://developers.lighton.ai/api-reference/budget/delete-company-budget.md): Delete the company's budget and all associated alerts. Requires CompanyAdmin role.
- [List budget alerts](https://developers.lighton.ai/api-reference/budget/list-budget-alerts.md): Return all alert thresholds for the company's budget.
- [Create budget alert](https://developers.lighton.ai/api-reference/budget/create-budget-alert.md): Add an alert threshold to the company's budget.
- [Toggle all budget alerts](https://developers.lighton.ai/api-reference/budget/toggle-all-budget-alerts.md): Enable or disable all alert thresholds for the company's budget in a single operation.
- [Update budget alert](https://developers.lighton.ai/api-reference/budget/update-budget-alert.md): Update an existing alert threshold.
- [Delete budget alert](https://developers.lighton.ai/api-reference/budget/delete-budget-alert.md): Delete an alert threshold.
- [Tutorials](https://developers.lighton.ai/tutorials/index.md): Step-by-step guides for building common document intelligence workflows.
- [From documents to answers](https://developers.lighton.ai/tutorials/from-documents-to-answers.md): What retrieval-augmented generation is, how retrieval and generation differ, and which LightOn endpoint to reach for.
- [Uploading & managing files](https://developers.lighton.ai/tutorials/files.md): Upload documents into LightOn so they become searchable in seconds.
- [Searching documents](https://developers.lighton.ai/tutorials/search.md): Find the most relevant passages in your documents using a natural-language query.
- [Asking questions](https://developers.lighton.ai/tutorials/ask.md): Get a grounded, LLM-generated answer over your documents with the sources it used.
- [Organizing documents with workspaces](https://developers.lighton.ai/tutorials/workspaces.md): Partition your corpus into isolated containers per team, customer, or tenant, then scope search and ask to a workspace.
- [Organizing documents with tags](https://developers.lighton.ai/tutorials/tags.md): Group documents into collections with flat, reusable labels, then scope search and ask to a collection.
- [Organizing documents with metadata](https://developers.lighton.ai/tutorials/facets/overview.md): Structured metadata on top of your documents: filter, classify, and enrich search.
- [Building a classification tree](https://developers.lighton.ai/tutorials/facets/define.md): Create content types and custom attributes: the schema that powers all facet queries.
- [Classify files and set attribute values](https://developers.lighton.ai/tutorials/facets/apply.md): Turn documents into structured, queryable data.
- [Filtering documents by metadata](https://developers.lighton.ai/tutorials/facets/filter.md): Query documents by content type and attribute value using structured facet filters.
- [Narrowing search with Agentic](https://developers.lighton.ai/tutorials/facets/scope.md): Detect content type and attribute filters from a natural-language query before searching, asking, or listing files.
- [Rules & constraints](https://developers.lighton.ai/tutorials/facets/rules.md): Troubleshoot errors and understand how Facets behaves when you hit a limit.
- [Parsing documents](https://developers.lighton.ai/tutorials/parse.md): Convert any document to clean Markdown, synchronously or as an async job.
- [Extracting structured data](https://developers.lighton.ai/tutorials/extract.md): Pull typed fields out of documents using a JSON Schema you provide.
- [Integrations](https://developers.lighton.ai/integrations/index.md): Connect LightOn to the tools and data sources your team already uses.
- [Google Drive](https://developers.lighton.ai/integrations/google-drive.md): Create workspaces synced to your Google Drive.
- [Microsoft SharePoint](https://developers.lighton.ai/integrations/microsoft-sharepoint.md): Create workspaces synced to your Microsoft SharePoint.
- [Lyceum Serverless Inference](https://developers.lighton.ai/integrations/lyceum.md): Use LightOn search as the retrieval layer for models hosted on Lyceum.
- [Scaleway Generative APIs](https://developers.lighton.ai/integrations/scaleway.md): Use LightOn search as the retrieval layer for models hosted on Scaleway.
- [OVHcloud AI Endpoints](https://developers.lighton.ai/integrations/ovh.md): Use LightOn search as the retrieval layer for models hosted on OVHcloud AI Endpoints.
- [Inceptron](https://developers.lighton.ai/integrations/inceptron.md): Use LightOn search as the retrieval layer for models hosted on Inceptron.
- [Quickstart](https://developers.lighton.ai/mcp-server/quickstart.md): Connect to the LightOn MCP server.
- [Tools](https://developers.lighton.ai/mcp-server/tools.md): Reference for all tools exposed by the LightOn MCP server.
- [Claude Code](https://developers.lighton.ai/mcp-server/claude-code.md): Use the LightOn MCP server directly from Claude Code.
- [OpenAI Codex](https://developers.lighton.ai/mcp-server/openai-codex.md): Use the LightOn MCP server directly from OpenAI Codex.
- [Mistral Vibe](https://developers.lighton.ai/mcp-server/mistral-vibe.md): Use the LightOn MCP server directly from Mistral Vibe.
- [OpenCode](https://developers.lighton.ai/mcp-server/opencode.md): Use the LightOn MCP server directly from OpenCode.
- [Cursor](https://developers.lighton.ai/mcp-server/cursor.md): Use the LightOn MCP server directly from Cursor.
- [Windsurf](https://developers.lighton.ai/mcp-server/windsurf.md): Use the LightOn MCP server directly from Windsurf.
- [SDKs](https://developers.lighton.ai/sdks/index.md): Official client libraries for the LightOn API.
- [Python quick start](https://developers.lighton.ai/sdks/python/quickstart.md): Install lighton-sdk and get your first grounded answer.
- [Python SDK reference](https://developers.lighton.ai/sdks/python/reference.md): Every public class, method, and type in lighton-sdk 1.1.0.
- [Use Cases](https://developers.lighton.ai/use-cases/index.md): Real-world examples and patterns built on the LightOn API.
- [Terms of Use](https://developers.lighton.ai/legal/terms-of-use.md): These Conditions of Use govern access and use of the Services made available by LightOn.
- [Terms of Service](https://developers.lighton.ai/legal/terms-of-service.md): These Terms of Service govern access to and use of the LightOn Console platform and its associated APIs.
- [Privacy Policy](https://developers.lighton.ai/legal/privacy-policy.md): Privacy policy governing data processing and protection for LightOn's Paradigm AI platform and services.
- [GDPR Compliance](https://developers.lighton.ai/legal/gdpr-compliance.md): Understand how Paradigm complies with GDPR regulations and your rights regarding personal data processing.
- [Cookies and Trackers Policy](https://developers.lighton.ai/legal/cookies-policy.md): How LightOn uses cookies and trackers across its websites, Console, and Paradigm services, and how you can control them.
- [How to submit a report to the Support team](https://developers.lighton.ai/support/index.md): On this page, you will find the official methods to report a bug, submit a feature request, or ask a question to our team.

## OpenAPI Specs

- [api-console](https://developers.lighton.ai/api-reference/api-console.yaml)

## Optional

- [Playground](https://console.lighton.ai)