メディアとアセット
アセットのインポート状況を取得
import_idでインポートを取得します。投稿用にはinclude_asset=trueを指定してください。準備完了の結果には登録済みアセットのid、kind、安定したasset_urlが含まれ、別途get_assetを呼ぶ必要はありません。保留中または存在しないアセットは予約できません。元URLやプレビューURLをメディア識別情報に使用しないでください。停滞している場合はjob_idでsosoapi_job_statusを取得し、重複インポートを開始しないでください。
POST /assets-api/imports/status契約確認日: · sha256:563d2d581da0ad29
概要
import_idでインポートを取得します。投稿用にはinclude_asset=trueを指定してください。準備完了の結果には登録済みアセットのid、kind、安定したasset_urlが含まれ、別途get_assetを呼ぶ必要はありません。保留中または存在しないアセットは予約できません。元URLやプレビュー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、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページは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
}
}