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

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.

Parameters

build_id: str

Returns

StreamChunk

line: str

The log line content

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
)
stream_chunk = client.build.logs(
    "build_id",
)
print(stream_chunk.line)

200Example

{
  "line": "line"
}

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.