מדיה ונכסים

יצירת נכס

רישום רשומת נכס עבור מדיה או טקסט שכבר מאוחסנים אצלכם (asset_url, asset_type). הפעולה אינה מעלה דבר: השתמשו ב-sosoapi_upload_asset לקובץ מקומי או ב-sosoapi_import_asset_url כדי ש-SosoAPI ימשוך URL ציבורי. העבירו workspace_id (הבקשה תידחה בלעדיו לאחר אכיפת יעד מפורש). idempotency_key אופציונלי.

POST /assets-api/create

החוזה נבדק: 2026-10-21 · sha256:563d2d581da0ad29

קריאה בפורמט Markdown הורדת החוזה הציבורי הורדת OpenAPI

סקירה

תגובת HTTP מוצלחת עשויה לציין שבקשה התקבלה, ולא שהושלמה. בעבודת רקע, שמרו את המזהה שהוחזר ובדקו את אותה פעולה עד שתסתיים. פוסט שתוזמן או התקבל נחשב שפורסם רק כשהפלטפורמה מאשרת זאת; חריגה מזמן ההמתנה אצל הלקוח אינה קובעת מה התוצאה.

אימות והרשאות

סוגי אמצעי גישה מתקבלים: 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_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 לפני ניסיון חוזר, ופעלו לפי Retry-After עבור 429. אם תוצאת כתיבה אינה ודאית או שמוחזר 5xx, קראו תחילה את התוצאה הקיימת. השתמשו שוב במפתח אידמפוטנטיות רק במקומות הנתמכים; התנהגות הניסיון החוזר משתנה בין פעולות ואינה מבטיחה מסירה בדיוק פעם אחת.

מדריך לפתרון בעיות

דוגמאות

הדוגמאות משתמשות בערכים בדויים שנבדקו מול הסכמות. החליפו את המזהים בכאלה שאתם מורשים להשתמש בהם, את המדיה בנכסים מוכנים ואת התאריכים במועד הפרסום שאישרתם. בדקו את התאמת החשבון לפני שליחת כתיבה. העמוד הזה אינו שולח בקשות 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 אימות והרשאות