背景操作

列出背景工作

列出已登入使用者近期背景工作、狀態及進度。

POST /jobs-api/list

Contract 核對日期: 2026-10-21 · sha256:563d2d581da0ad29

閱讀 Markdown 下載公開 contract 下載 OpenAPI

概覽

列出已登入使用者近期背景工作、狀態及進度。

HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID，讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時，都唔代表已發佈。

驗證及權限

接受嘅憑證類型: user_session, delegated_oauth, personal_access_token
委派權限: agent:operate
最低工作空間角色: 此 contract 冇指定工作空間最低角色；仍需符合擁有權及授權檢查。
存取範圍: 已登入使用者及獲授權資源範圍
需要所有工作空間同意: 唔係
會改動狀態: 唔係
完成依據: synchronous_http_response

憑證唔能夠擴大持有人權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只改變可見工具，唔會授權。

請求欄位

必填表示喺所屬物件及所選分支內必須提供；子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。

請求欄位
欄位／分支	類型／必填	限制
`$`	`object`父物件內必填	`additionalProperties: false`
`limit`	`integer`可選／陣列項目	Page size, 1 to 100. Sending limit or cursor switches this route to cursor paging and adds next_cursor to the answer. `minimum: 1` `maximum: 100`
`cursor`	`string`可選／陣列項目	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. `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.

HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID，讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時，都唔代表已發佈。

必填表示喺所屬物件及所選分支內必須提供；子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。

回應及完成條件
欄位／分支	類型／必填	限制
`$`	`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`可選／陣列項目	Present only when the request sent limit or cursor. Null on the last page. —
`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；handler 錯誤可能係 error／message／code envelope。保留可用嘅 request_id 或 x-request-id，唔好記錄憑證。401／403先修正存取問題；429遵守 Retry-After。寫入結果未明或5xx時，先讀原有結果，再決定重試；只喺操作支援時重用 idempotency key，並冇通用重試或 exactly-once 保證。

問題排解指南

範例

以下虛構值已按 contract 驗證，唔係真實帳戶 ID、憑證或發佈紀錄。請用已授權範圍回傳嘅 ID、已準備好嘅素材及已審核排程取代，寫入前核對平台資格。此頁唔會呼叫 API。

喺伺服器環境設定 SOSOAPI_ACCESS_TOKEN，使用此操作接受嘅憑證。唔好放入瀏覽器程式。一般 agent 建議透過 sosoapi auth login 用瀏覽器 OAuth，由 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 操作驗證及權限