Documentation | Build

Build

BuildResource

Methods

client.build.create() ->

post/v5/builds

Submit a container image build.

Upload a tar.gz archive containing the build context (Dockerfile and any files needed for the build) along with image name, tag, and optional build arguments.

Maximum file size: 500MB

Parameters

context_archive: str

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

image_name: str

Name for the built image

build_args: Optional[str]

JSON string of build arguments

image_tag: Optional[str]

(default: "latest")

Tag for the built image

Returns

class BuildCreateResponse:

account_id: str

build_id: str

build_status: Literal["queued", "running", "success", "failed", "cancelling", "cancelled", "timed_out", "error", "unknown"]

The current build status from the cloud provider

created_at:

datetime

(format: date-time)

created_by:

Identity

The identity that created the entity.

image_name: str

image_tag: str

build_end_time: Optional[datetime]

(format: date-time)

When the cloud provider finished the build

build_start_time: Optional[datetime]

(format: date-time)

When the cloud provider started the build

image_url: Optional[str]

object: Optional[Literal["agentex_cloud_build"]]

(default: "agentex_cloud_build")

Request example

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
build = client.build.create(
    context_archive="context_archive",
    image_name="image_name",
)
print(build.account_id)

200Example

{
  "account_id": "account_id",
  "build_id": "build_id",
  "build_status": "queued",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "image_name": "image_name",
  "image_tag": "image_tag",
  "build_end_time": "2019-12-27T18:11:19.117Z",
  "build_start_time": "2019-12-27T18:11:19.117Z",
  "image_url": "image_url",
  "object": "agentex_cloud_build"
}