Skip to main content

Python SDK for Sleigh runtime server.

Project description

Sleigh Python SDK

Python SDK for the Sleigh runtime server.

Two client variants are included:

  • LangChain Tool variant: one-call as_langchain_tool() (returns StructuredTool)
  • MCP variant: expose runtime APIs as MCP tools over stdio

1. Install

pip install sleigh-sdk

Optional extras:

pip install "sleigh-sdk[langchain]"
pip install "sleigh-sdk[mcp]"

2. Base Python Client

from sleigh_sdk import SleighClient

client = SleighClient(base_url="http://127.0.0.1:10122")
session_token = client.create_session_token()["session_token"]
created = client.create_sandbox(session_token=session_token, image="python:3.11-slim")
sandbox_id = created["sandbox_id"]

3. Ordered Workflow (AI Coding)

Run multiple steps in one request and stop early on failure/timeout:

sandbox_id = created["sandbox_id"]
result = client.run_workflow(
    session_token=session_token,
    steps=[
        {"action": "exec_command", "sandbox_id": sandbox_id, "command": "echo hello", "wait": True, "wait_timeout_seconds": 10},
        {"action": "create_snapshot", "sandbox_id": sandbox_id},
        {"action": "exec_command", "sandbox_id": sandbox_id, "command": "uname -a", "wait": True},
    ],
)
print(result["stopped_early"], result["steps"])

Note: in SDK validation, every workflow step must include sandbox_id.


3.1 Exec Completion Webhook Subscription

Subscribe a callback for a specific exec task:

sub = client.subscribe_exec_webhook(
    session_token=session_token,
    sandbox_id=sandbox_id,
    exec_id="exec_xxx",
    webhook_url="https://your-domain/webhook/notify/evt_xxx",
)
print(sub)

Server sends a signed POST when exec reaches terminal state.


4. Sandbox Read API (AI Coding)

read_result = client.read_sandbox(
    session_token=session_token,
    sandbox_id=sandbox_id,
    command="rg",
    args=["TODO", "/workspace"],
    timeout_seconds=10,
    max_output_bytes=65536,
    max_lines=200,
)
print(read_result)

5. Mount + Environment Copy

List available mount workspace directories first:

dirs = client.list_mount_workspaces(session_token=session_token)
print(dirs["items"])

Mount is now server-enforced read-only:

mount_result = client.mount_path(
    session_token=session_token,
    sandbox_id=sandbox_id,
    workspace_path="/project-a",
    container_path="/workspace",
)
print(mount_result)

List available environment directories first:

env_dirs = client.list_environment_workspaces(session_token=session_token)
print(env_dirs["items"])

Copy one allowlisted environment directory into sandbox filesystem (non-mount path, via docker cp):

copy_result = client.copy_environment(
    session_token=session_token,
    sandbox_id=sandbox_id,
    environment_path="/env-a",
    sandbox_path="/app",
)
print(copy_result)

6. Code Write API (Sandbox Semantic)

code_write targets:

  • POST /sandboxes/{id}/ops/code/write
  • validates sandbox auth and targets file inside sandbox filesystem
  • sandbox_path is required and must be an absolute file path in sandbox
  • service exports target file directory to host temp workspace, applies edit, and syncs back
  • quality checks: run pre-commit when config exists; otherwise auto-detect language for fallback checks
  • write_mode=context_edit is default for partial edits; pass raw snippets with old_text, new_text, and optional before_context/after_context/occurrence
  • write_mode=replace_file is supported for full overwrite by raw source content
  • For agent friendliness, LangChain tool also supports explicit actions: code_write_context_edit and code_write_replace_file
result = client.code_write(
    session_token=session_token,
    sandbox_id=sandbox_id,
    sandbox_path="/app/calculator.py",
    write_mode="context_edit",
    before_context="    def multiply(self, a, b):\n        return a * b\n\n",
    old_text="    def multiply(self, a, b):\n        return a * b\n",
    new_text="    def multiply(self, a, b):\n        return a * b\n\n    def sqrt(self, a):\n        if a < 0:\n            raise ValueError('Cannot sqrt negative number!')\n        return a ** 0.5\n",
)

# Full overwrite mode (raw source content)
rewrite_result = client.code_write(
    session_token=session_token,
    sandbox_id=sandbox_id,
    sandbox_path="/app/calculator.py",
    write_mode="replace_file",
    content="print('hello from overwrite mode')\n",
)

7. Low-Memory Guard (Create + Expand)

When host available memory ratio:

  • < 10%: create/expand is blocked
  • >= 10% and < 15%: create requires confirm_low_memory=True; expand proceeds with warning in response reason
created = client.create_sandbox(
    session_token=session_token,
    image="python:3.11-slim",
    confirm_low_memory=True,
    request_timeout_seconds=180,
)

8. More Examples

  • LangChain integration: ../README_langchain.md
  • MCP integration: ../README_mcp.md

9. Session Exec History

list_session_exec_tasks accepts optional session_id. If omitted, SDK uses session_token as session_id automatically:

history = client.list_session_exec_tasks(
    session_token=session_token,
    limit=20,
)
print(history)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sleigh_sdk-0.1.19.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sleigh_sdk-0.1.19-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file sleigh_sdk-0.1.19.tar.gz.

File metadata

  • Download URL: sleigh_sdk-0.1.19.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sleigh_sdk-0.1.19.tar.gz
Algorithm Hash digest
SHA256 8255aeeca2d361bfac6177bace5edd7545125d3d3c5a2c53c325b30009f7ab9f
MD5 23de285c1b75186a21b100ef3b148518
BLAKE2b-256 68ea01e44cb4161803a39790a84c785ec0aa66b22cf69df9bdfb4547cec86e4d

See more details on using hashes here.

File details

Details for the file sleigh_sdk-0.1.19-py3-none-any.whl.

File metadata

  • Download URL: sleigh_sdk-0.1.19-py3-none-any.whl
  • Upload date:
  • Size: 13.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sleigh_sdk-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 4797f28ea26e908ae0b193eaeb33ec2400520d26ed17fd3e50f51781d601ebd9
MD5 92fdceb2e36ad5dcb4f21df3f70ff60e
BLAKE2b-256 3ef1dadee3a89af173764d1995c6ff522ee02e8720d63bae208ddcbed6aea3fb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page