背景操作

列出任务

列出已登录用户的近期背景工作，包含状态与进度。

POST /jobs-api/list

契约审核日期： 2026-10-21 · sha256:563d2d581da0ad29

阅读 Markdown 下载公开契约下载 OpenAPI

概览

列出已登录用户的近期背景工作，包含状态与进度。

成功 HTTP 响应可能表示请求已接受，并非已完成。背景工作请存储返回 ID，持续检查同一操作直到完成。已排程或已接受的帖子，只有平台确认后才算已发布；客户端逾时无法证明结果。

验证与权限

接受的凭证类别: user_session, delegated_oauth, personal_access_token
委派能力: agent:operate
最低工作区角色: 此契约没有最低工作区角色要求；拥有权与授权检查仍然适用。
访问范围: 此用户有权访问的资源
需要所有工作区同意: 否
变更状态: 否
操作完成时: synchronous_http_response

令牌只能使用其所有者持有的权利。每次请求会检查工作区成员资格、资源拥有权、所选工作区及已授予能力。core 与 full 配置只变更显示的工具，不会授予访问权限。

请求字段

「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。

请求字段
字段 / 分支	类型 / 必填	约束
`$`	`object`在父对象中必填	`additionalProperties: false`
`limit`	`integer`可选／项目	每页笔数为 1 至 100。发送 limit 或 cursor 会将此路由切换为游标分页，并在响应加入 next_cursor。 `minimum: 1` `maximum: 100`
`cursor`	`string`可选／项目	不透明游标：原样使用上一页的 next_cursor。首页应省略。每一页都必须发送相同的筛选条件。 `minLength: 1` `maxLength: 512`

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Page size, 1 to 100. Sending limit or cursor switches this route to cursor paging and adds next_cursor to the answer."
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Opaque cursor: the next_cursor of the previous page, unchanged. Omit it for the first page. The same filters must be sent with every page."
    }
  },
  "additionalProperties": false
}

响应与完成

成功 HTTP 状态：200。操作完成时： synchronous_http_response.

「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。

响应与完成
字段 / 分支	类型 / 必填	约束
`$`	`object`在父对象中必填	—
`jobs`	`array`在父对象中必填	—
`jobs[]`	`object`可选／项目	—
`jobs[].id`	`string`在父对象中必填	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`jobs[].user_id`	`string`在父对象中必填	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`jobs[].kind`	`string`在父对象中必填	—
`jobs[].status`	`string`在父对象中必填	—
`jobs[].payload`	`string \| number \| boolean \| null \| array \| object`在父对象中必填	—
`jobs[].payload`anyOf 1	`string`在父对象中必填	—
`jobs[].payload`anyOf 2	`number`在父对象中必填	—
`jobs[].payload`anyOf 3	`boolean`在父对象中必填	—
`jobs[].payload`anyOf 4	`null`在父对象中必填	—
`jobs[].payload`anyOf 5	`array`在父对象中必填	—
`jobs[].payload[]`anyOf 5	`reference`可选／项目	`#/$defs/__schema0`
`jobs[].payload`anyOf 6	`object`在父对象中必填	`additionalProperties: {"$ref":"#/$defs/__schema0"}`
`jobs[].payload.*`anyOf 6	`reference`可选／项目	`#/$defs/__schema0`
`jobs[].scheduled_for`	`string \| null`在父对象中必填	—
`jobs[].scheduled_for`anyOf 1	`string`在父对象中必填	—
`jobs[].scheduled_for`anyOf 2	`null`在父对象中必填	—
`jobs[].schedule_timezone`	`string \| null`在父对象中必填	—
`jobs[].schedule_timezone`anyOf 1	`string`在父对象中必填	—
`jobs[].schedule_timezone`anyOf 2	`null`在父对象中必填	—
`jobs[].progress`	`integer \| null`在父对象中必填	—
`jobs[].progress`anyOf 1	`integer`在父对象中必填	`minimum: 0` `maximum: 100`
`jobs[].progress`anyOf 2	`null`在父对象中必填	—
`jobs[].progress_message`	`string \| null`在父对象中必填	—
`jobs[].progress_message`anyOf 1	`string`在父对象中必填	—
`jobs[].progress_message`anyOf 2	`null`在父对象中必填	—
`jobs[].created_at`	`string`在父对象中必填	—
`jobs[].updated_at`	`string`在父对象中必填	—
`next_cursor`	`string \| null`可选／项目	仅在请求发送 limit 或 cursor 时出现。最后一页为 null。 —
`next_cursor`anyOf 1	`string`可选／项目	—
`next_cursor`anyOf 2	`null`可选／项目	—

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "jobs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "user_id": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "kind": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "payload": {
            "$ref": "#/$defs/__schema0"
          },
          "scheduled_for": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "schedule_timezone": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "progress": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 0,
                "maximum": 100
              },
              {
                "type": "null"
              }
            ]
          },
          "progress_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "user_id",
          "kind",
          "status",
          "payload",
          "scheduled_for",
          "schedule_timezone",
          "progress",
          "progress_message",
          "created_at",
          "updated_at"
        ]
      }
    },
    "next_cursor": {
      "description": "Present only when the request sent limit or cursor. Null on the last page.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "jobs"
  ],
  "$defs": {
    "__schema0": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/__schema0"
          }
        },
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "$ref": "#/$defs/__schema0"
          }
        }
      ]
    }
  }
}

错误与安全重试

检查 HTTP 状态和响应正文。400 验证错误可能包含 ZodError；处理程序错误使用 error、message 和 code 字段。保留 request_id 或 x-request-id 以便诊断，但不要保留凭证。先解决 401/403 访问错误再重试，并在收到 429 时遵循 Retry-After。如写入结果不确定或返回 5xx，先读取现有结果。仅在支持时复用幂等键；重试行为因操作而异，并不保证恰好交付一次。

故障排查指南

示例

这些示例使用已依schema检查的虚构值。请将 ID 替换为你有权使用的 ID、将媒体替换为已就绪素材，并将日期替换为已确认的发布时间。提交写入前，请检查账号资格。本页不会发送 API 请求。

在服务器上将 SOSOAPI_ACCESS_TOKEN 设为此操作接受的凭证，且不要放入浏览器代码。agent 请使用 sosoapi auth login 通过浏览器登录，并由 CLI 更新凭证。

request.json

{}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/jobs-api/list" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/jobs-api/list", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /jobs-api/list < request.json

合成响应示例

{
  "jobs": []
}

MCP： sosoapi_list_jobs

全部 API 操作验证与权限