Skip to main content

Create an agent task

Creates a model task. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model's task.

Request Body REQUIRED
user_message_content REQUIRED

消息内容,字符串或内容项数组,工具协议兼容的 message_content(保留字段)。

stream boolean REQUIRED

是否启用流式(SSE)返回;true 则以 text/event-stream 推送 Task 事件。

structured_output object

期望的结构化输出 JSON Schema;仅非流式模式有效,流式模式下将被忽略。

client_id string

调用方客户端标识(如 AIME)。

request_id string

请求链路唯一 ID;便于将复杂调用串联在一起。

session_id string

会话 ID;用于跨多轮交互复用上下文。

task_id string

任务 ID;用于区分主任务与子任务。

user_id string

终端用户 ID。

agent_config object

The Agent configuration used by the server.

agent_id string REQUIRED

Agent 唯一标识(目录名)。

name string REQUIRED

Agent 名称。

description string REQUIRED

Agent 描述。

developer_prompt string REQUIRED

主系统提示词(开发者指令)。

code_for_agent string REQUIRED

注入到 Agent 侧的代码片段。

code_for_interpreter string REQUIRED

注入到代码解释器侧的代码片段。

allowed_tools string[]

默认允许使用的工具。

tool_mcp_config object

MCP 服务器配置(工具来源)。

model string REQUIRED

主模型名称。

max_model_length integer REQUIRED

模型上下文最大 tokens。

max_response_length integer REQUIRED

模型生成的最大 tokens。

compress_prompt string

上下文压缩时使用的系统提示词。

compress_model string

用于压缩上下文的模型名称。

compress_threshold_token_ratio number

触发上下文压缩的 token 比例阈值。

inference_args object

默认推理参数覆盖项。

builtin_tools object[]

内置工具集合(含 CodeInterpreter/Task 等)。

type string REQUIRED

Possible values: [function]

工具类型,此处固定为 function。

function object REQUIRED
name string REQUIRED

工具/函数名称(唯一标识)。

description string

函数的用途说明。

parameters object REQUIRED

JSON Schema for the function parameters.

strict boolean

是否启用严格参数校验。

code_interpreter_config object

代码解释器连接配置(Jupyter)。

builtin_subagents object[]

内置子代理列表(名称/工具/提示词等)。

allowed_tools string[]

允许使用的工具白名单;为 null 允许全部,空数组表示禁止所有。

disallowed_tools string[]

禁用的工具黑名单;为 null 或空数组不生效。

allowed_subagents string[]

允许使用的子代理白名单;为 null 允许全部,空数组禁止所有。

stop_tools string[]

命中则停止代理循环的工具名列表;为 null 或空数组不生效。

client_tools object[]

客户端自带工具定义;命中后会停止由服务端执行,等待客户端完成。

type string REQUIRED

Possible values: [function]

工具类型,此处固定为 function。

function object REQUIRED
name string REQUIRED

工具/函数名称(唯一标识)。

description string

函数的用途说明。

parameters object REQUIRED

JSON Schema for the function parameters.

strict boolean

是否启用严格参数校验。

history_messages object[]

历史对话消息,用于提供上下文。

thought_messages object[]

隐藏的助手思考内容(不可见思考轨迹),如有将并入上下文。

inference_args object

推理参数覆盖项(如温度、最大 tokens 等),具体字段由后端实现决定。

workspace_dir string

文件系统工作目录;供文件工具与代码解释器使用。

env object

Agent 的运行时环境变量键值对。

log_dir string

日志输出目录。

rollout_save_dir string

回溯(rollout)结果保存目录。

return_rollout boolean

是否在最终结果中返回 rollout 事件集合。

include_compress_model_rollout boolean

是否包含上下文压缩模型的 rollout 结果。

include_subagent_rollout boolean

是否包含子 Agent 的 rollout 结果。

Responses
200

OK

Schema OPTIONAL
jsonrpc string

JSON-RPC protocol version, always '2.0'.

id OPTIONAL

请求/响应 ID,由客户端生成或服务器透传;可为字符串、整数或 null。

result object OPTIONAL

The task object returned in JSON-RPC result.

object string

Possible values: [task]

固定为 task。

id string

任务 ID。

session_id string

会话 ID。

user_id string

用户 ID。

status string

Possible values: [created, queued, working, input-required, paused, completed, canceled, expired, failed]

任务生命周期状态。 CREATED:任务已创建但尚未开始。 QUEUED:任务已排队,等待处理。 WORKING:任务正在处理中。 INPUT_REQUIRED:任务需要额外输入以继续。 PAUSED:任务已暂停,需恢复后继续。 COMPLETED:任务已成功完成。 CANCELED:任务已取消,不会继续处理。 EXPIRED:任务已过期,不会继续处理。 FAILED:任务处理失败,不会重试。

常见情况:

  1. CREATED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED
  2. CREATED -> WORKING -> INPUT_REQUIRED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED
  3. CREATED -> WORKING -> PAUSED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED
  4. CREATED -> QUEUED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED
  5. CREATED -> QUEUED -> WORKING -> INPUT_REQUIRED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED
  6. CREATED -> QUEUED -> WORKING -> PAUSED -> WORKING -> COMPLETED|FAILED|CANCELED|EXPIRED

取消情况:

  1. CREATED -> CANCELED
  2. CREATED -> WORKING -> CANCELED
  3. CREATED -> QUEUED -> CANCELED
  4. CREATED -> QUEUED -> WORKING -> CANCELED
  5. CREATED -> QUEUED -> WORKING -> PAUSED -> CANCELED
  6. CREATED -> QUEUED -> WORKING -> INPUT_REQUIRED -> CANCELED

过期情况:

  1. CREATED -> WORKING -> EXPIRED
  2. CREATED -> WORKING -> INPUT_REQUIRED -> EXPIRED
  3. CREATED -> WORKING -> PAUSED -> EXPIRED
  4. CREATED -> QUEUED -> EXPIRED
  5. CREATED -> QUEUED -> WORKING -> EXPIRED
  6. CREATED -> QUEUED -> WORKING -> INPUT_REQUIRED -> EXPIRED
  7. CREATED -> QUEUED -> WORKING -> PAUSED -> EXPIRED
created_at integer

任务创建时间(Unix 秒)。

output object[]

模型/代理生成的输出条目集合(多类型)。

usage object OPTIONAL

token 用量统计信息。

error object OPTIONAL

JSON-RPC error object.

code integer

错误码(遵循 JSON-RPC 约定或服务端自定义)。

message string

错误信息。

data OPTIONAL

自定义错误数据,任意 JSON 值或 null。

input_required_call_ids string[] OPTIONAL

若任务等待外部输入,则给出需要执行的工具调用(如等待用户参数)。

metadata object OPTIONAL

扩展元数据。

previous_task_id string OPTIONAL

前置任务 ID(用于续写/衔接)。

rollouts object[] OPTIONAL

任务推演/回溯事件集合(可选)。

error object OPTIONAL

JSON-RPC error object.

code integer

错误码(遵循 JSON-RPC 约定或服务端自定义)。

message string

错误信息。

data OPTIONAL

自定义错误数据,任意 JSON 值或 null。