予約と公開
Xの投稿クレジットを取得
このワークスペースで共有する組織のX投稿クレジットを取得します。workspace_idが必要です。Freeは一度限り10、Proは請求期間ごとに100です。テキストは1、URLを含むテキストは10消費します。任意のtextを指定すると費用を見積もります。保存済みの利用枠を取得する操作で、X APIは呼び出しません。
POST /studio-api/x/usage契約確認日： · sha256:563d2d581da0ad29
概要
このワークスペースで共有する組織の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、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページは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