媒体与素材
创建素材
为已由你托管的媒体或文字登记素材记录(asset_url、asset_type)。此操作不会上传任何内容:本地文件请使用 sosoapi_upload_asset;若要由 SosoAPI 获取公开 URL,请使用 sosoapi_import_asset_url。请传入 workspace_id(强制明确指定目标后,未提供即拒绝)。idempotency_key 为可选。
POST /assets-api/create契约审核日期: · sha256:563d2d581da0ad29
概览
为已由你托管的媒体或文字登记素材记录(asset_url、asset_type)。此操作不会上传任何内容:本地文件请使用 sosoapi_upload_asset;若要由 SosoAPI 获取公开 URL,请使用 sosoapi_import_asset_url。请传入 workspace_id(强制明确指定目标后,未提供即拒绝)。idempotency_key 为可选。
成功 HTTP 响应可能表示请求已接受,并非已完成。背景工作请存储返回 ID,持续检查同一操作直到完成。已排程或已接受的帖子,只有平台确认后才算已发布;客户端逾时无法证明结果。
验证与权限
令牌只能使用其所有者持有的权利。每次请求会检查工作区成员资格、资源拥有权、所选工作区及已授予能力。core 与 full 配置只变更显示的工具,不会授予访问权限。
请求字段
「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。
| 字段 / 分支 | 类型 / 必填 | 约束 |
|---|---|---|
$ | object在父对象中必填 |
|
workspace_id | string可选/项目 |
|
asset_type | string在父对象中必填 |
|
asset_url | string在父对象中必填 |
|
title | string可选/项目 |
|
description | string可选/项目 |
|
tags | array可选/项目 |
|
tags[] | string可选/项目 |
|
metadata | object可选/项目 | 自由格式 JSON 对象;序列化后的 UTF-8 大小不得超过 16384 字节。
|
metadata.* | any JSON value可选/项目 | — |
source | string可选/项目 |
|
source_metadata | object可选/项目 | 自由格式 JSON 对象;序列化后的 UTF-8 大小不得超过 16384 字节。
|
source_metadata.* | any JSON value可选/项目 | — |
idempotency_key | string可选/项目 |
|
完整 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.
成功 HTTP 响应可能表示请求已接受,并非已完成。背景工作请存储返回 ID,持续检查同一操作直到完成。已排程或已接受的帖子,只有平台确认后才算已发布;客户端逾时无法证明结果。
「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。
| 字段 / 分支 | 类型 / 必填 | 约束 |
|---|---|---|
$ | object在父对象中必填 | — |
asset | object在父对象中必填 | — |
asset.id | integer | string在父对象中必填 | — |
asset.idanyOf 1 | integer在父对象中必填 |
|
asset.idanyOf 2 | string在父对象中必填 | — |
asset.workspace_id | string在父对象中必填 |
|
asset.user_id | string在父对象中必填 |
|
asset.asset_type | string在父对象中必填 |
|
asset.asset_url | string | null在父对象中必填 | — |
asset.asset_urlanyOf 1 | string在父对象中必填 | — |
asset.asset_urlanyOf 2 | null在父对象中必填 | — |
asset.preview_url | string | null可选/项目 | 由 工作区 授权的暂时读取 URL。preview_expires_at 后,请通过素材读取/清单重新获取;保留 asset_url 作为持久媒体身分。 — |
asset.preview_urlanyOf 1 | string可选/项目 |
|
asset.preview_urlanyOf 2 | null可选/项目 | — |
asset.preview_expires_at | string | null可选/项目 | — |
asset.preview_expires_atanyOf 1 | string可选/项目 |
|
asset.preview_expires_atanyOf 2 | null可选/项目 | — |
asset.title | string | null在父对象中必填 | — |
asset.titleanyOf 1 | string在父对象中必填 | — |
asset.titleanyOf 2 | null在父对象中必填 | — |
asset.description | string | null在父对象中必填 | — |
asset.descriptionanyOf 1 | string在父对象中必填 | — |
asset.descriptionanyOf 2 | null在父对象中必填 | — |
asset.tags | array | null在父对象中必填 | — |
asset.tagsanyOf 1 | array在父对象中必填 | — |
asset.tags[]anyOf 1 | string可选/项目 | — |
asset.tagsanyOf 2 | null在父对象中必填 | — |
asset.metadata | object | null在父对象中必填 | — |
asset.metadataanyOf 1 | object在父对象中必填 |
|
asset.metadata.*anyOf 1 | any JSON value可选/项目 | — |
asset.metadataanyOf 2 | null在父对象中必填 | — |
asset.source | string | null可选/项目 | — |
asset.sourceanyOf 1 | string可选/项目 | — |
asset.sourceanyOf 2 | null可选/项目 | — |
asset.source_metadata | object | null可选/项目 | — |
asset.source_metadataanyOf 1 | object可选/项目 |
|
asset.source_metadata.*anyOf 1 | any JSON value可选/项目 | — |
asset.source_metadataanyOf 2 | null可选/项目 | — |
asset.created_at | string在父对象中必填 | — |
asset.version | integer可选/项目 |
|
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,先读取现有结果。仅在支持时复用幂等键;重试行为因操作而异,并不保证恰好交付一次。
故障排查指南示例
这些示例使用已依schema检查的虚构值。请将 ID 替换为你有权使用的 ID、将媒体替换为已就绪素材,并将日期替换为已确认的发布时间。提交写入前,请检查账号资格。本页不会发送 API 请求。
在服务器上将 SOSOAPI_ACCESS_TOKEN 设为此操作接受的凭证,且不要放入浏览器代码。agent 请使用 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.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/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