Skip to content
sgp
API Reference

Build

Submit container image build
build.create(BuildCreateParams**kwargs) -> AgentexCloudBuild
POST/v5/builds
Get a build
build.retrieve(strbuild_id) -> AgentexCloudBuild
GET/v5/builds/{build_id}
List container image builds
build.list(BuildListParams**kwargs) -> SyncCursorPage[AgentexCloudBuild]
GET/v5/builds
Stream build logs
build.logs(strbuild_id) -> StreamChunk
GET/v5/builds/{build_id}/logs
Cancel a build
build.cancel(strbuild_id) -> AgentexCloudBuild
POST/v5/builds/{build_id}/cancel
List agents built but not deployed
build.list_undeployed() -> BuildListUndeployedResponse
GET/v5/builds/undeployed
ModelsExpand Collapse
class AgentexCloudBuild: …
id: str

The unique identifier of the entity.

account_id: str

The ID of the account that owns the given entity.

agent_name: str

The name of the agent that this build belongs to

build_status: Literal["queued", "running", "success", 8 more]

The current build lifecycle status

One of the following:
"queued"
"running"
"success"
"failed"
"cancelling"
"cancelled"
"deleting"
"delete_failed"
"timed_out"
"error"
"unknown"
cloud_provider_build_id: str

The unique identifier of the build from the cloud provider, or an internal UUID when an existing image is copied without a provider build.

created_at: datetime

The date and time when the entity was created in ISO format.

formatdate-time
created_by: Identity

The identity that created the entity.

id: str
type: Literal["user", "service_account"]
One of the following:
"user"
"service_account"
object: Optional[Literal["identity"]]
image_name: str

The name of the container image to build.

image_tag: str

The tag for the container image.

source_commit: Optional[str]

Git commit the build context was at, when a git work tree.

source_dirty: Optional[bool]

Whether the work tree had uncommitted changes at build time (null outside git).

source_ref: Optional[str]

Git branch or tag for source_commit, when resolvable.

source_repo: Optional[str]

Normalized git remote the build context came from (host/path, no credentials).

source_subpath: Optional[str]

Build-context path relative to the repo root (which agent, in a monorepo).

working_tree_hash: Optional[str]

Deterministic SHA-256 content hash of the build inputs (not the tarball).

agent_id: Optional[str]

The UUID of the agent that this build belongs to

build_end_time: Optional[datetime]

When the cloud provider finished the build

formatdate-time
build_start_time: Optional[datetime]

When the cloud provider started the build

formatdate-time
image_url: Optional[str]

The URL of the container image. This is not guaranteed to be present until the build is complete.

object: Optional[Literal["agentex_cloud_build"]]
class StreamChunk: …

A single log line from the build process.

line: str

The log line content

List[BuildListUndeployedResponseItem]
agent_name: str

The agent name from cloud builds

latest_build: AgentexCloudBuild

The most recent cloud build for this agent

id: str

The unique identifier of the entity.

account_id: str

The ID of the account that owns the given entity.

agent_name: str

The name of the agent that this build belongs to

build_status: Literal["queued", "running", "success", 8 more]

The current build lifecycle status

One of the following:
"queued"
"running"
"success"
"failed"
"cancelling"
"cancelled"
"deleting"
"delete_failed"
"timed_out"
"error"
"unknown"
cloud_provider_build_id: str

The unique identifier of the build from the cloud provider, or an internal UUID when an existing image is copied without a provider build.

created_at: datetime

The date and time when the entity was created in ISO format.

formatdate-time
created_by: Identity

The identity that created the entity.

id: str
type: Literal["user", "service_account"]
One of the following:
"user"
"service_account"
object: Optional[Literal["identity"]]
image_name: str

The name of the container image to build.

image_tag: str

The tag for the container image.

source_commit: Optional[str]

Git commit the build context was at, when a git work tree.

source_dirty: Optional[bool]

Whether the work tree had uncommitted changes at build time (null outside git).

source_ref: Optional[str]

Git branch or tag for source_commit, when resolvable.

source_repo: Optional[str]

Normalized git remote the build context came from (host/path, no credentials).

source_subpath: Optional[str]

Build-context path relative to the repo root (which agent, in a monorepo).

working_tree_hash: Optional[str]

Deterministic SHA-256 content hash of the build inputs (not the tarball).

agent_id: Optional[str]

The UUID of the agent that this build belongs to

build_end_time: Optional[datetime]

When the cloud provider finished the build

formatdate-time
build_start_time: Optional[datetime]

When the cloud provider started the build

formatdate-time
image_url: Optional[str]

The URL of the container image. This is not guaranteed to be present until the build is complete.

object: Optional[Literal["agentex_cloud_build"]]
total_builds: int

Total number of builds for this agent