API Reference

Upload a Build

POST https://api.copilot.mobile.dev/v2/project/{id}/build

This endpoint should be used to upload a mobile application (.apk for Android, .zip for iOS). The response includes the unique identifier of the build (build ID), used for other APIs.

You can also include a list of tags (separated by comma ,) to add to the build.

Header Parameters

Name	Type	Value
Content-Length	integer	The size in bytes of the file
Content-Type	string	multipart/form-data
Content-Disposition	string	Content disposition with valid filename ending in .zip or .apk Example: form-data; name="file"; filename="filename.apk"

Path Parameters

Name	Type	Value
id	string	The project ID (Prefixed with proj_)

Request Body

Single file in its binary format:

"file": Binary file

Additional form values:

"tags": List of tags for that build separated by comma

Examples

cURL

curl https://api.copilot.mobile.dev/v2/project/proj_01hrv/build \
    -F "file=@/path/to/app/android.apk" \
    -F "tags=tag1,tag2,tag3" \
    -u ":" 

Node.js

const axios = require('axios');
const fs = require('fs');
const FormData = require('form-data');

const fileStream = fs.createReadStream('/path/to/app/android.apk');
const apiKey = 'sk_live_3afBO...1ewM';
const tags = 'tag1,tag2,tag3'; 
const projectId = 'proj_0h1rv';

const form = new FormData();
form.append('file', fileStream);
form.append('tags', tags);

axios.post(`https://api.copilot.mobile.dev/v2/project/${projectId}/build`, form, {
  auth: { username: apiKey, password: '' },
  headers: {
    ...form.getHeaders(),
  }
})
.then(response => console.log('Response:', response.data))
.catch(error => console.error('Error:', error.response?.data || error));

Python

import requests

file_path = 'path/to/app/android.apk'
api_key = ''
tags = 'tag1,tag2,tag3'
project_id = 'proj_01hrv'

response = requests.post(f'https://api.copilot.mobile.dev/v2/project/{project_id}/build', 
  files={'file': open(file_path, 'rb')},
  data={'tags': tags},
  auth=(api_key, '')
)

print('Response:', response.json())

Responses

200: OK

{
  "id": "bd_01hq3arydfenz9s3f0ytd7yv3k"
}

413: Payload too large

File is larger than 650MB. If this is your case, contact us.

---

Triggering a Test Suite

POST https://api.copilot.mobile.dev/v2/project/{id}/run

This endpoint should be used to trigger all the Test Cases of a given Test Suite with a specified build, if there is any test case already running it will stop and start a new test run. The response includes the unique identifier of each test case (Test Case ID), alongside either the Run ID in case of success or an error if it failed for any reason.

To specify the build you can either use the Build ID or a Build Tag. If the Tag is used, the most recent build of that Tag will be used.

Path Parameters

Name	Type	Value
id	string	The project ID (Prefixed with proj_)

Request Body

The request body is a JSON format with the following parameters

Name	Type	Value
testSuiteId	string	The Test Suite ID (Prefixed with ts_)
buildTag	string	A Build Tag specified when a build was uploaded. Cannot be used with buildId
buildId	string	The Build ID (Prefixed with bd_). Cannot be used with buildTag

Request Body Example:

{
  "buildTag": "nightly"
  "testSuiteId": "ts_01h3w"
}

Examples

cURL

curl https://api.copilot.mobile.dev/v2/project/proj_01hrv/run \
    -d '{
        "buildTag": "nightly",
        "testSuiteId": "ts_01hv2"
    }' \
    -u "sk_live_3afBO...1ewM:" \
    -H "Content-Type: application/json"

Node.js

const axios = require('axios');

const apiKey = 'sk_live_3afBO...1ewM';
const projectId = 'proj_01hrv';
const tag = 'nightly';
const testSuiteId = 'ts_01hv2';

axios.post(`https://api.copilot.mobile.dev/v2/project/${projectId}/run`, {
  buildTag: tag,
  testSuiteId: testSuiteId
}, {
  auth: { username: apiKey, password: '' }
})
.then(response => console.log('Response:', response.data))
.catch(error => console.error('Error:', error.response?.data || error));

Python

import requests

api_key = 'sk_live_3afBO...1ewM'
project_id = 'proj_01hrv'
tag = 'nightly'
test_suite_id = 'ts_01hv2'

response = requests.post(f'https://api.copilot.mobile.dev/v2/project/{project_id}/run',
                         json={'buildTag': tag, 'testSuiteId': test_suite_id},
                         auth=(api_key, ''))

print('Response:', response.json())

Responses

200: OK

{
  "testCases": [
    {
      "id": "req_01hq1cdv3tevtrm4h3he9bp0hq",
      "runId": "run_01hq3f70fxeb1bx2esmpqq8fmr",
      "status": "PENDING"
    },
    {
      "id": "run_02fq3vdc8vktemh1a2gpa3910b",
      "error": "Quota exceeded (max_runs_per_month)"
    }
  ]
}