排程與發布
取得 X 發布額度
讀取此 Workspace 共用的 Organization X 發布額度。需要 workspace_id。Free 一次獲得 10；Pro 每個帳務週期獲得 100。純文字費用為 1，含 URL 的文字費用為 10。選填 text 可估算費用。此操作讀取已儲存額度，不呼叫 X API。
POST /studio-api/x/usage契約檢閱日期： · sha256:563d2d581da0ad29
概覽
讀取此 Workspace 共用的 Organization X 發布額度。需要 workspace_id。Free 一次獲得 10；Pro 每個帳務週期獲得 100。純文字費用為 1，含 URL 的文字費用為 10。選填 text 可估算費用。此操作讀取已儲存額度，不呼叫 X API。
成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。
驗證與權限
權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具，不會授予存取權。
請求欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | 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，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | 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；處理常式錯誤使用 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/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