跳转到主要内容
POST
/
v3
/
organizations
/
{org_id}
/
sessions
/
{devin_id}
/
archive
归档会话
curl --request POST \
  --url https://api.devin.ai/v3/organizations/{org_id}/sessions/{devin_id}/archive \
  --header 'Authorization: Bearer <token>'
{
  "acus_consumed": 123,
  "created_at": 123,
  "org_id": "<string>",
  "origin": "webapp",
  "pull_requests": [
    {
      "pr_state": "<string>",
      "pr_url": "<string>"
    }
  ],
  "session_id": "<string>",
  "status": "new",
  "tags": [
    "<string>"
  ],
  "updated_at": 123,
  "url": "<string>",
  "category": "bug_fixing",
  "child_session_ids": [
    "<string>"
  ],
  "is_archived": false,
  "parent_session_id": "<string>",
  "playbook_id": "<string>",
  "service_user_id": "<string>",
  "status_detail": "working",
  "structured_output": {},
  "subcategory": "<string>",
  "title": "<string>",
  "user_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.devin.ai/llms.txt

Use this file to discover all available pages before exploring further.

devin_id 是以 devin- 作为前缀的会话 ID (例如:devin-abc123) 。

权限

需要一个在组织级别拥有 ManageOrgSessions 权限的服务用户。

注意事项

归档会话会将其保留,便于日后查阅。已归档的会话仍可查看,但无法修改或继续。

授权

Authorization
string
header
必填

服务用户凭据(前缀:cog_)

路径参数

devin_id
string | null
必填

Devin 会话 ID(前缀:devin-)

示例:

"devin-abc123def456"

org_id
string | null
必填

组织 ID(前缀:org-)

示例:

"org-abc123def456"

响应

成功响应

acus_consumed
number
必填
created_at
integer
必填
org_id
string
必填
origin
enum<string>
必填

该会话的创建来源。

可用选项:
webapp,
slack,
teams,
api,
linear,
jira,
scheduled,
automation,
cli,
desktop,
other
pull_requests
SessionPullRequest · object[]
必填
session_id
string
必填
status
enum<string>
必填
可用选项:
new,
claimed,
running,
exit,
error,
suspended,
resuming
tags
string[]
必填
updated_at
integer
必填
url
string
必填
category
enum<string> | null

如果已完成分类,则为会话分配的用例类别。仅在 get/list 端点中返回。

可用选项:
bug_fixing,
ci_cd_and_devops,
code_quality_and_security,
code_review_and_analysis,
data_and_automation,
documentation_and_content,
feature_development,
migrations_and_upgrades,
other,
refactoring_and_optimization,
research_and_exploration,
unit_test_generation
child_session_ids
string[] | null
is_archived
boolean
默认值:false
parent_session_id
string | null
playbook_id
string | null
service_user_id
string | null
status_detail
enum<string> | null

会话当前状态的附加信息。当 status 为“running”时:可为“working”(正在处理)、“waiting_for_user”(需要用户输入)、“waiting_for_approval”(在安全模式下等待操作批准)或“finished”(任务已完成)。当 status 为“suspended”时:表示挂起原因,例如“inactivity”“user_request”“usage_limit_exceeded”“out_of_credits”“out_of_quota”“no_quota_allocation”“payment_declined”“org_usage_limit_exceeded”“total_session_limit_exceeded”或“error”。仅在 get/list 端点中返回。

可用选项:
working,
waiting_for_user,
waiting_for_approval,
finished,
inactivity,
user_request,
usage_limit_exceeded,
out_of_credits,
out_of_quota,
no_quota_allocation,
payment_declined,
org_usage_limit_exceeded,
total_session_limit_exceeded,
error
structured_output
Structured Output · object

来自会话的已验证结构化输出。仅在 GET/LIST 端点中返回。

subcategory
string | null

为会话分配的子类别显示名称。若已设置类别但未分配或未解析出子类别,则为“Other”。仅在 get/list 端点中返回。

title
string | null
user_id
string | null