Developer API

API Documentation

Build powerful integrations with our REST API. AI-powered code generation makes it even easier.

RESTful API

Standard REST API with JSON responses. Easy to integrate with any language.

API Keys

Secure authentication using API keys. Generate and manage keys from your dashboard.

Webhooks

Receive real-time events when workflows complete or errors occur.

AI Code Generation

Our AI can generate integration code from natural language descriptions.

Quick Start

// Create a new procedure
const response = await fetch('https://api.workos.com/v1/procedures', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Order Processing',
    description: 'Automated order workflow',
    steps: [
      {
        action: 'INPUT',
        title: 'Collect Order Details',
        config: {
          fieldLabel: 'Order Number',
          inputType: 'text'
        }
      }
    ]
  })
});

const procedure = await response.json();

API Endpoints

Complete reference for all available endpoints

POST/v1/procedures

Create a new procedure

Procedures
GET/v1/procedures

List all procedures

Procedures
GET/v1/procedures/{id}

Get procedure details

Procedures
POST/v1/runs

Start a new run

Runs
GET/v1/runs/{id}

Get run status

Runs
POST/v1/webhooks

Create a webhook

Webhooks

Get Your API Key

Start building integrations today. Our AI can help generate code for your specific use case.