Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 1 deletion .github/scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To test locally:
cd docs

# Clone agent-sdk if not already present
git clone https://github.com/All-Hands-AI/agent-sdk.git agent-sdk
git clone https://github.com/OpenHands/agent-sdk.git agent-sdk

# Run the script
python .github/scripts/sync_code_blocks.py
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sync-agent-sdk-openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
- name: Checkout agent-sdk
uses: actions/checkout@v4
with:
repository: All-Hands-AI/agent-sdk
repository: OpenHands/agent-sdk
path: agent-sdk
ref: ${{ env.AGENT_SDK_REF }}
fetch-depth: 0
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sync-docs-code-blocks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
- name: Checkout agent-sdk
uses: actions/checkout@v4
with:
repository: All-Hands-AI/agent-sdk
repository: OpenHands/agent-sdk
path: agent-sdk
ref: ${{ github.event.inputs.agent_sdk_ref || 'main' }}
fetch-depth: 0
Expand Down
2 changes: 1 addition & 1 deletion .openhands/microagents/sdk-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Links to the GitHub source file:

```mdx
<Note>
This example is available on GitHub: [examples/01_standalone_sdk/02_custom_tools.py](https://github.com/All-Hands-AI/agent-sdk/blob/main/examples/01_standalone_sdk/02_custom_tools.py)
This example is available on GitHub: [examples/01_standalone_sdk/02_custom_tools.py](https://github.com/OpenHands/agent-sdk/blob/main/examples/01_standalone_sdk/02_custom_tools.py)
</Note>
```

