Skip to main content

Documentation Index

Fetch the complete documentation index at: https://buildpixel.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The BuildPixel API is JSON-over-HTTPS REST, with a Socket.IO channel for live build logs and outbound webhooks for event delivery.

​
Base URL

https://api.buildpixel.io

​
Quick example

# 1. List your projects
curl https://api.buildpixel.io/projects \
  -H "Authorization: Bearer $TOKEN"

# 2. Trigger a build
curl -X POST \
  https://api.buildpixel.io/projects/$PROJECT_ID/build-settings/$SETTING_ID/trigger \
  -H "Authorization: Bearer $TOKEN" \
  -d '{}'

# Response: { "buildId": "65f2...", "status": "pending" }

# 3. Poll for completion (or use Socket.IO for live updates)
curl https://api.buildpixel.io/builds/$BUILD_ID \
  -H "Authorization: Bearer $TOKEN"
For real-time monitoring, prefer Socket.IO over polling.

​
Conventions

​
IDs

Resource IDs are 24-char strings. URL-safe, sortable by creation time, globally unique within an org.

​
Timestamps

ISO 8601, UTC: 
2026-05-10T14:23:45.123Z

​
Pagination

List endpoints use cursor-based pagination: 
curl "https://api.buildpixel.io/builds?limit=50&cursor=<opaque>"

{
  "items": [...],
  "nextCursor": "..."
}
limit defaults to 25, max 100. The cursor is opaque — don’t try to parse it.

​
Where to go next

Authentication

How to get a token and use it.

Errors

Status codes and the error response shape.

Builds

Trigger, list, fetch, download artifacts.

Real-time

Socket.IO for live build status and logs.