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
      • login
      • workflows
      • voices
      • templates
      • uploads
LogoLogo
On this page
  • list
  • Synopsis
  • Flags
  • Examples
  • Output (table)
  • show
  • Synopsis
  • Description
  • Examples
  • Errors
  • run
  • Synopsis
  • Description
  • Flags
  • Examples
  • Errors
CLICommands

onepin templates

Was this page helpful?
Previous

uploads

Next
Built with

Browse and clone workflow templates. Requires templates:read scope for list/show; workflows:write for run (clone).

Templates are pre-built workflow definitions created by the OnePin team. Clone one into your workspace to create an editable workflow.


list

Synopsis

onepin templates list [OPTIONS]

Flags

FlagDefaultDescription
--limit INT50Items per page
--offset INT0Pagination offset
--alloffFetch all pages automatically
--jsonoffEmit JSON to stdout

Examples

$onepin templates list
$
$onepin templates list --all --json | jq '.[] | {id, name}'

Output (table)

ID NAME UPDATED
3fa85f64-5717-4562-b3fc-2c963f66afa6 Narration — English 2026-04-15
7d8e9f00-1234-5678-abcd-ef0123456789 Dubbing — Korean 2026-04-10

show

Synopsis

onepin templates show <TEMPLATE_ID>

Description

Retrieves a single template by UUID. Cross-workspace reads return only the published snapshot — unpublished drafts are not visible.

Examples

$onepin templates show 3fa85f64-5717-4562-b3fc-2c963f66afa6
$
$onepin templates show 3fa85f64-5717-4562-b3fc-2c963f66afa6 --json

Errors

ConditionExit
Template not found or not published1 (404)

run

Synopsis

onepin templates run <TEMPLATE_ID> [--name NAME] [--watch] [--json]

Description

Convenience command that performs two calls in sequence:

  1. Clone — POST /api/v1/templates/{id}/clone creates a new workflow in your workspace from the template’s published definition.
  2. Start — POST /api/v1/workflows/{new_id}/runs triggers a run of the new workflow.

The clone always uses the template’s published definition, not any in-progress draft. This prevents cross-workspace leakage of unpublished content.

Requires workflows:write scope.

Flags

FlagDefaultDescription
--name TEXT"<template name> (copy)"Name for the new workflow
--watchoffPoll the run to completion (same backoff as workflows run --watch)
--jsonoffEmit JSON to stdout

Examples

$# Clone and start with default name
$onepin templates run 3fa85f64-5717-4562-b3fc-2c963f66afa6
$
$# Custom name, watch until done
$onepin templates run 3fa85f64-5717-4562-b3fc-2c963f66afa6 \
> --name "My Narration Pipeline" \
> --watch

Output:

Workflow created: 9c1d2e3f-... "My Narration Pipeline"
Run started: run_01JXXXXXXXXXXXXXXXXXXXXX
✓ completed (18s)

JSON output:

1{
2 "workflow": {
3 "id": "9c1d2e3f-...",
4 "name": "My Narration Pipeline"
5 },
6 "run": {
7 "id": "run_01JXXXXXXXXXXXXXXXXXXXXX",
8 "status": "running"
9 }
10}

Errors

ConditionExit
Template not found or not published1 (404)
Definition validation failure1 (422)
Insufficient scope (workflows:write missing)1 (403)