启动session - StartCodeInterpreterSession
功能介绍
该API用于启动一个代码解释器的Session。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
PUT /v1/code-interpreters/{code_interpreter_name}/sessions-start
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| code_interpreter_name | 是 | String | 参数解释: 与会话关联的代码解释器的唯一标识符。 代码解释器名称获取方式: 1.进入AgentArts平台,在左侧导航栏选择"组件库 > 沙箱工具 "。 2.在代码解释器列表中"代码解释器名称/ID"处获取代码解释器名称。 约束限制: 必须为已创建的代码解释器名称,若不存在则返回404错误。 取值范围: 符合正则^[a-z][a-z0-9-]{0,46}[a-z0-9]$,即必须以小写字母开头,小写字母或数字结尾,中间可包含数字、小写字母、中划线,字符长度必须在2-40个字符之间。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 本次智能体工具调用对应的身份认证凭据。需要根据实际的智能体工具的入站身份认证方式获取对应的身份认证凭据。 API Key认证、IAM认证及OAuth 2.0认证具体请参见认证鉴权。 约束限制: 不涉及。 取值范围: 不超过4096位字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 代码解释器会话的名称。此名称有助于您识别和管理会话。名称无需唯一。 约束限制: 需符合正则条件^[a-zA-Z0-9_-]+$,仅允许字母、数字、中划线、下划线,不允许为空字符串。 取值范围: 符合正则条件^[a-zA-Z0-9_-]+$,长度1-128个字符。 默认取值: 不涉及。 |
| session_timeout | 否 | Integer | 参数解释: 此设置表示会话在无任何活动后自动终止的时间。 约束限制: 输入值必须在60~86400范围内,超出范围将返回400错误。 取值范围: 60~86400(单位:秒)。 默认取值: 900(单位:秒,即15分钟)。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code_interpreter_name | String | 参数解释: 代码解释器的名称。 取值范围: 与请求路径中的code_interpreter_name一致。 |
| created_at | String | 参数解释: 代码解释器会话创建的时间。 取值范围: 格式为ISO 8601,示例:2026-04-28T10:00:00Z,时区为UTC。 |
| name | String | 参数解释: 代码解释器会话的名称。 取值范围: 与请求参数name一致,符合正则条件^[a-zA-Z0-9_-]+$,长度1-128字符。 |
| session_id | String | 参数解释: 代码解释器会话的唯一标识符,由系统自动生成。该ID需用于后续停止会话、执行代码等操作的请求Header(X-HW-AgentArts-Code-Interpreter-Session-Id)中。 取值范围: 由系统生成的唯一字符串。 |
| session_timeout | Integer | 参数解释: 代码解释器会话的超时时间。 取值范围: 60~86400(单位:秒)。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 参数解释: 异常错误码。 取值范围: 不涉及。 |
| message | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
请求示例
/v1/code-interpreters/123/sessions-start
{
"name" : "session-name",
"session_timeout" : 900
} 响应示例
状态码:200
OK
{
"code_interpreter_name" : "string",
"session_id" : "string",
"created_at" : "2026-04-28T10:00:00Z",
"name" : "string",
"session_timeout" : 900
} 状态码:400
请求参数错误。
{
"error_code" : "AgentArts.04010001",
"error_msg" : "body -> name: String should match pattern \"^[a-zA-Z0-9_-]+$\""
} 状态码:409
操作冲突。
{
"error_code" : "AgentArts.04010005",
"error_msg" : "Session session-001 already exists"
} 状态码:429
请求频率超限。
{
"error_code" : "AgentArts.04010006",
"error_msg" : "Session limit reached for container"
} 状态码:500
服务内部错误。
{
"error_code" : "AgentArts.04010000",
"error_msg" : "Jupyter down"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | 请求参数错误。 |
| 401 | 未授权(认证令牌缺失、无效或已过期)。 |
| 409 | 操作冲突。 |
| 429 | 请求频率超限。 |
| 500 | 服务内部错误。 |
错误码
请参见错误码。