Documentation | Deploy

Deploy

DeployResource

Methods

client.deploy.create() ->

AgentexCloudDeploy

post/v5/agentex/deployments

Create a new deployment.

Submits a deployment request. The deployment will:

Parse and merge configuration files
Create a Kubernetes Job running helm install
Wait for deployment completion
Return results

client.deploy.retrieve() ->

AgentexCloudDeploy

get/v5/agentex/deployments/{deployment_id}

Get a deployment by its ID.

client.deploy.list() -> SyncCursorPage[

AgentexCloudDeploy

]

get/v5/agentex/deployments

List all deployments with pagination and optional filters.

Parameters

agent_name: Optional[str]

Filter deployments by agent name (via associated build)

build_id: Optional[str]

Filter deployments by build ID

ending_before: Optional[str]

limit: Optional[int]

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

preview_label: Optional[str]

Filter deployments by preview label (e.g. branch name). The label is non-unique — many deployments can share it. Combine with limit=1 to get the latest deploy for that label.

sort_by: Optional[str]

sort_order: Optional[

SortOrder

]

starting_after: Optional[str]

Returns

AgentexCloudDeploy

id: str

account_id: str

created_at:

datetime

(format: date-time)

created_by:

Identity

The identity that created the entity.

environment_config: str

manifest_file: str

namespace: str

status: str

build_id: Optional[str]

deploy_events: Optional[List[

AgentexCloudDeployEvent

]]

Kubernetes events for this deployment.

expires_at: Optional[datetime]

(format: date-time)

helm_release_name: Optional[str]

object: Optional[Literal["agentex_cloud_deploy"]]

(default: "agentex_cloud_deploy")

preview_label: Optional[str]

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.deploy.list()
page = page.items[0]
print(page.id)

200Example

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "environment_config": "environment_config",
      "manifest_file": "manifest_file",
      "namespace": "namespace",
      "status": "status",
      "build_id": "build_id",
      "deploy_events": [
        {
          "message": "message",
          "reason": "reason",
          "timestamp": "2019-12-27T18:11:19.117Z",
          "type": "type"
        }
      ],
      "expires_at": "2019-12-27T18:11:19.117Z",
      "helm_release_name": "helm_release_name",
      "object": "agentex_cloud_deploy",
      "preview_label": "preview_label"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

client.deploy.logs(, ) ->

DeployLogsResponse

get/v5/agentex/deployments/{deployment_id}/logs

Get structured log lines for a deployment with cursor-based pagination.

The CLI can poll this endpoint to stream logs incrementally:

First call: no cursor
Subsequent calls: cursor=next_cursor from the previous response
Stop polling when the deployment reaches a terminal status

client.deploy.delete() ->

AgentexCloudDeploy

delete/v5/agentex/deployments/{deployment_id}

Soft-delete a deployment. Marks it as deleted and triggers K8s resource cleanup.

Domain types

class AgentexCloudDeploy: ...

class AgentexCloudDeployEvent: ...

Slim event representation for the API response.

class DeployLogsResponse: ...

Response containing structured deployment log lines with cursor-based pagination.

The CLI can poll this endpoint to stream logs incrementally:

First call: no after_id
Subsequent calls: after_id=next_cursor from previous response
Stop polling when has_more is False and the deployment reaches a terminal status