Skip to content
sgp
API Reference

Deploy

Deploy a built agent image
deploy.create(DeployCreateParams**kwargs) -> AgentexCloudDeploy
POST/v5/agentex/deployments
Get an agent deployment
deploy.retrieve(strdeployment_id) -> AgentexCloudDeploy
GET/v5/agentex/deployments/{deployment_id}
List agent deployments
deploy.list(DeployListParams**kwargs) -> SyncCursorPage[AgentexCloudDeploy]
GET/v5/agentex/deployments
Get agent deployment logs
deploy.logs(strdeployment_id, DeployLogsParams**kwargs) -> DeployLogsResponse
GET/v5/agentex/deployments/{deployment_id}/logs
Delete and tear down a deployment
deploy.delete(strdeployment_id) -> AgentexCloudDeploy
DELETE/v5/agentex/deployments/{deployment_id}
ModelsExpand Collapse
class AgentexCloudDeploy: …
id: str

The unique identifier of the deployment.

account_id: str

The ID of the account that owns the given entity.

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"]]
environment_config: str

YAML content of environment configuration from the environment config file.

manifest_file: str

YAML content of manifest configuration.

namespace: str

Kubernetes namespace where the deployment is deployed.

status: str

Deployment status: pending, running, completed, failed, or cancelled.

build_id: Optional[str]

The build_id of the cloud build that produced the deployed image.

deploy_events: Optional[List[AgentexCloudDeployEvent]]

Kubernetes events for this deployment.

message: Optional[str]

Full event message.

reason: Optional[str]

Short reason, e.g. ‘Pulling’, ‘Scheduled’.

timestamp: Optional[datetime]

When the event was observed.

formatdate-time
type: Optional[str]

Event type, e.g. ‘Normal’ or ‘Warning’.

expires_at: Optional[datetime]

When this deployment will be cleaned up. Always set on preview deployments (defaults to 8 hours from creation if the request omits it). Null on non-preview deployments — they have no TTL.

formatdate-time
helm_release_name: Optional[str]

Helm release name after successful deployment.

object: Optional[Literal["agentex_cloud_deploy"]]
preview_label: Optional[str]

Non-unique grouping label for preview deployments. Filter ?preview_label=X&limit=1 returns the latest deploy for the label. Sanitized (lowercase alphanumeric + hyphens) and capped at 30 characters.

class AgentexCloudDeployEvent: …

Slim event representation for the API response.

message: Optional[str]

Full event message.

reason: Optional[str]

Short reason, e.g. ‘Pulling’, ‘Scheduled’.

timestamp: Optional[datetime]

When the event was observed.

formatdate-time
type: Optional[str]

Event type, e.g. ‘Normal’ or ‘Warning’.

class DeployLogsResponse: …

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

The CLI can poll this endpoint to stream logs incrementally:

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

The deployment ID

has_more: bool

True if there may be more lines beyond this page (len(lines) == limit).

lines: Optional[List[Line]]

Structured log lines

id: str

Unique log line identifier (time-ordered)

message: str

Log line content after the K8s timestamp

log_level: Optional[str]

Parsed log level (INFO, ERROR, WARN, DEBUG, FATAL)

timestamp: Optional[datetime]

Parsed K8s log timestamp

formatdate-time
next_cursor: Optional[str]

Cursor for the next page. Pass this as the after_id query parameter to get subsequent logs.