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

client.build.retrieve() ->

BuildRetrieveResponse

get/v5/builds/{build_id}

Get a build by ID, including current status from the cloud provider.

client.build.list() -> SyncCursorPage[

BuildListResponse

]

get/v5/builds

List Builds

Parameters

ending_before: Optional[str]

limit: Optional[int]

(maximum: 10000, minimum: 1, default: 100)

sort_by: Optional[str]

sort_order: Optional[Literal["asc", "desc"]]

(default: "asc")

"asc"

"desc"

starting_after: Optional[str]

Returns

class BuildListResponse:

account_id: str

build_id: str

created_at:

datetime

(format: date-time)

created_by:

Identity

The identity that created the entity.

image_name: str

image_tag: str

image_url: str

status: str

The current build status from the cloud provider

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

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
)
page = client.build.list()
page = page.items[0]
print(page.account_id)

200Example

{
  "has_more": true,
  "items": [
    {
      "account_id": "account_id",
      "build_id": "build_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "image_name": "image_name",
      "image_tag": "image_tag",
      "image_url": "image_url",
      "status": "status",
      "build_end_time": "2019-12-27T18:11:19.117Z",
      "build_start_time": "2019-12-27T18:11:19.117Z",
      "object": "agentex_cloud_build"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

client.build.logs() ->

StreamChunk

get/v5/builds/{build_id}/logs

Stream build logs via Server-Sent Events (SSE).

Returns a streaming response with content-type text/event-stream. Each log line is sent as an SSE data event.

client.build.cancel() ->

BuildCancelResponse

post/v5/builds/{build_id}/cancel

Cancel a pending or running build.

Domain types

class StreamChunk: ...

A single log line from the build process.