メディアとアセット

アセットを作成

自身でホストしているメディアやテキストのアセットレコードを登録します（asset_url、asset_type）。アップロードは行いません。ローカルファイルにはsosoapi_upload_asset、公開URLからSosoAPIに取得させる場合はsosoapi_import_asset_urlを使用してください。workspace_idを指定します（明示的な対象指定が必須になると、未指定は拒否されます）。idempotency_keyは任意です。

POST /assets-api/create

契約確認日： 2026-10-21 · sha256:563d2d581da0ad29

Markdownで読む公開契約をダウンロード OpenAPIをダウンロード

概要

HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。

認証と権限

受け付ける認証情報の種類: user_session, delegated_oauth, personal_access_token
委任された機能権限: agent:operate
ワークスペースの最低ロール: editor
アクセス範囲: このユーザーがアクセスを許可されたリソース
すべてのワークスペースへの同意が必要: いいえ
状態を変更: はい
操作完了時: synchronous_http_response

トークンは所有者の権利内でのみ使えます。各要求で所属、リソース所有権、選択ワークスペース、付与機能を確認します。coreとfullは表示だけを変え、アクセスは付与しません。

リクエストのフィールド

必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。

リクエストのフィールド
フィールド／分岐	型／必須	制約
`$`	`object`親要素内で必須	`additionalProperties: false`
`workspace_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)$"`
`asset_type`	`string`親要素内で必須	`enum: ["text","image","video"]`
`asset_url`	`string`親要素内で必須	`minLength: 1` `maxLength: 2048`
`title`	`string`任意／項目	`maxLength: 200`
`description`	`string`任意／項目	`maxLength: 2000`
`tags`	`array`任意／項目	`maxItems: 50`
`tags[]`	`string`任意／項目	`maxLength: 64`
`metadata`	`object`任意／項目	自由形式のJSONオブジェクトです。シリアライズ後のUTF-8サイズは16384バイト以下である必要があります。 `additionalProperties: {}`
`metadata.*`	`any JSON value`任意／項目	—
`source`	`string`任意／項目	`maxLength: 64`
`source_metadata`	`object`任意／項目	自由形式のJSONオブジェクトです。シリアライズ後のUTF-8サイズは16384バイト以下である必要があります。 `additionalProperties: {}`
`source_metadata.*`	`any JSON value`任意／項目	—
`idempotency_key`	`string`任意／項目	`minLength: 8` `maxLength: 160`

完全な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)$"
    },
    "asset_type": {
      "type": "string",
      "enum": [
        "text",
        "image",
        "video"
      ]
    },
    "asset_url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2048
    },
    "title": {
      "type": "string",
      "maxLength": 200
    },
    "description": {
      "type": "string",
      "maxLength": 2000
    },
    "tags": {
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 64
      }
    },
    "metadata": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "Free-form JSON object; its serialized UTF-8 size must not exceed 16384 bytes."
    },
    "source": {
      "type": "string",
      "maxLength": 64
    },
    "source_metadata": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "Free-form JSON object; its serialized UTF-8 size must not exceed 16384 bytes."
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 8,
      "maxLength": 160
    }
  },
  "required": [
    "asset_type",
    "asset_url"
  ],
  "additionalProperties": false
}

レスポンスと完了条件

成功時のHTTPステータス： 200. 操作完了時： synchronous_http_response.

