Skip to content

docs: add Settings and Secrets API guide#490

Draft
malhotra5 wants to merge 5 commits intomainfrom
feat/encrypted-secrets-in-transit
Draft

docs: add Settings and Secrets API guide#490
malhotra5 wants to merge 5 commits intomainfrom
feat/encrypted-secrets-in-transit

Conversation

@malhotra5
Copy link
Copy Markdown
Contributor

Summary

Documents the new settings and secrets API example added in OpenHands/software-agent-sdk#3060.

Important: This branch name (feat/encrypted-secrets-in-transit) matches the SDK PR branch name so the check-examples CI workflow can find this documentation.

Changes

  • Added sdk/guides/agent-server/settings-secrets-api.mdx documenting:
    • Settings endpoints (GET/PATCH)
    • Secrets CRUD operations
    • Secret name validation
    • Secret redaction behavior
  • Updated docs.json to include the new page in the Remote Agent Server section

Related PR


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

@malhotra5 can click here to continue refining the PR

Documents the new settings and secrets API example added in
OpenHands/software-agent-sdk#3060.

Covers:
- Settings endpoints (GET/PATCH)
- Secrets CRUD operations
- Secret name validation
- Secret redaction behavior

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

mintlify Bot commented May 5, 2026

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

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview May 5, 2026, 8:38 PM

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

Comment thread sdk/guides/agent-server/settings-secrets-api.mdx
Synced code blocks with examples from the feat/encrypted-secrets-in-transit
branch of software-agent-sdk. Updated 16 files including the new
settings-secrets-api.mdx example.

Co-authored-by: openhands <openhands@all-hands.dev>
Updated documentation to reflect the improved example that:
- Stores LLM config via Settings API
- Verifies X-Expose-Secrets: encrypted mode
- Runs a real RemoteConversation agent session
- Tests custom secrets CRUD operations

Co-authored-by: openhands <openhands@all-hands.dev>
Updated documentation to reflect the new example that:
- Uses POST /api/conversations with secrets_encrypted=True
- Demonstrates full encrypted secrets flow for frontend clients
- Shows how to poll conversation state

Co-authored-by: openhands <openhands@all-hands.dev>
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.

3 participants