Docs
Powered by

API Reference

work.studio provides a comprehensive REST API for programmatic access to all platform features. All services expose OpenAPI specifications with interactive documentation.

Interactive API Explorer
Authentication

Explore and test APIs directly using our Swagger UI interfaces.

View API Explorer →

Learn how to authenticate your API requests.

Authentication Guide →

Platform Architecture

work.studio is built as a modular platform with the following core services:

graph TB
    subgraph "API Gateway"
        ALB[Application Load Balancer]
    end
    
    subgraph "Core Services"
        ACC[Account Service]
        CAT[Catalog Service]
        CON[Connection Service]
        POR[Portal Service]
    end
    
    subgraph "Execution Services"
        RUN[Run Service]
        TRG[Trigger Service]
        TSK[Task Service]
        WH[Webhook Service]
    end
    
    subgraph "Data Services"
        STR[Storage Service]
        SUB[Subscription Service]
        NOT[Notification Service]
    end
    
    subgraph "AI Services"
        AI[AI Runtime]
        KB[KB Worker]
        EMB[Embedding Service]
    end
    
    ALB --> ACC
    ALB --> CAT
    ALB --> CON
    ALB --> POR
    ALB --> RUN
    ALB --> TRG
    ALB --> TSK
    ALB --> WH
    ALB --> STR
    ALB --> SUB
    ALB --> NOT
    ALB --> AI
    ALB --> KB

Base URL

All API endpoints are accessed through the API gateway:

https://api.work.studio/api/v1/workflow
 
https://api.work.studio/api/v1/workflow

Service Overview

Core Services

Service Description API Explorer
Account User authentication, organizations, teams, API keys Swagger UI
Catalog Connectors, templates, marketplace, AI agents Swagger UI
Connection OAuth credentials, API keys, connection management Swagger UI
Portal Workflow publishing, dashboards, embedded forms Swagger UI

Execution Services

Service Description API Explorer
Run Workflow execution, run history, logs Swagger UI
Trigger Event triggers, schedules, webhooks Swagger UI
Task Human tasks, approvals, forms Swagger UI
Webhook Incoming webhook management Swagger UI

Data Services

Service Description API Explorer
Storage File storage, resources, secrets Swagger UI
Subscription Billing, plans, usage tracking Swagger UI
Notification Email, Slack, Teams notifications Swagger UI

AI Services

Service Description API Explorer
AI Runtime LLM execution, AI agents, embeddings Swagger UI
KB Worker Knowledge base indexing, RAG Swagger UI

Common Headers

All authenticated requests require these headers:

Header Description
Authorization Bearer token: Bearer sv_live_xxxxx
Content-Type application/json for POST/PUT/PATCH
X-Workspace-Id Workspace identifier (optional)

Rate Limits

Endpoint Type Rate Limit
Standard APIs 1000 requests/minute
Webhook Triggers 100 requests/second
AI Endpoints Based on subscription tier

Rate limit headers are included in responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1619827200

Error Responses

All errors follow a standard format:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid workflow configuration",
    "details": [
      {
        "field": "trigger.config.schedule",
        "message": "Invalid cron expression"
      }
    ]
  },
  "requestId": "req_abc123",
  "timestamp": "2024-01-15T10:30:00Z"
}

HTTP Status Codes

Code Meaning
200 Success
201 Created
400 Bad Request - Invalid input
401 Unauthorized - Invalid or missing token
403 Forbidden - Insufficient permissions
404 Not Found
429 Rate Limited
500 Internal Server Error

Client libraries

pip install workstudio

A client for the REST API — workflows, runs and agents.

Source · PyPI

 
npm install @workstudio-inc/sdk

Headless and framework-agnostic. Covers the embeddable integration marketplace today; the surface is growing to the rest of the API.

Source · npm

Both are MIT licensed and at 0.1.0, so expect the surface to move. Pin a version if you need stability.

No library for your language? The API is plain REST over HTTPS with a bearer token, so any HTTP client works — every endpoint on this page has a curl example. Tell us what you'd want at support@work.studio.