How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OpenHands

OpenHands Conversations API

The Conversations API from OpenHands — 16 operation(s) for conversations.

Provider Profile APIs.io OpenAPI GitHub

OpenHands Conversations API is one of 14 APIs that OpenHands publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 20 operations across 16 paths, and defines 22 schemas. It is described by OpenAPI 3.1.0, at version 0.53.0.

Requests are made against 2 base URLs: https://app.all-hands.dev, http://localhost:3000.

20 operations 16 paths 22 schemas 1 DELETE12 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.53.0
Servers
https://app.all-hands.dev
http://localhost:3000
Authentication
API Key
Resource Areas
1

Authentication & Security 1

OpenHands Conversations API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Session-API-Key (APIKeyHeader).

Paths & Operations 20

Across 16 paths, the API surfaces 20 operations — 1 DELETE, 12 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Conversations 20
GET
/api/conversations/{conversation_id}/list-files
List Workspace Files
list_files_api_conversations__conversation_id__list_files_get 2 params → 200404422500
GET
/api/conversations/{conversation_id}/select-file
Get File Content
select_file_api_conversations__conversation_id__select_file_get 2 params → 200415422500
GET
/api/conversations/{conversation_id}/zip-directory
Download Workspace Archive
zip_current_workspace_api_conversations__conversation_id__zip_directory_get 1 param → 200422500
GET
/api/conversations/{conversation_id}/git/changes
Git Changes
git_changes_api_conversations__conversation_id__git_changes_get 1 param → 200404422500
GET
/api/conversations/{conversation_id}/git/diff
Git Diff
git_diff_api_conversations__conversation_id__git_diff_get 2 params → 200422500
POST
/api/conversations/{conversation_id}/upload-files
Upload Files
upload_files_api_conversations__conversation_id__upload_files_post 1 param body → 200422
POST
/api/conversations/{conversation_id}/submit-feedback
Submit Feedback
submit_feedback_api_conversations__conversation_id__submit_feedback_post 1 param → 200422
GET
/api/conversations/{conversation_id}/config
Get Remote Runtime Config
get_remote_runtime_config_api_conversations__conversation_id__config_get 1 param → 200422
GET
/api/conversations/{conversation_id}/events
Search Events
search_events_api_conversations__conversation_id__events_get 5 params body → 200422
POST
/api/conversations/{conversation_id}/events
Add Event
add_event_api_conversations__conversation_id__events_post 1 param → 200422
GET
/api/conversations/{conversation_id}/microagents
Get Microagents
get_microagents_api_conversations__conversation_id__microagents_get 1 param → 200422
POST
/api/conversations
New Conversation
new_conversation_api_conversations_post body → 200422
GET
/api/conversations
Search Conversations
search_conversations_api_conversations_get 4 params → 200422
GET
/api/conversations/{conversation_id}
Get Conversation
get_conversation_api_conversations__conversation_id__get 1 param → 200422
DELETE
/api/conversations/{conversation_id}
Delete Conversation
delete_conversation_api_conversations__conversation_id__delete 1 param → 200422
PATCH
/api/conversations/{conversation_id}
Update Conversation
update_conversation_api_conversations__conversation_id__patch 1 param body → 200422
GET
/api/conversations/{conversation_id}/remember-prompt
Get Prompt
get_prompt_api_conversations__conversation_id__remember_prompt_get 2 params → 200422
POST
/api/conversations/{conversation_id}/start
Start Conversation
start_conversation_api_conversations__conversation_id__start_post 1 param body → 200422
POST
/api/conversations/{conversation_id}/stop
Stop Conversation
stop_conversation_api_conversations__conversation_id__stop_post 1 param → 200422
GET
/api/conversations/{conversation_id}/trajectory
Get Trajectory
get_trajectory_api_conversations__conversation_id__trajectory_get 1 param → 200422

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ConversationInfo (14 properties), InitSessionRequest (11 properties), EventFilter (7 properties), SuggestedTask (5 properties). Each schema is shown below with its type and property counts.

HTTPValidationError
object
1 property
ProvidersSetModel
object
1 property
MCPSHTTPServerConfig
object
2 properties 1 required
POSTUploadFilesModel
object
Upload files response model
2 properties 2 required
RuntimeStatus
string
UpdateConversationRequest
object
Request model for updating conversation metadata.
1 property 1 required
EventFilter
object
7 properties
InitSessionRequest
object
11 properties
TaskType
string
ConversationStatus
string
ValidationError
object
3 properties 3 required
ProviderType
string
CreateMicroagent
object
3 properties 1 required
MCPSSEServerConfig
object
Configuration for a single MCP server. Attributes: url: The server URL apikey: Optional API key for authentication
2 properties 1 required
ConversationInfoResultSet
object
2 properties
Body_upload_files_api_conversations__conversation_id__upload_files_post
object
1 property 1 required
SuggestedTask
object
5 properties 5 required
ConversationTrigger
string
MCPConfig
object
Configuration for MCP (Message Control Protocol) settings. Attributes: sseservers: List of MCP SSE server configs stdioservers: List of MCP stdio server config…
3 properties
MCPStdioServerConfig
object
Configuration for a MCP server that uses stdio. Attributes: name: The name of the server command: The command to run the server args: The arguments to pass to…
4 properties 2 required
ConversationResponse
object
4 properties 2 required
ConversationInfo
object
14 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openhands-conversations-api-openapi.yml Raw ↑

Other APIs OpenHands publishes across the network.

OpenHands Agent SDK
AE Profile APIs.io
OpenHands CLI
AE Profile APIs.io
OpenHands Local GUI REST API
AE Profile APIs.io
OpenHands Cloud
AE Profile APIs.io
OpenHands Add Git Providers API
AE Profile APIs.io
OpenHands Alive API
AE Profile APIs.io
OpenHands Health API
AE Profile APIs.io
OpenHands Options API
AE Profile APIs.io
OpenHands Reset Settings API
AE Profile APIs.io
OpenHands Secrets API
AE Profile APIs.io
OpenHands Settings API
AE Profile APIs.io
OpenHands Unset Provider Tokens API
AE Profile APIs.io
#Conversations
← Back to O APIs
API Details
ID
openhands:openhands-conversations-api
Server
https://app.all-hands.dev
Provider
OpenHands
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openhands-conversations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openhands-conversations-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of OpenHands Conversations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.