API Documentation

The ClawVortex API lets you programmatically generate AGENTS.md files, manage agent fleets, and perform CRUD operations on workflows. All endpoints require an API key passed via the Authorization header.

Base URL: https://api.clawvortex.com/v1
Authorization: Bearer YOUR_API_KEY

AGENTS.md Code Generation

Export any visual workflow from your canvas to a valid AGENTS.md configuration file. The generated output is fully compatible with the OpenClaw CLI and runtime.

POST /workflows/:id/export

Generate an AGENTS.md file from a saved workflow.

curl -X POST https://api.clawvortex.com/v1/workflows/wf_abc123/export \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format": "agents-md", "include_comments": true}'

Response:

{
  "workflow_id": "wf_abc123",
  "format": "agents-md",
  "content": "# AGENTS.md\n\n## coordinator\nrole: orchestrator\nmodel: claude-sonnet-4-20250514\nhandoff_to: [researcher, writer]\n...",
  "agents_count": 3,
  "exported_at": "2026-03-25T10:00:00Z"
}

POST /workflows/:id/export/preview

Preview the generated AGENTS.md without saving. Useful for validating changes before committing to your repo.

curl -X POST https://api.clawvortex.com/v1/workflows/wf_abc123/export/preview \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format": "agents-md", "include_comments": true}'

Example: Multi-Agent Code Review Pipeline

A workflow with three agents that reviews PRs, checks for security issues, and writes a summary.

# Generated by ClawVortex — wf_review42
# Pipeline: Code Review

## pr-reader
role: ingestion
model: claude-haiku-4-20250414
description: Reads PR diff and extracts changed files, functions, and test coverage delta.
tools: [github-api]

## security-scanner
role: reviewer
model: claude-sonnet-4-20250514
description: Scans for common vulnerabilities — injection, auth bypass, secrets in code.
handoff_from: pr-reader
handoff_condition: always

## summary-writer
role: output
model: claude-haiku-4-20250414
description: Compiles findings into a structured PR comment with severity labels.
handoff_from: [security-scanner]
output: github-comment

Example: Customer Onboarding Workflow

A four-agent workflow that handles new customer signup, data enrichment, welcome messaging, and CRM sync.

# Generated by ClawVortex — wf_onboard99
# Pipeline: Customer Onboarding

## intake
role: trigger
model: input
description: Receives signup webhook with email, name, and plan tier.

## enricher
role: processor
model: claude-sonnet-4-20250514
description: Looks up company info, LinkedIn profile, and previous interactions.
handoff_from: intake
tools: [clearbit-api, linkedin-api]

## welcome-agent
role: communicator
model: claude-haiku-4-20250414
description: Sends personalized welcome email based on enriched profile and plan tier.
handoff_from: enricher
tools: [resend-api]

## crm-sync
role: integrator
model: claude-haiku-4-20250414
description: Creates or updates contact in CRM with enriched data and onboarding status.
handoff_from: enricher
tools: [hubspot-api]

GET /workflows/:id/export/history

List previous AGENTS.md exports for a workflow. Useful for diffing changes between versions.

curl https://api.clawvortex.com/v1/workflows/wf_abc123/export/history \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "exports": [
    {"id": "exp_001", "exported_at": "2026-03-25T10:00:00Z", "agents_count": 3, "diff_from_previous": "+1 agent, updated handoff rules"},
    {"id": "exp_002", "exported_at": "2026-03-20T14:30:00Z", "agents_count": 2, "diff_from_previous": "initial export"}
  ]
}

Fleet Management

Start, stop, and monitor agents across your entire fleet from a single API. Push config updates without redeploying.

GET /fleet

List all agents in your fleet with their current status.

curl https://api.clawvortex.com/v1/fleet \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "agents": [
    {"id": "agt_001", "name": "coordinator", "status": "running", "uptime_hours": 142},
    {"id": "agt_002", "name": "researcher", "status": "running", "uptime_hours": 142},
    {"id": "agt_003", "name": "writer", "status": "stopped", "uptime_hours": 0}
  ],
  "total": 3,
  "running": 2
}

POST /fleet/:agentId/restart

Restart a specific agent with optional config overrides.

curl -X POST https://api.clawvortex.com/v1/fleet/agt_001/restart \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"config_override": {"model": "claude-sonnet-4-20250514", "max_tokens": 4096}}'

POST /fleet/deploy

Deploy a workflow to your fleet. Creates or updates agents as needed.

curl -X POST https://api.clawvortex.com/v1/fleet/deploy \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workflow_id": "wf_abc123", "environment": "production"}'

Workflow CRUD Operations

Create, read, update, and delete workflows programmatically. Each workflow contains agent nodes, handoff rules, and canvas layout data.

GET /workflows

List all workflows in your team.

curl https://api.clawvortex.com/v1/workflows \
  -H "Authorization: Bearer YOUR_API_KEY"

POST /workflows

Create a new workflow.

curl -X POST https://api.clawvortex.com/v1/workflows \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Support Pipeline",
    "agents": [
      {"name": "triage", "role": "classifier", "model": "claude-haiku-4-20250414"},
      {"name": "resolver", "role": "specialist", "model": "claude-sonnet-4-20250514"},
      {"name": "escalator", "role": "handoff", "model": "claude-sonnet-4-20250514"}
    ],
    "handoffs": [
      {"from": "triage", "to": "resolver", "condition": "confidence > 0.8"},
      {"from": "triage", "to": "escalator", "condition": "confidence <= 0.8"}
    ]
  }'

PATCH /workflows/:id

Update an existing workflow. Supports partial updates.

curl -X PATCH https://api.clawvortex.com/v1/workflows/wf_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Pipeline", "handoffs": [...]}'

DELETE /workflows/:id

Delete a workflow. Running agents are stopped first.

curl -X DELETE https://api.clawvortex.com/v1/workflows/wf_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Authentication

API keys are scoped per team. Generate keys from the ClawVortex dashboard under Settings → API Keys. All requests must include the key in the Authorization header as a Bearer token.

Rate limits: 100 requests/minute for Team plans, 1000 requests/minute for Enterprise. Responses include X-RateLimit-Remaining headers.