專案與內容
列出專案
列出工作空間專案（用於來源追溯和帳號預設值的選填層）及目前使用中專案。
POST /studio-api/projects/list契約檢閱日期： · sha256:563d2d581da0ad29
概覽
列出工作空間專案（用於來源追溯和帳號預設值的選填層）及目前使用中專案。
成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。
驗證與權限
權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具，不會授予存取權。
請求欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
workspace_id | string在父物件中必填 |
|
limit | integer選填／項目 | 每頁筆數為 1 至 100。傳送 limit 或 cursor 會將此路由切換為游標分頁，並在回應加入 next_cursor。
|
cursor | string選填／項目 | 不透明游標：原樣使用上一頁的 next_cursor。首頁應省略。每一頁都必須傳送相同的篩選條件。
|
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.
成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 | — |
projects | array在父物件中必填 | — |
projects[] | object選填／項目 | — |
projects[].id | string在父物件中必填 |
|
projects[].workspace_id | string在父物件中必填 |
|
projects[].name | string在父物件中必填 |
|
projects[].operational_state | string在父物件中必填 |
|
projects[].lifecycle_version | integer在父物件中必填 |
|
projects[].defaults_version | integer在父物件中必填 |
|
projects[].archived_at | string | null在父物件中必填 | — |
projects[].archived_atanyOf 1 | string在父物件中必填 | — |
projects[].archived_atanyOf 2 | null在父物件中必填 | — |
projects[].archived_by | string | null在父物件中必填 | — |
projects[].archived_byanyOf 1 | string在父物件中必填 |
|
projects[].archived_byanyOf 2 | null在父物件中必填 | — |
projects[].archived_by_api_key_id | string | null在父物件中必填 | — |
projects[].archived_by_api_key_idanyOf 1 | string在父物件中必填 |
|
projects[].archived_by_api_key_idanyOf 2 | null在父物件中必填 | — |
projects[].created_at | string在父物件中必填 | — |
projects[].updated_at | string在父物件中必填 | — |
projects[].version | integer選填／項目 |
|
active_project_id | string | null在父物件中必填 | — |
active_project_idanyOf 1 | string在父物件中必填 |
|
active_project_idanyOf 2 | null在父物件中必填 | — |
next_cursor | string | null選填／項目 | 僅在請求傳送 limit 或 cursor 時出現。最後一頁為 null。 — |
next_cursoranyOf 1 | string選填／項目 | — |
next_cursoranyOf 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 存取錯誤再重試，並在收到 429 時遵循 Retry-After。如寫入結果不確定或回傳 5xx，先讀取現有結果。僅在支援時重複使用冪等鍵；重試行為因操作而異，並不保證恰好傳送一次。
故障排查指南範例
這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 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.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/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
}