מדיה ונכסים
קבלת נכס
קריאת נכס אחד לפי id: מטא-נתונים ו-URL לתצוגה מקדימה לזמן קצר.
POST /assets-api/getהחוזה נבדק: · sha256:563d2d581da0ad29
סקירה
קריאת נכס אחד לפי id: מטא-נתונים ו-URL לתצוגה מקדימה לזמן קצר.
תגובת HTTP מוצלחת עשויה לציין שבקשה התקבלה, ולא שהושלמה. בעבודת רקע, שמרו את המזהה שהוחזר ובדקו את אותה פעולה עד שתסתיים. פוסט שתוזמן או התקבל נחשב שפורסם רק כשהפלטפורמה מאשרת זאת; חריגה מזמן ההמתנה אצל הלקוח אינה קובעת מה התוצאה.
אימות והרשאות
אסימון יכול להשתמש רק בזכויות שיש לבעליו. כל בקשה בודקת חברות בסביבת העבודה, בעלות על משאבים, סביבות עבודה נבחרות ויכולות שהוענקו. הפרופילים core ו-full משנים אילו כלים מוצגים; הם אינם מעניקים גישה.
שדות הבקשה
שדה חובה נדרש בתוך אובייקט האב והענף הנבחר שלו. צאצא נדרש אינו הופך אב אופציונלי לנדרש. הכללים ושמות השדות שלהלן מועתקים מהחוזה.
| שדה / ענף | סוג / חובה | אילוצים |
|---|---|---|
$ | objectחובה באובייקט האב |
|
workspace_id | stringרשות / פריט |
|
id | integer | stringחובה באובייקט האב | — |
idanyOf 1 | integerחובה באובייקט האב |
|
idanyOf 2 | stringחובה באובייקט האב | — |
include_version | booleanרשות / פריט | רשות. true מוסיף את גרסת המשאב לתשובה. — |
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)$"
},
"id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string"
}
]
},
"include_version": {
"description": "Optional. true adds the resource version to the answer.",
"type": "boolean"
}
},
"required": [
"id"
],
"additionalProperties": false
}תגובה והשלמה
סטטוסי HTTP להצלחה: 200. מתי הפעולה הושלמה: synchronous_http_response.
תגובת HTTP מוצלחת עשויה לציין שבקשה התקבלה, ולא שהושלמה. בעבודת רקע, שמרו את המזהה שהוחזר ובדקו את אותה פעולה עד שתסתיים. פוסט שתוזמן או התקבל נחשב שפורסם רק כשהפלטפורמה מאשרת זאת; חריגה מזמן ההמתנה אצל הלקוח אינה קובעת מה התוצאה.
שדה חובה נדרש בתוך אובייקט האב והענף הנבחר שלו. צאצא נדרש אינו הופך אב אופציונלי לנדרש. הכללים ושמות השדות שלהלן מועתקים מהחוזה.
| שדה / ענף | סוג / חובה | אילוצים |
|---|---|---|
$ | 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רשות / פריט |
|
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"
]
}
},
"required": [
"asset"
]
}שגיאות וניסיונות חוזרים בטוחים
בדקו את סטטוס ה-HTTP ואת גוף התגובה. שגיאת אימות 400 עשויה להכיל ZodError; שגיאות מטפל משתמשות בשדות error, message ו-code. שמרו request_id או x-request-id לאבחון, ללא אמצעי גישה. תקנו שגיאות גישה 401/403 לפני ניסיון חוזר, ופעלו לפי Retry-After עבור 429. אם תוצאת כתיבה אינה ודאית או שמוחזר 5xx, קראו תחילה את התוצאה הקיימת. השתמשו שוב במפתח אידמפוטנטיות רק במקומות הנתמכים; התנהגות הניסיון החוזר משתנה בין פעולות ואינה מבטיחה מסירה בדיוק פעם אחת.
מדריך לפתרון בעיותדוגמאות
הדוגמאות משתמשות בערכים בדויים שנבדקו מול הסכמות. החליפו את המזהים בכאלה שאתם מורשים להשתמש בהם, את המדיה בנכסים מוכנים ואת התאריכים במועד הפרסום שאישרתם. בדקו את התאמת החשבון לפני שליחת כתיבה. העמוד הזה אינו שולח בקשות API.
הגדירו בשרת שלכם SOSOAPI_ACCESS_TOKEN לאמצעי גישה שהפעולה הזו מקבלת, והשאירו אותו מחוץ לקוד הדפדפן. עבור סוכן, השתמשו ב-sosoapi auth login כדי להיכנס דרך הדפדפן ולאפשר ל-CLI לרענן את אמצעי הגישה שלו.
request.json
{
"id": 0
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/assets-api/get" \
-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/get", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"id": 0
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /assets-api/get < 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"
}
}כלים ומדריכים קשורים
MCP: sosoapi_get_asset