Operasi latar belakang
Daftar tugas
Tampilkan tugas latar belakang terbaru pengguna yang masuk, beserta status dan progres.
POST /jobs-api/listKontrak ditinjau: · sha256:563d2d581da0ad29
Ringkasan
Tampilkan tugas latar belakang terbaru pengguna yang masuk, beserta status dan progres.
Respons HTTP berhasil dapat berarti permintaan diterima, bukan selesai. Untuk pekerjaan latar belakang, simpan ID yang dikembalikan dan periksa operasi yang sama sampai selesai. Postingan terjadwal atau diterima baru dipublikasikan setelah platform mengonfirmasi; timeout klien tidak membuktikan hasilnya.
Autentikasi dan izin
Token hanya dapat menggunakan hak pemiliknya. Setiap permintaan memeriksa keanggotaan ruang kerja, kepemilikan sumber daya, ruang kerja terpilih, dan kemampuan yang diberikan. Profil core dan full mengubah alat yang ditampilkan; tidak memberikan akses.
Kolom permintaan
Wajib berarti wajib dalam objek induk dan cabang yang dipilih. Anak wajib tidak membuat induk opsional menjadi wajib. Aturan dan nama kolom di bawah disalin dari kontrak.
| Kolom / cabang | Jenis / wajib | Batasan |
|---|---|---|
$ | objectWajib dalam induk |
|
limit | integerOpsional / item | Ukuran halaman, 1 hingga 100. Mengirim limit atau cursor mengalihkan rute ke paginasi kursor dan menambahkan next_cursor ke jawaban.
|
cursor | stringOpsional / item | Kursor opak: next_cursor dari halaman sebelumnya, tanpa perubahan. Hilangkan untuk halaman pertama. Filter yang sama harus dikirim pada setiap halaman.
|
JSON Schema lengkap
{
"$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
}Respons dan penyelesaian
Status HTTP berhasil: 200. Saat operasi selesai: synchronous_http_response.
Respons HTTP berhasil dapat berarti permintaan diterima, bukan selesai. Untuk pekerjaan latar belakang, simpan ID yang dikembalikan dan periksa operasi yang sama sampai selesai. Postingan terjadwal atau diterima baru dipublikasikan setelah platform mengonfirmasi; timeout klien tidak membuktikan hasilnya.
Wajib berarti wajib dalam objek induk dan cabang yang dipilih. Anak wajib tidak membuat induk opsional menjadi wajib. Aturan dan nama kolom di bawah disalin dari kontrak.
| Kolom / cabang | Jenis / wajib | Batasan |
|---|---|---|
$ | objectWajib dalam induk | — |
jobs | arrayWajib dalam induk | — |
jobs[] | objectOpsional / item | — |
jobs[].id | stringWajib dalam induk |
|
jobs[].user_id | stringWajib dalam induk |
|
jobs[].kind | stringWajib dalam induk | — |
jobs[].status | stringWajib dalam induk | — |
jobs[].payload | string | number | boolean | null | array | objectWajib dalam induk | — |
jobs[].payloadanyOf 1 | stringWajib dalam induk | — |
jobs[].payloadanyOf 2 | numberWajib dalam induk | — |
jobs[].payloadanyOf 3 | booleanWajib dalam induk | — |
jobs[].payloadanyOf 4 | nullWajib dalam induk | — |
jobs[].payloadanyOf 5 | arrayWajib dalam induk | — |
jobs[].payload[]anyOf 5 | referenceOpsional / item |
|
jobs[].payloadanyOf 6 | objectWajib dalam induk |
|
jobs[].payload.*anyOf 6 | referenceOpsional / item |
|
jobs[].scheduled_for | string | nullWajib dalam induk | — |
jobs[].scheduled_foranyOf 1 | stringWajib dalam induk | — |
jobs[].scheduled_foranyOf 2 | nullWajib dalam induk | — |
jobs[].schedule_timezone | string | nullWajib dalam induk | — |
jobs[].schedule_timezoneanyOf 1 | stringWajib dalam induk | — |
jobs[].schedule_timezoneanyOf 2 | nullWajib dalam induk | — |
jobs[].progress | integer | nullWajib dalam induk | — |
jobs[].progressanyOf 1 | integerWajib dalam induk |
|
jobs[].progressanyOf 2 | nullWajib dalam induk | — |
jobs[].progress_message | string | nullWajib dalam induk | — |
jobs[].progress_messageanyOf 1 | stringWajib dalam induk | — |
jobs[].progress_messageanyOf 2 | nullWajib dalam induk | — |
jobs[].created_at | stringWajib dalam induk | — |
jobs[].updated_at | stringWajib dalam induk | — |
next_cursor | string | nullOpsional / item | Hanya ada jika permintaan mengirim limit atau cursor. Null pada halaman terakhir. — |
next_cursoranyOf 1 | stringOpsional / item | — |
next_cursoranyOf 2 | nullOpsional / item | — |
JSON Schema lengkap
{
"$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"
}
}
]
}
}
}Kesalahan dan percobaan ulang aman
Periksa status HTTP dan isi respons. Kesalahan validasi 400 mungkin berisi ZodError; kesalahan handler menggunakan kolom error, message, dan code. Simpan request_id atau x-request-id untuk diagnosis, tanpa kredensial. Atasi kesalahan akses 401/403 sebelum mencoba lagi, dan ikuti Retry-After untuk 429. Jika penulisan belum pasti atau mengembalikan 5xx, baca hasil yang sudah ada terlebih dahulu. Gunakan kembali kunci idempotensi hanya jika didukung; perilaku percobaan ulang berbeda menurut operasi dan tidak menjamin pengiriman tepat satu kali.
Panduan pemecahan masalahContoh
Contoh ini menggunakan nilai fiktif yang diperiksa terhadap skema. Ganti ID dengan yang diizinkan bagi Anda, media dengan aset siap, dan tanggal dengan waktu publikasi yang dikonfirmasi. Periksa kelayakan akun sebelum mengirim penulisan. Halaman ini tidak mengirim permintaan API.
Atur SOSOAPI_ACCESS_TOKEN di server Anda ke kredensial yang diterima operasi ini, dan jauhkan dari kode browser. Untuk agen, gunakan sosoapi auth login untuk masuk melalui browser dan biarkan CLI memperbarui kredensialnya.
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.jsonJavaScript
// 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.jsonContoh respons sintetis
{
"jobs": []
}Alat dan panduan terkait
MCP: sosoapi_list_jobs