Skip to content

docs: add OpenAI-compatible agent-server gateway guide#554

Draft
enyst wants to merge 2 commits into
mainfrom
openhands/openai-chat-completions-gateway
Draft

docs: add OpenAI-compatible agent-server gateway guide#554
enyst wants to merge 2 commits into
mainfrom
openhands/openai-chat-completions-gateway

Conversation

@enyst
Copy link
Copy Markdown
Member

@enyst enyst commented Jun 6, 2026

  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

  • Adds an SDK agent-server guide for the OpenAI-compatible /v1/chat/completions gateway.
  • Documents model IDs (openhands_<profile_name>), compatible auth headers, and conversation ID reuse via X-OpenHands-ServerConversation-ID.
  • Adds the new guide to the SDK Remote Agent Server navigation and includes the new examples/02_remote_agent_server/14_openai_compatible_gateway.py code block so the agent-sdk documented-examples check passes.

Related SDK PR: OpenHands/software-agent-sdk#3545

This PR was created by an AI agent (OpenHands) on behalf of the user.

@enyst can click here to continue refining the PR

Co-authored-by: openhands <openhands@all-hands.dev>
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Jun 6, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Jun 6, 2026, 2:06 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Co-authored-by: openhands <openhands@all-hands.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant