Python SDK — Usage

1
import os
2
from onepin import OnePinClient
3
4
# Explicit token
5
client = OnePinClient(token="op_live_...")
6
7
# From environment variable (explicit read — the SDK does not auto-read env vars)
8
client = OnePinClient(token=os.environ["ONEPIN_API_KEY"])
9
10
# Custom base URL
11
client = OnePinClient(
12
    token="op_live_...",
13
    base_url="https://api.onepin.ai",
14
)

1
client = OnePinClient(token="op_live_...")
2
for wf in client.workflows.list():
3
    print(wf.id)

1
# List — iterate the pager directly; pages are fetched automatically
2
for wf in client.workflows.list(limit=50, offset=0):
3
    print(wf.id, wf.name, wf.status)
4
5
# Get one — response is an envelope; the workflow is at .data
6
result = client.workflows.get(workflow_id="3fa85f64-5717-4562-b3fc-2c963f66afa6")
7
wf = result.data
8
print(wf.id, wf.name)
9
10
# Start a run — envelope; run at .data
11
result = client.workflows.runs.start("3fa85f64-5717-4562-b3fc-2c963f66afa6")
12
run = result.data
13
print(run.id, run.status)
14
15
# List run history — iterate the pager directly
16
for r in client.workflows.runs.list("3fa85f64-5717-4562-b3fc-2c963f66afa6", limit=20):
17
    print(r.id, r.status, r.created_at)

1
for v in client.voices.list(limit=50):
2
    print(v.id, v.display_name, v.locale)
3
4
result = client.voices.get(voice_id="...")
5
voice = result.data
6
7
result = client.voices.similar(voice_id="...")
8
similar = result.data

1
# List gallery templates — iterate the pager directly
2
for t in client.templates.list(limit=50):
3
    print(t.id, t.name)
4
5
# Get one — envelope; template at .data
6
result = client.templates.get(template_id="3fa85f64-5717-4562-b3fc-2c963f66afa6")
7
tmpl = result.data
8
9
# Clone into a workflow in your workspace (requires workflows:write scope)
10
# The new workflow is at .data
11
result = client.templates.clone(
12
    template_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
13
    name="My production pipeline",   # optional; defaults to "<template name> (copy)"
14
)
15
new_wf = result.data
16
print(new_wf.id, new_wf.name)

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.data.upload.id
9
upload_url = result.data.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
confirmed = client.uploads.confirm(
17
    upload_id=upload_id,
18
    context_type="workflow",
19
    context_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
20
)
21
print(confirmed.data.id, confirmed.data.status)
22
23
# Delete an upload
24
client.uploads.delete(upload_id)