# LightOn Developers

## Docs

- [Create API key](https://developers.lighton.ai/api-reference/api-keys/create-api-key.md): Create a new API key for the authenticated user.
- [List API keys](https://developers.lighton.ai/api-reference/api-keys/list-api-keys.md): List all API keys belonging to 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.
- [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.
- [Update API key](https://developers.lighton.ai/api-reference/api-keys/update-api-key.md): Update an existing API key.
- [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.
- [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 extract job status](https://developers.lighton.ai/api-reference/extract/get-extract-job-status.md): Returns the current status of an async extract job. Poll until `status` is `completed` or `failed`.
- [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.
- [Delete a file](https://developers.lighton.ai/api-reference/files/delete-a-file.md): Permanently delete a file and all associated data.
- [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.
- [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 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.
- [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.
- [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).
- [Upload a file](https://developers.lighton.ai/api-reference/files/upload-a-file.md): Upload a file to a workspace.
- [API Reference](https://developers.lighton.ai/api-reference/introduction.md): Complete schema for the LightOn REST API.
- [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`.
- [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.
- [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.
- [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.
- [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.
- [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 workspace in your company](https://developers.lighton.ai/api-reference/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.
- [Delete a company workspace](https://developers.lighton.ai/api-reference/workspaces/delete-a-company-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [List workspaces in your company](https://developers.lighton.ai/api-reference/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.
- [Retrieve a company workspace](https://developers.lighton.ai/api-reference/workspaces/retrieve-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://developers.lighton.ai/api-reference/workspaces/update-a-company-workspace.md): ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.
- [Authentication](https://developers.lighton.ai/authentication.md): Authenticate API requests with a bearer token.
- [Introduction](https://developers.lighton.ai/index.md): Upload a PDF. Search it in milliseconds. Parse any document to clean Markdown.
- [Google Drive](https://developers.lighton.ai/integrations/google-drive.md): Create workspaces synced to your Google Drive.
- [Integrations](https://developers.lighton.ai/integrations/index.md): Connect LightOn to the tools and data sources your team already uses.
- [Microsoft SharePoint](https://developers.lighton.ai/integrations/microsoft-sharepoint.md): Create workspaces synced to your Microsoft SharePoint.
- [Scaleway Generative APIs](https://developers.lighton.ai/integrations/scaleway.md): Use LightOn search as the retrieval layer for models hosted on Scaleway.
- [GDPR Compliance](https://developers.lighton.ai/legal/gdpr-compliance.md): Understand how Paradigm complies with GDPR regulations and your rights regarding personal data processing.
- [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.
- [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.
- [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.
- [Claude Code](https://developers.lighton.ai/mcp-server/claude-code.md): Use the LightOn MCP server directly from Claude Code.
- [Cursor](https://developers.lighton.ai/mcp-server/cursor.md): Use the LightOn MCP server directly from Cursor.
- [Mistral Vibe](https://developers.lighton.ai/mcp-server/mistral-vibe.md): Use the LightOn MCP server directly from Mistral Vibe.
- [OpenAI Codex](https://developers.lighton.ai/mcp-server/openai-codex.md): Use the LightOn MCP server directly from OpenAI Codex.
- [OpenCode](https://developers.lighton.ai/mcp-server/opencode.md): Use the LightOn MCP server directly from OpenCode.
- [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.
- [Windsurf](https://developers.lighton.ai/mcp-server/windsurf.md): Use the LightOn MCP server directly from Windsurf.
- [Prompting](https://developers.lighton.ai/prompting/index.md): Best practices for writing effective prompts with LightOn APIs.
- [Quickstart](https://developers.lighton.ai/quickstart.md): Get a search result in under 5 minutes.
- [SDKs](https://developers.lighton.ai/sdks/index.md): Official client libraries for the LightOn API.
- [Asking questions](https://developers.lighton.ai/tutorials/ask.md): Get a grounded, LLM-generated answer over your documents with the sources it used.
- [Extracting structured data](https://developers.lighton.ai/tutorials/extract.md): Pull typed fields out of documents using a JSON Schema you provide.
- [Uploading & managing files](https://developers.lighton.ai/tutorials/files.md): Upload documents into LightOn so they become searchable in seconds.
- [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.
- [Tutorials](https://developers.lighton.ai/tutorials/index.md): Step-by-step guides for building common document intelligence workflows.
- [Parsing documents](https://developers.lighton.ai/tutorials/parse.md): Convert any document to clean Markdown, synchronously or as an async job.
- [Searching documents](https://developers.lighton.ai/tutorials/search.md): Find the most relevant passages in your documents using a natural-language query.
- [Use Cases](https://developers.lighton.ai/use-cases/index.md): Real-world examples and patterns built on the LightOn API.

## OpenAPI Specs

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

## Optional

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