# Onyx Documentation ## Docs - [Code Execution](https://docs.onyx.app/admins/actions/code_interpreter.md): Enable Python code execution for your AI Agents in Onyx - [Image Generation](https://docs.onyx.app/admins/actions/image_generation.md): Enable image generation capabilities for your AI Agents in Onyx - [MCP](https://docs.onyx.app/admins/actions/mcp.md): Configure Model Context Protocol (MCP) actions in Onyx - [OpenAPI](https://docs.onyx.app/admins/actions/openapi.md): Configure custom actions in Onyx with OpenAPI - [Voice Mode](https://docs.onyx.app/admins/actions/voice_mode.md): Set up voice providers to enable Voice Mode for your Onyx instance - [Web Search](https://docs.onyx.app/admins/actions/web_search.md): Enable web search capabilities for your AI Agents in Onyx - [Hook Extensions](https://docs.onyx.app/admins/advanced_configs/hook_extensions.md): Inject custom logic into Onyx's pipeline at defined stages without modifying source code - [Language Model Access Controls](https://docs.onyx.app/admins/advanced_configs/llm_access_controls.md): Configure access controls for language model providers - [OpenSearch Document Index Migration](https://docs.onyx.app/admins/advanced_configs/opensearch_document_index_migration.md): Migrating indexed documents from Vespa to OpenSearch - [Index Settings](https://docs.onyx.app/admins/advanced_configs/search_configs.md): Configure search settings and parameters - [Spending Limits](https://docs.onyx.app/admins/advanced_configs/spending_limits.md): Configure spending limits in Onyx - [White Labeling](https://docs.onyx.app/admins/advanced_configs/white_labeling.md): Customize Onyx's branding and appearance - [Custom Agents](https://docs.onyx.app/admins/agents/overview.md): Managing AI agents - [Anthropic](https://docs.onyx.app/admins/ai_models/anthropic.md): Configure Anthropic Claude language models for Onyx - [Azure OpenAI](https://docs.onyx.app/admins/ai_models/azure_openai.md): Configure Azure OpenAI for enterprise-grade GPT models - [Amazon Bedrock](https://docs.onyx.app/admins/ai_models/bedrock.md): Configure Amazon Bedrock models for use with Onyx - [Bifrost](https://docs.onyx.app/admins/ai_models/bifrost.md): Configure Bifrost as a language model gateway for Onyx - [Custom Inference Provider](https://docs.onyx.app/admins/ai_models/custom_inference_provider.md): Configure an OpenAI-compatible language model provider - [Google Vertex AI](https://docs.onyx.app/admins/ai_models/google_ai.md): Configure Google Vertex AI language models for use with Onyx - [LiteLLM Proxy](https://docs.onyx.app/admins/ai_models/litellm_proxy.md): Configure LiteLLM Proxy as a language model gateway for Onyx - [LM Studio](https://docs.onyx.app/admins/ai_models/lm_studio.md): Using LM Studio with Onyx - [Ollama](https://docs.onyx.app/admins/ai_models/ollama.md): Using Ollama with Onyx - [OpenAI](https://docs.onyx.app/admins/ai_models/openai.md): Configure OpenAI language models for Onyx - [OpenRouter](https://docs.onyx.app/admins/ai_models/openrouter.md): Using OpenRouter with Onyx - [Overview](https://docs.onyx.app/admins/ai_models/overview.md): Configure language model providers and models in Onyx - [Custom Analytics](https://docs.onyx.app/admins/analytics/custom_analytics.md): Configure a custom analytics provider in Onyx - [Usage Analytics](https://docs.onyx.app/admins/analytics/overview.md): Analytics and usage monitoring in Onyx - [Query History](https://docs.onyx.app/admins/analytics/query_history.md): View and export query history in Onyx - [Manage Your Subscription](https://docs.onyx.app/admins/billing/manage.md): Update seats, manage licenses, and access the Stripe portal - [Plans & Billing](https://docs.onyx.app/admins/billing/overview.md): Understand Onyx plans and how billing works for Cloud and Self-Hosted deployments - [Subscribe to a Plan](https://docs.onyx.app/admins/billing/subscribing.md): How to subscribe to a paid Onyx plan on Cloud or Self-Hosted - [Troubleshooting](https://docs.onyx.app/admins/billing/troubleshooting.md): Common billing and licensing issues and how to resolve them - [Airtable](https://docs.onyx.app/admins/connectors/official/airtable.md): Access tables from Airtable - [Asana](https://docs.onyx.app/admins/connectors/official/asana.md): Index tasks and comments from Asana projects - [Bitbucket Connector](https://docs.onyx.app/admins/connectors/official/bitbucket.md): Access knowledge from your Bitbucket Repositories (Cloud only) - [BookStack](https://docs.onyx.app/admins/connectors/official/bookstack.md): Access knowledge from your own BookStack instance - [ClickUp](https://docs.onyx.app/admins/connectors/official/clickup.md): 'Access tasks from ClickUp' - [Confluence](https://docs.onyx.app/admins/connectors/official/confluence.md): Access knowledge from your company Wiki - [Discord](https://docs.onyx.app/admins/connectors/official/discord.md): 'Access knowledge from your Messages' - [Discourse](https://docs.onyx.app/admins/connectors/official/discourse.md): Access knowledge from your Discourse **Topics** - [Document360](https://docs.onyx.app/admins/connectors/official/document360.md): 'Access wiki articles from Document360' - [Dropbox](https://docs.onyx.app/admins/connectors/official/dropbox.md): Access knowledge from Dropbox - [Drupal Wiki](https://docs.onyx.app/admins/connectors/official/drupal_wiki.md): Access knowledge from your Drupal Wiki instance - [Egnyte](https://docs.onyx.app/admins/connectors/official/egnyte.md): Access files stored in Egnyte - [File](https://docs.onyx.app/admins/connectors/official/file.md): Index files from a local or network drive - [Fireflies](https://docs.onyx.app/admins/connectors/official/fireflies.md): Access meeting transcripts from Fireflies - [Freshdesk](https://docs.onyx.app/admins/connectors/official/freshdesk.md): Access tickets and conversations from Freshdesk - [GitBook](https://docs.onyx.app/admins/connectors/official/gitbook.md): Access documentation from GitBook - [GitHub Connector](https://docs.onyx.app/admins/connectors/official/github.md): Access knowledge from your GitHub Repositories - [GitLab](https://docs.onyx.app/admins/connectors/official/gitlab.md): Index repositories and issues from GitLab - [Gmail OAuth](https://docs.onyx.app/admins/connectors/official/gmail/oauth.md): Set up Gmail OAuth for the connector - [Gmail Overview](https://docs.onyx.app/admins/connectors/official/gmail/overview.md): Overview of the Gmail connector - [Gmail Service Account](https://docs.onyx.app/admins/connectors/official/gmail/service_account.md): Set up Gmail Service Account for the connector - [Gong](https://docs.onyx.app/admins/connectors/official/gong.md): Access call transcripts from Gong - [Google Drive OAuth](https://docs.onyx.app/admins/connectors/official/google_drive/oauth.md): Set up Google Drive OAuth for the connector - [Google Drive Overview](https://docs.onyx.app/admins/connectors/official/google_drive/overview.md): Overview of the Google Drive connector - [Google Drive Service Account](https://docs.onyx.app/admins/connectors/official/google_drive/service_account.md): Set up Google Drive Service Account for the connector - [Google Sites](https://docs.onyx.app/admins/connectors/official/google_sites.md): Access sites and pages from Google Sites - [Google Cloud Storage](https://docs.onyx.app/admins/connectors/official/google_storage.md): Access files from Google Cloud Storage buckets - [Guru](https://docs.onyx.app/admins/connectors/official/guru.md): Access cards and collections from Guru - [Highspot](https://docs.onyx.app/admins/connectors/official/highspot.md): Access sales content from Highspot - [HubSpot](https://docs.onyx.app/admins/connectors/official/hubspot.md): Access CRM data from HubSpot - [Jira](https://docs.onyx.app/admins/connectors/official/jira.md): Access issues and projects from Jira - [Linear](https://docs.onyx.app/admins/connectors/official/linear.md): Access issues and projects from Linear - [Notion](https://docs.onyx.app/admins/connectors/official/notion.md): Access pages and databases from Notion - [Oracle Cloud Storage](https://docs.onyx.app/admins/connectors/official/oci_storage.md): Access files from Oracle Cloud Storage buckets - [Productboard](https://docs.onyx.app/admins/connectors/official/productboard.md): Access product feedback and features from Productboard - [Cloudflare R2](https://docs.onyx.app/admins/connectors/official/r2.md): Access files from Cloudflare R2 buckets - [RequestTracker](https://docs.onyx.app/admins/connectors/official/requesttracker.md): Access tickets from RequestTracker - [S3 Access Keys](https://docs.onyx.app/admins/connectors/official/s3/access-keys.md): Authorize the S3 connector using AWS Access Keys. - [S3 Assume Role](https://docs.onyx.app/admins/connectors/official/s3/assume-role.md): This method automatically uses the IAM role attached to your EC2 instance to access S3 buckets. No manual credential entry is required. - [S3 IAM Role](https://docs.onyx.app/admins/connectors/official/s3/iam-role.md): Authorize the S3 connector using an AWS IAM Role with assume role policy. - [S3 Overview](https://docs.onyx.app/admins/connectors/official/s3/overview.md): Overview of the S3 connector - [Salesforce](https://docs.onyx.app/admins/connectors/official/salesforce.md): Access CRM data from Salesforce - [Certificate-Based Authentication](https://docs.onyx.app/admins/connectors/official/sharepoint/certificate.md): Set up SharePoint connector using certificate-based authentication with optional permission sync support - [Client Secret Authentication](https://docs.onyx.app/admins/connectors/official/sharepoint/client-secret.md): Set up SharePoint connector using client secret authentication - [Overview](https://docs.onyx.app/admins/connectors/official/sharepoint/sharepoint.md): Access files and notes from your SharePoint Sites - [Slab](https://docs.onyx.app/admins/connectors/official/slab.md): Access documentation from Slab - [Slack Federated](https://docs.onyx.app/admins/connectors/official/slack/slack_federated.md): Set up the Slack Federated connector - [Slack Indexed](https://docs.onyx.app/admins/connectors/official/slack/slack_indexed.md): Set up the Slack Indexed connector - [Microsoft Teams](https://docs.onyx.app/admins/connectors/official/teams.md): Access messages and files from Microsoft Teams - [Web](https://docs.onyx.app/admins/connectors/official/web.md): Index public or internal web pages - [XenForo](https://docs.onyx.app/admins/connectors/official/xenforo.md): Access forum posts from XenForo - [Zendesk](https://docs.onyx.app/admins/connectors/official/zendesk.md): Access tickets and conversations from Zendesk - [Zulip](https://docs.onyx.app/admins/connectors/official/zulip.md): Access messages from Zulip streams - [Overview](https://docs.onyx.app/admins/connectors/overview.md): Managing connectors and data sources in Onyx - [Enterprise Edition](https://docs.onyx.app/admins/getting_started/enterprise_edition.md): Enterprise Edition administration features - [Slack Bot](https://docs.onyx.app/admins/getting_started/slack_bot_setup.md): How to set up a Slack bot connected to Onyx - [Chat UI](https://docs.onyx.app/admins/managing_features/chat.md): Managing the Chat UI experience across your organization - [Connectors](https://docs.onyx.app/admins/managing_features/connectors_link.md): Set up and manage data source connectors - [Document Sets](https://docs.onyx.app/admins/managing_features/document_sets.md): Managing document sets - [Contact Us](https://docs.onyx.app/admins/miscellaneous/contact_us.md): Excited to hear from you! - [Discord Bot](https://docs.onyx.app/admins/miscellaneous/discord_bot.md): Configure your Discord bot - [Overview](https://docs.onyx.app/admins/overview.md): An Overview of Administering Onyx - [What's Changing in Permissions](https://docs.onyx.app/admins/permissions/whats_changing.md): Onyx is moving to group-based permissions. Here's what's changing, what's being removed, and what you need to do. - [Service Accounts](https://docs.onyx.app/admins/user_management/api_keys.md): Create and manage service accounts for programmatic access - [Users and Groups](https://docs.onyx.app/admins/user_management/users_and_groups.md): Manage users, roles, groups, and invitations in Onyx - [Release Notes](https://docs.onyx.app/changelog.md): New Features, Improvements, and Bug Fixes - [Basic Auth](https://docs.onyx.app/deployment/authentication/basic.md): Set up Onyx with basic username/password authentication - [Google OAuth](https://docs.onyx.app/deployment/authentication/oauth.md): Google OAuth authentication setup - [OIDC](https://docs.onyx.app/deployment/authentication/oidc.md): OpenID Connect authentication setup - [SAML](https://docs.onyx.app/deployment/authentication/saml.md): SAML authentication setup - [SCIM](https://docs.onyx.app/deployment/authentication/scim.md): Automated user and group provisioning with SCIM 2.0 - [EC2](https://docs.onyx.app/deployment/cloud/aws/ec2.md): Deploy Onyx on AWS EC2 - [EKS](https://docs.onyx.app/deployment/cloud/aws/eks.md): Deploy Onyx on AWS EKS - [RDS](https://docs.onyx.app/deployment/cloud/aws/rds.md): Setup AWS RDS for Onyx - [Azure](https://docs.onyx.app/deployment/cloud/azure.md): Deploy Onyx on Azure Virtual Machines - [Digital Ocean](https://docs.onyx.app/deployment/cloud/digital_ocean.md): Deploy Onyx on Digital Ocean Droplets - [GCP](https://docs.onyx.app/deployment/cloud/gcp.md): Deploy Onyx on GCP Compute Engine - [Chrome Extension](https://docs.onyx.app/deployment/configuration/chrome_extension.md): Use Onyx in Chrome from any page - [Configure Onyx](https://docs.onyx.app/deployment/configuration/configuration.md): How to configure Onyx using environment variables and deployment files - [Onyx MCP Server](https://docs.onyx.app/deployment/configuration/mcp_server.md): Connect LLMs like Claude, Cursor, and other AI tools to your Onyx knowledge base via the Model Context Protocol - [Website Widget](https://docs.onyx.app/deployment/configuration/website_widget.md): Deploy the Onyx chat widget on your website - [Quickstart](https://docs.onyx.app/deployment/getting_started/quickstart.md): Recommended way to deploy Onyx in minutes - [Resourcing](https://docs.onyx.app/deployment/getting_started/resourcing.md): Resource requirements for deploying Onyx - [Desktop App](https://docs.onyx.app/deployment/local/desktop_app.md): Install and configure the Onyx desktop application - [Docker](https://docs.onyx.app/deployment/local/docker.md): Deploy Onyx with Docker Compose - [Kubernetes](https://docs.onyx.app/deployment/local/kubernetes.md): Deploy Onyx with Helm - [OpenSearch](https://docs.onyx.app/deployment/local/opensearch.md): Configuring Onyx with OpenSearch - [Terraform](https://docs.onyx.app/deployment/local/terraform.md): Provision Onyx infrastructure on AWS with Terraform - [Contact Us](https://docs.onyx.app/deployment/miscellaneous/contact_us.md): Ways to get in touch with the Onyx team - [Enterprise Edition](https://docs.onyx.app/deployment/miscellaneous/enterprise_edition.md): Enterprise Edition features and deployment - [Release Process & Updates](https://docs.onyx.app/deployment/miscellaneous/release_process.md): Onyx release process, versioning, and recommended update process - [Overview](https://docs.onyx.app/deployment/overview.md): An overview of deploying Onyx - [Create Custom Tool](https://docs.onyx.app/developers/api_reference/actions/create_custom_tool.md) - [Delete Custom Tool](https://docs.onyx.app/developers/api_reference/actions/delete_custom_tool.md) - [Get Custom Tool](https://docs.onyx.app/developers/api_reference/actions/get_custom_tool.md) - [List OpenAPI Tools](https://docs.onyx.app/developers/api_reference/actions/list_openapi_tools.md) - [List Tools](https://docs.onyx.app/developers/api_reference/actions/list_tools.md) - [Update Custom Tool](https://docs.onyx.app/developers/api_reference/actions/update_custom_tool.md) - [Validate Tool](https://docs.onyx.app/developers/api_reference/actions/validate_tool.md) - [Create Agent](https://docs.onyx.app/developers/api_reference/agents/create_persona.md) - [Delete Agent](https://docs.onyx.app/developers/api_reference/agents/delete_persona.md) - [Get Agents Admin Paginated](https://docs.onyx.app/developers/api_reference/agents/get_agents_admin_paginated.md): Paginated endpoint for listing agents (formerly personas) (admin view). - [Get Agents Paginated](https://docs.onyx.app/developers/api_reference/agents/get_agents_paginated.md): Paginated endpoint for listing agents available to the user. - [Get Agent](https://docs.onyx.app/developers/api_reference/agents/get_persona.md) - [List Agents Admin](https://docs.onyx.app/developers/api_reference/agents/list_personas_admin.md) - [Undelete Agent](https://docs.onyx.app/developers/api_reference/agents/undelete_persona.md) - [Update Agent](https://docs.onyx.app/developers/api_reference/agents/update_persona.md) - [Create New Chat Session](https://docs.onyx.app/developers/api_reference/chat/create_new_chat_session.md) - [Delete All Chat Sessions](https://docs.onyx.app/developers/api_reference/chat/delete_all_chat_sessions.md) - [Delete Chat Session By Id](https://docs.onyx.app/developers/api_reference/chat/delete_chat_session_by_id.md) - [Fetch Chat File](https://docs.onyx.app/developers/api_reference/chat/fetch_chat_file.md) - [Get Chat Session](https://docs.onyx.app/developers/api_reference/chat/get_chat_session.md) - [Get User Chat Sessions](https://docs.onyx.app/developers/api_reference/chat/get_user_chat_sessions.md) - [Handle Send Chat Message](https://docs.onyx.app/developers/api_reference/chat/handle_send_chat_message.md): This endpoint is used to send a new chat message. - [Search Chats](https://docs.onyx.app/developers/api_reference/chat/search_chats.md): Search for chat sessions based on the provided query. If no query is provided, returns recent chat sessions. - [Seed Chat](https://docs.onyx.app/developers/api_reference/chat/seed_chat.md) - [Stop Chat Session](https://docs.onyx.app/developers/api_reference/chat/stop_chat_session.md): Stop a chat session by setting a stop signal in Redis. This endpoint is called by the frontend when the user clicks the stop button. - [Associate Credential To Connector](https://docs.onyx.app/developers/api_reference/files_connectors/associate_credential_to_connector.md): NOTE(rkuo): internally discussed and the consensus is this endpoint and create_connector_with_mock_credential should be combined. - [Connector Run Once](https://docs.onyx.app/developers/api_reference/files_connectors/connector_run_once.md): Used to trigger indexing on a set of cc_pairs associated with a single connector. - [Create Connector From Model](https://docs.onyx.app/developers/api_reference/files_connectors/create_connector_from_model.md) - [Create Credential From Model](https://docs.onyx.app/developers/api_reference/files_connectors/create_credential_from_model.md) - [Create Credential With Private Key](https://docs.onyx.app/developers/api_reference/files_connectors/create_credential_with_private_key.md) - [Create Deletion Attempt For Connector Id](https://docs.onyx.app/developers/api_reference/files_connectors/create_deletion_attempt_for_connector_id.md) - [Delete Connector By Id](https://docs.onyx.app/developers/api_reference/files_connectors/delete_connector_by_id.md) - [Delete Credential By Id](https://docs.onyx.app/developers/api_reference/files_connectors/delete_credential_by_id.md) - [Delete Credential By Id Admin](https://docs.onyx.app/developers/api_reference/files_connectors/delete_credential_by_id_admin.md): Same as the user endpoint, but can delete any credential (not just the user's own) - [Dissociate Credential From Connector](https://docs.onyx.app/developers/api_reference/files_connectors/dissociate_credential_from_connector.md) - [Force Delete Credential By Id](https://docs.onyx.app/developers/api_reference/files_connectors/force_delete_credential_by_id.md) - [Get Basic Connector Indexing Status](https://docs.onyx.app/developers/api_reference/files_connectors/get_basic_connector_indexing_status.md) - [Get CC Pair Full Info](https://docs.onyx.app/developers/api_reference/files_connectors/get_cc_pair_full_info.md) - [Get CC Pair Index Attempts](https://docs.onyx.app/developers/api_reference/files_connectors/get_cc_pair_index_attempts.md) - [Get CC Pair Indexing Errors](https://docs.onyx.app/developers/api_reference/files_connectors/get_cc_pair_indexing_errors.md): Gives back all errors for a given CC Pair. Allows pagination based on page and page_size params. - [Get Cc Source Full Info](https://docs.onyx.app/developers/api_reference/files_connectors/get_cc_source_full_info.md) - [Get Connector By Id](https://docs.onyx.app/developers/api_reference/files_connectors/get_connector_by_id.md) - [Get Connector Indexing Status](https://docs.onyx.app/developers/api_reference/files_connectors/get_connector_indexing_status.md) - [Get Connector Status](https://docs.onyx.app/developers/api_reference/files_connectors/get_connector_status.md) - [Get Connectors](https://docs.onyx.app/developers/api_reference/files_connectors/get_connectors.md) - [Get Connectors By Credential](https://docs.onyx.app/developers/api_reference/files_connectors/get_connectors_by_credential.md): Get a list of connectors. Allow filtering by a specific credential id. - [Get Credential By Id](https://docs.onyx.app/developers/api_reference/files_connectors/get_credential_by_id.md) - [Get Currently Failed Indexing Status](https://docs.onyx.app/developers/api_reference/files_connectors/get_currently_failed_indexing_status.md) - [Get Docs By Connector Credential Pair](https://docs.onyx.app/developers/api_reference/files_connectors/get_docs_by_connector_credential_pair.md) - [Get Indexed Sources](https://docs.onyx.app/developers/api_reference/files_connectors/get_indexed_sources.md) - [List Connector Files](https://docs.onyx.app/developers/api_reference/files_connectors/list_connector_files.md): List all files in a file connector. - [List Credentials](https://docs.onyx.app/developers/api_reference/files_connectors/list_credentials.md) - [List Credentials Admin](https://docs.onyx.app/developers/api_reference/files_connectors/list_credentials_admin.md): Lists all public credentials - [Prune Cc Pair](https://docs.onyx.app/developers/api_reference/files_connectors/prune_cc_pair.md): Triggers pruning on a particular cc_pair immediately - [Swap Credentials For Connector](https://docs.onyx.app/developers/api_reference/files_connectors/swap_credentials_for_connector.md) - [Update CC Pair Status](https://docs.onyx.app/developers/api_reference/files_connectors/update_cc_pair_status.md): This method returns nearly immediately. It simply sets some signals and optimistically assumes any running background processes will clean themselves up. This is done to improve the perceived end user experience. - [Update Connector Files](https://docs.onyx.app/developers/api_reference/files_connectors/update_connector_files.md): Update files in a connector by adding new files and/or removing existing ones. This is an atomic operation that validates, updates the connector config, and triggers indexing. - [Update Credential Data](https://docs.onyx.app/developers/api_reference/files_connectors/update_credential_data.md) - [Update Credential From Model](https://docs.onyx.app/developers/api_reference/files_connectors/update_credential_from_model.md) - [Update Credential Private Key](https://docs.onyx.app/developers/api_reference/files_connectors/update_credential_private_key.md) - [Upload Files Api](https://docs.onyx.app/developers/api_reference/files_connectors/upload_files_api.md) - [Delete Ingestion Doc](https://docs.onyx.app/developers/api_reference/ingestion/delete_ingestion_doc.md) - [Get Ingestion Docs](https://docs.onyx.app/developers/api_reference/ingestion/get_ingestion_docs.md) - [Upsert Ingestion Doc](https://docs.onyx.app/developers/api_reference/ingestion/upsert_ingestion_doc.md) - [Create Global Token Limit Settings](https://docs.onyx.app/developers/api_reference/miscellaneous/create_global_token_limit_settings.md) - [Delete Token Limit Settings](https://docs.onyx.app/developers/api_reference/miscellaneous/delete_token_limit_settings.md) - [Get Global Token Limit Settings](https://docs.onyx.app/developers/api_reference/miscellaneous/get_global_token_limit_settings.md) - [Get Backend Version](https://docs.onyx.app/developers/api_reference/miscellaneous/get_version.md) - [Get Latest App Version Tags](https://docs.onyx.app/developers/api_reference/miscellaneous/get_versions.md): Fetches the latest stable and beta versions of Onyx Docker images. Since DockerHub does not explicitly flag stable and beta images, this endpoint can be used to programmatically check for new images. - [Healthcheck](https://docs.onyx.app/developers/api_reference/miscellaneous/healthcheck.md) - [Update Token Limit Settings](https://docs.onyx.app/developers/api_reference/miscellaneous/update_token_limit_settings.md) - [Create Project](https://docs.onyx.app/developers/api_reference/projects/create_project.md) - [Delete Project](https://docs.onyx.app/developers/api_reference/projects/delete_project.md) - [Delete User File](https://docs.onyx.app/developers/api_reference/projects/delete_user_file.md): Delete a user file belonging to the current user. - [Get Chat Session Project Files](https://docs.onyx.app/developers/api_reference/projects/get_chat_session_project_files.md): Return user files for the project linked to the given chat session. - [Get Files In Project](https://docs.onyx.app/developers/api_reference/projects/get_files_in_project.md) - [Get Project](https://docs.onyx.app/developers/api_reference/projects/get_project.md) - [Get Project Details](https://docs.onyx.app/developers/api_reference/projects/get_project_details.md) - [Get Project Instructions](https://docs.onyx.app/developers/api_reference/projects/get_project_instructions.md) - [Get Projects](https://docs.onyx.app/developers/api_reference/projects/get_projects.md) - [Get User File](https://docs.onyx.app/developers/api_reference/projects/get_user_file.md): Fetch a single user file by ID for the current user. - [Get User File Statuses](https://docs.onyx.app/developers/api_reference/projects/get_user_file_statuses.md): Fetch statuses for a set of user file IDs owned by the current user. - [Link User File To Project](https://docs.onyx.app/developers/api_reference/projects/link_user_file_to_project.md): Link an existing user file to a specific project for the current user. - [Unlink User File From Project](https://docs.onyx.app/developers/api_reference/projects/unlink_user_file_from_project.md): Unlink an existing user file from a specific project for the current user. - [Update Project](https://docs.onyx.app/developers/api_reference/projects/update_project.md) - [Upload User Files](https://docs.onyx.app/developers/api_reference/projects/upload_user_files.md) - [Upsert Project Instructions](https://docs.onyx.app/developers/api_reference/projects/upsert_project_instructions.md): Create or update this project's instructions stored on the project itself. - [Execute Open Urls](https://docs.onyx.app/developers/api_reference/search/execute_open_urls.md): Fetch content for specific URLs using the configured content provider. Intended to complement `/search-lite` when you need content for a subset of URLs. - [Execute Web Search](https://docs.onyx.app/developers/api_reference/search/execute_web_search.md): Perform a web search and immediately fetch content for the returned URLs. - [Execute Web Search Lite](https://docs.onyx.app/developers/api_reference/search/execute_web_search_lite.md): Lightweight search-only endpoint. Returns search snippets and URLs without fetching page contents. Pair with `/open-urls` if you need to fetch content later. - [Handle Search Request](https://docs.onyx.app/developers/api_reference/search/handle_search_request.md) - [Activate User Api](https://docs.onyx.app/developers/api_reference/user_management/activate_user_api.md) - [Bulk Invite Users](https://docs.onyx.app/developers/api_reference/user_management/bulk_invite_users.md): emails are string validated. If any email fails validation, no emails are invited and an exception is raised. - [Deactivate User Api](https://docs.onyx.app/developers/api_reference/user_management/deactivate_user_api.md) - [Delete User](https://docs.onyx.app/developers/api_reference/user_management/delete_user.md) - [Get Auth Type](https://docs.onyx.app/developers/api_reference/user_management/get_auth_type.md) - [Get User Role](https://docs.onyx.app/developers/api_reference/user_management/get_user_role.md) - [List Accepted Users](https://docs.onyx.app/developers/api_reference/user_management/list_accepted_users.md) - [List All Users](https://docs.onyx.app/developers/api_reference/user_management/list_all_users.md) - [List All Users Basic Info](https://docs.onyx.app/developers/api_reference/user_management/list_all_users_basic_info.md) - [List Invited Users](https://docs.onyx.app/developers/api_reference/user_management/list_invited_users.md) - [Remove Invited User](https://docs.onyx.app/developers/api_reference/user_management/remove_invited_user.md) - [Set User Role](https://docs.onyx.app/developers/api_reference/user_management/set_user_role.md) - [Verify User Logged In](https://docs.onyx.app/developers/api_reference/user_management/verify_user_logged_in.md) - [Contact Us](https://docs.onyx.app/developers/contact_us.md): Excited to hear from you! - [Core Concepts](https://docs.onyx.app/developers/core_concepts.md): Essential concepts and terminology for working with Onyx APIs - [Send a Message to Onyx](https://docs.onyx.app/developers/guides/chat_new_guide.md): Sending messages programmatically to Onyx - [Create Connectors](https://docs.onyx.app/developers/guides/create_connector.md): Learn how to create and configure connectors programmatically - [Index Files with the Ingestion API](https://docs.onyx.app/developers/guides/index_files_ingestion_api.md): Learn how to programmatically index documents using Onyx's ingestion API - [Overview & Auth](https://docs.onyx.app/developers/overview.md): Overview of Onyx APIs - [Actions & MCP](https://docs.onyx.app/overview/core_features/actions.md): Extend the capabilities of Onyx Agents - [Custom Agents](https://docs.onyx.app/overview/core_features/agents.md): Create custom AI Agents for unique use cases - [Chat UI](https://docs.onyx.app/overview/core_features/chat.md): Overview of Onyx's primary user interface - [Code Execution](https://docs.onyx.app/overview/core_features/code_interpreter.md): Safe and sandboxed Python runtime available to the LLM - [Connectors](https://docs.onyx.app/overview/core_features/connectors.md): Ingest knowledge from connected applications - [Craft (beta)](https://docs.onyx.app/overview/core_features/craft.md): Create web apps, documents, slides, and more from your company knowledge - [Image Generation](https://docs.onyx.app/overview/core_features/image_generation.md): Create visuals according to user prompts - [RAG and Search](https://docs.onyx.app/overview/core_features/internal_search.md): Enterprise Search across all your applications - [Voice Mode](https://docs.onyx.app/overview/core_features/voice_mode.md): Interact with Onyx using voice - [Web Search](https://docs.onyx.app/overview/core_features/web_search.md): AI-powered web search - [FAQ](https://docs.onyx.app/overview/getting_started/faq.md): Frequently asked questions about using Onyx - [Quickstart](https://docs.onyx.app/overview/getting_started/quickstart.md): Recommended way to deploy Onyx in minutes - [Use Cases](https://docs.onyx.app/overview/getting_started/use_cases.md): Ideas for an AI-powered workplace. - [Contact Us](https://docs.onyx.app/overview/miscellaneous/contact_us.md): Excited to hear from you! - [Open Source Statement](https://docs.onyx.app/overview/miscellaneous/open_source_statement.md): Onyx's commitment to open source principles - [Chrome Extension](https://docs.onyx.app/overview/onyx_anywhere/chrome_extension.md): Accessing Onyx via a Chrome Extension - [CLI](https://docs.onyx.app/overview/onyx_anywhere/cli.md): Interact with Onyx from the command line - [Desktop App](https://docs.onyx.app/overview/onyx_anywhere/desktop_app.md): Accessing Onyx via the desktop application - [Discord Bot](https://docs.onyx.app/overview/onyx_anywhere/discord_bot.md): Access Onyx within Discord - [MCP Server](https://docs.onyx.app/overview/onyx_anywhere/mcp_server.md): Access Onyx from Claude, Cursor, and other AI tools via the Model Context Protocol - [Mobile App (Coming Soon)](https://docs.onyx.app/overview/onyx_anywhere/mobile_app.md): Access Onyx from mobile devices - [Slack Bot](https://docs.onyx.app/overview/onyx_anywhere/slack.md): Accessing Onyx within Slack - [Website Widget](https://docs.onyx.app/overview/onyx_anywhere/website_widget.md): Embed Onyx AI chat on any website - [Access Controls](https://docs.onyx.app/security/architecture/access_controls.md): Resource protection from users - [Data Flows](https://docs.onyx.app/security/architecture/data_flows.md): How data and queries are handled and stored - [Data Storage](https://docs.onyx.app/security/architecture/data_storage.md): How data is persisted in the Onyx system - [FAQ](https://docs.onyx.app/security/architecture/faq.md): General questions about Onyx security - [System Description](https://docs.onyx.app/security/architecture/system_description.md): High level view of Onyx components - [Contact Us](https://docs.onyx.app/security/contact_us.md): Excited to hear from you! - [Compliance](https://docs.onyx.app/security/onyx_cloud/compliance.md): Certifications - [Multi Tenant](https://docs.onyx.app/security/onyx_cloud/multi_tenant.md): Self-serve cloud - [Single Tenant](https://docs.onyx.app/security/onyx_cloud/single_tenant.md): Enterprise cloud - [Data Processing](https://docs.onyx.app/security/self_hosted/data_processing.md): How sensitive data is processed - [FAQ](https://docs.onyx.app/security/self_hosted/faq.md): Common questions specifically for self-hosting - [Welcome to Onyx!](https://docs.onyx.app/welcome.md): Open Source AI Platform for Work ## OpenAPI Specs - [openapi](https://docs.onyx.app/developers/api_reference/openapi.json) ## Optional - [Website](https://onyx.app/) - [Discord](https://discord.gg/TDJ59cGV2X)