How do I download a build programmatically from Applivery?

First, generate a short-lived download token using the Workspace API. Then, use that token to resolve the actual download URL, which is served via a redirect.

What parameters are required when generating a download token?

You need to provide the `organizationId`, `applicationId`, and `buildId` as path parameters, and the `type` of file as a query parameter (e.g., `auto`, `file`, or `aab`).

What does the `type` parameter do when generating a download token?

The `type` parameter specifies the file format to generate the download token for. `auto` returns .apk or .plist, `file` returns the raw binary (.ipa or .pkg), and `aab` returns the original .aab file.

What is the endpoint for resolving the download URL?

The endpoint is: `GET https://download-api.applivery.io/v1/download/{token}`. No authentication is required for this endpoint.

What HTTP method is used to resolve the download URL?

The API responds with an HTTP `302 Found` redirect to the file's storage location. Use a tool like `curl -L` to follow the redirect.

What happens if the download token has expired?

If the token has expired, you will receive a `401 Unauthorized` error. You need to generate a new token from Step 1.

Download Applivery Builds Programmatically via API

Q: What type of token is required to generate a download token?

Generating a download token requires a Service Account token or a user session token obtained at login. Integrations API (App API Token) is not supported.

Q: What is the endpoint for generating a download token?

The endpoint is: `GET https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/builds/{buildId}/downloadToken`.

Downloading a Build programmatically requires a two-step process: first, generate a short-lived download token, then use that token to resolve the actual download URL. The download URL is served via a redirect response.

Warning

Unlike the other build endpoints, the download token endpoint is only available through the Workspace API and requires a Service Account token or a user session token obtained at login. The Integrations API (App API Token) does not support this endpoint.

To create a Service Account, see Service Accounts.

Overview: Download flow

Step 1: Generate a download token
  GET /v1/organizations/{organizationId}/apps/{applicationId}/builds/{buildId}/downloadToken
  → returns { token, expiresAt }

Step 2: Resolve the download URL
  GET https://download-api.applivery.io/v1/download/{token}
  → HTTP 302 redirect to the actual file URL

Generate a Download Token

Generates a short-lived, single-use token that authorizes the download of a specific Build file.

Endpoint

GET https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/builds/{buildId}/downloadToken

Authentication

Authorization: Bearer <your_service_account_token>

Path parameters

Parameter	Type	Required	Description
`organizationId`	String	Yes	The unique identifier (or slug) of your Applivery organization.
`applicationId`	String	Yes	The unique identifier of the App the Build belongs to.
`buildId`	String	Yes	The unique identifier of the Build you want to download. Returned by POST – Upload a Build and GET – List of Builds.

Query parameters

Parameter	Type	Required	Description
`type`	String	Yes	Specifies which file format to generate the download token for. See values below.

type values

Value	Description
`auto`	Default behavior. Returns a `.apk` for Android Builds, or the manifest (`.plist`) for Apple Builds. This is the standard option for in-app installation flows.
`file`	Returns the raw binary file. For Apple Builds, this is the `.ipa` or `.pkg` file instead of the manifest. Use this when you need the actual file rather than an OTA install link.
`aab`	For Android Builds originally uploaded as an `.aab`, this returns the original `.aab` file instead of the Universal `.apk` that Applivery generates from it.

Example Request

curl 'https://api.applivery.io/v1/organizations/MY_ORG_SLUG/apps/MY_APP_ID/builds/MY_BUILD_ID/downloadToken?type=file' \
  -X GET \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_SERVICE_ACCOUNT_TOKEN'

Responses

{
  "status": true,
  "data": {
    "token": "string",
    "expiresAt": "string"
  }
}

Build not yet processed. The Build exists but has not finished processing. Only Builds with status: processed can have download tokens generated.

{
  "status": false,
  "error": {
    "code": 5014,
    "message": "Build Not Processed"
  }
}

{
  "status": false,
  "error": {
    "code": 4002,
    "message": "No auth token"
  }
}

{
  "status": false,
  "error": {
    "code": 3001,
    "message": "Entity not found"
  }
}

Field	Description
`token`	The download token string. Pass this as the path parameter to Step 2 to resolve the download URL.
`expiresAt`	ISO 8601 timestamp indicating when the token expires. Tokens are short-lived — use them promptly after generation.

Resolve the Download URL

Uses the token obtained in Step 1 to get the actual file download URL. The API responds with an HTTP 302 Found redirect to the file's storage location.

Warning

No authentication required. This endpoint is public — the token itself acts as the credential. Anyone with the token can download the file, so treat tokens as sensitive and do not share them beyond the intended recipient.

Endpoint

GET https://download-api.applivery.io/v1/download/{token}

Path parameters

Parameter	Type	Required	Description
`token`	String	Yes	The download token returned in Step 1.

Example Request

curl -L 'https://download-api.applivery.io/v1/download/YOUR_DOWNLOAD_TOKEN' \
  -o downloaded_build.ipa

Note

The -L flag instructs curl to follow the 302 redirect automatically. Without it, you will receive the redirect response with the Location header containing the actual file URL, but no file will be downloaded.

Redirect behavior by platform

The URL in the Location redirect header varies depending on the platform and the type parameter used in Step 1:

Platform	`type` value	Redirect target
Android	`auto`	Universal `.apk` file
Android	`aab`	Original `.aab` file
Apple	`auto`	OTA manifest (`.plist`) — for in-app installation via MDM or direct install link
Apple	`file`	Raw binary — `.ipa` for iOS, `.pkg` for macOS

Responses

Redirect to the file URL.
The response does not have a body. The actual download URL is in the Location response header. Follow the redirect to download the file.

Token expired. Download tokens are short-lived. If the token has expired, generate a new one from Step 1.

{
  "status": false,
  "error": {
    "code": 4005,
    "message": "Token Expired"
  }
}

{
  "status": false,
  "error": {
    "code": 3001,
    "message": "Entity not found"
  }
}

Complete example: Download a Build file

# Step 1: Generate the download token
TOKEN=$(curl -s \
  'https://api.applivery.io/v1/organizations/MY_ORG/apps/MY_APP/builds/MY_BUILD/downloadToken?type=file' \
  -H 'Authorization: Bearer YOUR_SERVICE_ACCOUNT_TOKEN' \
  | jq -r '.data.token')

# Step 2: Download the file, following the redirect
curl -L \
  "https://download-api.applivery.io/v1/download/$TOKEN" \
  -o my_build.ipa

Key Takeaways

Downloading builds programmatically requires a two-step process: token generation and URL resolution.

Service Account tokens are required for generating download tokens.

Download tokens are short-lived and single-use.

The download URL is served via a redirect response.

The type parameter determines the file format returned (apk, ipa, aab).