Developer API

Build powerful automations with our API

RESTful API with comprehensive endpoints for workflows, agents, executions, and integrations. Built for developers.

Quick Start

Get Your API Key

  1. 1Log in to your dashboard
  2. 2Navigate to Settings → API Keys
  3. 3Generate a new API key
  4. 4Copy and secure your key
Get started

Base URL

https://api.hyperautomate.ai/v1

Rate Limits

  • Free: 100 requests/hour
  • Pro: 1,000 requests/hour
  • Enterprise: Custom limits

Authentication

API Keys

Generate API keys in your dashboard for server-to-server authentication.

Authorization: Bearer YOUR_API_KEY

OAuth 2.0

Use OAuth 2.0 for user-authenticated requests and third-party integrations.

Authorization: Bearer YOUR_OAUTH_TOKEN

API Endpoints

Workflows

GET/workflows

List all workflows

POST/workflows

Create a new workflow

GET/workflows/:id

Get workflow details

PUT/workflows/:id

Update a workflow

DELETE/workflows/:id

Delete a workflow

POST/workflows/:id/execute

Trigger workflow execution

Agents

GET/agents

List all AI agents

POST/agents

Create a new agent

GET/agents/:id

Get agent details

PUT/agents/:id

Update an agent

POST/agents/:id/chat

Send message to agent

Executions

GET/executions

List workflow executions

GET/executions/:id

Get execution details

POST/executions/:id/retry

Retry failed execution

POST/executions/:id/cancel

Cancel running execution

Integrations

GET/integrations

List available integrations

POST/integrations/connect

Connect to a service

GET/integrations/:id

Get integration status

DELETE/integrations/:id

Disconnect integration

Example Request

# Create a new workflow
curl -X POST https://api.hyperautomate.ai/v1/workflows \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Welcome Email Workflow",
    "trigger": {
      "type": "webhook",
      "path": "/webhook/new-user"
    },
    "actions": [
      {
        "type": "send_email",
        "template": "welcome",
        "to": "{{trigger.email}}"
      }
    ]
  }'

Official SDKs

JavaScript

Node.js

npm install @hyperautomate/sdk
View docs →
Python

Python

pip install hyperautomate
View docs →
Go

Go

go get github.com/hyperautomate/go-sdk
View docs →
Ruby

Ruby

gem install hyperautomate
View docs →

Need help with integration?

Our developer support team is here to help you build and scale your automations.