# Hymalaia Documentation ## Docs - [Anthropic](https://docs.hymalaia.com/ai-configs/anthropic.md): Configure Hymalaia to use different Anthropic Claude models like Claude 3.5 Sonnet. - [Azure OpenAI](https://docs.hymalaia.com/ai-configs/azure-openAI.md): Configure Hymalaia to use GPT models hosted on Azure OpenAI. - [Custom model server](https://docs.hymalaia.com/ai-configs/custom-model-server.md) - [FastChat](https://docs.hymalaia.com/ai-configs/fastChat.md) - [GenAI Overview](https://docs.hymalaia.com/ai-configs/genAI-overview.md): Overview of the Generative AI functionality and LLM integrations in Hymalaia. - [HuggingFace Inference API](https://docs.hymalaia.com/ai-configs/huggingface-inference-api.md): Configure Hymalaia to use HuggingFace Inference APIs - [Ollama](https://docs.hymalaia.com/ai-configs/ollama.md): Configure Hymalaia to use Ollama - [OpenAI](https://docs.hymalaia.com/ai-configs/openAI.md): Configure Hymalaia to use different OpenAI models via API key. - [Vertex AI](https://docs.hymalaia.com/ai-configs/vertex-ai.md): Configure Hymalaia to use Vertex AI for LLMs via Google Cloud. - [Create Custom Tool](https://docs.hymalaia.com/api-reference/actions/create_custom_tool.md) - [Delete Custom Tool](https://docs.hymalaia.com/api-reference/actions/delete_custom_tool.md) - [Get Custom Tool](https://docs.hymalaia.com/api-reference/actions/get_custom_tool.md) - [List OpenAPI Tools](https://docs.hymalaia.com/api-reference/actions/list_openapi_tools.md) - [List Tools](https://docs.hymalaia.com/api-reference/actions/list_tools.md) - [Update Custom Tool](https://docs.hymalaia.com/api-reference/actions/update_custom_tool.md) - [Validate Tool](https://docs.hymalaia.com/api-reference/actions/validate_tool.md) - [Create Agent](https://docs.hymalaia.com/api-reference/agents/create_persona.md) - [Delete Agent](https://docs.hymalaia.com/api-reference/agents/delete_persona.md) - [Get Agents Admin Paginated](https://docs.hymalaia.com/api-reference/agents/get_agents_admin_paginated.md): Paginated endpoint for listing agents (formerly personas) (admin view). - [Get Agents Paginated](https://docs.hymalaia.com/api-reference/agents/get_agents_paginated.md): Paginated endpoint for listing agents available to the user. - [Get Agent](https://docs.hymalaia.com/api-reference/agents/get_persona.md) - [List Agents Admin](https://docs.hymalaia.com/api-reference/agents/list_personas_admin.md) - [Undelete Agent](https://docs.hymalaia.com/api-reference/agents/undelete_persona.md) - [Update Agent](https://docs.hymalaia.com/api-reference/agents/update_persona.md) - [Send Chat Message (Deprecated)](https://docs.hymalaia.com/api-reference/chat-send-message.md): Endpoint for sending a chat message via Hymalaia API - [Create New Chat Session](https://docs.hymalaia.com/api-reference/chat/create_new_chat_session.md) - [Delete All Chat Sessions](https://docs.hymalaia.com/api-reference/chat/delete_all_chat_sessions.md) - [Delete Chat Session By Id](https://docs.hymalaia.com/api-reference/chat/delete_chat_session_by_id.md) - [Fetch Chat File](https://docs.hymalaia.com/api-reference/chat/fetch_chat_file.md) - [Get Chat Session](https://docs.hymalaia.com/api-reference/chat/get_chat_session.md) - [Get User Chat Sessions](https://docs.hymalaia.com/api-reference/chat/get_user_chat_sessions.md) - [Handle Send Chat Message](https://docs.hymalaia.com/api-reference/chat/handle_send_chat_message.md): This endpoint is used to send a new chat message. - [Search Chats](https://docs.hymalaia.com/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.hymalaia.com/api-reference/chat/seed_chat.md) - [Stop Chat Session](https://docs.hymalaia.com/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. - [Core Concepts](https://docs.hymalaia.com/api-reference/core_concepts.md): Essential concepts and terminology for working with Hymalaia APIs - [Associate Credential To Connector](https://docs.hymalaia.com/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.hymalaia.com/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.hymalaia.com/api-reference/files_connectors/create_connector_from_model.md) - [Create Credential From Model](https://docs.hymalaia.com/api-reference/files_connectors/create_credential_from_model.md) - [Create Credential With Private Key](https://docs.hymalaia.com/api-reference/files_connectors/create_credential_with_private_key.md) - [Create Deletion Attempt For Connector Id](https://docs.hymalaia.com/api-reference/files_connectors/create_deletion_attempt_for_connector_id.md) - [Delete Connector By Id](https://docs.hymalaia.com/api-reference/files_connectors/delete_connector_by_id.md) - [Delete Credential By Id](https://docs.hymalaia.com/api-reference/files_connectors/delete_credential_by_id.md) - [Delete Credential By Id Admin](https://docs.hymalaia.com/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.hymalaia.com/api-reference/files_connectors/dissociate_credential_from_connector.md) - [Force Delete Credential By Id](https://docs.hymalaia.com/api-reference/files_connectors/force_delete_credential_by_id.md) - [Get Basic Connector Indexing Status](https://docs.hymalaia.com/api-reference/files_connectors/get_basic_connector_indexing_status.md) - [Get CC Pair Full Info](https://docs.hymalaia.com/api-reference/files_connectors/get_cc_pair_full_info.md) - [Get CC Pair Index Attempts](https://docs.hymalaia.com/api-reference/files_connectors/get_cc_pair_index_attempts.md) - [Get CC Pair Indexing Errors](https://docs.hymalaia.com/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.hymalaia.com/api-reference/files_connectors/get_cc_source_full_info.md) - [Get Connector By Id](https://docs.hymalaia.com/api-reference/files_connectors/get_connector_by_id.md) - [Get Connector Indexing Status](https://docs.hymalaia.com/api-reference/files_connectors/get_connector_indexing_status.md) - [Get Connector Status](https://docs.hymalaia.com/api-reference/files_connectors/get_connector_status.md) - [Get Connectors](https://docs.hymalaia.com/api-reference/files_connectors/get_connectors.md) - [Get Connectors By Credential](https://docs.hymalaia.com/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.hymalaia.com/api-reference/files_connectors/get_credential_by_id.md) - [Get Currently Failed Indexing Status](https://docs.hymalaia.com/api-reference/files_connectors/get_currently_failed_indexing_status.md) - [Get Docs By Connector Credential Pair](https://docs.hymalaia.com/api-reference/files_connectors/get_docs_by_connector_credential_pair.md) - [Get Indexed Sources](https://docs.hymalaia.com/api-reference/files_connectors/get_indexed_sources.md) - [List Connector Files](https://docs.hymalaia.com/api-reference/files_connectors/list_connector_files.md): List all files in a file connector. - [List Credentials](https://docs.hymalaia.com/api-reference/files_connectors/list_credentials.md) - [List Credentials Admin](https://docs.hymalaia.com/api-reference/files_connectors/list_credentials_admin.md): Lists all public credentials - [Prune Cc Pair](https://docs.hymalaia.com/api-reference/files_connectors/prune_cc_pair.md): Triggers pruning on a particular cc_pair immediately - [Swap Credentials For Connector](https://docs.hymalaia.com/api-reference/files_connectors/swap_credentials_for_connector.md) - [Update CC Pair Status](https://docs.hymalaia.com/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.hymalaia.com/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.hymalaia.com/api-reference/files_connectors/update_credential_data.md) - [Update Credential From Model](https://docs.hymalaia.com/api-reference/files_connectors/update_credential_from_model.md) - [Update Credential Private Key](https://docs.hymalaia.com/api-reference/files_connectors/update_credential_private_key.md) - [Upload Files Api](https://docs.hymalaia.com/api-reference/files_connectors/upload_files_api.md) - [Send a Message to Hymalaia](https://docs.hymalaia.com/api-reference/guides/chat_new_guide.md): Sending messages programmatically to Hymalaia - [Create Connectors](https://docs.hymalaia.com/api-reference/guides/create_connector.md): Learn how to create and configure connectors programmatically - [Create Global Token Limit Settings](https://docs.hymalaia.com/api-reference/miscellaneous/create_global_token_limit_settings.md) - [Delete Token Limit Settings](https://docs.hymalaia.com/api-reference/miscellaneous/delete_token_limit_settings.md) - [Get Global Token Limit Settings](https://docs.hymalaia.com/api-reference/miscellaneous/get_global_token_limit_settings.md) - [Get Backend Version](https://docs.hymalaia.com/api-reference/miscellaneous/get_version.md) - [Get Latest App Version Tags](https://docs.hymalaia.com/api-reference/miscellaneous/get_versions.md): Fetches the latest stable and beta versions of Hymalaia 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.hymalaia.com/api-reference/miscellaneous/healthcheck.md) - [Update Token Limit Settings](https://docs.hymalaia.com/api-reference/miscellaneous/update_token_limit_settings.md) - [Overview & Auth](https://docs.hymalaia.com/api-reference/overview.md): Overview of Hymalaia APIs - [Create Project](https://docs.hymalaia.com/api-reference/projects/create_project.md) - [Delete Project](https://docs.hymalaia.com/api-reference/projects/delete_project.md) - [Delete User File](https://docs.hymalaia.com/api-reference/projects/delete_user_file.md): Delete a user file belonging to the current user. - [Get Chat Session Project Files](https://docs.hymalaia.com/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.hymalaia.com/api-reference/projects/get_files_in_project.md) - [Get Project](https://docs.hymalaia.com/api-reference/projects/get_project.md) - [Get Project Details](https://docs.hymalaia.com/api-reference/projects/get_project_details.md) - [Get Project Instructions](https://docs.hymalaia.com/api-reference/projects/get_project_instructions.md) - [Get Projects](https://docs.hymalaia.com/api-reference/projects/get_projects.md) - [Get User File](https://docs.hymalaia.com/api-reference/projects/get_user_file.md): Fetch a single user file by ID for the current user. - [Get User File Statuses](https://docs.hymalaia.com/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.hymalaia.com/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.hymalaia.com/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.hymalaia.com/api-reference/projects/update_project.md) - [Upload User Files](https://docs.hymalaia.com/api-reference/projects/upload_user_files.md) - [Upsert Project Instructions](https://docs.hymalaia.com/api-reference/projects/upsert_project_instructions.md): Create or update this project's instructions stored on the project itself. - [Execute Open Urls](https://docs.hymalaia.com/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.hymalaia.com/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.hymalaia.com/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.hymalaia.com/api-reference/search/handle_search_request.md): Simple search endpoint, does not create a new message or records in the DB - [Activate User Api](https://docs.hymalaia.com/api-reference/user_management/activate_user_api.md) - [Bulk Invite Users](https://docs.hymalaia.com/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.hymalaia.com/api-reference/user_management/deactivate_user_api.md) - [Delete User](https://docs.hymalaia.com/api-reference/user_management/delete_user.md) - [Get Auth Type](https://docs.hymalaia.com/api-reference/user_management/get_auth_type.md) - [Get User Role](https://docs.hymalaia.com/api-reference/user_management/get_user_role.md) - [List Accepted Users](https://docs.hymalaia.com/api-reference/user_management/list_accepted_users.md) - [List All Users](https://docs.hymalaia.com/api-reference/user_management/list_all_users.md) - [List All Users Basic Info](https://docs.hymalaia.com/api-reference/user_management/list_all_users_basic_info.md) - [List Invited Users](https://docs.hymalaia.com/api-reference/user_management/list_invited_users.md) - [Remove Invited User](https://docs.hymalaia.com/api-reference/user_management/remove_invited_user.md) - [Set User Role](https://docs.hymalaia.com/api-reference/user_management/set_user_role.md) - [Verify User Logged In](https://docs.hymalaia.com/api-reference/user_management/verify_user_logged_in.md) - [Basic Auth Setup](https://docs.hymalaia.com/auth/basic-auth-setup.md): How to set up Hymalaia with username/password authentication - [Google OAuth Setup](https://docs.hymalaia.com/auth/google-oauth-setup.md): How to set up user login via Google OAuth in Hymalaia - [OIDC/SAML Setup](https://docs.hymalaia.com/auth/oidc-saml-setup.md): Integrating Hymalaia with your IdP - [Airtable Connector](https://docs.hymalaia.com/connectors/airtable.md): Access tables from Airtable - [Asana Connector](https://docs.hymalaia.com/connectors/asana-connector.md): Index tasks and comments from Asana projects - [Axero Connector](https://docs.hymalaia.com/connectors/axero-connector.md): Index articles, blogs, wikis, and forums from Axero (Communifire) via the REST API - [Bitbucket Connector](https://docs.hymalaia.com/connectors/bitbucket-connector.md): Access knowledge from your Bitbucket Repositories (Cloud only) - [BookStack Connector](https://docs.hymalaia.com/connectors/bookStack-connector.md): Access knowledge from your own BookStack instance - [ClickUp Connector](https://docs.hymalaia.com/connectors/clickUp-connector.md): Access tasks from ClickUp - [Coda Connector](https://docs.hymalaia.com/connectors/coda-connector.md): Index Coda docs, pages, and tables via the Coda REST API - [Confluence Connector](https://docs.hymalaia.com/connectors/confluence-connector.md): Access knowledge from your company Wiki - [Databricks Connector](https://docs.hymalaia.com/connectors/databricks-connector.md): Index Databricks Unity Catalog (or Hive) table metadata in Hymalaia - [Discord Connector](https://docs.hymalaia.com/connectors/discord-connector.md): Access knowledge from your Discord Messages - [Discourse Connector](https://docs.hymalaia.com/connectors/discourse-connector.md): Access knowledge from your Discourse Topics - [Document360 Connector](https://docs.hymalaia.com/connectors/document360-connector.md): Access wiki articles from Document360 - [Dropbox Connector](https://docs.hymalaia.com/connectors/dropbox-connector.md): Access knowledge from Dropbox - [Drupal Wiki Connector](https://docs.hymalaia.com/connectors/drupal_wiki-connector.md): Access knowledge from your Drupal Wiki instance - [Egnyte Connector](https://docs.hymalaia.com/connectors/egnyte-connector.md): Access files stored in Egnyte - [File Connector](https://docs.hymalaia.com/connectors/file-connector.md): Access knowledge from Local Files - [Fireflies Connector](https://docs.hymalaia.com/connectors/fireflies-connector.md): Access knowledge from your Fireflies meetings - [Freshdesk Connector](https://docs.hymalaia.com/connectors/freshdesk-connector.md): Access knowledge from your Freshdesk Tickets - [GitBook Connector](https://docs.hymalaia.com/connectors/gitBook-connector.md): Access documentation from GitBook - [GitHub Connector](https://docs.hymalaia.com/connectors/gitHub-connector.md): Access knowledge from your GitHub Repositories - [GitLab Connector](https://docs.hymalaia.com/connectors/gitLab-connector.md): Access knowledge from your GitLab repositories - [Gmail Connector](https://docs.hymalaia.com/connectors/gmail-connector.md): Access knowledge from your Emails - [Gong Connector](https://docs.hymalaia.com/connectors/gong-connector.md): Access the latest call transcripts from Gong - [OAuth Setup](https://docs.hymalaia.com/connectors/google-drive-OAuth-setup.md) - [Google Drive Connector Overview](https://docs.hymalaia.com/connectors/google-drive-connector.md): Access knowledge from your Files - [Google Sites Connector](https://docs.hymalaia.com/connectors/google-sites-connector.md): Access sites and pages from Google Sites - [Google Storage Connector](https://docs.hymalaia.com/connectors/google-storage-connector.md): Access documents stored in Google Cloud Storage buckets - [Guru Connector](https://docs.hymalaia.com/connectors/guru-connector.md): Access and index Guru Cards using a User Access Token - [Highspot Connector](https://docs.hymalaia.com/connectors/highspot-connector.md): Index and search your Highspot content using Hymalaia - [HubSpot Connector](https://docs.hymalaia.com/connectors/hubSpot-connector.md): Access CRM data from HubSpot - [Jira Connector](https://docs.hymalaia.com/connectors/jira-connector.md): Sync and search Jira issues and project updates with Hymalaia - [Linear Connector](https://docs.hymalaia.com/connectors/linear-connector.md): Sync and search Linear issues with Hymalaia - [Notion Connector](https://docs.hymalaia.com/connectors/notion-connector.md): Access pages and databases from Notion - [Gmail OAuth Setup](https://docs.hymalaia.com/connectors/oauth-setup.md): Set up the Gmail connector using an OAuth-enabled Google App - [Oracle Storage Connector](https://docs.hymalaia.com/connectors/oracle-storage-connector.md): Index and search documents from Oracle Cloud Infrastructure (OCI) using Hymalaia - [Outline Connector](https://docs.hymalaia.com/connectors/outline-connector.md): Index Outline collections and documents via the Outline API - [Outlook Connector](https://docs.hymalaia.com/connectors/outlook-connector.md): Configure the Outlook connector in Hymalaia - [Connector Overview](https://docs.hymalaia.com/connectors/overview.md): Basic Information about Connectors - [Postgres Connector](https://docs.hymalaia.com/connectors/postgres-connector.md): Index PostgreSQL table metadata (schemas and DDL) in Hymalaia - [Productboard Connector](https://docs.hymalaia.com/connectors/productboard-connector.md): Index Features, Components, Products, and Objectives from Productboard - [R2 Connector](https://docs.hymalaia.com/connectors/r2-connector.md): Access documents stored in Cloudflare R2 buckets - [Request Tracker Connector](https://docs.hymalaia.com/connectors/request-tracker-connector.md): Access tickets and transactions from Request Tracker 4.x - [S3 Access Keys](https://docs.hymalaia.com/connectors/s3/access-keys.md): Authorize the S3 connector using AWS Access Keys. - [S3 Assume Role](https://docs.hymalaia.com/connectors/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.hymalaia.com/connectors/s3/iam-role.md): Authorize the S3 connector using an AWS IAM Role with assume role policy. - [S3 Overview](https://docs.hymalaia.com/connectors/s3/overview.md): Overview of the S3 connector - [Salesforce Connector](https://docs.hymalaia.com/connectors/salesforce-connector.md): Access CRM data from Salesforce - [Gmail Service Account Setup](https://docs.hymalaia.com/connectors/service-account-connector.md): Set up the Gmail connector using a Service Account (Google Workspace only) - [Service Account Setup](https://docs.hymalaia.com/connectors/service-account-setup-drive.md) - [Certificate-Based Authentication](https://docs.hymalaia.com/connectors/sharepoint/certificate.md): Set up SharePoint connector using certificate-based authentication with optional permission sync support - [Client Secret Authentication](https://docs.hymalaia.com/connectors/sharepoint/client-secret.md): Set up SharePoint connector using client secret authentication - [Overview](https://docs.hymalaia.com/connectors/sharepoint/sharepoint.md): Access files and notes from your SharePoint Sites - [Slab Connector](https://docs.hymalaia.com/connectors/slab-connector.md): Access the latest Posts from Slab - [Slack Federated](https://docs.hymalaia.com/connectors/slack/slack_federated.md): Set up the Slack Federated connector - [Slack Indexed](https://docs.hymalaia.com/connectors/slack/slack_indexed.md): Set up the Slack Indexed connector - [Snowflake Connector](https://docs.hymalaia.com/connectors/snowflake-connector.md): Index Snowflake table metadata (DDL) in Hymalaia - [Teams Connector](https://docs.hymalaia.com/connectors/teams-connector.md): Access knowledge from your Teams Posts - [Web Connector](https://docs.hymalaia.com/connectors/web-connector.md): Access knowledge from Web Pages - [Wikipedia Connector](https://docs.hymalaia.com/connectors/wikipedia-connector.md): Access public articles from Wikipedia - [XenForo Connector](https://docs.hymalaia.com/connectors/xenforo-connector.md): Access forum posts from XenForo - [Zendesk Connector](https://docs.hymalaia.com/connectors/zendesk-connector.md): Access knowledge from Zendesk Articles - [Zulip Connector](https://docs.hymalaia.com/connectors/zulip-connector.md): Capture discussions from Zulip Streams and Topics - [Agent Search](https://docs.hymalaia.com/guides/agent-search.md): A guide to use advanced search capability in Hymalaia. - [Creating Assistants](https://docs.hymalaia.com/guides/creating-assistants.md): A comprehensive guide to creating and configuring AI assistants in Hymalaia. - [Embedding Models](https://docs.hymalaia.com/guides/embedding-models.md): A comprehensive guide to selecting and using embedding models in your application. - [LLM Providers](https://docs.hymalaia.com/guides/llm-providers.md): A comprehensive guide to selecting and using LLM providers in Hymalaia. - [Chrome Extension](https://docs.hymalaia.com/hymalaia-chrome-extension.md): Use Hymalaia in Chrome from any page. - [Introduction](https://docs.hymalaia.com/introduction.md): Welcome to Hymalaia - [Multilingual Setup](https://docs.hymalaia.com/multilingual-setup.md): Configure Hymalaia to support languages other than English. - [Slack Bot Setup](https://docs.hymalaia.com/slack-bot-setup.md): How to set up a Slack bot to automatically answer questions - [System Overview](https://docs.hymalaia.com/system-overview.md): High-level explanation of Hymalaia system components and data flows. - [Custom Tools](https://docs.hymalaia.com/tools/custom-tools.md): How to create custom tools with Hymalaia. - [Tools Overview](https://docs.hymalaia.com/tools/tools-overview.md): How to use tools with Hymalaia. ## OpenAPI Specs - [openapi](https://docs.hymalaia.com/api-reference/openapi.json)