For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
  • Python SDK
    • Install
    • Usage
    • Errors
  • CLI
    • Overview
LogoLogo
On this page
  • Get started
  • What you can do
  • How it fits together
Get Started

OnePin Python SDK & CLI

Was this page helpful?

Quickstart

Next
Built with

OnePin is a workflow-driven voice synthesis platform — build, run, and manage multi-step TTS pipelines from source script through translation, generation, and quality validation. This site documents the REST API, the onepin Python SDK, and the onepin CLI.

Get started

Quickstart

Install the SDK and make your first API call in under 5 minutes.

Authentication

API keys, scopes, credential resolution, and key rotation.

API Reference

Every REST endpoint with request/response schemas, rendered from the OpenAPI spec.

Python SDK

Sync and async clients, pagination helpers, and typed exceptions.

CLI

onepin command-line tool for scripting, CI pipelines, and interactive exploration.

What you can do

ResourceAPI-key operations
Workflowslist, get, run, list runs
Voiceslist
Templateslist, get, clone into workflow
Uploadscreate (presigned URL), confirm, delete

How it fits together

Your code / CI
    │
    ▼  pip install onepin
OnePinClient  ──▶  https://api.onepin.ai/api/v1/
                           │
                     donut-be  (FastAPI + PostgreSQL)
                           │
                     arq worker  (async job execution)

Each API key is scoped to a single workspace. All resources — workflows, templates, uploads — belong to the workspace the key was created under.