Artifacts
Build artifact management — upload, list, download via signed URLs. Time-limited share tokens and token-authorized artifact delivery. Getting builds to testers: latest-build install links, tester groups, sends, installs, feedback, device registration and browser push.
Downloads an artifact using a scoped download token. No session auth required — the token itself is the authorization. For S3/R2 storage, redirects to a presigned URL.
Path Parameters
Scoped download token
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/install/artifact/string"Returns local artifact bytes using the signed path token.
Path Parameters
Signed local download token
Response Body
application/octet-stream
application/json
application/json
curl -X GET "https://example.com/install/download/string""string"Returns an Apple property-list manifest authorized by the scoped token in the URL.
Path Parameters
Artifact install token
Response Body
application/xml
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/install/ios/string/manifest.plist""string"Revokes a scoped download token so it can no longer be used.
Authorization
bearer_auth In: header
Path Parameters
Download token ID
Response Body
application/json
application/json
curl -X DELETE "https://example.com/v1/artifact-tokens/string"{ "revoked": true}Resolves a time-limited path token and redirects to the backing storage URL. The token is the authorization; no session bearer token is used.
Path Parameters
Scoped download token
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/artifacts/dl/string"Returns the artifact bytes using the signed path token.
Path Parameters
Signed local download token
Response Body
application/octet-stream
application/json
application/json
curl -X GET "https://example.com/v1/artifacts/download/string""string"Returns an Apple property-list manifest authorized by the install token in the URL.
Path Parameters
Artifact install token
Response Body
application/xml
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/artifacts/install/ios/string/manifest.plist""string"Backward-compatible alias for signed local artifact downloads.
Path Parameters
Signed local download token
Response Body
application/octet-stream
application/json
application/json
curl -X GET "https://example.com/v1/artifacts/local-download/string""string"Stores a bounded binary artifact using the signed path token. The token is the authorization; no session bearer token is used.
Path Parameters
Signed local upload token
Request Body
application/octet-stream
Raw artifact bytes
TypeScript Definitions
Use the request body type in TypeScript.
binaryResponse Body
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/artifacts/local-upload/string" \ -H "Content-Type: application/octet-stream" \ -d 'string'Authorization
bearer_auth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/artifacts/query" \ -H "Content-Type: application/json" \ -d '{ "build_ids": [ "string" ] }'{ "artifacts": [ { "artifact_type": "apk", "build_id": "string", "checksum": "string", "created_at": 0, "expires_at": 0, "file_path": "string", "file_size": 0, "id": "string", "metadata": {}, "name": "string", "state": "string" } ]}Returns a signed download URL for an artifact. URLs expire after 15 minutes.
Authorization
bearer_auth In: header
Path Parameters
Artifact ID
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/artifacts/string/download-link"{ "download_url": "string", "expires_at": 0}Creates a one-hour install session for an APK or install-ready signed IPA. QA viewers may use this endpoint through their artifact read permission.
Authorization
bearer_auth In: header
Path Parameters
Artifact ID
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/artifacts/string/install-link"{ "download_url": "string", "expires_at": 0, "install_url": "string", "manifest_url": "string", "platform": "android"}Generates a scoped, time-limited download token for a specific artifact. The token can be shared with external users who don't have an account.
Authorization
bearer_auth In: header
Path Parameters
Artifact ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/artifacts/string/scoped-token" \ -H "Content-Type: application/json" \ -d '{}'{ "download_url": "string", "expires_at": 0, "id": "string", "prefix": "string", "single_use": true, "token": "string"}Lists all scoped download tokens for a specific artifact, including expired and revoked ones.
Authorization
bearer_auth In: header
Path Parameters
Artifact ID
Response Body
application/json
curl -X GET "https://example.com/v1/artifacts/string/scoped-tokens"{ "tokens": [ { "artifact_id": "string", "created_at": 0, "created_by": "string", "created_by_email": "string", "expires_at": 0, "id": "string", "is_expired": true, "is_revoked": true, "is_used": true, "prefix": "string", "revoked_at": 0, "single_use": true, "used_at": 0 } ]}Authorization
bearer_auth In: header
Path Parameters
Build ID
Response Body
application/json
curl -X GET "https://example.com/v1/builds/string/artifacts"{ "artifacts": [ { "artifact_type": "apk", "build_id": "string", "checksum": "string", "created_at": 0, "expires_at": 0, "file_path": "string", "file_size": 0, "id": "string", "metadata": {}, "name": "string", "state": "string" } ]}Who downloaded this build's files through an install page, share link or latest-build link.
Authorization
bearer_auth In: header
Path Parameters
Build ID
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/builds/string/installs"{ "installs": [ { "artifact_id": "string", "installed_at": 0, "user_email": "string", "via": "string" } ]}Authorization
bearer_auth In: header
Path Parameters
Build ID
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/builds/string/shares"{ "shares": [ { "build_id": "string", "group_id": "string", "group_name": "string", "id": "string", "message": "string", "recipients": [ { "email": "string", "installed_at": 0, "name": "string", "no_access": true, "user_id": "string" } ], "sent_at": 0, "sent_by_email": "string" } ]}Emails each member an install link and sends a browser notification to members who turned them on. Members without access to the app are listed with no_access and are not sent anything.
Authorization
bearer_auth In: header
Path Parameters
Build ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/builds/string/shares" \ -H "Content-Type: application/json" \ -d '{ "group_id": "string" }'{ "build_id": "string", "group_id": "string", "group_name": "string", "id": "string", "message": "string", "recipients": [ { "email": "string", "installed_at": 0, "name": "string", "no_access": true, "user_id": "string" } ], "sent_at": 0, "sent_by_email": "string"}Returns the size of each artifact the build published and its change from the latest earlier successful build of the same pipeline on the base branch: a pull request's target branch, otherwise the project's default branch.
Authorization
bearer_auth In: header
Path Parameters
Build ID
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/builds/string/sizes"{ "artifacts": [ { "artifact_id": "string", "artifact_type": "apk", "baseline_name": "string", "baseline_size_bytes": 0, "delta_bytes": 0, "name": "string", "size_bytes": 0 } ], "base_branch": "string", "baseline": null}Authorization
bearer_auth In: header
Path Parameters
Registration ID
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/device-registrations/string"{ "created_at": 0, "device_name": "string", "error": "string", "expires_at": 0, "id": "string", "pipeline_id": "string", "profile_url": "string", "state": "pending"}Feedback on builds of apps I can see, newest first.
Authorization
bearer_auth In: header
Query Parameters
How far back, 1 to 30 days. Default 7.
int64Response Body
application/json
curl -X GET "https://example.com/v1/feedback/recent"{ "feedback": [ { "build_number": 0, "feedback": { "app_version": "string", "artifact_id": "string", "author_email": "string", "author_name": "string", "build_id": "string", "created_at": 0, "device": "string", "has_screenshot": true, "id": "string", "message": "string", "os_version": "string" }, "project_id": "string", "project_name": "string" } ]}Authorization
bearer_auth In: header
Path Parameters
Link ID
Response Body
application/json
curl -X DELETE "https://example.com/v1/latest-links/string"Returns a profile url to open on the device. Installing the profile sends its UDID back and registers it on the pipeline's Apple team.
Authorization
bearer_auth In: header
Path Parameters
Pipeline ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/pipelines/string/device-registrations" \ -H "Content-Type: application/json" \ -d '{}'{ "created_at": 0, "device_name": "string", "error": "string", "expires_at": 0, "id": "string", "pipeline_id": "string", "profile_url": "string", "state": "pending"}Authorization
bearer_auth In: header
Path Parameters
Pipeline ID
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/pipelines/string/latest-links"{ "links": [ { "branch": "string", "created_at": 0, "created_by_email": "string", "id": "string", "last_used_at": 0, "pipeline_id": "string", "platform": "android", "prefix": "string", "project_id": "string", "url": "string", "use_count": 0 } ]}A permanent link that always opens the newest successful build of the pipeline for one platform, optionally on one branch. The url is only returned here.
Authorization
bearer_auth In: header
Path Parameters
Pipeline ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/pipelines/string/latest-links" \ -H "Content-Type: application/json" \ -d '{ "platform": "android" }'{ "branch": "string", "created_at": 0, "created_by_email": "string", "id": "string", "last_used_at": 0, "pipeline_id": "string", "platform": "android", "prefix": "string", "project_id": "string", "url": "string", "use_count": 0}Authorization
bearer_auth In: header
Path Parameters
Project ID
Query Parameters
Maximum artifacts to return (defaults to 200, max 200)
int64Response Body
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/artifacts"{ "artifacts": [ { "artifact_type": "apk", "build_id": "string", "checksum": "string", "created_at": 0, "expires_at": 0, "file_path": "string", "file_size": 0, "id": "string", "metadata": {}, "name": "string", "state": "string" } ]}Runner creates an artifact record and gets a signed upload URL.
Authorization
bearer_auth In: header
Path Parameters
Runner ID
Build/Job ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/runners/string/jobs/string/artifacts" \ -H "Content-Type: application/json" \ -d '{ "artifact_type": "string", "name": "string" }'{ "artifact": { "artifact_type": "apk", "build_id": "string", "checksum": "string", "created_at": 0, "expires_at": 0, "file_path": "string", "file_size": 0, "id": "string", "metadata": {}, "name": "string", "state": "string" }, "upload_url": "string"}Authorization
bearer_auth In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/runners/string/jobs/string/artifacts/string/abort" \ -H "Content-Type: application/json" \ -d '{}'{ "artifact": { "artifact_type": "apk", "build_id": "string", "checksum": "string", "created_at": 0, "expires_at": 0, "file_path": "string", "file_size": 0, "id": "string", "metadata": {}, "name": "string", "state": "string" }}Authorization
bearer_auth In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/runners/string/jobs/string/artifacts/string/complete" \ -H "Content-Type: application/json" \ -d '{}'{ "artifact": { "artifact_type": "apk", "build_id": "string", "checksum": "string", "created_at": 0, "expires_at": 0, "file_path": "string", "file_size": 0, "id": "string", "metadata": {}, "name": "string", "state": "string" }}curl -X GET "https://example.com/v1/tester-groups"{ "groups": [ { "created_at": 0, "id": "string", "members": [ { "email": "string", "name": "string", "user_id": "string" } ], "name": "string", "updated_at": 0 } ]}Authorization
bearer_auth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/tester-groups" \ -H "Content-Type: application/json" \ -d '{ "member_user_ids": [ "string" ], "name": "string" }'{ "created_at": 0, "id": "string", "members": [ { "email": "string", "name": "string", "user_id": "string" } ], "name": "string", "updated_at": 0}Authorization
bearer_auth In: header
Path Parameters
Group ID
Response Body
application/json
application/json
curl -X DELETE "https://example.com/v1/tester-groups/string"Authorization
bearer_auth In: header
Path Parameters
Group ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/tester-groups/string" \ -H "Content-Type: application/json" \ -d '{ "member_user_ids": [ "string" ], "name": "string" }'{ "created_at": 0, "id": "string", "members": [ { "email": "string", "name": "string", "user_id": "string" } ], "name": "string", "updated_at": 0}Authorization
bearer_auth In: header
Query Parameters
This browser's push endpoint, to report whether it is subscribed.
Response Body
application/json
curl -X GET "https://example.com/v1/web-push/config"{ "public_key": "string", "subscribed": true}Authorization
bearer_auth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/web-push/subscriptions" \ -H "Content-Type: application/json" \ -d '{ "auth": "string", "endpoint": "string", "p256dh": "string" }'curl -X POST "https://example.com/v1/web-push/test"Authorization
bearer_auth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "https://example.com/v1/web-push/unsubscribe" \ -H "Content-Type: application/json" \ -d '{ "endpoint": "string" }'