Skip to content

docs: add SDK quickstart guide for invoking pipelines from external applications (#407) #751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mithileshgau wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

docs: add SDK quickstart guide for invoking pipelines from external applications (#407) #751

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8b5ce66
docs: add SDK quickstart guide (#407)
mithileshgau May 4, 2026
7622283
docs: fix markdown heading and correct API documentation links in SDK…
mithileshgau May 4, 2026
88d3630
docs: fix SDK quickstart troubleshooting and examples path
mithileshgau May 4, 2026
7e99890
docs: fix FastAPI example with env validation and modern lifespan
mithileshgau May 4, 2026
d1565a3
docs: add env validation to TypeScript examples
mithileshgau May 4, 2026
5307be7
docs: fix startup race condition and TypeScript type issues in Expres…
mithileshgau May 4, 2026
0af1f33
docs: prevent internal error leakage in FastAPI and Express examples
mithileshgau May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,17 @@ _Drop pipelines into any Python or TypeScript app with a few lines of code, no i

6. Run your pipelines as standalone processes or integrate them into your existing [Python](https://docs.rocketride.org/sdk/python-sdk) and [TypeScript/JS](https://docs.rocketride.org/sdk/node-sdk) applications utilizing our SDK.

## Invoking Pipelines from External Applications

New to RocketRide SDKs? Start with the **[SDK Quick Start Guide](docs/SDK_QUICKSTART.md)** — 5 minutes to your first pipeline call.

The guide includes:

- SDK installation and engine setup
- Python and TypeScript examples with error handling
- Web framework integration (FastAPI, Express.js)
- Configuration, troubleshooting, and best practices

## Observability

Selecting running pipelines allows for in-depth analytics. Trace call trees, token usage, memory consumption, and more to optimize your pipelines before scaling and deploying. Find the models, agents, and tools best fit for your task.
Expand Down
Loading
Loading