# OpenHands Docs

## Docs

- [List Supported Models](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/list-supported-models.md): List model identifiers available on this server based on configured providers.
- [List Agents](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/list-agents.md): List available agent types supported by this server.
- [List Security Analyzers](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/list-security-analyzers.md): List supported security analyzers.
- [Get Config](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-config.md): Get current config.
- [List Workspace Files](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/list-workspace-files.md): List workspace files visible to the conversation runtime. Applies .gitignore and internal ignore rules.
- [Get File Content](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-file-content.md): Return the content of the given file from the conversation workspace.
- [Download Workspace Archive](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/download-workspace-archive.md): Return a ZIP archive of the current conversation workspace.
- [Git Changes](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/git-changes.md)
- [Git Diff](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/git-diff.md)
- [Upload Files](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/upload-files.md)
- [Submit Feedback](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/submit-feedback.md): Submit user feedback.
- [Get Remote Runtime Config](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-remote-runtime-config.md): Retrieve the runtime configuration.
- [Search Events](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/search-events.md): Search through the event stream with filtering and pagination.
- [Add Event](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/add-event.md)
- [Get Microagents](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-microagents.md): Get all microagents associated with the conversation.
- [Search Conversations](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/search-conversations.md)
- [New Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/new-conversation.md): Initialize a new session or join an existing one.
- [Get Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-conversation.md)
- [Delete Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/delete-conversation.md)
- [Update Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/update-conversation.md): Update conversation metadata.
- [Get Prompt](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-prompt.md)
- [Start Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/start-conversation.md): Start an agent loop for a conversation.
- [Stop Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/stop-conversation.md): Stop an agent loop for a conversation.
- [Load Settings](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/load-settings.md)
- [Store Settings](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/store-settings.md)
- [Reset Settings](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/reset-settings.md): Resets user settings. (Deprecated)
- [Store Provider Tokens](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/store-provider-tokens.md)
- [Unset Provider Tokens](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/unset-provider-tokens.md)
- [Load Custom Secrets Names](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/load-custom-secrets-names.md)
- [Create Custom Secret](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/create-custom-secret.md)
- [Update Custom Secret](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/update-custom-secret.md)
- [Delete Custom Secret](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/delete-custom-secret.md)
- [Get User Installations](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-user-installations.md)
- [Get User Repositories](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-user-repositories.md)
- [Get User](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-user.md)
- [Search Repositories](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/search-repositories.md)
- [Get Suggested Tasks](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-suggested-tasks.md): Get suggested tasks for the authenticated user across their most recently pushed repositories.
- [Get Repository Branches](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-repository-branches.md): Get branches for a repository.
- [Get Repository Microagents](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-repository-microagents.md): Scan the microagents directory of a repository and return the list of microagents.
- [Get Repository Microagent Content](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-repository-microagent-content.md): Fetch the content of a specific microagent file from a repository.
- [Get Trajectory](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/get-trajectory.md): Get trajectory.
- [Alive](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/alive.md)
- [Health](https://allhandsai-sync-llms-files-1784520990.mintlify.site/api-reference/health.md)
- [Alive](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/server-details/alive.md): Basic liveness check - returns OK if the server process is running.
- [Health](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/server-details/health.md): Basic health check - returns OK if the server process is running.
- [Ready](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/server-details/ready.md): Readiness check - returns OK only if the server has completed initialization.
- [Get Server Info](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/server-details/get-server-info.md)
- [Search Conversation Events](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/events/search-conversation-events.md): Search / List local events
- [Count Conversation Events](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/events/count-conversation-events.md): Count local events matching the given filters
- [Get Conversation Event](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/events/get-conversation-event.md): Get a local event given an id
- [Batch Get Conversation Events](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/events/batch-get-conversation-events.md): Get a batch of local events given their ids, returning null for any missing item.
- [Send Message](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/events/send-message.md): Send a message to a conversation
- [Respond To Confirmation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/events/respond-to-confirmation.md): Accept or reject a pending action in confirmation mode.
- [Search Conversations](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/search-conversations.md): Search / List conversations
- [Count Conversations](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/count-conversations.md): Count conversations matching the given filters
- [Get Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/get-conversation.md): Given an id, get a conversation
- [Delete Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/delete-conversation.md): Permanently delete a conversation.
- [Update Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/update-conversation.md): Update conversation metadata.
- [Batch Get Conversations](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/batch-get-conversations.md): Get a batch of conversations given their ids, returning null for any missing item
- [Start Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/start-conversation.md): Start a conversation in the local environment.
- [Pause Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/pause-conversation.md): Pause a conversation, allowing it to be resumed later.
- [Run Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/run-conversation.md): Start running the conversation in the background.
- [Update Conversation Secrets](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/update-conversation-secrets.md): Update secrets for a conversation.
- [Set Conversation Confirmation Policy](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/set-conversation-confirmation-policy.md): Set the confirmation policy for a conversation.
- [Set Conversation Security Analyzer](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/set-conversation-security-analyzer.md): Set the security analyzer for a conversation.
- [Generate Conversation Title](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/generate-conversation-title.md): Generate a title for the conversation using LLM.
- [Ask Agent](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/ask-agent.md): Ask the agent a simple question without affecting conversation state.
- [Condense Conversation](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/conversations/condense-conversation.md): Force condensation of the conversation history.
- [List Available Tools](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/tools/list-available-tools.md): List all available tools.
- [Search Bash Events](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/bash/search-bash-events.md): Search / List bash event events
- [Get Bash Event](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/bash/get-bash-event.md): Get a bash event event given an id
- [Batch Get Bash Events](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/bash/batch-get-bash-events.md): Get a batch of bash event events given their ids, returning null for any missing item.
- [Start Bash Command](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/bash/start-bash-command.md): Execute a bash command in the background
- [Execute Bash Command](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/bash/execute-bash-command.md): Execute a bash command and wait for a result
- [Clear All Bash Events](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/bash/clear-all-bash-events.md): Clear all bash events from storage
- [Git Changes](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/git/git-changes.md)
- [Git Diff](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/git/git-diff.md)
- [Upload File](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/files/upload-file.md): Upload a file to the workspace.
- [Download File](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/files/download-file.md): Download a file from the workspace.
- [Download Trajectory](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/files/download-trajectory.md): Download a file from the workspace.
- [Get Vscode Url](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/vscode/get-vscode-url.md): Get the VSCode URL with authentication token.
- [Get Vscode Status](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/vscode/get-vscode-status.md): Get the VSCode server status.
- [Get Desktop Url](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/desktop/get-desktop-url.md): Get the noVNC URL for desktop access.
- [Get Skills](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/skills/get-skills.md): Load and merge skills from all configured sources.
- [Sync Skills](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/skills/sync-skills.md): Force refresh of public skills from GitHub repository.
- [Get Hooks](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/hooks/get-hooks.md): Load hooks from the workspace .openhands/hooks.json file.
- [Get Server Info](https://allhandsai-sync-llms-files-1784520990.mintlify.site/sdk/guides/agent-server/api-reference/get-server-info.md)

## OpenAPI Specs

- [agent-sdk](https://allhandsai-sync-llms-files-1784520990.mintlify.site/openapi/agent-sdk.json)