Expand Down
48 changes: 45 additions & 3 deletions openapi/agent-sdk.json
Original file line number Diff line number Diff line change
Expand Up @@ -1489,14 +1489,14 @@
}
}
},
"/api/bash/execute_bash_command": {
"/api/bash/start_bash_command": {
"post": {
"tags": [
"Bash"
],
"summary": "Start Bash Command",
"description": "Execute a bash command",
"operationId": "start_bash_command_api_bash_execute_bash_command_post",
"description": "Execute a bash command in the background",
"operationId": "start_bash_command_api_bash_start_bash_command_post",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -1531,6 +1531,48 @@
}
}
},
"/api/bash/execute_bash_command": {
"post": {
"tags": [
"Bash"
],
"summary": "Execute Bash Command",
"description": "Execute a bash command and wait for a result",
"operationId": "execute_bash_command_api_bash_execute_bash_command_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecuteBashRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BashOutput"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/bash/bash_events": {
"delete": {
"tags": [
Expand Down
2 changes: 1 addition & 1 deletion openhands/usage/cloud/gitlab-installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This feature works for personal projects and is available for group projects wit
[Premium or Ultimate tier subscription](https://docs.gitlab.com/user/project/integrations/webhooks/#group-webhooks).

A webhook is automatically installed within a few minutes after the owner/maintainer of the project or group logs into
OpenHands Cloud. If you decide to delete the webhook, then re-installing will require the support of All Hands AI but
OpenHands Cloud. If you decide to delete the webhook, then re-installing will require our support, but
we are planning to improve this in a future release.
</Note>

Expand Down
2 changes: 1 addition & 1 deletion sdk/arch/llms/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ human review of committed configuration.
into SDK telemetry so downstream interfaces can display usage estimates.

Refer to the docstring within
[`openhands.sdk.llm.LLM`](https://github.com/All-Hands-AI/agent-sdk/blob/main/openhands-sdk/openhands/sdk/llm/llm.py)
[`openhands.sdk.llm.LLM`](https://github.com/OpenHands/agent-sdk/blob/main/openhands-sdk/openhands/sdk/llm/llm.py)
for the full schema. All fields can be set programmatically or via environment
variables using the naming rule `field -> LLM_FIELD`.

2 changes: 1 addition & 1 deletion sdk/arch/llms/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ graph LR

## Creating LLM instances

Use the [`openhands.sdk.llm.LLM`](https://github.com/All-Hands-AI/agent-sdk/blob/main/openhands-sdk/openhands/sdk/llm/llm.py)
Use the [`openhands.sdk.llm.LLM`](https://github.com/OpenHands/agent-sdk/blob/main/openhands-sdk/openhands/sdk/llm/llm.py)
class to configure model access. The only required field is the `model` name;
other options (API keys, retry tuning, response tracing) are optional.

Expand Down
6 changes: 3 additions & 3 deletions sdk/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export LLM_API_KEY=your-api-key-here
<Accordion title="Option 2: Install from Source" icon="code">
```bash
# Clone the repository
git clone https://github.com/All-Hands-AI/agent-sdk.git
git clone https://github.com/OpenHands/agent-sdk.git
cd agent-sdk

# Install dependencies and setup development environment
Expand Down Expand Up @@ -168,5 +168,5 @@ ls examples/01_standalone_sdk/
### Get Help

- **[Slack Community](https://openhands.dev/joinslack)** - Ask questions and share projects
- **[GitHub Issues](https://github.com/All-Hands-AI/agent-sdk/issues)** - Report bugs or request features
- **[Example Directory](https://github.com/All-Hands-AI/agent-sdk/tree/main/examples)** - Browse working code samples
- **[GitHub Issues](https://github.com/OpenHands/agent-sdk/issues)** - Report bugs or request features
- **[Example Directory](https://github.com/OpenHands/agent-sdk/tree/main/examples)** - Browse working code samples
2 changes: 1 addition & 1 deletion sdk/guides/custom-tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ These components are tied together by a **ToolDefinition** that registers the to
## Creating a Custom Tool

<Note>
This example is available on GitHub: [examples/01_standalone_sdk/02_custom_tools.py](https://github.com/All-Hands-AI/agent-sdk/blob/main/examples/01_standalone_sdk/02_custom_tools.py)
This example is available on GitHub: [examples/01_standalone_sdk/02_custom_tools.py](https://github.com/OpenHands/agent-sdk/blob/main/examples/01_standalone_sdk/02_custom_tools.py)
</Note>

Here's a minimal example of creating a custom grep tool:
Expand Down
2 changes: 1 addition & 1 deletion sdk/guides/hello-world.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The simplest possible OpenHands agent - configure an LLM, create an
---

<Note>
This example is available on GitHub: [examples/01_standalone_sdk/01_hello_world.py](https://github.com/All-Hands-AI/agent-sdk/blob/main/examples/01_standalone_sdk/01_hello_world.py)
This example is available on GitHub: [examples/01_standalone_sdk/01_hello_world.py](https://github.com/OpenHands/agent-sdk/blob/main/examples/01_standalone_sdk/01_hello_world.py)
</Note>

This is the most basic example showing how to set up and run an OpenHands agent:
Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ MCP (Model Context Protocol) is a protocol for exposing tools and resources to A
## Basic MCP Usage

<Note>
This example is available on GitHub: [examples/01_standalone_sdk/07_mcp_integration.py](https://github.com/All-Hands-AI/agent-sdk/blob/main/examples/01_standalone_sdk/07_mcp_integration.py)
This example is available on GitHub: [examples/01_standalone_sdk/07_mcp_integration.py](https://github.com/OpenHands/agent-sdk/blob/main/examples/01_standalone_sdk/07_mcp_integration.py)
</Note>

Here's an example integrating MCP servers with an agent:
Expand Down Expand Up @@ -139,7 +139,7 @@ agent = Agent(
## MCP with OAuth

<Note>
This example is available on GitHub: [examples/01_standalone_sdk/08_mcp_with_oauth.py](https://github.com/All-Hands-AI/agent-sdk/blob/main/examples/01_standalone_sdk/08_mcp_with_oauth.py)
This example is available on GitHub: [examples/01_standalone_sdk/08_mcp_with_oauth.py](https://github.com/OpenHands/agent-sdk/blob/main/examples/01_standalone_sdk/08_mcp_with_oauth.py)
</Note>

For MCP servers requiring OAuth authentication:
Expand Down
4 changes: 2 additions & 2 deletions sdk/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Other SDKs (e.g. [Claude Code](https://github.com/anthropics/claude-agent-sdk-py
</Card>
<Card
title="API Reference"
href="https://github.com/All-Hands-AI/agent-sdk/tree/main/openhands/sdk"
href="https://github.com/OpenHands/agent-sdk/tree/main/openhands/sdk"
>
Explore the complete SDK API and source code.
</Card>
Expand Down Expand Up @@ -118,7 +118,7 @@ Other SDKs (e.g. [Claude Code](https://github.com/anthropics/claude-agent-sdk-py
</Card>
<Card
title="GitHub Repository"
href="https://github.com/All-Hands-AI/agent-sdk"
href="https://github.com/OpenHands/agent-sdk"
>
Contribute to the SDK or report issues on GitHub.
</Card>
Expand Down