Create Deployment
Updated at:
Creates a new Deployment, binding an Agent and configuring the trigger method. The request body carries the Agent reference, schedule, and initial events; the response returns the complete Deployment object.
Prerequisites
Endpoint and authentication configured. For details, see API overview and authentication.
Endpoint
POST /deployments
Request body
| Field | Required | Type | Description |
|---|---|---|---|
name | Yes | string | Deployment name, max 256 characters |
description | No | string | Description of the deployment purpose |
agent | Yes | object | Associated Agent |
environment_id | No | string | Associated Environment ID |
schedule | No | object | Scheduled trigger configuration; omit for manual trigger |
initial_events | Yes | array<object> | List of initial events sent to the Agent on trigger, 1-50 items |
resources | No | array<object> | List of mounted file resources |
vault_ids | No | array<string> | Associated Vault ID list |
metadata | No | object | Business custom key-value pairs |
Request example
curl -X POST "$AGENTSTUDIO_URL/deployments" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Daily order summary",
"agent": {
"id": "agent_xxx",
"version": 12
},
"environment_id": "env_xxx",
"schedule": {
"type": "cron",
"expression": "0 9 * * 1-5",
"timezone": "Asia/Shanghai"
},
"initial_events": [
{
"type": "message",
"role": "user",
"content": [
{
"type": "text",
"text": "Summarize order data from yesterday"
}
]
}
]
}'
Response
{
"id": "depl_xxx",
"type": "deployment",
"name": "Daily order summary",
"status": "active",
"agent": {
"id": "agent_xxx",
"version": 12
},
"environment_id": "env_xxx",
"schedule": {
"type": "cron",
"expression": "0 9 * * 1-5",
"timezone": "Asia/Shanghai",
"last_run_at": null,
"next_run_at": "2026-07-28T01:00:00Z"
},
"initial_events": [
{
"type": "message",
"role": "user",
"content": [
{
"type": "text",
"text": "Summarize order data from yesterday"
}
]
}
],
"resources": [],
"vault_ids": [],
"metadata": {},
"paused_reason": null,
"archived_at": null,
"created_at": "2026-07-28T01:00:00Z",
"updated_at": "2026-07-28T01:00:00Z",
"request_id": "req_xxx"
}
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Deployment ID |
type | string | Fixed value deployment |
name | string | Deployment name |
description | string | Description of the deployment purpose |
agent | object | — |
environment_id | string | — |
schedule | object | — |
initial_events | array<object> | — |
resources | array<object> | — |
vault_ids | array<string> | — |
metadata | object | — |
status | string | — |
paused_reason | object | null | Pause reason, returned only when the status is paused |
archived_at | string | null | — |
created_at | string | — |
updated_at | string | — |
request_id | string | Unique identifier of this request, include it when troubleshooting |
Error codes
| HTTP status | Error code | Description |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid. |
| 401 | InvalidApiKey | Invalid API-key provided. |
Is this page helpful?