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.

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

Parameters

deployment_id: str

cursor: Optional[str]

Cursor from previous response's next_cursor field

limit: Optional[int]

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

Maximum number of log lines to return

Returns

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

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

next_cursor: Optional[str]

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

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
)
response = client.deploy.logs(
    deployment_id="deployment_id",
)
print(response.deployment_id)

200Example

{
  "deployment_id": "deployment_id",
  "has_more": true,
  "lines": [
    {
      "id": "id",
      "message": "message",
      "log_level": "log_level",
      "timestamp": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_cursor": "next_cursor"
}

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