dograh/examples/README.md
nuthalapativarun 2a92406f02
feat(examples): add multi-node Workflow SDK example in Python and TypeScript (#440)
* feat(examples): add multi-node Workflow SDK example in Python and TypeScript

Closes #369

* docs: preserve workflow name in SDK build examples

---------

Co-authored-by: Abhishek Kumar <abhishek@a6k.me>
2026-06-18 15:13:10 +05:30

54 lines
1.7 KiB
Markdown

# Dograh SDK Examples
Runnable examples of the Dograh SDK in Python and TypeScript.
## Shared environment variables
Copy `.env.example` to `.env` in each example directory and fill in your values, then `source .env` (or use your preferred dotenv loader).
| Variable | Description |
| --------------------- | ------------------------------------------------------------ |
| `DOGRAH_API_ENDPOINT` | Dograh API base URL (e.g. `http://localhost:8000`) |
| `DOGRAH_API_TOKEN` | API token — sent as `X-API-Key` |
The workflow ID and destination phone number are set as constants at the top of each example script — edit them there.
## Python
```bash
pip install dograh-sdk
export DOGRAH_API_ENDPOINT=http://localhost:8000
export DOGRAH_API_TOKEN=sk-...
# Fetch a workflow by ID and place a test phone call.
python python/fetch_workflow_and_call.py
# Create a new workflow from a definition.
python python/create_workflow.py
# Build a 3-node agent with the Workflow SDK and save it as a draft.
# Edit WORKFLOW_ID at the top of the file first.
python python/build_workflow_with_sdk.py
# Load an existing workflow, edit the startCall prompt, and save as a draft.
# Edit WORKFLOW_ID at the top of the file first.
python python/load_and_edit_workflow.py
```
## TypeScript
Uses `tsx` to run directly.
```bash
cd typescript
npm install
export DOGRAH_API_ENDPOINT=http://localhost:8000
export DOGRAH_API_TOKEN=sk-...
npm run call # fetch_workflow_and_call.ts
npm run create # create_workflow.ts
npm run build # build_workflow_with_sdk.ts (edit WORKFLOW_ID in the file first)
npm run edit # load_and_edit_workflow.ts (edit WORKFLOW_ID in the file first)
```