Create, List, and Check Build Status

The Builds API lets you trigger and monitor Capwrapper build jobs programmatically. Submit your web app URL and configuration to start a build, then poll the status endpoint until the build completes and a download URL is available. All endpoints require a valid API key — see the REST API overview for authentication details.

Create a build

POST /api/v1/builds Triggers a new build for your web app. Returns a build object with an id you can use to poll for status.

Request body

string

required

The public HTTPS URL of your web app. Must be publicly accessible at build time.

string

required

Display name for your app. This is the name shown on the device home screen and in the app store listing.

string

required

Unique app identifier in reverse domain notation (e.g. com.example.myapp). Must be unique across all your builds for a given platform.

string

required

Semver version string (e.g. "1.2.0"). Must be higher than the version used in the previous build for the same bundle ID.

string[]

List of native permissions to request from the user. Accepted values include "camera", "gps", "notifications", and others. Omit this field to request no permissions.

Example request

curl -X POST https://api.capwrapper.com/v1/builds \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://myapp.example.com",
    "appName": "My Finance App",
    "bundleId": "com.example.financeapp",
    "version": "1.2.0",
    "permissions": ["camera", "notifications"]
  }'

Response

{
  "id": "bld_abc123xyz",
  "status": "queued",
  "createdAt": "2026-04-11T10:00:00Z",
  "url": "https://myapp.example.com",
  "appName": "My Finance App",
  "bundleId": "com.example.financeapp",
  "version": "1.2.0"
}

string

Unique build identifier. Use this to poll for status with GET /api/v1/builds/:id.

string

Initial build status. Always "queued" immediately after creation.

string

ISO 8601 timestamp of when the build was created.

Get build status

GET /api/v1/builds/:id Returns the current status and details of a specific build. Poll this endpoint after creating a build to check when it completes.

Path parameters

string

required

The build ID returned by POST /api/v1/builds.

Build status values

Value	Description
`queued`	Build is waiting in the queue
`building`	Build is actively running
`success`	Build completed successfully — `downloadUrl` is available
`failed`	Build failed — check `error` field for details

Example request

curl https://api.capwrapper.com/v1/builds/bld_abc123xyz \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (success)

{
  "id": "bld_abc123xyz",
  "status": "success",
  "createdAt": "2026-04-11T10:00:00Z",
  "completedAt": "2026-04-11T10:01:45Z",
  "downloadUrl": "https://cdn.capwrapper.com/builds/bld_abc123xyz/app-release.apk",
  "platform": "android"
}

string

Unique build identifier.

string

Current build status: queued, building, success, or failed.

string

ISO 8601 timestamp of when the build was created.

string

ISO 8601 timestamp of when the build finished. Present only when status is success or failed.

string

Signed download URL for the compiled binary. Present only when status is success.

string

Target platform: android or ios.

List all builds

GET /api/v1/builds Returns a paginated list of all your builds, sorted newest first.

Query parameters

integer

Number of builds to return. Default: 20. Maximum: 100.

integer

Number of builds to skip. Use with limit to paginate through results. Default: 0.

Example request

curl "https://api.capwrapper.com/v1/builds?limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "builds": [
    {
      "id": "bld_abc123xyz",
      "status": "success",
      "appName": "My Finance App",
      "createdAt": "2026-04-11T10:00:00Z"
    }
  ],
  "total": 42,
  "limit": 10,
  "offset": 0
}

object[]

Array of build summary objects.

integer

Total number of builds in your account.

integer

The limit value used for this response.

integer

The offset value used for this response.

​Create a build

​Request body

​Example request

​Response

​Get build status

​Path parameters

​Build status values

​Example request

​Response (success)

​List all builds

​Query parameters

​Example request

​Response

Create a build

Request body

Example request

Response

Get build status

Path parameters

Build status values

Example request

Response (success)

List all builds

Query parameters

Example request

Response