Skip to main content
POST
/
v5
/
builds
Submit Build
curl --request POST \
  --url https://api.egp.scale.com/v5/builds \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form context_archive='@example-file' \
  --form 'image_name=<string>' \
  --form 'agent_name=<string>' \
  --form 'agent_id=<string>' \
  --form image_tag=latest \
  --form 'build_args=<string>'
{
  "id": "<string>",
  "cloud_provider_build_id": "<string>",
  "agent_name": "<string>",
  "image_name": "<string>",
  "image_tag": "<string>",
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "<string>",
    "object": "identity"
  },
  "object": "agentex_cloud_build",
  "agent_id": "<string>",
  "image_url": "<string>",
  "build_start_time": "2023-11-07T05:31:56Z",
  "build_end_time": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

Body

multipart/form-data
​
context_archive
file
required

tar.gz archive containing the build context (Dockerfile and any files needed for the build)

​
image_name
string
required

Name for the built image

​
agent_name
string

Name of the brand-new agent to create from this build

​
agent_id
string

ID of the existing agent this build targets

​
image_tag
string
default:latest

Tag for the built image

​
build_args
string

JSON string of build arguments

​
platform
enum<string>

Target platform for the Docker build. Defaults to the build host's native architecture when not specified.

Available options:
linux/amd64,
linux/arm64,
linux/arm/v7

Response

Successful Response

​
id
string
required
​
cloud_provider_build_id
string
required
​
agent_name
string
required
​
image_name
string
required
​
image_tag
string
required
​
build_status
enum<string>
required

The current build lifecycle status

Available options:
queued,
running,
success,
failed,
cancelling,
cancelled,
deleting,
delete_failed,
timed_out,
error,
unknown
​
account_id
string
required
​
created_at
string<date-time>
required
​
created_by
Identity · object
required

The identity that created the entity.

​
object
string
default:agentex_cloud_build
Allowed value: "agentex_cloud_build"
​
agent_id
string
​
image_url
string
​
build_start_time
string<date-time>

When the cloud provider started the build

​
build_end_time
string<date-time>

When the cloud provider finished the build