Skip to content

Add Agent Server REST API docs to API Reference #397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rbren wants to merge 4 commits into
base: main
Choose a base branch
from
+5,813 −3,531
Open

Add Agent Server REST API docs to API Reference #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b35b523
Reorganize API Reference: add Agent Server REST API docs
openhands-agent Mar 15, 2026
9bf3788
Fix: Add Server Details tag to root endpoint
openhands-agent Mar 15, 2026
eed58ff
Revert script changes - keep existing OpenAPI generation pipeline
openhands-agent Mar 15, 2026
bfe6588
Add AGENTS note for agent-server OpenAPI env sensitivity
enyst Mar 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ Workflow: `.github/workflows/sync-agent-sdk-openapi.yml`
- Checks out `OpenHands/software-agent-sdk`
- Runs the agent-server OpenAPI generator
- Updates `openapi/agent-sdk.json` via an automated PR
- **Important:** agent-server OpenAPI generation is environment-sensitive. If `SESSION_API_KEY` or `OH_SESSION_API_KEYS_0` is set when `openhands-agent-server/openhands/agent_server/openapi.py` runs, FastAPI includes the `X-Session-API-Key` `APIKeyHeader` security scheme in the generated schema. For neutral docs generation, ensure those env vars are unset.


## Docs writing conventions

Expand Down
34 changes: 18 additions & 16 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,14 +341,7 @@
"sdk/guides/agent-server/apptainer-sandbox",
"sdk/guides/agent-server/api-sandbox",
"sdk/guides/agent-server/cloud-workspace",
"sdk/guides/agent-server/custom-tools",
{
"group": "API Reference",
"openapi": {
"source": "/openapi/agent-sdk.json",
"directory": "sdk/guides/agent-server/api-reference"
}
}
"sdk/guides/agent-server/custom-tools"
]
},
{
Expand Down Expand Up @@ -385,14 +378,23 @@
{
"group": "API Reference",
"pages": [
"sdk/api-reference/openhands.sdk.agent",
"sdk/api-reference/openhands.sdk.conversation",
"sdk/api-reference/openhands.sdk.event",
"sdk/api-reference/openhands.sdk.llm",
"sdk/api-reference/openhands.sdk.security",
"sdk/api-reference/openhands.sdk.tool",
"sdk/api-reference/openhands.sdk.utils",
"sdk/api-reference/openhands.sdk.workspace"
{
"group": "Python SDK",
"pages": [
"sdk/api-reference/openhands.sdk.agent",
"sdk/api-reference/openhands.sdk.conversation",
"sdk/api-reference/openhands.sdk.event",
"sdk/api-reference/openhands.sdk.llm",
"sdk/api-reference/openhands.sdk.security",
"sdk/api-reference/openhands.sdk.tool",
"sdk/api-reference/openhands.sdk.utils",
"sdk/api-reference/openhands.sdk.workspace"
]
},
{
"group": "Agent Server",
"openapi": "/openapi/agent-server.json"
}
]
}
]
Expand Down
Loading
Loading