Promote dev → production

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

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

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

import requests

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

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

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

print(response.text)

{
  "success": true,
  "data": {
    "deployed_sha": "<string>",
    "files_count": 123,
    "tables_created": [
      "<string>"
    ],
    "tables_synced": 123,
    "rows_copied": 123,
    "table_errors": [
      {}
    ],
    "table_sync_failed": true,
    "flows_published": 123,
    "flow_errors": [
      {}
    ],
    "flows_failed": 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>"
}

Promote dev → production

Copies the dev working copy to production and syncs table structure. Table DATA and flow publishing are opt-in via tables / flows.

No field is required — an empty body {} is a valid, complete request: it promotes the code and syncs table structure without copying any rows or publishing any flows. This one genuinely takes an empty body, unlike the other all-optional-looking bodies on this API.

A deploy can partially succeed: table and flow failures are collected rather than thrown, so check table_sync_failed / flows_failed and the matching error arrays on a 200 rather than assuming success.

Required scope: code:write

POST

deploy

Promote dev → production

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

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

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

import requests

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

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

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

print(response.text)

{
  "success": true,
  "data": {
    "deployed_sha": "<string>",
    "files_count": 123,
    "tables_created": [
      "<string>"
    ],
    "tables_synced": 123,
    "rows_copied": 123,
    "table_errors": [
      {}
    ],
    "table_sync_failed": true,
    "flows_published": 123,
    "flow_errors": [
      {}
    ],
    "flows_failed": 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>"
}

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

tables

string[]

flows

string[]

Response

Success.

success

enum<boolean>

required

Available options:

true

data

object

required

Hide child attributes

data.deployed_sha

string | null

required

Commit sha of the deployed snapshot, or null when no commit was recorded.

data.files_count

number

required

Number of dev files promoted.

data.tables_created

string[]

required

Custom tables created in production during this deploy.

data.tables_synced

number

required

Count of tables whose structure was synced.

data.rows_copied

number

required

Rows copied for the tables named in tables. 0 when data copy was not requested.

data.table_errors

object[]

required

Per-table failures. Non-empty means the deploy partially succeeded.

data.table_sync_failed

boolean

required

True when table_errors is non-empty.

data.flows_published

number

required

Count of flows published on the connected number.

data.flow_errors

object[]

required

Per-flow publish failures.

data.flows_failed

boolean

required

True when flow_errors is non-empty.

Author/edit bot code from a natural-language instruction via the code agent List the project's WhatsApp Flows

Getting started

Endpoints

Promote dev → production

Authorizations

Headers

Body

Response