Skip to content
sgp
API Reference
Build

List agents built but not deployed

build.list_undeployed() -> BuildListUndeployedResponse
GET/v5/builds/undeployed

List agents that exist only as cloud builds and have no healthy deployment yet.

Unlike listing builds, this aggregates by agent: it returns one entry per distinct agent name whose builds have never reached a healthy deploy, each carrying that agent’s most recent build and its total build count. The result is a plain list (not paginated) and is limited to builds the caller is permitted to read. Use this to surface agents that were built but still need to be deployed; use GET /v5/builds when you need the individual build records instead.

ReturnsExpand Collapse
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

List agents built but not deployed

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
)
response = client.build.list_undeployed()
print(response)
[
  {
    "agent_name": "agent_name",
    "latest_build": {
      "id": "id",
      "account_id": "account_id",
      "agent_name": "agent_name",
      "build_status": "queued",
      "cloud_provider_build_id": "cloud_provider_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",
      "source_commit": "source_commit",
      "source_dirty": true,
      "source_ref": "source_ref",
      "source_repo": "source_repo",
      "source_subpath": "source_subpath",
      "working_tree_hash": "working_tree_hash",
      "agent_id": "agent_id",
      "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"
    },
    "total_builds": 0
  }
]
Returns Examples
[
  {
    "agent_name": "agent_name",
    "latest_build": {
      "id": "id",
      "account_id": "account_id",
      "agent_name": "agent_name",
      "build_status": "queued",
      "cloud_provider_build_id": "cloud_provider_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",
      "source_commit": "source_commit",
      "source_dirty": true,
      "source_ref": "source_ref",
      "source_repo": "source_repo",
      "source_subpath": "source_subpath",
      "working_tree_hash": "working_tree_hash",
      "agent_id": "agent_id",
      "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"
    },
    "total_builds": 0
  }
]