mirror of
https://github.com/harivansh-afk/sandbox-agent.git
synced 2026-04-16 22:03:52 +00:00
docs: documentation overhaul and universal schema reference (#10)
* remove website .astro * fix default origin * docs: comprehensive documentation overhaul - Add quickstart with multi-platform examples (E2B, Daytona, Docker, local) - Add environment variables setup with platform-specific tabs - Add Python SDK page (coming soon) - Add local deployment guide - Update E2B/Daytona/Docker guides with TypeScript examples - Configure OpenAPI auto-generation for API reference - Add CORS configuration guide - Update manage-sessions with Rivet Actors examples - Fix SDK method names and URLs throughout - Add icons to main documentation pages - Remove outdated universal-api and http-api pages * docs: add universal schema and agent compatibility docs - Create universal-schema.mdx with full event/item schema reference - Create agent-compatibility.mdx mirroring README feature matrix - Rename glossary.md to universal-schema.mdx - Update CLAUDE.md with sync requirements for new docs - Add links in README to building-chat-ui, manage-sessions, universal-schema - Fix CLI docs link (rivet.dev -> sandboxagent.dev) * docs: add inspector page and daytona network limits warning
This commit is contained in:
parent
a6f77f3008
commit
08d299a3ef
40 changed files with 1996 additions and 1004 deletions
41
docs/sdks/python.mdx
Normal file
41
docs/sdks/python.mdx
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: "Python"
|
||||
description: "Python client for managing sessions and streaming events."
|
||||
icon: "python"
|
||||
tag: "Coming Soon"
|
||||
---
|
||||
|
||||
The Python SDK is on our roadmap. It will provide a typed client for managing sessions and streaming events, similar to the TypeScript SDK.
|
||||
|
||||
In the meantime, you can use the [HTTP API](/http-api) directly with any HTTP client like `requests` or `httpx`.
|
||||
|
||||
```python
|
||||
import httpx
|
||||
|
||||
base_url = "http://127.0.0.1:2468"
|
||||
headers = {"Authorization": f"Bearer {token}"}
|
||||
|
||||
# Create a session
|
||||
httpx.post(
|
||||
f"{base_url}/v1/sessions/my-session",
|
||||
headers=headers,
|
||||
json={"agent": "claude", "permissionMode": "default"}
|
||||
)
|
||||
|
||||
# Send a message
|
||||
httpx.post(
|
||||
f"{base_url}/v1/sessions/my-session/messages",
|
||||
headers=headers,
|
||||
json={"message": "Hello from Python"}
|
||||
)
|
||||
|
||||
# Get events
|
||||
response = httpx.get(
|
||||
f"{base_url}/v1/sessions/my-session/events",
|
||||
headers=headers,
|
||||
params={"offset": 0, "limit": 50}
|
||||
)
|
||||
events = response.json()["events"]
|
||||
```
|
||||
|
||||
Want the Python SDK sooner? [Open an issue](https://github.com/rivet-dev/sandbox-agent/issues) to let us know.
|
||||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: "TypeScript SDK"
|
||||
title: "TypeScript"
|
||||
description: "Use the generated client to manage sessions and stream events."
|
||||
icon: "js"
|
||||
---
|
||||
|
||||
The TypeScript SDK is generated from the OpenAPI spec that ships with the server. It provides a typed
|
||||
|
|
@ -147,4 +148,4 @@ The SDK exports OpenAPI-derived types for events, items, and capabilities:
|
|||
import type { UniversalEvent, UniversalItem, AgentCapabilities } from "sandbox-agent";
|
||||
```
|
||||
|
||||
See `docs/universal-api.mdx` for the universal schema fields and semantics.
|
||||
See the [API Reference](/api) for schema details.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue