OpenMax
免费试用

Apps API · Issues

Issues: 15 个接口

← 全部分组

GET /api/v1/issues

List issues

权限(scope): work:issue:read · 调用方式: appToken · operationId: list-issues

Required app scope: work:issue:read.

Returns issues across projects. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
page query integer (int32) Page number (default: 1)
page_size query integer (int32) Items per page (default: 20, max: 100)
order_by query string Sort expression, e.g. created_at:desc
include_automation query boolean Include automation run issues, excluded by default
status query string: backlog, in_progress, pending_plan, delivered, accepted, terminated Filter by one status
statuses query string Comma-separated inclusion filter for issue statuses
priority query string: low, medium, high Filter by priority
include_archived query boolean Include issues archived through project cascade
query query string Case-insensitive issue title search

回包

GET /api/v1/issues/{issue_id}

Get issue details

权限(scope): work:issue:read · 调用方式: appToken · operationId: get-issue

Required app scope: work:issue:read.

Returns detailed information about a specific issue. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

回包

PATCH /api/v1/issues/{issue_id}

Update issue

权限(scope): work:issue:write · 调用方式: appToken · operationId: update-issue

Required app scope: work:issue:write.

Updates issue metadata. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

请求体

application/json · UpdateIssueRequestBody

字段 类型 必填 说明
description string Update issue description
priority string: low, medium, high Update issue priority
title string Update issue title

回包

POST /api/v1/issues/{issue_id}/accept-delivered

Accept delivered issue

权限(scope): work:issue:accept · 调用方式: appToken · operationId: accept-delivered-issue

Required app scope: work:issue:accept.

Accepts a delivered issue. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

请求体

application/json · AcceptDeliveredIssueRequestBody

字段 类型 必填 说明
source string: im, explicit, text_card_proxy 是 Acceptance source

回包

POST /api/v1/issues/{issue_id}/accept-plan

Accept issue plan

权限(scope): work:issue:accept · 调用方式: appToken · operationId: accept-issue-plan

Required app scope: work:issue:accept.

Accepts the submitted execution plan and moves the issue to in_progress. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

请求体

application/json · AcceptIssuePlanRequestBody

字段 类型 必填 说明
expected_plan_token string Optional current_plan_token of the plan the caller reviewed. Send it only to decide an issue in pending_plan, and only as the issue owner: with a token, a non-owner gets 403, a silent automation's or archived issue is refused, an issue not in pending_plan gets 412, and a plan that has changed since gets 412 WORK_ISSUE_PLAN_CHANGED; nothing is accepted in any of these cases. Omit to accept without the token rules; null is invalid
source string Origin of the plan acceptance (e.g. explicit, text_card_proxy)

回包

POST /api/v1/issues/{issue_id}/activate

Activate issue

权限(scope): work:issue:write · 调用方式: appToken · operationId: activate-issue

Required app scope: work:issue:write.

Activates a backlog issue and wakes the lead when required. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

请求体

application/json · ActivateIssueRequestBody

字段 类型 必填 说明
source string: lead_chat, ui, event_binding, system Activation source. Defaults to ui (the human/UI action path) when omitted.

回包

POST /api/v1/issues/{issue_id}/deliver

Deliver issue

权限(scope): work:issue:write · 调用方式: appToken · operationId: deliver-issue

Required app scope: work:issue:write.

Delivers an in-progress issue. Silent automation issues require a structured result and complete automatically; ordinary issues retain human acceptance. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是

请求体

application/json · DeliverIssueBody (可不带)

字段 类型 必填 说明
artifacts array of AutomationArtifactItem
idempotency_key string
outcome string: success, partial, failed
summary string

回包

POST /api/v1/issues/{issue_id}/move

Move issue to project

权限(scope): work:issue:write · 调用方式: appToken · operationId: move-issue-project

Required app scope: work:issue:write.

Moves an issue to another project. Nothing moves into or out of the Owner's hidden project of automations attached to no project, and a run of an automation attached to no project cannot move out of the Inbox: 409 WORK_PROJECT_SYSTEM_MANAGED. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

请求体

application/json · MoveIssueProjectRequestBody

字段 类型 必填 说明
new_project_id string (uuid) 是 New project UUID

回包

POST /api/v1/issues/{issue_id}/reassign-owner

Reassign issue owner

权限(scope): work:issue:write · 调用方式: appToken · operationId: reassign-issue-owner

Required app scope: work:issue:write.

