> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# プロジェクトの公開状態を取得

> アクセス可能なプロジェクトの元動画の公開進捗、翻訳版の公開試行、公開予約を取得します。

アクセス可能なプロジェクトの元動画の公開進捗、翻訳版の公開試行、公開予約を取得します。

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/publishing_list
```

## 認証と権限

<ParamField header="x-api-key" type="string" required>
  このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
  でのみ使用でき、この REST エンドポイントでは使用できません。
</ParamField>

必要な権限: `publishing:read`.

有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。

## パラメーター

<ParamField body="projectId" type="string" required>
  テキスト値。

  最小文字数: 1. 最大文字数: 200. パターン: `^[^/\\]+$`.
</ParamField>

<Accordion title="完全な入力スキーマ">
  以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "projectId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      }
    },
    "required": ["projectId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## リクエスト例

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

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/publishing_list' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_launch_2026"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/publishing_list', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.VOICECHEAP_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(input),
  });
  const body = await response.json();
  if (!response.ok) throw new Error(body.code + ': ' + body.message);
  console.log(body);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/publishing_list",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_launch_2026"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## レスポンス

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

プロジェクトの元動画の公開状態、翻訳動画の公開試行に関する公開情報、および実行者がそのプロジェクトで予約した公開を返します。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "projectId": "project_launch_2026",
      "originalPublish": {
        "id": "7db6b953-7664-4bc2-811a-6aa7aa29038d",
        "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
        "title": "Product launch",
        "description": "Meet the new product.",
        "status": "completed",
        "useDynamicSubtitles": false,
        "createdAt": 1792152000000,
        "updatedAt": 1792152060000,
        "channels": [
          {
            "channelId": "UC1234567890abcdefghijkl",
            "platform": "youtube",
            "status": "completed",
            "videoId": "example1234",
            "videoUrl": "https://www.youtube.com/watch?v=example1234"
          }
        ]
      },
      "translations": [
        {
          "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
          "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
          "targetLanguage": "english",
          "attempts": [],
          "publishedVideos": []
        }
      ],
      "scheduled": [
        {
          "id": "9c186772-fdba-4da7-9f37-b860e319a754",
          "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
          "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
          "platform": "youtube",
          "status": "scheduled",
          "scheduledAt": 1918375200000,
          "title": "English product launch"
        }
      ]
    }
  }
  ```
</ResponseExample>

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.projectId` | 親プロジェクトの識別子。 |
| `data.originalPublish` | 原版公開の公開用状態。プロジェクトに原版公開がない場合は null。 |
| `data.translations` | 翻訳バージョンごとに1つの項目があり、workId、translatedVersionId、targetLanguage、attempts、publishedVideos を含みます。試行と公開のリストが空の場合は \[] を返します。 |
| `data.translations[].attempts` | 任意の公開試行の配列。id、status、origin、および任意の scheduledAt、processingStartedAt、publishedAt、failedAt、privacyStatus、url、videoId、errorMessage を含みます。 |
| `data.translations[].publishedVideos` | type、videoId、privacyStatus と、任意の url、datePublished、origin、scheduledAt、plannedPublicationId を含む任意の配列。 |
| `data.scheduled` | 認証済みの実行者と、このプロジェクトに属する予約公開レコード。id、省略可能な workId と translatedVersionId、platform、status、scheduledAt、title、省略可能な publishedVideoUrl を含みます。 |
| `data.scheduled[].scheduledAt` | 予約時刻（Unix ミリ秒）。 |
| `data.originalPublish.id` | 元メディアの公開試行の識別子。 |
| `data.originalPublish.workId` | 元の公開ワークフローで使用された、省略可能な言語別ワーク識別子。 |
| `data.originalPublish.title` | 公開時のタイトル。 |
| `data.originalPublish.description` | 省略可能な説明。 |
| `data.originalPublish.status` | idle、scheduled、in-progress、completed、failed のいずれか。 |
| `data.originalPublish.useDynamicSubtitles` | 元の公開ワークフローで動的字幕が要求されたかどうか。 |
| `data.originalPublish.dynamicSubtitlesVideoUrl` | 任意の生成済み字幕付き動画 URL。 |
| `data.originalPublish.scheduledAt` | 省略可能な予約時刻。Unix 時間のミリ秒単位。 |
| `data.originalPublish.createdAt` | 作成時刻（Unix ミリ秒）。 |
| `data.originalPublish.updatedAt` | 最終更新時刻。Unix ミリ秒。 |
| `data.originalPublish.channels` | チャンネルごとの状態。channelId、platform、status、および任意の videoId、videoUrl、scheduledAt を含みます。 |

## 操作の注意事項

* プロジェクトに元動画の公開状態がない場合、originalPublish は null です。返却用の投影結果には、保存済みクレジット会計、チャネル認証、プライバシー設定、未加工のエラーメッセージは含まれません。
* 各 translations エントリには attempts と publishedVideos の配列が含まれ、レコードが存在しない場合は \[] になります。
* scheduled は projectId と認証済み実行者の両方で絞り込まれ、実際のチーム請求所有者では絞り込まれません。
* 公開アクションのリクエスト単位の実行が完了した後に、リソースの状態をポーリングするためのアクションです。
* 保存された失敗は、VoiceCheap のエラーコードと固定メッセージを返します。コードとリソースの現在の状態を使って、復旧方法を判断してください。

## 使用量

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

## エラー

| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | access\_token または api\_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | `VALIDATION_ERROR` | スキーマに従って入力を修正してください。無効な値や整合性のない値は実行前に拒否されます。 |
| 401 | `API_KEY_EXPIRED` | API キーの有効期限が切れています。 |
| 401 | `INVALID_API_KEY` | 有効期限内の有効な API キーを指定してください。 |
| 401 | `INVALID_CREDENTIAL` | Authorization ヘッダーの形式が不正、または x-api-key と競合しています。 |
| 401 | `MISSING_CREDENTIAL` | 利用可能なヘッダー認証情報が指定されていないか、4096文字を超えています。 |
| 401 | `USER_NOT_FOUND` | 認証情報に対応するアカウントはすでに存在しません。 |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | 認証情報のユーザーが複数のチームに属しているため、課金コンテキストが曖昧です。 |
| 403 | `FORBIDDEN` | 認証済み実行者は、このプロジェクトにアクセスできません。 |
| 403 | `INSUFFICIENT_SCOPE` | 必要な権限をすべて付与するか、別の認証情報を使用してください。 |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | アカウントの連携上限を確認できませんでした。 |
| 403 | `SUBSCRIPTION_REQUIRED` | 有効な有料サブスクリプションを使用してください。 |
| 403 | `TEAM_OWNER_NOT_FOUND` | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | `PROJECT_NOT_FOUND` | アクセス可能なアカウントにこのプロジェクトは存在しません。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 月次リセットを待つか、プランを変更してください。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | `INTERNAL_ERROR` | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | `SERVER_RESTARTING` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["publishing:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.