> Documentation index for agents: https://docs.rocketride.ai/llms.txt

# Python SDK

Build, run, and manage AI pipelines from Python. The `rocketride` package is
async-first — built on `asyncio` and `websockets` — and speaks the engine's native
[WebSocket protocol](/connect/websocket): you author a `.pipe`
([visually](/clients/vscode) or [by hand](/reference/pipeline-reference)) and run it
against the engine from your own application.

## Install

```bash
pip install rocketride
```

Python 3.10+. The [`rocketride` CLI](/connect/cli) is installed with the package.

## Quickstart

```python
import asyncio
from rocketride import RocketRideClient


async def main():
    async with RocketRideClient(uri='https://api.rocketride.ai', auth='my-key') as client:
        result = await client.use(filepath='pipeline.pipe')
        token = result['token']
        out = await client.send(token, 'Hello, pipeline!', objinfo={'name': 'input.txt'}, mimetype='text/plain')
        print(out)
        await client.terminate(token)


asyncio.run(main())
```

`send()` / `send_files()` target pipelines whose **source** is `webhook` or
`dropper`; if your pipeline source is `chat`, use
[`client.chat()`](/clients/python/chat). No pipeline yet? The
[IDE walkthrough](/quickstart/ide-walkthrough) builds one in minutes.

## Explore the SDK

- [Configuration](/clients/python/configuration/): Constructor options, environment variables, timeouts, and reconnection.

- [Connection](/clients/python/connection/): The attach/login layers, context manager, persist mode, and lifecycle callbacks.

- [Running Pipelines](/clients/python/pipelines/): Start with use(), watch progress, validate, and terminate.

- [Deployments](/clients/python/deploy/): Publish immutable versions, point team environments at them, and schedule runs.

- [Sending Data](/clients/python/data/): One-shot sends, concurrent file uploads with progress, and chunked streaming.

- [File Storage](/clients/python/storage/): Read, write, and manage your server-side store; signed URLs for direct access.

- [Chat](/clients/python/chat/): Build a Question, stream the response, parse it with Answer.

- [Run Logs](/clients/python/logs/): The log continuum and the DVR session: live monitoring and replay with one API.

- [Error Handling](/clients/python/errors/): What the SDK raises, when, and how to catch it.

- [API Reference](/clients/python/reference/): Every public class and method, in one place.

- [Examples](/clients/python/examples/): Seven complete programs, from hello-pipeline to custom DAP requests.

- [Analytics](/clients/python/analytics/): Report client-side analytics events through the SDK.

- [OpenTelemetry Bridge](/clients/python/otel-bridge/): Export live pipeline traces and metrics over OTLP with rocketride otel.

- [Pipeline Diff](/clients/python/pipe-diff/): Review what changed between two .pipe revisions with rocketride diff.

## Links

- [GitHub](https://github.com/rocketride-org/rocketride-server) · [PyPI](https://pypi.org/project/rocketride/) · [Discord](https://discord.gg/PMXrtenMsY)
- [Release notes](/support/release-notes) · [Get help](/support/get-help)
