Developer HTTP API

The HTTP door to the same operations as the MCP server and the CLI. JSON in, JSON out.

Base URL and auth

https://appbricx.com/api/dev/v1
Authorization: Bearer apx_pat_...

• Use an access token. Tokens work on /dev/v1 and /mcp only; they are never accepted by the rest of the Appbricx API (billing, admin, workspace settings).
• The web app's signed-in session also works here, with every scope across all of the user's workspaces.
• Send content-type: application/json on requests with a body.

Endpoints

"read" endpoints work with any valid token. Writing endpoints also need a non-viewer role in the project's workspace.

HTTP bodies use camelCase (dryRun, fullPage, skipVerify); the MCP tools use snake_case for the same fields. data/query also accepts entity in place of table.

Examples

export API=https://appbricx.com/api/dev/v1
export AUTH="Authorization: Bearer $APPBRICX_TOKEN"
export P=3f2c9a10-...   # project id

Check

curl -sS -X POST "$API/projects/$P/check" -H "$AUTH" \
  -H "content-type: application/json" \
  -d "{\"contract\": $(cat appbricx.json)}"
# → { "report": { "ok": true, "errors": [], "fixes": [...], "warnings": [], "summary": {...} } }

Apply

curl -sS -X POST "$API/projects/$P/apply" -H "$AUTH" \
  -H "content-type: application/json" \
  -d "{\"contract\": $(cat appbricx.json)}"
# → { "report": {...}, "summary": "... demo sign-ins per role ...", "warnings": [], "changed": true }

Verify

curl -sS -X POST "$API/projects/$P/verify" -H "$AUTH"
# → { "report": { "status": "pass", "ms": 25000, "stages": [
#       { "stage": "static",  "status": "pass", "checks": [...] },
#       { "stage": "data",    "status": "pass", "checks": [...] },
#       { "stage": "browser", "status": "pass", "checks": [...] } ] } }

Each check has id, status, evidence and, when it fails, a fix. skipped is never a pass.

Screenshot

# The PNG itself
curl -sS -X POST "$API/projects/$P/screenshot?format=png" -H "$AUTH" \
  -H "content-type: application/json" \
  -d '{"route": "/jobs", "as": "technician"}' -o jobs.png

# JSON: png (base64), url, signedInAs, viewport, errors, overflowX, text
curl -sS -X POST "$API/projects/$P/screenshot" -H "$AUTH" \
  -H "content-type: application/json" \
  -d '{"as": "guest"}'

as is a persona id, a demo login email or "guest". The default viewport is 390×844.

Errors

Errors are JSON with a message and, usually, a code:

{ "error": "This token lacks the \"deploy\" scope", "code": "FORBIDDEN_SCOPE" }

Next

• App contract
• Access tokens
• Developer CLI