レスポンスと完了条件
フィールド／分岐	型／必須	制約
`$`	`object`親要素内で必須	—
`asset`	`object`親要素内で必須	—
`asset.id`	`integer \| string`親要素内で必須	—
`asset.id`anyOf 1	`integer`親要素内で必須	`minimum: -9007199254740991` `maximum: 9007199254740991`
`asset.id`anyOf 2	`string`親要素内で必須	—
`asset.workspace_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)$"`
`asset.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)$"`
`asset.asset_type`	`string`親要素内で必須	`enum: ["text","image","video","audio"]`
`asset.asset_url`	`string \| null`親要素内で必須	—
`asset.asset_url`anyOf 1	`string`親要素内で必須	—
`asset.asset_url`anyOf 2	`null`親要素内で必須	—
`asset.preview_url`	`string \| null`任意／項目	ワークスペースで認可された一時読み取りURLです。preview_expires_at後はAssetの取得・一覧で更新し、永続的なメディア識別にはasset_urlを維持します。 —
`asset.preview_url`anyOf 1	`string`任意／項目	`format: "uri"`
`asset.preview_url`anyOf 2	`null`任意／項目	—
`asset.preview_expires_at`	`string \| null`任意／項目	—
`asset.preview_expires_at`anyOf 1	`string`任意／項目	`format: "date-time"` `pattern: "^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"`
`asset.preview_expires_at`anyOf 2	`null`任意／項目	—
`asset.title`	`string \| null`親要素内で必須	—
`asset.title`anyOf 1	`string`親要素内で必須	—
`asset.title`anyOf 2	`null`親要素内で必須	—
`asset.description`	`string \| null`親要素内で必須	—
`asset.description`anyOf 1	`string`親要素内で必須	—
`asset.description`anyOf 2	`null`親要素内で必須	—
`asset.tags`	`array \| null`親要素内で必須	—
`asset.tags`anyOf 1	`array`親要素内で必須	—
`asset.tags[]`anyOf 1	`string`任意／項目	—
`asset.tags`anyOf 2	`null`親要素内で必須	—
`asset.metadata`	`object \| null`親要素内で必須	—
`asset.metadata`anyOf 1	`object`親要素内で必須	`additionalProperties: {}`
`asset.metadata.*`anyOf 1	`any JSON value`任意／項目	—
`asset.metadata`anyOf 2	`null`親要素内で必須	—
`asset.source`	`string \| null`任意／項目	—
`asset.source`anyOf 1	`string`任意／項目	—
`asset.source`anyOf 2	`null`任意／項目	—
`asset.source_metadata`	`object \| null`任意／項目	—
`asset.source_metadata`anyOf 1	`object`任意／項目	`additionalProperties: {}`
`asset.source_metadata.*`anyOf 1	`any JSON value`任意／項目	—
`asset.source_metadata`anyOf 2	`null`任意／項目	—
`asset.created_at`	`string`親要素内で必須	—
`asset.version`	`integer`任意／項目	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`deduped`	`boolean`親要素内で必須	—

完全なJSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "asset": {
      "type": "object",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            },
            {
              "type": "string"
            }
          ]
        },
        "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)$"
        },
        "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)$"
        },
        "asset_type": {
          "type": "string",
          "enum": [
            "text",
            "image",
            "video",
            "audio"
          ]
        },
        "asset_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "preview_url": {
          "description": "Workspace-authorized temporary read URL. Refresh through Asset read/list after preview_expires_at; keep asset_url as persisted media identity.",
          "anyOf": [
            {
              "type": "string",
              "format": "uri"
            },
            {
              "type": "null"
            }
          ]
        },
        "preview_expires_at": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            },
            {
              "type": "null"
            }
          ]
        },
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "tags": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "metadata": {
          "anyOf": [
            {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ]
        },
        "source": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "source_metadata": {
          "anyOf": [
            {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {}
            },
            {
              "type": "null"
            }
          ]
        },
        "created_at": {
          "type": "string"
        },
        "version": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "id",
        "workspace_id",
        "user_id",
        "asset_type",
        "asset_url",
        "title",
        "description",
        "tags",
        "metadata",
        "created_at"
      ]
    },
    "deduped": {
      "type": "boolean"
    }
  },
  "required": [
    "asset",
    "deduped"
  ]
}

エラーと安全な再試行

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

{
  "asset_type": "text",
  "asset_url": "example"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/assets-api/create" \
  -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/assets-api/create", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "asset_type": "text",
  "asset_url": "example"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /assets-api/create < request.json

合成レスポンス例

{
  "asset": {
    "id": 0,
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "user_id": "11111111-1111-4111-8111-111111111111",
    "asset_type": "text",
    "asset_url": null,
    "title": null,
    "description": null,
    "tags": null,
    "metadata": null,
    "created_at": "example"
  },
  "deduped": false
}

MCP: sosoapi_create_asset

すべてのAPI操作認証と権限