Python SDK — Usage

1
from onepin import OnePinClient
2
3
# Explicit key
4
client = OnePinClient(api_key="op_live_...")
5
6
# From environment (reads ONEPIN_API_KEY automatically)
7
client = OnePinClient.from_environment()
8
9
# Custom base URL (e.g. local dev proxy)
10
client = OnePinClient(
11
    api_key="op_live_...",
12
    base_url="https://api.onepin.ai",
13
)

1
with OnePinClient(api_key="op_live_...") as client:
2
    page = client.workflows.list()

1
# List (single page)
2
page = client.workflows.list(limit=50, offset=0)
3
for wf in page.items:
4
    print(wf.id, wf.name, wf.status)
5
6
# Get one
7
wf = client.workflows.get("3fa85f64-5717-4562-b3fc-2c963f66afa6")
8
print(wf.definition)
9
10
# Start a run
11
run = client.workflows.runs.start("3fa85f64-5717-4562-b3fc-2c963f66afa6")
12
print(run.id, run.status)
13
14
# List run history
15
runs_page = client.workflows.runs.list("3fa85f64-5717-4562-b3fc-2c963f66afa6", limit=20)
16
for r in runs_page.items:
17
    print(r.id, r.status, r.created_at)

1
page = client.voices.list(limit=50)
2
for v in page.items:
3
    print(v.id, v.display_name, v.locale)

1
# List gallery templates
2
page = client.templates.list(limit=50)
3
for t in page.items:
4
    print(t.id, t.name)
5
6
# Get one
7
tmpl = client.templates.get("3fa85f64-5717-4562-b3fc-2c963f66afa6")
8
9
# Clone into a workflow in your workspace (requires workflows:write scope)
10
new_wf = client.templates.clone(
11
    template_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
12
    name="My production pipeline",   # optional; defaults to "<template name> (copy)"
13
)
14
print(new_wf.id, new_wf.name)
15
16
# Convenience: clone then immediately start a run
17
run = client.templates.run("3fa85f64-5717-4562-b3fc-2c963f66afa6")
18
print(run.workflow_id, run.id)

1
import httpx
2
3
# Step 1: create the upload record and get a presigned URL
4
result = client.uploads.create(
5
    filename="my-script.txt",
6
    category="script",           # "script" (.txt/.docx) or "dictionary" (.csv)
7
)
8
upload_id  = result.upload.id
9
upload_url = result.upload_url
10
11
# Step 2: PUT the file bytes directly to S3 (not via the SDK — raw HTTP)
12
with open("my-script.txt", "rb") as f:
13
    httpx.put(upload_url, content=f.read())  # must return 200
14
15
# Step 3: confirm the upload and bind it to a workflow
16
upload = client.uploads.confirm(
17
    upload_id=upload_id,
18
    workflow_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
19
)
20
print(upload.id, upload.status)
21
22
# Delete an upload
23
client.uploads.delete(upload_id)