Skip to main content
POST
/
builds
Create a new Build
curl --request POST \
  --url https://api.emulator.farm/v1/builds \
  --header 'Content-Type: application/json' \
  --header 'X-EMULATOR-FARM-API-KEY: <api-key>' \
  --data '
{
  "name": "AOSP 14 Base Build",
  "version": "14.0.0-r1",
  "description": "Android 14 base build with Google Apps",
  "image_url": "https://storage.example.com/builds/aosp-14-base.img",
  "metadata": {}
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "AOSP 14 Base Build",
  "version": "14.0.0-r1",
  "status": "ready",
  "created_at": "2025-12-10T12:00:00Z",
  "updated_at": "2025-12-10T12:00:00Z",
  "description": "Android 14 base build with Google Apps",
  "image_url": "https://storage.example.com/builds/aosp-14-base.img",
  "metadata": {
    "android_version": "14",
    "api_level": "34",
    "architecture": "x86_64"
  }
}

Authorizations

​
X-EMULATOR-FARM-API-KEY
string
header
required

Body

application/json
​
name
string
required
Example:

"AOSP 14 Base Build"

​
version
string
required
Example:

"14.0.0-r1"

​
description
string | null
Example:

"Android 14 base build with Google Apps"

​
image_url
string<uri> | null
Example:

"https://storage.example.com/builds/aosp-14-base.img"

​
metadata
object

Response

Build created successfully

​
id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string
required
Example:

"AOSP 14 Base Build"

​
version
string
required
Example:

"14.0.0-r1"

​
status
enum<string>
required
Available options:
pending,
building,
ready,
failed
Example:

"ready"

​
created_at
string<date-time>
required
Example:

"2025-12-10T12:00:00Z"

​
updated_at
string<date-time>
required
Example:

"2025-12-10T12:00:00Z"

​
description
string | null
Example:

"Android 14 base build with Google Apps"

​
image_url
string<uri> | null
Example:

"https://storage.example.com/builds/aosp-14-base.img"

​
metadata
object
Example:
{
  "android_version": "14",
  "api_level": "34",
  "architecture": "x86_64"
}