Skip to content

Add documentation for Settings and Secrets API examples#492

Closed
malhotra5 wants to merge 1 commit intomainfrom
docs-settings-api-examples
Closed

Add documentation for Settings and Secrets API examples#492
malhotra5 wants to merge 1 commit intomainfrom
docs-settings-api-examples

Conversation

@malhotra5
Copy link
Copy Markdown
Contributor

Summary

Adds documentation for the Settings and Secrets API examples in the software-agent-sdk.

Examples Documented

  • examples/02_remote_agent_server/12_settings_and_secrets_api.py - Settings and Secrets API workflow
  • examples/02_remote_agent_server/13_workspace_get_llm.py - Workspace settings retrieval methods

Documentation Covers

  1. Settings API

    • Storing LLM configuration via /api/settings
    • Encrypted storage with OH_SECRET_KEY
  2. Secrets API

    • CRUD operations for custom secrets
    • LookupSecret references for lazy resolution
  3. Workspace Settings Methods

    • workspace.get_llm() - Retrieve configured LLM
    • workspace.get_secrets() - Get LookupSecret references
    • workspace.get_mcp_config() - Get MCP configuration
  4. Security

    • Session API key authentication
    • API key headers in LookupSecrets

Related SDK 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:
- examples/02_remote_agent_server/12_settings_and_secrets_api.py
- examples/02_remote_agent_server/13_workspace_get_llm.py

Covers:
- Settings API for LLM configuration
- Secrets API for encrypted secret storage
- LookupSecret references for lazy resolution
- workspace.get_llm(), get_secrets(), get_mcp_config() methods
- Session API key authentication

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

mintlify Bot commented May 6, 2026

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

Project Status Preview Updated (UTC)
all-hands-ai 🟡 Building May 6, 2026, 3:47 PM

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

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.

2 participants