排程及發佈
讀取 X 發佈額度
讀取工作空間所屬組織共享 X 額度，需要 workspace_id。Free 一次 10 credits，Pro 每 billing period 100；純文字費用 1，含 URL 文字費用 10。可選 text 報價。只讀已儲存額度，唔會呼叫 X API。
POST /studio-api/x/usageContract 核對日期: · sha256:563d2d581da0ad29
概覽
讀取工作空間所屬組織共享 X 額度，需要 workspace_id。Free 一次 10 credits，Pro 每 billing period 100；純文字費用 1，含 URL 文字費用 10。可選 text 報價。只讀已儲存額度，唔會呼叫 X API。
HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID，讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時，都唔代表已發佈。
驗證及權限
憑證唔能夠擴大持有人權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只改變可見工具，唔會授權。
請求欄位
必填表示喺所屬物件及所選分支內必須提供；子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
workspace_id | string父物件內必填 |
|
text | 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)$"
},
"text": {
"type": "string",
"maxLength": 4096
}
},
"required": [
"workspace_id"
],
"additionalProperties": false
}回應及完成條件
成功 HTTP 狀態碼: 200. 完成依據: synchronous_http_response.
HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID，讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時，都唔代表已發佈。
必填表示喺所屬物件及所選分支內必須提供；子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 | — |
workspace_id | string父物件內必填 |
|
plan | string父物件內必填 |
|
allowance | string父物件內必填 |
|
period_start | string父物件內必填 |
|
period_end | string | null父物件內必填 | — |
period_endanyOf 1 | string父物件內必填 |
|
period_endanyOf 2 | null父物件內必填 | — |
limit | number父物件內必填 | — |
limitanyOf 1 | number父物件內必填 |
|
limitanyOf 2 | number父物件內必填 |
|
reserved | integer父物件內必填 |
|
consumed | integer父物件內必填 |
|
remaining | integer父物件內必填 |
|
costs | object父物件內必填 | — |
costs.text | number父物件內必填 |
|
costs.with_url | number父物件內必填 |
|
draft_credits | number可選／陣列項目 | — |
draft_creditsanyOf 1 | number可選／陣列項目 |
|
draft_creditsanyOf 2 | number可選／陣列項目 |
|
完整 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)$"
},
"plan": {
"type": "string",
"enum": [
"free",
"founding_pro"
]
},
"allowance": {
"type": "string",
"enum": [
"one_time",
"monthly"
]
},
"period_start": {
"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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"period_end": {
"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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"limit": {
"anyOf": [
{
"type": "number",
"const": 10
},
{
"type": "number",
"const": 100
}
]
},
"reserved": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"consumed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"remaining": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"costs": {
"type": "object",
"properties": {
"text": {
"type": "number",
"const": 1
},
"with_url": {
"type": "number",
"const": 10
}
},
"required": [
"text",
"with_url"
]
},
"draft_credits": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 10
}
]
}
},
"required": [
"workspace_id",
"plan",
"allowance",
"period_start",
"period_end",
"limit",
"reserved",
"consumed",
"remaining",
"costs"
]
}錯誤及安全重試
檢查 HTTP 狀態及實際回應格式。驗證400可能回傳 ZodError；handler 錯誤可能係 error／message／code envelope。保留可用嘅 request_id 或 x-request-id，唔好記錄憑證。401／403先修正存取問題；429遵守 Retry-After。寫入結果未明或5xx時，先讀原有結果，再決定重試；只喺操作支援時重用 idempotency key，並冇通用重試或 exactly-once 保證。
問題排解指南範例
以下虛構值已按 contract 驗證，唔係真實帳戶 ID、憑證或發佈紀錄。請用已授權範圍回傳嘅 ID、已準備好嘅素材及已審核排程取代，寫入前核對平台資格。此頁唔會呼叫 API。
喺伺服器環境設定 SOSOAPI_ACCESS_TOKEN，使用此操作接受嘅憑證。唔好放入瀏覽器程式。一般 agent 建議透過 sosoapi auth login 用瀏覽器 OAuth，由 CLI 管理憑證更新。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/x/usage" \
-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/x/usage", {
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/x/usage < request.json虛構回應範例
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"plan": "free",
"allowance": "one_time",
"period_start": "2099-01-15T09:00:00Z",
"period_end": null,
"limit": 10,
"reserved": 0,
"consumed": 0,
"remaining": 0,
"costs": {
"text": 1,
"with_url": 10
}
}相關工具及指南
MCP: sosoapi_get_x_usage