Skip to content

Build

Submit container image build
client.build.create(BuildCreateParams { image_name, agent_id, agent_name, 11 more } body, RequestOptionsoptions?): AgentexCloudBuild { id, account_id, agent_name, 17 more }
POST/v5/builds
Get a build
client.build.retrieve(stringbuildID, RequestOptionsoptions?): AgentexCloudBuild { id, account_id, agent_name, 17 more }
GET/v5/builds/{build_id}
List container image builds
client.build.list(BuildListParams { agent_name, ending_before, limit, 5 more } query?, RequestOptionsoptions?): CursorPage<AgentexCloudBuild { id, account_id, agent_name, 17 more } >
GET/v5/builds
Stream build logs
client.build.logs(stringbuildID, RequestOptionsoptions?): StreamChunk { line } | Stream<StreamChunk { line } >
GET/v5/builds/{build_id}/logs
Cancel a build
client.build.cancel(stringbuildID, RequestOptionsoptions?): AgentexCloudBuild { id, account_id, agent_name, 17 more }
POST/v5/builds/{build_id}/cancel
List agents built but not deployed
client.build.listUndeployed(RequestOptionsoptions?): BuildListUndeployedResponse { agent_name, latest_build, total_builds }
GET/v5/builds/undeployed
ModelsExpand Collapse
AgentexCloudBuild { id, account_id, agent_name, 17 more }
id: string

The unique identifier of the entity.

account_id: string

The ID of the account that owns the given entity.

agent_name: string

The name of the agent that this build belongs to

build_status: "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: string

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: string

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

formatdate-time
created_by: Identity { id, type, object }

The identity that created the entity.

id: string
type: "user" | "service_account"
One of the following:
"user"
"service_account"
object?: "identity"
image_name: string

The name of the container image to build.

image_tag: string

The tag for the container image.

source_commit: string | null

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

source_dirty: boolean | null

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

source_ref: string | null

Git branch or tag for source_commit, when resolvable.

source_repo: string | null

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

source_subpath: string | null

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

working_tree_hash: string | null

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

agent_id?: string

The UUID of the agent that this build belongs to

build_end_time?: string

When the cloud provider finished the build

formatdate-time
build_start_time?: string

When the cloud provider started the build

formatdate-time
image_url?: string

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

object?: "agentex_cloud_build"
StreamChunk { line }

A single log line from the build process.

line: string

The log line content

BuildListUndeployedResponse = Array<BuildListUndeployedResponseItem>
agent_name: string

The agent name from cloud builds

latest_build: AgentexCloudBuild { id, account_id, agent_name, 17 more }

The most recent cloud build for this agent

id: string

The unique identifier of the entity.

account_id: string

The ID of the account that owns the given entity.

agent_name: string

The name of the agent that this build belongs to

build_status: "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: string

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: string

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

formatdate-time
created_by: Identity { id, type, object }

The identity that created the entity.

id: string
type: "user" | "service_account"
One of the following:
"user"
"service_account"
object?: "identity"
image_name: string

The name of the container image to build.

image_tag: string

The tag for the container image.

source_commit: string | null

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

source_dirty: boolean | null

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

source_ref: string | null

Git branch or tag for source_commit, when resolvable.

source_repo: string | null

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

source_subpath: string | null

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

working_tree_hash: string | null

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

agent_id?: string

The UUID of the agent that this build belongs to

build_end_time?: string

When the cloud provider finished the build

formatdate-time
build_start_time?: string

When the cloud provider started the build

formatdate-time
image_url?: string

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

object?: "agentex_cloud_build"
total_builds: number

Total number of builds for this agent