פרויקטים ותוכן

רשימת פרויקטים

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

POST /studio-api/projects/list

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

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

סקירה

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

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

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

סוגי אמצעי גישה מתקבלים: user_session, delegated_oauth, personal_access_token
יכולת מואצלת: agent:operate
תפקיד מינימלי בסביבת העבודה: viewer
היקף הגישה: משאבים שהמשתמש הזה מורשה לגשת אליהם
נדרשת הסכמה לכל סביבות העבודה: לא
משנה מצב: לא
מתי הפעולה הושלמה: 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)$"`
`limit`	`integer`רשות / פריט	גודל עמוד, 1 עד 100. שליחת limit או cursor מעבירה את הנתיב לדפדוף באמצעות סמן ומוסיפה next_cursor לתשובה. `minimum: 1` `maximum: 100`
`cursor`	`string`רשות / פריט	סמן אטום: next_cursor מהעמוד הקודם, ללא שינוי. השמיטו בעמוד הראשון. יש לשלוח את אותם המסננים בכל עמוד. `minLength: 1` `maxLength: 512`
`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)$"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Page size, 1 to 100. Sending limit or cursor switches this route to cursor paging and adds next_cursor to the answer."
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Opaque cursor: the next_cursor of the previous page, unchanged. Omit it for the first page. The same filters must be sent with every page."
    },
    "include_version": {
      "description": "Optional. true adds the resource version to the answer.",
      "type": "boolean"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

תגובה והשלמה

סטטוסי HTTP להצלחה: 200. מתי הפעולה הושלמה: synchronous_http_response.

תגובה והשלמה
שדה / ענף	סוג / חובה	אילוצים
`$`	`object`חובה באובייקט האב	—
`projects`	`array`חובה באובייקט האב	—
`projects[]`	`object`רשות / פריט	—
`projects[].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)$"`
`projects[].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)$"`
`projects[].name`	`string`חובה באובייקט האב	`minLength: 1` `maxLength: 200`
`projects[].operational_state`	`string`חובה באובייקט האב	`enum: ["active","archived"]`
`projects[].lifecycle_version`	`integer`חובה באובייקט האב	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`projects[].defaults_version`	`integer`חובה באובייקט האב	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`projects[].archived_at`	`string \| null`חובה באובייקט האב	—
`projects[].archived_at`anyOf 1	`string`חובה באובייקט האב	—
`projects[].archived_at`anyOf 2	`null`חובה באובייקט האב	—
`projects[].archived_by`	`string \| null`חובה באובייקט האב	—
`projects[].archived_by`anyOf 1	`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)$"`
`projects[].archived_by`anyOf 2	`null`חובה באובייקט האב	—
`projects[].archived_by_api_key_id`	`string \| null`חובה באובייקט האב	—
`projects[].archived_by_api_key_id`anyOf 1	`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)$"`
`projects[].archived_by_api_key_id`anyOf 2	`null`חובה באובייקט האב	—
`projects[].created_at`	`string`חובה באובייקט האב	—
`projects[].updated_at`	`string`חובה באובייקט האב	—
`projects[].version`	`integer`רשות / פריט	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`active_project_id`	`string \| null`חובה באובייקט האב	—
`active_project_id`anyOf 1	`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)$"`
`active_project_id`anyOf 2	`null`חובה באובייקט האב	—
`next_cursor`	`string \| null`רשות / פריט	מופיע רק כשהבקשה שלחה limit או cursor. ‏Null בעמוד האחרון. —
`next_cursor`anyOf 1	`string`רשות / פריט	—
`next_cursor`anyOf 2	`null`רשות / פריט	—

JSON Schema מלא

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "projects": {
      "type": "array",
      "items": {
        "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)$"
          },
          "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)$"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "operational_state": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ]
          },
          "lifecycle_version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "defaults_version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "archived_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "archived_by": {
            "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"
              }
            ]
          },
          "archived_by_api_key_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"
              }
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "id",
          "workspace_id",
          "name",
          "operational_state",
          "lifecycle_version",
          "defaults_version",
          "archived_at",
          "archived_by",
          "archived_by_api_key_id",
          "created_at",
          "updated_at"
        ]
      }
    },
    "active_project_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"
        }
      ]
    },
    "next_cursor": {
      "description": "Present only when the request sent limit or cursor. Null on the last page.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "projects",
    "active_project_id"
  ]
}

שגיאות וניסיונות חוזרים בטוחים

בדקו את סטטוס ה-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

{
  "workspace_id": "11111111-1111-4111-8111-111111111111"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/projects/list" \
  -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/studio-api/projects/list", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_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 /studio-api/projects/list < request.json

דוגמת תגובה סינתטית

{
  "projects": [],
  "active_project_id": null
}

MCP: sosoapi_list_projects

כל פעולות ה-API אימות והרשאות