# Xagent

## Docs

- [Building Agents](https://docs.xagent.run/agents/building.md): Creating and configuring custom agents
- [Agents Overview](https://docs.xagent.run/agents/overview.md): Understanding agents vs tasks in Xagent
- [Create Agent](https://docs.xagent.run/api-reference/agents/create-agent.md): Create a new custom agent.
- [Delete Agent](https://docs.xagent.run/api-reference/agents/delete-agent.md): Delete an agent.
- [Get Agent](https://docs.xagent.run/api-reference/agents/get-agent.md): Get agent details.
- [List Agents](https://docs.xagent.run/api-reference/agents/list-agents.md): List all agents for the current user.
- [Optimize Instructions](https://docs.xagent.run/api-reference/agents/optimize-instructions.md): Optimize agent instructions using an LLM.
- [Preview Agent](https://docs.xagent.run/api-reference/agents/preview-agent.md): Preview agent response without saving to database.
- [Publish Agent](https://docs.xagent.run/api-reference/agents/publish-agent.md): Publish an agent (make it publicly accessible).
- [Unpublish Agent](https://docs.xagent.run/api-reference/agents/unpublish-agent.md): Unpublish an agent (revert to draft status).
- [Update Agent](https://docs.xagent.run/api-reference/agents/update-agent.md): Update an existing agent.
- [Upload Agent Logo](https://docs.xagent.run/api-reference/agents/upload-agent-logo.md): Upload or update agent logo.
- [Change Password](https://docs.xagent.run/api-reference/authentication/change-password.md): Change user password endpoint
- [Check Auth](https://docs.xagent.run/api-reference/authentication/check-auth.md): Check authentication status endpoint
- [Get Register Switch](https://docs.xagent.run/api-reference/authentication/get-register-switch.md)
- [Login](https://docs.xagent.run/api-reference/authentication/login.md): User login endpoint
- [Oauth Callback](https://docs.xagent.run/api-reference/authentication/oauth-callback.md): Unified entry point for OAuth callback
- [Oauth Login](https://docs.xagent.run/api-reference/authentication/oauth-login.md): Unified entry point for OAuth login
- [Refresh Token](https://docs.xagent.run/api-reference/authentication/refresh-token.md): Refresh JWT access token using refresh token
- [Register](https://docs.xagent.run/api-reference/authentication/register.md): User registration endpoint with default configuration inheritance
- [Setup Admin](https://docs.xagent.run/api-reference/authentication/setup-admin.md)
- [Setup Status](https://docs.xagent.run/api-reference/authentication/setup-status.md)
- [Update Register Switch](https://docs.xagent.run/api-reference/authentication/update-register-switch.md)
- [Verify Current Token](https://docs.xagent.run/api-reference/authentication/verify-current-token.md): Verify current token validity
- [Create User Channel](https://docs.xagent.run/api-reference/channels/create-user-channel.md): Create a new channel configuration.
- [Delete User Channel](https://docs.xagent.run/api-reference/channels/delete-user-channel.md): Delete a channel configuration.
- [Get User Channels](https://docs.xagent.run/api-reference/channels/get-user-channels.md): Get all channels configured by the current user.
- [Update User Channel](https://docs.xagent.run/api-reference/channels/update-user-channel.md): Update a channel configuration.
- [Create Task](https://docs.xagent.run/api-reference/chat/create-task.md): Create new chat task
- [Delete Task](https://docs.xagent.run/api-reference/chat/delete-task.md): Delete a task and all related data
- [Get Task](https://docs.xagent.run/api-reference/chat/get-task.md): Get task details
- [Get Task Output Files](https://docs.xagent.run/api-reference/chat/get-task-output-files.md): Get output files for a task
- [Get Task Status](https://docs.xagent.run/api-reference/chat/get-task-status.md): Get task status
- [Get Task Workspace Files](https://docs.xagent.run/api-reference/chat/get-task-workspace-files.md): Get all workspace files for a task
- [Get Tasks](https://docs.xagent.run/api-reference/chat/get-tasks.md): Get tasks list with pagination
- [Update Task](https://docs.xagent.run/api-reference/chat/update-task.md): Update task details.
- [Delete Connected Account](https://docs.xagent.run/api-reference/cloud-storage/delete-connected-account.md): Delete a connected cloud account
- [List Connected Accounts](https://docs.xagent.run/api-reference/cloud-storage/list-connected-accounts.md): List connected cloud accounts
- [List Google Drive Files](https://docs.xagent.run/api-reference/cloud-storage/list-google-drive-files.md): List files in Google Drive folder
- [List Google Drives](https://docs.xagent.run/api-reference/cloud-storage/list-google-drives.md): List Google Drives (My Drive + Shared Drives)
- [Create Custom Api](https://docs.xagent.run/api-reference/custom-api-management/create-custom-api.md): Create a new Custom API.
- [Delete Custom Api](https://docs.xagent.run/api-reference/custom-api-management/delete-custom-api.md): Delete a Custom API.
- [Get Custom Api](https://docs.xagent.run/api-reference/custom-api-management/get-custom-api.md): Get a specific Custom API by ID.
- [List Custom Apis](https://docs.xagent.run/api-reference/custom-api-management/list-custom-apis.md): List all Custom APIs for the current user.
- [Update Custom Api](https://docs.xagent.run/api-reference/custom-api-management/update-custom-api.md): Update an existing Custom API.
- [Delete File](https://docs.xagent.run/api-reference/files/delete-file.md)
- [Download File](https://docs.xagent.run/api-reference/files/download-file.md)
- [List Files](https://docs.xagent.run/api-reference/files/list-files.md)
- [List Task Files](https://docs.xagent.run/api-reference/files/list-task-files.md): Get all files for a specific task.
- [Preview File](https://docs.xagent.run/api-reference/files/preview-file.md)
- [Public Preview File](https://docs.xagent.run/api-reference/files/public-preview-file.md)
- [Upload File](https://docs.xagent.run/api-reference/files/upload-file.md)
- [API Reference](https://docs.xagent.run/api-reference/introduction.md): Xagent API documentation
- [Batch Delete Collections Api](https://docs.xagent.run/api-reference/kb/batch-delete-collections-api.md): Delete multiple collections in one request.
- [Check Documents Exist Api](https://docs.xagent.run/api-reference/kb/check-documents-exist-api.md): Check which of the given filenames already exist in the collection.
- [Delete Collection Api](https://docs.xagent.run/api-reference/kb/delete-collection-api.md): Delete a collection and all its data.
- [Delete Document Api](https://docs.xagent.run/api-reference/kb/delete-document-api.md): Delete a document and all its associated data.
- [Get Parse Result Api](https://docs.xagent.run/api-reference/kb/get-parse-result-api.md): Get parsed document results with pagination.
- [Ingest](https://docs.xagent.run/api-reference/kb/ingest.md): Upload and ingest a document into the knowledge base.
- [Ingest Cloud](https://docs.xagent.run/api-reference/kb/ingest-cloud.md): Ingest files from cloud storage.
- [Ingest Web](https://docs.xagent.run/api-reference/kb/ingest-web.md): Ingest website content into the knowledge base.
- [List Collections Api](https://docs.xagent.run/api-reference/kb/list-collections-api.md): List all collections with their statistics.
- [Rename Collection Api](https://docs.xagent.run/api-reference/kb/rename-collection-api.md): Rename a collection.
- [Save Collection Config](https://docs.xagent.run/api-reference/kb/save-collection-config.md): Save ingestion configuration for a specific collection.
- [Search](https://docs.xagent.run/api-reference/kb/search.md): Search documents in the knowledge base.
- [Create Mcp Server](https://docs.xagent.run/api-reference/mcp-management/create-mcp-server.md): Create a new MCP server.
- [Delete Mcp Server](https://docs.xagent.run/api-reference/mcp-management/delete-mcp-server.md): Delete an MCP server.
- [Get Mcp Server](https://docs.xagent.run/api-reference/mcp-management/get-mcp-server.md): Get a specific MCP server.
- [Get Mcp Server Logs](https://docs.xagent.run/api-reference/mcp-management/get-mcp-server-logs.md): Get logs for an internal MCP server.
- [Get Mcp Server Tools](https://docs.xagent.run/api-reference/mcp-management/get-mcp-server-tools.md): Get tools available from a specific MCP server.
- [Get Mcp Servers](https://docs.xagent.run/api-reference/mcp-management/get-mcp-servers.md): List MCP servers for the current user.
- [Get Supported Transports](https://docs.xagent.run/api-reference/mcp-management/get-supported-transports.md): Get list of supported transport types with descriptions.
- [List Mcp Apps](https://docs.xagent.run/api-reference/mcp-management/list-mcp-apps.md): Get the list of available MCP applications in the library.
- [Test Mcp Connection](https://docs.xagent.run/api-reference/mcp-management/test-mcp-connection.md): Test MCP server connection without saving.
- [Toggle Mcp Server](https://docs.xagent.run/api-reference/mcp-management/toggle-mcp-server.md): Toggle MCP server active status.
- [Update Mcp Server](https://docs.xagent.run/api-reference/mcp-management/update-mcp-server.md): Update an existing MCP server.
- [Create Memory](https://docs.xagent.run/api-reference/memory/create-memory.md)
- [Delete Memory](https://docs.xagent.run/api-reference/memory/delete-memory.md)
- [Get Memory](https://docs.xagent.run/api-reference/memory/get-memory.md)
- [Get Memory Stats](https://docs.xagent.run/api-reference/memory/get-memory-stats.md)
- [Get Store Info](https://docs.xagent.run/api-reference/memory/get-store-info.md): Get current memory store information for debugging
- [List Memories](https://docs.xagent.run/api-reference/memory/list-memories.md)
- [Update Memory](https://docs.xagent.run/api-reference/memory/update-memory.md)
- [Create Model](https://docs.xagent.run/api-reference/models/create-model.md): Create a new model configuration
- [Create Model](https://docs.xagent.run/api-reference/models/create-model-1.md): Create a new model configuration
- [Delete Model](https://docs.xagent.run/api-reference/models/delete-model.md): Delete a model configuration
- [Delete Model By Path](https://docs.xagent.run/api-reference/models/delete-model-by-path.md): Delete a model configuration, including slash-containing model IDs.
- [Delete User Default Model](https://docs.xagent.run/api-reference/models/delete-user-default-model.md): Delete a user's default model configuration
- [Fetch Multiple Providers Models](https://docs.xagent.run/api-reference/models/fetch-multiple-providers-models.md): Fetch available models from multiple providers at once.
- [Fetch Provider Models](https://docs.xagent.run/api-reference/models/fetch-provider-models.md): Fetch available models from a specific provider.
- [Get Available Model Providers](https://docs.xagent.run/api-reference/models/get-available-model-providers.md): Get available model providers
- [Get Compact Default Model](https://docs.xagent.run/api-reference/models/get-compact-default-model.md): Get the compact default model (config_type='compact')
- [Get Default Model](https://docs.xagent.run/api-reference/models/get-default-model.md): Get the default model for a specific type
- [Get Embedding Default Model](https://docs.xagent.run/api-reference/models/get-embedding-default-model.md): Get the default embedding model (config_type='embedding')
- [Get General Default Model](https://docs.xagent.run/api-reference/models/get-general-default-model.md): Get the general default model (config_type='general')
- [Get Model](https://docs.xagent.run/api-reference/models/get-model.md): Get a specific model configuration
- [Get Model By Path](https://docs.xagent.run/api-reference/models/get-model-by-path.md): Get a specific model configuration, including slash-containing model IDs.
- [Get Models Summary](https://docs.xagent.run/api-reference/models/get-models-summary.md): Get summary statistics of accessible models
- [Get Public Summary](https://docs.xagent.run/api-reference/models/get-public-summary.md): Get public summary of available models (no authentication required).
- [Get Small Fast Default Model](https://docs.xagent.run/api-reference/models/get-small-fast-default-model.md): Get the small/fast default model (config_type='small_fast')
- [Get User Default Model](https://docs.xagent.run/api-reference/models/get-user-default-model.md): Get a user's default model configuration for a specific type
- [Get User Default Models](https://docs.xagent.run/api-reference/models/get-user-default-models.md): Get all user's default model configurations with per-type admin fallback
- [Get Visual Default Model](https://docs.xagent.run/api-reference/models/get-visual-default-model.md): Get the visual default model (config_type='visual')
- [List Model Abilities](https://docs.xagent.run/api-reference/models/list-model-abilities.md): List all model abilities across accessible models
- [List Model Categories](https://docs.xagent.run/api-reference/models/list-model-categories.md): List all model categories accessible to the current user
- [List Model Providers](https://docs.xagent.run/api-reference/models/list-model-providers.md): List all model providers accessible to the current user
- [List Models](https://docs.xagent.run/api-reference/models/list-models.md): List all model configurations accessible to the current user
- [List Public Categories](https://docs.xagent.run/api-reference/models/list-public-categories.md): List all available model categories (no authentication required).
- [List Public Models](https://docs.xagent.run/api-reference/models/list-public-models.md): List public model information (no authentication required).
- [List Public Providers](https://docs.xagent.run/api-reference/models/list-public-providers.md): List all available model providers (no authentication required).
- [List Supported Providers](https://docs.xagent.run/api-reference/models/list-supported-providers.md): Get list of supported model providers with their information.
- [List Xinference Tts Models](https://docs.xagent.run/api-reference/models/list-xinference-tts-models.md): Get available TTS models from Xinference server.
- [Set User Default Model](https://docs.xagent.run/api-reference/models/set-user-default-model.md): Set a user's default model configuration
- [Test Model Connection](https://docs.xagent.run/api-reference/models/test-model-connection.md): Test connection with provided model parameters before saving.
- [Test Models](https://docs.xagent.run/api-reference/models/test-models.md): Test model configurations
- [Update Model](https://docs.xagent.run/api-reference/models/update-model.md): Update a model configuration
- [Update Model By Path](https://docs.xagent.run/api-reference/models/update-model-by-path.md): Update a model configuration, including slash-containing model IDs.
- [Get Agents](https://docs.xagent.run/api-reference/monitor/get-agents.md): Get list of agents
- [Get Dashboard Stats](https://docs.xagent.run/api-reference/monitor/get-dashboard-stats.md): Get dashboard statistics
- [Get Model Stats](https://docs.xagent.run/api-reference/monitor/get-model-stats.md): Get model usage statistics
- [Get Monitoring Stats](https://docs.xagent.run/api-reference/monitor/get-monitoring-stats.md): Get monitoring statistics
- [Get Popular Tools](https://docs.xagent.run/api-reference/monitor/get-popular-tools.md): Get popular tools statistics
- [Get Tools](https://docs.xagent.run/api-reference/monitor/get-tools.md): Get list of available tools
- [Get Skill](https://docs.xagent.run/api-reference/skills/get-skill.md): Get single skill detail (including template)
- [List Skills](https://docs.xagent.run/api-reference/skills/list-skills.md): List all available skills
- [Recall Skill](https://docs.xagent.run/api-reference/skills/recall-skill.md): Select appropriate skill based on task
- [Reload Skills](https://docs.xagent.run/api-reference/skills/reload-skills.md): Manually reload all skills
- [Get Template](https://docs.xagent.run/api-reference/templates/get-template.md): Get details of a single template (including agent_config)
- [Like Template](https://docs.xagent.run/api-reference/templates/like-template.md): Like or unlike a template
- [List Templates](https://docs.xagent.run/api-reference/templates/list-templates.md): List all available templates (including statistics)
- [Use Template](https://docs.xagent.run/api-reference/templates/use-template.md): Use a template to create an agent (records usage count)
- [Create Database](https://docs.xagent.run/api-reference/text2sql/create-database.md): Create a new database configuration
- [Delete Database](https://docs.xagent.run/api-reference/text2sql/delete-database.md): Delete a database configuration
- [Get Databases](https://docs.xagent.run/api-reference/text2sql/get-databases.md): Get user's database configurations
- [Predict Data](https://docs.xagent.run/api-reference/text2sql/predict-data.md): Generate prediction based on chart data
- [Test Database Connection](https://docs.xagent.run/api-reference/text2sql/test-database-connection.md): Test database connection
- [Update Database](https://docs.xagent.run/api-reference/text2sql/update-database.md): Update an existing database configuration
- [Delete Tool Credential](https://docs.xagent.run/api-reference/tools/delete-tool-credential.md)
- [Get Available Tools](https://docs.xagent.run/api-reference/tools/get-available-tools.md): Get list of all available tools, including MCP tools.
- [Get Configurable Tools](https://docs.xagent.run/api-reference/tools/get-configurable-tools.md)
- [Get Sql Connections](https://docs.xagent.run/api-reference/tools/get-sql-connections.md)
- [Get Tool Credentials](https://docs.xagent.run/api-reference/tools/get-tool-credentials.md)
- [Get Tool Usage](https://docs.xagent.run/api-reference/tools/get-tool-usage.md): Get tool usage statistics
- [Remove Sql Connection](https://docs.xagent.run/api-reference/tools/remove-sql-connection.md)
- [Update Tool Credentials](https://docs.xagent.run/api-reference/tools/update-tool-credentials.md)
- [Update Tool Enabled](https://docs.xagent.run/api-reference/tools/update-tool-enabled.md)
- [Upsert Sql Connection](https://docs.xagent.run/api-reference/tools/upsert-sql-connection.md)
- [Trace Events Reference](https://docs.xagent.run/api-reference/websocket/trace-events.md): Complete reference for trace events in WebSocket streams
- [WebSocket API](https://docs.xagent.run/api-reference/websocket/websocket.md): Real-time WebSocket communication for task execution
- [Authenticate Widget](https://docs.xagent.run/api-reference/widget/authenticate-widget.md): Authenticate widget and issue a guest token
- [Create Widget Task](https://docs.xagent.run/api-reference/widget/create-widget-task.md): Create new chat task for widget guest
- [Configuration](https://docs.xagent.run/deployment/configuration.md): Configure models, tools, and system settings
- [Self-Hosted Deployment](https://docs.xagent.run/deployment/self-hosted.md): Deploy Xagent on your own infrastructure
- [File Management](https://docs.xagent.run/files/management.md): Managing files during task execution
- [Files Overview](https://docs.xagent.run/files/overview.md): Understanding files in Xagent
- [File Upload](https://docs.xagent.run/files/upload.md): Uploading files for task execution
- [What is Xagent](https://docs.xagent.run/index.md): Describe tasks. Not workflows.
- [Installation](https://docs.xagent.run/installation.md): Detailed installation options for Xagent
- [Knowledge Base Overview](https://docs.xagent.run/knowledge/overview.md): Enhancing agents with domain-specific knowledge
- [Knowledge Retrieval](https://docs.xagent.run/knowledge/retrieval.md): Retrieving and using knowledge from your knowledge base
- [Uploading Knowledge](https://docs.xagent.run/knowledge/uploading.md): How to upload and manage knowledge base
- [Memory Configuration](https://docs.xagent.run/memory/configuration.md): Configuring memory settings for optimal performance
- [Memory Overview](https://docs.xagent.run/memory/overview.md): Understanding agent memory and learning
- [Memory Types](https://docs.xagent.run/memory/types.md): Understanding memory categories in Xagent
- [Embedding Models](https://docs.xagent.run/models/embedding.md): Configuring embedding models for knowledge base
- [Image Generation Models](https://docs.xagent.run/models/image-generation.md): Configuring image generation and editing models
- [LLM Models](https://docs.xagent.run/models/llm.md): Configuring Large Language Models for Xagent
- [Models Overview](https://docs.xagent.run/models/overview.md): Understanding model types in Xagent
- [Quick Start](https://docs.xagent.run/quickstart.md): Create your first task in 5 minutes
- [Task Execution](https://docs.xagent.run/tasks/execution.md): Understanding how Xagent executes tasks
- [Tasks Overview](https://docs.xagent.run/tasks/overview.md): Understanding Xagent task execution system
- [Creating Templates](https://docs.xagent.run/templates/creating.md): How to create and contribute templates
- [Templates](https://docs.xagent.run/templates/overview.md): Pre-built agent templates for common use cases
- [Built-in Tools](https://docs.xagent.run/tools/built-in.md): Detailed reference for all built-in tools
- [Custom Tools via MCP](https://docs.xagent.run/tools/custom.md): Integrating custom tools using MCP protocol
- [MCP Providers Configuration](https://docs.xagent.run/tools/mcp-providers.md): How to configure OAuth credentials for Google, LinkedIn, and Microsoft MCP integrations.
- [Tools Overview](https://docs.xagent.run/tools/overview.md): Understanding tools in Xagent

## OpenAPI Specs

- [openapi](https://docs.xagent.run/api-reference/openapi.json)