REST API Overview

Authenticate to the Superflow REST API and understand its request and response conventions.

The Superflow REST API lets your own systems automate Superflow, for example creating a project automatically whenever your pipeline deploys a new client site.

If your goal is to let an AI tool work with Superflow, the MCP connector is the better fit: per-user sign-in, no tokens to manage, and a much wider set of capabilities.

Authentication

Every request carries two headers:

x-superflow-api-key · string · required

Your workspace API key.

x-superflow-auth-token · string · required

Your workspace auth token.

Both values are on the Superflow Dashboard under Settings, then Integrations, then REST API. Keep them server-side; anyone holding both can act on your workspace.

Conventions

• Requests are POST with Content-Type: application/json, and the payload wrapped in a data object:

  { "data": { "projectUrl": "https://example.com", "projectName": "Example" } }
  

• Successful responses arrive wrapped in result:

  { "result": { "status": "success", "message": "...", "data": { } } }
  

• Failures arrive wrapped in error, with a message and a status code such as INVALID_ARGUMENT, ALREADY_EXISTS, or RESOURCE_EXHAUSTED:

  { "error": { "message": "Invalid Auth token.", "status": "INVALID_ARGUMENT" } }
  

• Requests are rate limited per caller and workspace. Space out bursts rather than retrying failures in a tight loop.

Endpoints

Create Project

Create a website project, optionally mark it as already installed, and optionally kick off agent checks in the same call.

More endpoints are on the way. If you need one that is not here yet, tell us at [e-mail], or use the MCP connector, which already covers projects, agents, comments, analytics and invitations.