OpenHands — API

OpenHands v0.53.0 · spec ↗ · 43 endpoints

OpenHands: Code Less, Make More

What it covers

Api 41 create, read, update, delete
Alive 1 read
Health 1 read

Endpoints

Open an endpoint for its inputs and outputs.

Api 41

DELETE /api/conversations/{conversation_id} Delete Conversation

Loading…
DELETE /api/secrets/{secret_id} Delete Custom Secret

Loading…
GET /api/conversations Search Conversations

Loading…
GET /api/conversations/{conversation_id} Get Conversation

Loading…
GET /api/conversations/{conversation_id}/config Get Remote Runtime Config

Loading…
GET /api/conversations/{conversation_id}/events Search Events

Loading…
GET /api/conversations/{conversation_id}/git/changes Git Changes

Loading…
GET /api/conversations/{conversation_id}/git/diff Git Diff

Loading…
GET /api/conversations/{conversation_id}/list-files List Workspace Files

Loading…
GET /api/conversations/{conversation_id}/microagents Get Microagents

Loading…
GET /api/conversations/{conversation_id}/remember-prompt Get Prompt

Loading…
GET /api/conversations/{conversation_id}/select-file Get File Content

Loading…
GET /api/conversations/{conversation_id}/trajectory Get Trajectory

Loading…
GET /api/conversations/{conversation_id}/zip-directory Download Workspace Archive

Loading…
GET /api/options/agents List Agents

Loading…
GET /api/options/config Get Config

Loading…
GET /api/options/models List Supported Models

Loading…
GET /api/options/security-analyzers List Security Analyzers

Loading…
GET /api/secrets Load Custom Secrets Names

Loading…
GET /api/settings Load Settings

Loading…
GET /api/user/info Get User

Loading…
GET /api/user/installations Get User Installations

Loading…
GET /api/user/repositories Get User Repositories

Loading…
GET /api/user/repository/branches Get Repository Branches

Loading…
GET /api/user/repository/{repository_name}/microagents Get Repository Microagents

Loading…
GET /api/user/repository/{repository_name}/microagents/content Get Repository Microagent Content

Loading…
GET /api/user/search/repositories Search Repositories

Loading…
GET /api/user/suggested-tasks Get Suggested Tasks

Loading…
PATCH /api/conversations/{conversation_id} Update Conversation

Loading…
POST /api/add-git-providers Store Provider Tokens

Loading…
POST /api/conversations New Conversation

Loading…
POST /api/conversations/{conversation_id}/events Add Event

Loading…
POST /api/conversations/{conversation_id}/start Start Conversation

Loading…
POST /api/conversations/{conversation_id}/stop Stop Conversation

Loading…
POST /api/conversations/{conversation_id}/submit-feedback Submit Feedback

Loading…
POST /api/conversations/{conversation_id}/upload-files Upload Files

Loading…
POST /api/reset-settings Reset Settings

Loading…
POST /api/secrets Create Custom Secret

Loading…
POST /api/settings Store Settings

Loading…
POST /api/unset-provider-tokens Unset Provider Tokens

Loading…
PUT /api/secrets/{secret_id} Update Custom Secret

Loading…

Alive 1

GET /alive Alive

Loading…

Health 1

GET /health Health

Loading…