Skip to main content
POST
Deploy agent

Authorizations

Authorization
string
header
default:<auth-token>
required

Your API token, sent raw (no Bearer prefix).

Path Parameters

agentId
string
required

Body

application/json
name
string
Example:

"Support Agent Deployment"

region
string

Where to run the agent. A new agent starts in the default region.

Example:

"in002"

profile
string
Example:

"cpu-small"

minReplica
integer
Example:

0

maxReplica
integer
Example:

1

Response

Deployment accepted.

agentId
string
Example:

"ag_7f2c91"

name
string
Example:

"Support Agent"

status
enum<string>

active once deployed. A new agent stays inactive only if its first deploy couldn't run, for example when the account has no active API key. Call Deploy agent yourself then.

Available options:
inactive,
active
Example:

"active"

deploymentId
string
Example:

"dp_44b1e0"

createdAt
string<date-time>
updatedAt
string<date-time>