Generate a new WhatsApp Flow via the flows sub-agent

curl --request POST \
  --url https://api.paigeme.dev/v1/flows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instruction": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({instruction: '<string>'})
};

fetch('https://api.paigeme.dev/v1/flows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.paigeme.dev/v1/flows"

payload = { "instruction": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "success": true,
    "flow_name": "<string>",
    "flow_path": "<string>",
    "summary": "<string>",
    "screens": 123,
    "validation": {},
    "meta_flow_id": "<string>",
    "meta_status": "<string>",
    "meta_validation_errors": [
      {}
    ],
    "user_waba_error": "<string>",
    "paige_dev": {},
    "is_dynamic": true
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

Generate a new WhatsApp Flow via the flows sub-agent

Builds a flow from a natural-language instruction — there is no hand-authored flow JSON path. Saves the JSON, records the flow, and drafts it on the connected WABA (never auto-publishes). Consumes credits.

A 200 does not mean the flow was built. The body is one of two shapes: the full result, or a bail-out { "success": false, "error": … } with none of the flow fields (the agent produced no flow, or the run was cancelled). Only a provider-level failure becomes 502. Check success and the presence of flow_name before reading the rest.

Note that success: false on the FULL shape means something narrower — the flow was saved, but Meta raised validation errors or a WABA copy failed. meta_validation_errors / user_waba_error tell you which.

Required scope: flows:write

POST

flows

Generate a new WhatsApp Flow via the flows sub-agent

curl --request POST \
  --url https://api.paigeme.dev/v1/flows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instruction": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({instruction: '<string>'})
};

fetch('https://api.paigeme.dev/v1/flows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.paigeme.dev/v1/flows"

payload = { "instruction": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "success": true,
    "flow_name": "<string>",
    "flow_path": "<string>",
    "summary": "<string>",
    "screens": 123,
    "validation": {},
    "meta_flow_id": "<string>",
    "meta_status": "<string>",
    "meta_validation_errors": [
      {}
    ],
    "user_waba_error": "<string>",
    "paige_dev": {},
    "is_dynamic": true
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request body",
    "details": {}
  },
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Project API key issued in Settings → API keys. Send it as Authorization: Bearer pk_live_….

Headers

X-Paige-Project

string

Target project id, for an MCP OAuth bearer (mcp_at_…) attached to more than one project — get ids from GET /v1/projects. Matched case-insensitively.

Omit it and a READ falls back to the connection's default project; a mutation (any non-GET) on a connection with 2+ projects is rejected with 400 project_required — a write is never defaulted to a guessed project. A connection with exactly one project never needs the header.

Scopes are checked against the SELECTED project only, never a union across the connection.

For a pk_ API key the header selects nothing — one key is one project's context — but it IS validated: omit it and the key's own project is used, send it and it must name that project, otherwise the call is rejected with 403 project_not_attached (a blank value is 400 invalid_project_header, as above).

Body

application/json

instruction

string

required

Natural-language description of the WhatsApp Flow to build.

Required string length: 1 - 5000

Response

Success.

success

enum<boolean>

required

Available options:

true

data

object

required

Option 1
Option 2

Hide child attributes

data.success

boolean

required

True only when Meta raised no validation errors AND both WABA copies were written. Check the error fields below on false — the flow JSON is still saved locally.

data.flow_name

string

required

data.flow_path

string

required

Where the JSON was saved, e.g. flows/booking.json.

data.summary

string

required

The agent's description of what it built or changed.

data.screens

number

required

Screen count in the resulting flow.

data.validation

object

required

Paige's own pre-publish validation result.

data.meta_flow_id

string | null

required

Flow id on the user's WABA, or null when not connected.

data.meta_status

string

required

DRAFT | PUBLISHED | LOCAL — LOCAL means saved in Paige only.

data.meta_validation_errors

object[]

required

Meta's validation errors, empty when it accepted the flow.

data.user_waba_error

string | null

required

Why the user's own WABA copy failed, if it did. Paige Dev is unaffected.

data.paige_dev

object | null

required

Result of the Paige Dev shared-number publish.

data.is_dynamic

boolean

required

True when the flow declares a data endpoint (dynamic flow).

List the project's WhatsApp Flows Read one flow, including its JSON definition

Getting started

Endpoints

Generate a new WhatsApp Flow via the flows sub-agent

Authorizations

Headers

Body

Response