更新 Deployment

curl --request POST \
  --url https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'zai-beta: <zai-beta>' \
  --header 'zai-version: <zai-version>' \
  --data '
{
  "name": "<string>",
  "agent": "<string>",
  "environment_id": "<string>",
  "schedule": {
    "type": "cron",
    "expression": "0 9 * * 1-5",
    "timezone": "Asia/Shanghai"
  },
  "initial_events": [
    {
      "type": "user.message",
      "content": [
        {
          "type": "text",
          "text": "<string>"
        }
      ]
    }
  ],
  "description": "<string>",
  "metadata": {},
  "vault_ids": [
    "<string>"
  ],
  "resources": [
    {
      "type": "memory_store",
      "memory_store_id": "<string>",
      "access": "read_write",
      "instructions": "<string>"
    }
  ]
}
'

import requests

url = "https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId}"

payload = {
    "name": "<string>",
    "agent": "<string>",
    "environment_id": "<string>",
    "schedule": {
        "type": "cron",
        "expression": "0 9 * * 1-5",
        "timezone": "Asia/Shanghai"
    },
    "initial_events": [
        {
            "type": "user.message",
            "content": [
                {
                    "type": "text",
                    "text": "<string>"
                }
            ]
        }
    ],
    "description": "<string>",
    "metadata": {},
    "vault_ids": ["<string>"],
    "resources": [
        {
            "type": "memory_store",
            "memory_store_id": "<string>",
            "access": "read_write",
            "instructions": "<string>"
        }
    ]
}
headers = {
    "zai-version": "<zai-version>",
    "zai-beta": "<zai-beta>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'zai-version': '<zai-version>',
    'zai-beta': '<zai-beta>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    agent: '<string>',
    environment_id: '<string>',
    schedule: {type: 'cron', expression: '0 9 * * 1-5', timezone: 'Asia/Shanghai'},
    initial_events: [{type: 'user.message', content: [{type: 'text', text: '<string>'}]}],
    description: '<string>',
    metadata: {},
    vault_ids: ['<string>'],
    resources: [
      {
        type: 'memory_store',
        memory_store_id: '<string>',
        access: 'read_write',
        instructions: '<string>'
      }
    ]
  })
};

