Download OpenAPI specification:Download
This is the VoltBuilder API specification. You need to have a Pro account or better to use this API. You can request credentials at https://volt.build/plan/. Every response includes the current API release version in the API-Version header. The version is independent of the /v1 URL.
This endpoint retrieves the status of the last submitted build as JSON.
curl --request GET \ --url https://api.volt.build/v1/app \ --header 'authorization: Bearer REPLACE_BEARER_TOKEN'
{- "status": "Completed",
- "timestamp": 1599670881,
- "name": "MyApp",
- "links": {
}
}To correlate duplicate browser attempts, send the same X-Upload-Attempt-ID on each attempt. It is hashed for diagnostics only; it does not provide authorization, idempotency, or deduplication.
| X-Request-ID | string Optional request correlation value. Hashed before it is returned in the X-Request-ID response header and logged; otherwise the API uses a generated identifier. |
| X-Correlation-ID | string Optional request correlation value used when X-Request-ID is absent. Hashed before it is returned in the X-Request-ID response header and logged; otherwise the API uses a generated identifier. |
| X-Upload-Attempt-ID | string Client correlation value, hashed before logging. |
| platform required | string Enum: "ios" "android" "windows" |
| app required | string <binary> |
curl --request POST \ --url https://api.volt.build/v1/app \ --header 'authorization: Bearer REPLACE_BEARER_TOKEN' \ --form platform=ios \ --form 'app=@app.zip;type=application/zip'
{- "reason": "UPLOAD_UNEXPECTED_FIELD"
}This is an OAuth2 compatible endpoint that allows you to request an access token for the API using your client credentials.
| grant_type required | string must be |
| client_id required | string <uuid> a uuid that represents your client |
| client_secret required | string a client secret (password) assigned to your client_id |
grant_type=client_credentials&client_id=a75fe631-6aae-4a75-869c-77efdbaae524&client_secret=JejqCteCsZXQVPhDNPGKJ6QM
{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "token_type": "bearer",
- "expires_in": 3600
}