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
  • API Reference
      • GETList Workflows
      • POSTCreate Workflow
      • GETGet Workflow
      • PUTUpdate Workflow
      • DELDelete Workflow
      • PATCHPatch Workflow
      • GETList Workflow Uploads
      • POSTPreview Run
      • GETRuns Summary
      • GETGet Run Steps
      • GETGet Run Overview
      • GETGet Run Data
      • GETDownload Run
      • GETDownload Run Node
      • POSTDuplicate Workflow
  • Python SDK
    • Install
    • Usage
    • Errors
  • CLI
    • Overview
LogoLogo
API Referenceworkflows

Create Workflow

POST
/api/v1/workflows
POST
/api/v1/workflows
$curl -X POST https://api.onepin.ai/api/v1/workflows \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "name": "Data Enrichment Workflow"
>}'
1{
2 "data": {
3 "id": "d4f1a2b3-9c8e-4f7a-8b2d-1a2b3c4d5e6f",
4 "user_id": "a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6",
5 "name": "Data Enrichment Workflow",
6 "definition": {},
7 "created_at": "2024-01-15T09:30:00Z",
8 "updated_at": "2024-01-15T09:30:00Z",
9 "description": "Workflow to enrich customer data with external APIs and validate results.",
10 "runs_count": 12,
11 "last_run_at": "2024-04-10T14:45:00Z",
12 "last_run_status": "completed"
13 },
14 "meta": {
15 "request_id": "7f8e9d6c-1234-4b56-8a9f-0b1c2d3e4f5a",
16 "timestamp": "2024-04-10T14:46:00Z"
17 }
18}
Create a workflow.
Was this page helpful?
Previous

Get Workflow

Next
Built with

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Headers

X-Workspace-Idstring or nullOptional

Request

This endpoint expects an object.
namestringRequired1-200 characters
descriptionstring or nullOptional<=5000 characters
definitionobjectOptional

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error