媒體與素材
取得素材匯入狀態
透過 import_id 讀取匯入。發布貼文時傳入 include_asset=true:ready 結果包含已登記素材 id、kind 和穩定的 asset_url,無需另行呼叫 get_asset。待處理或缺失的素材不可排程。絕不使用來源或預覽 URL 作為媒體識別。如停滯,使用 job_id 讀取 sosoapi_job_status;絕不啟動重複匯入。
POST /assets-api/imports/status契約檢閱日期: · sha256:563d2d581da0ad29
概覽
透過 import_id 讀取匯入。發布貼文時傳入 include_asset=true:ready 結果包含已登記素材 id、kind 和穩定的 asset_url,無需另行呼叫 get_asset。待處理或缺失的素材不可排程。絕不使用來源或預覽 URL 作為媒體識別。如停滯,使用 job_id 讀取 sosoapi_job_status;絕不啟動重複匯入。
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
驗證與權限
權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具,不會授予存取權。
請求欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
workspace_id | string在父物件中必填 |
|
import_id | string在父物件中必填 |
|
include_asset | boolean選填/項目 | — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspace_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)$"
},
"import_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)$"
},
"include_asset": {
"type": "boolean"
}
},
"required": [
"workspace_id",
"import_id"
],
"additionalProperties": false
}回應與完成
成功 HTTP 狀態:200。操作完成時: synchronous_http_response.
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 | — |
import | object在父物件中必填 | — |
import.id | string在父物件中必填 |
|
import.status | string在父物件中必填 |
|
import.job_id | string | null在父物件中必填 | — |
import.job_idanyOf 1 | string在父物件中必填 |
|
import.job_idanyOf 2 | null在父物件中必填 | — |
import.asset_id | integer | null在父物件中必填 | — |
import.asset_idanyOf 1 | integer在父物件中必填 |
|
import.asset_idanyOf 2 | null在父物件中必填 | — |
import.completed_asset_id | integer | null在父物件中必填 | — |
import.completed_asset_idanyOf 1 | integer在父物件中必填 |
|
import.completed_asset_idanyOf 2 | null在父物件中必填 | — |
import.asset_purged_at | string | null在父物件中必填 | — |
import.asset_purged_atanyOf 1 | string在父物件中必填 | — |
import.asset_purged_atanyOf 2 | null在父物件中必填 | — |
import.source_url | string在父物件中必填 |
|
import.final_url | string | null在父物件中必填 | — |
import.final_urlanyOf 1 | string在父物件中必填 |
|
import.final_urlanyOf 2 | null在父物件中必填 | — |
import.object_key | string | null在父物件中必填 | — |
import.object_keyanyOf 1 | string在父物件中必填 |
|
import.object_keyanyOf 2 | null在父物件中必填 | — |
import.content_type | string | null在父物件中必填 | — |
import.content_typeanyOf 1 | string在父物件中必填 |
|
import.content_typeanyOf 2 | null在父物件中必填 | — |
import.byte_size | integer | null在父物件中必填 | — |
import.byte_sizeanyOf 1 | integer在父物件中必填 |
|
import.byte_sizeanyOf 2 | null在父物件中必填 | — |
import.content_sha256 | string | null在父物件中必填 | — |
import.content_sha256anyOf 1 | string在父物件中必填 |
|
import.content_sha256anyOf 2 | null在父物件中必填 | — |
import.media_probe | reference | null在父物件中必填 | — |
import.media_probeanyOf 1 | string | number | boolean | null | array | object在父物件中必填 | — |
import.media_probeanyOf 1 / anyOf 1 | string在父物件中必填 | — |
import.media_probeanyOf 1 / anyOf 2 | number在父物件中必填 | — |
import.media_probeanyOf 1 / anyOf 3 | boolean在父物件中必填 | — |
import.media_probeanyOf 1 / anyOf 4 | null在父物件中必填 | — |
import.media_probeanyOf 1 / anyOf 5 | array在父物件中必填 | — |
import.media_probe[]anyOf 1 / anyOf 5 | reference選填/項目 |
|
import.media_probeanyOf 1 / anyOf 6 | object在父物件中必填 |
|
import.media_probe.*anyOf 1 / anyOf 6 | reference選填/項目 |
|
import.media_probeanyOf 2 | null在父物件中必填 | — |
import.error_message | string | null在父物件中必填 | — |
import.error_messageanyOf 1 | string在父物件中必填 | — |
import.error_messageanyOf 2 | null在父物件中必填 | — |
import.created_at | string在父物件中必填 | — |
import.completed_at | string | null在父物件中必填 | — |
import.completed_atanyOf 1 | string在父物件中必填 | — |
import.completed_atanyOf 2 | null在父物件中必填 | — |
asset | object | null選填/項目 | — |
assetanyOf 1 | object選填/項目 | — |
asset.idanyOf 1 | integer | string在父物件中必填 | — |
asset.idanyOf 1 / anyOf 1 | integer在父物件中必填 |
|
asset.idanyOf 1 / anyOf 2 | string在父物件中必填 | — |
asset.asset_typeanyOf 1 | string在父物件中必填 |
|
asset.asset_urlanyOf 1 | string | null在父物件中必填 | — |
asset.asset_urlanyOf 1 / anyOf 1 | string在父物件中必填 | — |
asset.asset_urlanyOf 1 / anyOf 2 | null在父物件中必填 | — |
assetanyOf 2 | null選填/項目 | — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"import": {
"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)$"
},
"status": {
"type": "string",
"enum": [
"queued",
"importing",
"needs_repair",
"ready",
"asset_purged",
"failed"
]
},
"job_id": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
},
"asset_id": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"completed_asset_id": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"asset_purged_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source_url": {
"type": "string",
"format": "uri"
},
"final_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"object_key": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"content_type": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"byte_size": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"content_sha256": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{64}$"
},
{
"type": "null"
}
]
},
"media_probe": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string"
},
"completed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"job_id",
"asset_id",
"completed_asset_id",
"asset_purged_at",
"source_url",
"final_url",
"object_key",
"content_type",
"byte_size",
"content_sha256",
"media_probe",
"error_message",
"created_at",
"completed_at"
]
},
"asset": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string"
}
]
},
"asset_type": {
"type": "string",
"enum": [
"text",
"image",
"video",
"audio"
]
},
"asset_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"asset_type",
"asset_url"
]
},
{
"type": "null"
}
]
}
},
"required": [
"import"
],
"$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,先讀取現有結果。僅在支援時重複使用冪等鍵;重試行為因操作而異,並不保證恰好傳送一次。
故障排查指南範例
這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材,並將日期替換為已確認的發布時間。提交寫入前,請檢查帳號資格。本頁不會傳送 API 請求。
在伺服器上將 SOSOAPI_ACCESS_TOKEN 設為此操作接受的憑證,且不要放入瀏覽器程式碼。代理程式請使用 sosoapi auth login 透過瀏覽器登入,並由 CLI 更新憑證。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"import_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/assets-api/imports/status" \
-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/assets-api/imports/status", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"import_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /assets-api/imports/status < request.json合成回應範例
{
"import": {
"id": "11111111-1111-4111-8111-111111111111",
"status": "queued",
"job_id": null,
"asset_id": null,
"completed_asset_id": null,
"asset_purged_at": null,
"source_url": "https://example.com/media.png",
"final_url": null,
"object_key": null,
"content_type": null,
"byte_size": null,
"content_sha256": null,
"media_probe": null,
"error_message": null,
"created_at": "example",
"completed_at": null
}
}