Skip to main content

Overview

The API Gateway is the entry point for all pluggable APIs.

Base URL​

Internal Base URL​

Authorization​

  • Client auth (x-app-authorization): Client Token (passport). Required on every endpoint.
  • User auth (Authorization): OAuth2 User Access Token. Required varies per endpoint.
  • Required headers (POST): platform and x-touchpoint. Missing either → 400 { reason: "missing_headers" }.

Workflows API​

/workflows/:name/*​

The primary entry point for executing workflows.

  • Client auth: required
  • User auth: required

The * resolves to a sub-route that selects the execution mode, documented in the following API pages. These sub-routes are available across all workflow entry points (regular, guest, and internal).

Guest API​

/guest/workflows/:name/*​

Run an allowlisted workflow without a user account.

  • User auth: none
  • reCAPTCHA: required on POST (score ≥ 0.6)
  • Rate limits (POST): 3 / 7 days per IP + global 4000/hour (per-workflow override)
  • Allowlist only (e.g. image-gen-flow, remove-background, topaz/upscale/image, ai-enhance/diffbir, pcp/v1/chat/completions)

Internal (backend-to-backend)​

/v2/workflows/:name/*​

Service-to-service entry point for executing workflows. Exposed on the internal gateway only.

  • User auth: required
  • Impersonation: a caller holding the WORKFLOWS_IMPERSONATION scope can run a workflow on behalf of another user by sending x-act-as-user-id; the request then executes as that user.

MCP API​

/:mcpServerName/mcp​

Entry point for Model Context Protocol clients (Claude, ChatGPT). mcpServerName resolves to your worker by the pa-<mcpServerName>-pluggable-worker naming convention.

  • Method: POST
  • User auth: required

See MCP Support for how to build and expose tools and resources.