alloy-runtime-sdk
Python SDK for Alloy Runtime.
Install
pip install alloy-runtime-sdk
Quick start
from alloy_runtime_sdk.api_client.client import ApiClient
async def main() -> None:
async with ApiClient(
base_url="https://your-alloy-runtime-host",
api_key="your_api_key",
) as client:
models = await client.list_models()
print(models)
What it includes
- Authenticated HTTP client methods for the Alloy Runtime API.
- Pipeline runtime helpers for Python-based pipeline steps.
- Structured logging helpers used by runtime integrations.
Logging
SDK logging is pretty, human-readable text by default:
from alloy_runtime_sdk.logging.config import LogConfig, LogLevel, configure, get_logger
configure(LogConfig(level=LogLevel.DEBUG))
logger = get_logger()
Use JSON Lines explicitly for files, CI, and log shippers:
from alloy_runtime_sdk.logging.config import LogConfig, LogFormat, configure
configure(LogConfig(format=LogFormat.JSONL, output_file="logs/sdk.jsonl"))
SDK logs stay compact: the logging formatter does not add default environment,
service, resource, or process-level session_id fields, and successful HTTP
responses are not logged. HTTP response logs are emitted only for error responses.
JSON to Markdown helper
Convert JSON-like Python values into LLM-readable Markdown prompt context:
from alloy_runtime_sdk.markdown import json_to_markdown
markdown = json_to_markdown(
{"customer": {"name": "Ada", "plan": "enterprise"}},
title="Customer Context",
)
Nested dictionaries become Markdown headings, leaves become key/value lines,
and list-of-dictionary values can render as Markdown tables. See
docs/sdk/json_to_markdown.md for options.
Local pipeline runner
The SDK supports both Hosted execution and SDK local execution for pipelines.
Use python -m alloy_runtime_sdk.pipeline.local_runner to run a local pipeline module against a hosted Alloy Runtime, or call run_local_pipeline() directly from Python. Local runs return both the stable pipeline_execution_id and active attempt_id/epoch; rerun with the same execution ID to continue the logical workflow.
See docs/pipelines/local_testing.md for the full workflow and examples.
Inspect compact execution live state without querying the database:
execution_state = await client.get_execution_live_state(execution_id)
pipeline_state = await client.get_pipeline_execution_live_state(
pipeline_id,
execution_id,
)
Use these methods for current status/progress polling. Use get_execution(...) for the durable model-execution transcript and get_pipeline_execution(...) for durable pipeline result, stdout/stderr, failure context, and generation-step detail.
Hosted pipeline executions can be cancelled through the API client:
await client.cancel_pipeline_execution(pipeline_id, execution_id)
Cancellation marks Alloy's execution record cancelled first; hosted provider
shutdown and child generation cancellation are handled by the server best-effort.
The SDK depends on alloy-runtime-types, which is published separately for stable,
versioned cross-package compatibility.
Hard-cut API migration
Use this SDK with the matching alloy-runtime-types version. Generation requests now use canonical model / agent_id, flat model_options, flat extra_headers, and canonical result.model response identity. See docs/generate/hardcut_migration.md before updating older SDK or pipeline code.
1 maintainer
Metadata
1 maintainer
Release files for alloy-runtime-sdk 0.2.124
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| alloy_runtime_sdk-0.2.124.tar.gz | 69.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| alloy_runtime_sdk-0.2.124-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 146.2 kB
Release files / alloy_runtime_sdk-0.2.124.tar.gz
| Download URL | alloy_runtime_sdk-0.2.124.tar.gz |
|---|---|
| Size | 69.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
640276ae481fb86b9c4928cc339ecb56689144445e98a0700924d4ac28843d6b
|
|
BLAKE2b-256 checksum How to use checksums |
a6e98b81e6c6f3d692f82aa1a0af6a118cf2c98058cd05f33e2f0711c134c86e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / alloy_runtime_sdk-0.2.124-py3-none-any.whl
| Download URL | alloy_runtime_sdk-0.2.124-py3-none-any.whl |
|---|---|
| Size | 76.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
224d1306df3be0ea764b90906d912f2a135b686590271cc2f521c8cc6fd95e64
|
|
BLAKE2b-256 checksum How to use checksums |
3f003e60fce03f390f09ad72af1fdc5e0a4b8562de159f95030c44fd839fe20c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency log
