API Reference

The HeadlessOps REST API provides programmatic access to all platform resources.

Base URL

https://app.headlessops.ai/api

Authentication

API Key (Recommended for programmatic access)

Include your API key in the Authorization header:

Authorization: Bearer iter_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API keys are scoped to a workspace — the workspace is resolved automatically. Use the flat paths (e.g. /api/integrations) with API key auth.

Session Cookie (Browser / web app)

Sign in to get a session cookie:

curl -X POST https://app.headlessops.ai/api/auth/sign-in/email \
  -H "Content-Type: application/json" \
  -d '{ "email": "you@example.com", "password": "your-password" }'

The response sets a Set-Cookie header. Subsequent requests with this cookie are authenticated.

Session auth is required for workspace-management endpoints (/api/workspaces/:workspaceId/...).

API Endpoint Groups

Machine-Readable API Docs

The full API specification is available as a JSON endpoint (no auth required):

curl https://app.headlessops.ai/api/docs

This is the same endpoint consumed by AI agents and MCP clients.