fetch('https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId}")
  .header("zai-version", "<zai-version>")
  .header("zai-beta", "<zai-beta>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"agent\": \"<string>\",\n  \"environment_id\": \"<string>\",\n  \"schedule\": {\n    \"type\": \"cron\",\n    \"expression\": \"0 9 * * 1-5\",\n    \"timezone\": \"Asia/Shanghai\"\n  },\n  \"initial_events\": [\n    {\n      \"type\": \"user.message\",\n      \"content\": [\n        {\n          \"type\": \"text\",\n          \"text\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"metadata\": {},\n  \"vault_ids\": [\n    \"<string>\"\n  ],\n  \"resources\": [\n    {\n      \"type\": \"memory_store\",\n      \"memory_store_id\": \"<string>\",\n      \"access\": \"read_write\",\n      \"instructions\": \"<string>\"\n    }\n  ]\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"agent\": \"<string>\",\n  \"environment_id\": \"<string>\",\n  \"schedule\": {\n    \"type\": \"cron\",\n    \"expression\": \"0 9 * * 1-5\",\n    \"timezone\": \"Asia/Shanghai\"\n  },\n  \"initial_events\": [\n    {\n      \"type\": \"user.message\",\n      \"content\": [\n        {\n          \"type\": \"text\",\n          \"text\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"metadata\": {},\n  \"vault_ids\": [\n    \"<string>\"\n  ],\n  \"resources\": [\n    {\n      \"type\": \"memory_store\",\n      \"memory_store_id\": \"<string>\",\n      \"access\": \"read_write\",\n      \"instructions\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("zai-version", "<zai-version>")
	req.Header.Add("zai-beta", "<zai-beta>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'agent' => '<string>',
    'environment_id' => '<string>',
    'schedule' => [
        'type' => 'cron',
        'expression' => '0 9 * * 1-5',
        'timezone' => 'Asia/Shanghai'
    ],
    'initial_events' => [
        [
                'type' => 'user.message',
                'content' => [
                                [
                                                                'type' => 'text',
                                                                'text' => '<string>'
                                ]
                ]
        ]
    ],
    'description' => '<string>',
    'metadata' => [
        
    ],
    'vault_ids' => [
        '<string>'
    ],
    'resources' => [
        [
                'type' => 'memory_store',
                'memory_store_id' => '<string>',
                'access' => 'read_write',
                'instructions' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "zai-beta: <zai-beta>",
    "zai-version: <zai-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "<string>",
  "type": "deployment",
  "name": "<string>",
  "agent": {
    "type": "agent",
    "id": "<string>",
    "version": 1
  },
  "environment_id": "<string>",
  "description": "<string>",
  "metadata": {},
  "resources": [
    {
      "type": "memory_store",
      "memory_store_id": "<string>",
      "access": "read_write",
      "instructions": "<string>"
    }
  ],
  "schedule": {
    "type": "cron",
    "expression": "<string>",
    "timezone": "Asia/Shanghai",
    "last_run_at": "<string>",
    "upcoming_runs_at": [
      "2023-11-07T05:31:56Z"
    ]
  },
  "initial_events": [
    {
      "type": "user.message",
      "content": [
        {
          "type": "text",
          "text": "<string>"
        }
      ]
    }
  ],
  "status": "active",
  "paused_reason": {
    "type": "manual"
  },
  "vault_ids": [
    "<string>"
  ],
  "archived_at": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "<string>",
    "details": {}
  },
  "request_id": "req_01J..."
}

Deployment

更新 Deployment

更新指定 Deployment 的可变配置。支持 name、description、metadata、initial_events、environment_id、vault_ids、resources、schedule 和 agent；agent 只能重新固定同一个 Agent 的版本或覆盖配置，不能切换 Agent ID。schedule: null 会改为仅手动触发，resources: null 和 metadata: null 会清空对应配置，environment_id: null 会保留原值。已归档 Deployment 不可更新。点击 Try it 按钮可快速试用。

POST

agent

managed

deployments

{deploymentId}

更新 Deployment

curl --request POST \
  --url https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'zai-beta: <zai-beta>' \
  --header 'zai-version: <zai-version>' \
  --data '
{
  "name": "<string>",
  "agent": "<string>",
  "environment_id": "<string>",
  "schedule": {
    "type": "cron",
    "expression": "0 9 * * 1-5",
    "timezone": "Asia/Shanghai"
  },
  "initial_events": [
    {
      "type": "user.message",
      "content": [
        {
          "type": "text",
          "text": "<string>"
        }
      ]
    }
  ],
  "description": "<string>",
  "metadata": {},
  "vault_ids": [
    "<string>"
  ],
  "resources": [
    {
      "type": "memory_store",
      "memory_store_id": "<string>",
      "access": "read_write",
      "instructions": "<string>"
    }
  ]
}
'

import requests

url = "https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId}"

payload = {
    "name": "<string>",
    "agent": "<string>",
    "environment_id": "<string>",
    "schedule": {
        "type": "cron",
        "expression": "0 9 * * 1-5",
        "timezone": "Asia/Shanghai"
    },
    "initial_events": [
        {
            "type": "user.message",
            "content": [
                {
                    "type": "text",
                    "text": "<string>"
                }
            ]
        }
    ],
    "description": "<string>",
    "metadata": {},
    "vault_ids": ["<string>"],
    "resources": [
        {
            "type": "memory_store",
            "memory_store_id": "<string>",
            "access": "read_write",
            "instructions": "<string>"
        }
    ]
}
headers = {
    "zai-version": "<zai-version>",
    "zai-beta": "<zai-beta>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'zai-version': '<zai-version>',
    'zai-beta': '<zai-beta>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    agent: '<string>',
    environment_id: '<string>',
    schedule: {type: 'cron', expression: '0 9 * * 1-5', timezone: 'Asia/Shanghai'},
    initial_events: [{type: 'user.message', content: [{type: 'text', text: '<string>'}]}],
    description: '<string>',
    metadata: {},
    vault_ids: ['<string>'],
    resources: [
      {
        type: 'memory_store',
        memory_store_id: '<string>',
        access: 'read_write',
        instructions: '<string>'
      }
    ]
  })
};

fetch('https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId}")
  .header("zai-version", "<zai-version>")
  .header("zai-beta", "<zai-beta>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"agent\": \"<string>\",\n  \"environment_id\": \"<string>\",\n  \"schedule\": {\n    \"type\": \"cron\",\n    \"expression\": \"0 9 * * 1-5\",\n    \"timezone\": \"Asia/Shanghai\"\n  },\n  \"initial_events\": [\n    {\n      \"type\": \"user.message\",\n      \"content\": [\n        {\n          \"type\": \"text\",\n          \"text\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"metadata\": {},\n  \"vault_ids\": [\n    \"<string>\"\n  ],\n  \"resources\": [\n    {\n      \"type\": \"memory_store\",\n      \"memory_store_id\": \"<string>\",\n      \"access\": \"read_write\",\n      \"instructions\": \"<string>\"\n    }\n  ]\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"agent\": \"<string>\",\n  \"environment_id\": \"<string>\",\n  \"schedule\": {\n    \"type\": \"cron\",\n    \"expression\": \"0 9 * * 1-5\",\n    \"timezone\": \"Asia/Shanghai\"\n  },\n  \"initial_events\": [\n    {\n      \"type\": \"user.message\",\n      \"content\": [\n        {\n          \"type\": \"text\",\n          \"text\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"metadata\": {},\n  \"vault_ids\": [\n    \"<string>\"\n  ],\n  \"resources\": [\n    {\n      \"type\": \"memory_store\",\n      \"memory_store_id\": \"<string>\",\n      \"access\": \"read_write\",\n      \"instructions\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("zai-version", "<zai-version>")
	req.Header.Add("zai-beta", "<zai-beta>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://agent-api.bigmodel.cn/api/agent/managed/v1/deployments/{deploymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'agent' => '<string>',
    'environment_id' => '<string>',
    'schedule' => [
        'type' => 'cron',
        'expression' => '0 9 * * 1-5',
        'timezone' => 'Asia/Shanghai'
    ],
    'initial_events' => [
        [
                'type' => 'user.message',
                'content' => [
                                [
                                                                'type' => 'text',
                                                                'text' => '<string>'
                                ]
                ]
        ]
    ],
    'description' => '<string>',
    'metadata' => [
        
    ],
    'vault_ids' => [
        '<string>'
    ],
    'resources' => [
        [
                'type' => 'memory_store',
                'memory_store_id' => '<string>',
                'access' => 'read_write',
                'instructions' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "zai-beta: <zai-beta>",
    "zai-version: <zai-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "<string>",
  "type": "deployment",
  "name": "<string>",
  "agent": {
    "type": "agent",
    "id": "<string>",
    "version": 1
  },
  "environment_id": "<string>",
  "description": "<string>",
  "metadata": {},
  "resources": [
    {
      "type": "memory_store",
      "memory_store_id": "<string>",
      "access": "read_write",
      "instructions": "<string>"
    }
  ],
  "schedule": {
    "type": "cron",
    "expression": "<string>",
    "timezone": "Asia/Shanghai",
    "last_run_at": "<string>",
    "upcoming_runs_at": [
      "2023-11-07T05:31:56Z"
    ]
  },
  "initial_events": [
    {
      "type": "user.message",
      "content": [
        {
          "type": "text",
          "text": "<string>"
        }
      ]
    }
  ],
  "status": "active",
  "paused_reason": {
    "type": "manual"
  },
  "vault_ids": [
    "<string>"
  ],
  "archived_at": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "<string>",
    "details": {}
  },
  "request_id": "req_01J..."
}

Authorizations

Authorization

string

header

required

标准的 HTTP Bearer 认证方式，在 API Keys 页面获取密钥。

Headers

zai-version

enum<string>

default:2026-05-26

required

Managed Agents API 协议版本，固定为 2026-05-26。

Available options:

2026-05-26

Example:

"2026-05-26"

zai-beta

string

default:managed-agents-2026-05-26

required

必须包含 managed-agents-2026-05-26；可与其他 beta 标识用逗号分隔。

Example:

"managed-agents-2026-05-26"

Path Parameters

deploymentId

string

required

deploymentId 资源标识。

Body

application/json

name

string

替换名称；trim 后不能为空，省略时保持不变。

Minimum string length: 1

agent

重新固定同一个 Agent 的版本或覆盖配置；不得切换到其他 Agent。

Minimum string length: 1

environment_id

string | null

重新绑定 Environment。字符串值必须指向 Agent 所有者名下未归档的 Environment；传 null 会保留原值。

Maximum string length: 64

Pattern: ^env_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

schedule

object | null

替换调度；null 表示改为仅手动运行，省略时保持不变。

Show child attributes

initial_events

object[]

整体替换每次运行的初始消息；必须含 1–50 条 user.message。

Required array length: 1 - 50 elements

Show child attributes

description

string | null

替换用途说明；非字符串值（包括 null）会清空，省略时保持不变。

metadata

object | null

整体替换 metadata；null 表示清空，省略时保持不变。键名不超过 64 字符，值为不超过 512 字符的字符串。

Show child attributes

vault_ids

string[]

整体替换 Vault ID；省略时保持不变。

Maximum array length: 20

Minimum string length: 1

resources

(memory_store · object | file · object)[] | null

整体替换资源；null 表示清空，省略时保持不变。

memory_store
file

Show child attributes

Response

请求成功。

string

required

type

enum<string>

required

Available options:

deployment

name

string

required

agent

object

required

Show child attributes

environment_id

string

required

Deployment 绑定的 Environment ID。旧数据缺失该字段时可能返回内部兼容值 env_default。

description

string | null

required

用途说明。

metadata

object

required

客户端自定义元数据；省略时默认为空对象。最多 16 个键，键名长度不超过 64 字符，值必须是长度不超过 512 字符的字符串。

Show child attributes

resources

(memory_store · object | file · object)[]

required

memory_store
file

Show child attributes

schedule

object | null

required

Show child attributes

initial_events

object[]

required

Show child attributes

status

enum<string>

required

Available options:

active,

paused

paused_reason

manual · object

required

暂停原因。手动暂停返回 manual；因资源失效自动暂停时返回对应错误类型。

manual
error

Show child attributes

vault_ids

string[]

required

archived_at

string | null

required

归档时间。

created_at

string<date-time>

required

创建时间。

updated_at

string<date-time>

required

更新时间。

API 指引

模型 API

工具 API

Managed Agents API (Beta)

Agent API

文件 API

批处理 API

知识库 API

实时 API

更新 Deployment

Authorizations

Headers

Path Parameters

Body

Response