Docs
Powered by

API Explorer

Explore and test work.studio APIs interactively using Swagger UI. Each service exposes its OpenAPI specification at the standard endpoints.

How to Access API Documentation

Each work.studio service exposes interactive API documentation:

Endpoint Description
/swagger-ui/index.html Interactive Swagger UI
/v3/api-docs OpenAPI 3.0 JSON specification
/v3/api-docs.yaml OpenAPI 3.0 YAML specification

Production API Explorers

Core Services

Account Service

User management, organizations, teams, and API key management.

Key Endpoints:

  • GET /account/me - Get current user
  • GET /account/organizations - List organizations
  • POST /account/api-keys - Create API key
  • GET /account/team/members - List team members

Open Account API Explorer

Catalog Service

Connector catalog, templates, marketplace, and AI agent configuration.

Key Endpoints:

  • GET /catalog/connectors - List available connectors
  • GET /catalog/templates - List workflow templates
  • GET /catalog/marketplace - Browse marketplace
  • GET /catalog/ai-agents - List AI agents
  • GET /catalog/llm-models - List LLM models

Open Catalog API Explorer

Connection Service

OAuth connections, API key credentials, and integration management.

Key Endpoints:

  • GET /connections - List connections
  • POST /connections - Create connection
  • POST /connections/{id}/test - Test connection
  • GET /connections/{id}/operations - List connector operations

Open Connection API Explorer

Portal Service

Workflow publishing, dashboards, and embedded forms.

Key Endpoints:

  • GET /portal/workflows - List published workflows
  • GET /portal/dashboards - List dashboards
  • POST /portal/embed - Generate embed code
  • GET /portal/customers - List customers

Open Portal API Explorer

Execution Services

Run Service

Workflow execution, run history, and logs.

Key Endpoints:

  • POST /run/workflows/{id}/execute - Execute workflow
  • GET /run/executions - List executions
  • GET /run/executions/{id} - Get execution details
  • GET /run/executions/{id}/logs - Get execution logs
  • POST /run/executions/{id}/cancel - Cancel execution

Open Run API Explorer

Trigger Service

Event triggers, schedules, and webhook triggers.

Key Endpoints:

  • GET /triggers - List triggers
  • POST /triggers - Create trigger
  • GET /triggers/{id}/executions - List trigger executions
  • PUT /triggers/{id}/enable - Enable trigger
  • PUT /triggers/{id}/disable - Disable trigger

Open Trigger API Explorer

Task Service

Human tasks, approvals, and interactive forms.

Key Endpoints:

  • GET /tasks - List pending tasks
  • GET /tasks/{id} - Get task details
  • POST /tasks/{id}/complete - Complete task
  • POST /tasks/{id}/assign - Assign task

Open Task API Explorer

Webhook Service

Incoming webhook management and configuration.

Key Endpoints:

  • GET /webhooks - List webhooks
  • POST /webhooks - Create webhook
  • GET /webhooks/{id}/logs - Get webhook logs

Open Webhook API Explorer

Data Services

Storage Service

File storage, resources, and secrets management.

Key Endpoints:

  • GET /storage/files - List files
  • POST /storage/files/upload - Upload file
  • GET /storage/resources - List resources
  • GET /storage/secrets - List secrets (names only)

Open Storage API Explorer

Subscription Service

Billing, plans, and usage tracking.

Key Endpoints:

  • GET /subscription/current - Get current subscription
  • GET /subscription/usage - Get usage metrics
  • GET /subscription/invoices - List invoices

Open Subscription API Explorer

Notification Service

Email, Slack, and Teams notifications.

Key Endpoints:

  • POST /notifications/send - Send notification
  • GET /notifications/history - Get notification history
  • GET /notifications/channels - List notification channels

Open Notification API Explorer

AI Services

AI Runtime

LLM execution, AI agents, and embeddings.

Key Endpoints:

  • POST /ai/generate - Generate text with LLM
  • POST /ai/chat - Chat conversation
  • POST /ai/embeddings - Generate embeddings
  • GET /ai/agents - List AI agents
  • POST /ai/agents/{id}/execute - Execute AI agent

Open AI Runtime API Explorer

KB Worker

Knowledge base indexing and RAG (Retrieval Augmented Generation).

Key Endpoints:

  • GET /kb/knowledge-bases - List knowledge bases
  • POST /kb/knowledge-bases - Create knowledge base
  • POST /kb/knowledge-bases/{id}/documents - Add document
  • POST /kb/knowledge-bases/{id}/query - Query knowledge base

Open KB Worker API Explorer

Using the API Explorer

1. Authenticate

Click the Authorize button in Swagger UI and enter your API key:

Bearer sv_live_your_api_key_here

2. Select an Endpoint

Browse the available endpoints organized by tags/categories.

3. Try It Out

Click Try it out, fill in parameters, and click Execute to make a live API call.

4. View Response

See the response body, headers, and HTTP status code.

Download OpenAPI Specs

For code generation or importing into tools like Postman:

Service OpenAPI JSON OpenAPI YAML
Account /v3/api-docs/account /v3/api-docs.yaml/account
Catalog /v3/api-docs/catalog /v3/api-docs.yaml/catalog
Connection /v3/api-docs/connection /v3/api-docs.yaml/connection
Portal /v3/api-docs/portal /v3/api-docs.yaml/portal
Run /v3/api-docs/run /v3/api-docs.yaml/run
Trigger /v3/api-docs/trigger /v3/api-docs.yaml/trigger
Task /v3/api-docs/task /v3/api-docs.yaml/task
Webhook /v3/api-docs/webhook /v3/api-docs.yaml/webhook
Storage /v3/api-docs/storage /v3/api-docs.yaml/storage
AI Runtime /v3/api-docs/ai-runtime /v3/api-docs.yaml/ai-runtime

Code Generation

Generate client libraries from OpenAPI specs:

# Install OpenAPI Generator
npm install @openapitools/openapi-generator-cli -g

# Generate TypeScript client
openapi-generator-cli generate \
  -i https://api.work.studio/v3/api-docs \
  -g typescript-fetch \
  -o ./workstudio-client

# Generate Python client
openapi-generator-cli generate \
  -i https://api.work.studio/v3/api-docs \
  -g python \
  -o ./workstudio-python