Skip to main content
POST
アクティブなワークスペースのフォルダー名、翻訳指示、プロジェクト ID、および任意のプロジェクト指標を取得します。

認証と権限

string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP でのみ使用でき、この REST エンドポイントでは使用できません。
必要な権限: folders:read. 有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。

パラメーター

string
必須
テキスト値。最小文字数: 1. 最大文字数: 200. パターン: ^[^/]+$.
boolean
真偽値。デフォルト値: false.
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

リクエスト例

例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。

レスポンス

初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 フォルダーの詳細を返します。指定した場合は、現在のプロジェクト指標も含みます。

結果フィールド

操作の注意事項

  • includeProjectMetrics のデフォルトは false です。指定しない限り、指標は省略されます。
  • チームのゲストの場合、projectIds と要求された集計値には、アクティブなチームで本人が API を通じて作成したプロジェクトのみが含まれます。保存結果と再実行にも同じプロジェクトアクセス確認が適用されます。

使用量

正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。

エラー