Reassigns an issue to another owner member. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

请求体

application/json · ReassignIssueOwnerRequestBody

字段 类型 必填 说明
new_owner_member_id string (uuid) 是 New owner member UUID

回包

POST /api/v1/issues/{issue_id}/resume

Resume issue after feedback

权限(scope): work:issue:write · 调用方式: appToken · operationId: resume-issue

Required app scope: work:issue:write.

Moves a pending_plan or delivered issue back to in_progress after human feedback. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

请求体

application/json · ResumeIssueRequestBody

字段 类型 必填 说明
expected_plan_token string Optional current_plan_token of the plan the owner's feedback refers to (an empty string when the issue has no current_plan_token). Send it only to give feedback on an issue in pending_plan, only as the issue owner and with a non-empty reason; do not send it when resuming a delivered issue. With a token, a non-owner gets 403, a silent automation's or archived issue is refused, an issue not in pending_plan gets 412, and a plan that has changed since gets 412 WORK_ISSUE_PLAN_CHANGED. Omit for an ordinary resume; null is invalid
reason string Human feedback or reason for resuming work
source string Origin of the resume action (e.g. lead_chat)

回包

POST /api/v1/issues/{issue_id}/revisions

Revise one completed automation result

权限(scope): work:issue:write · 调用方式: appToken · operationId: create-issue-revision

Required app scope: work:issue:write.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是

请求体

application/json · CreateIssueRevisionRequestBody

字段 类型 必填 说明
description string 是
idempotency_key string 是
origin_message_id string

回包

POST /api/v1/issues/{issue_id}/submit-plan

Submit issue plan

权限(scope): work:issue:write · 调用方式: appToken · operationId: submit-issue-plan

Required app scope: work:issue:write.

Submits a markdown execution plan for human confirmation and moves the issue to pending_plan. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

请求体

application/json · SubmitIssuePlanRequestBody

字段 类型 必填 说明
blueprint_id string (uuid) 是 Blueprint UUID for the submitted execution plan
card_message_id string (uuid) Optional IM card message UUID
plan_text string 是 Markdown plan text shown to the human for confirmation
source string Origin of the plan request (e.g. lead_chat, text_card_proxy)

回包

POST /api/v1/issues/{issue_id}/terminate

Terminate issue

权限(scope): work:issue:write · 调用方式: appToken · operationId: terminate-issue

Required app scope: work:issue:write.

Terminates an open issue early: non-terminal tasks are cancelled and an issue.terminated event is emitted for the Lead to run cleanup. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
issue_id path string (uuid) 是 Issue UUID

请求体

application/json · TerminateIssueRequestBody

字段 类型 必填 说明
reason string Why the issue is being terminated
source string Origin of the terminate action (e.g. lead_chat, ui)

回包

GET /api/v1/projects/{project_id}/issues

List project issues

权限(scope): work:issue:read · 调用方式: appToken · operationId: list-project-issues

Required app scope: work:issue:read.

Returns issues within a project. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
project_id path string (uuid) 是 Project UUID
page query integer (int32) Page number (default: 1)
page_size query integer (int32) Items per page (default: 20, max: 100)
order_by query string Sort expression, e.g. created_at:desc
include_automation query boolean Include automation run issues, excluded by default
status query string: backlog, in_progress, pending_plan, delivered, accepted, terminated Filter by one status
statuses query string Comma-separated inclusion filter for issue statuses
priority query string: low, medium, high Filter by priority
include_archived query boolean Include issues archived through project cascade
query query string Case-insensitive issue title search

回包

POST /api/v1/projects/{project_id}/issues

Create issue

权限(scope): work:issue:write · 调用方式: appToken · operationId: create-issue

Required app scope: work:issue:write.

Creates an issue within a project. The Owner's hidden project of automations attached to no project takes no manual issue (409 WORK_PROJECT_SYSTEM_MANAGED). Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
project_id path string (uuid) 是 Project UUID

请求体

application/json · CreateIssueRequestBody

字段 类型 必填 说明
backlog boolean Whether to create in backlog. Defaults to true when omitted; set false to start in_progress
description string Issue description
lead_agent_id string (uuid) 是 Lead agent UUID
origin_conversation_id string (uuid) Origin conversation UUID
origin_message_id string (uuid) Origin message UUID
owner_member_id string (uuid) 是 Issue owner member UUID (required)
priority string: low, medium, high Issue priority (optional, default medium)
title string 是 Issue title

回包