> ## 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.

# Get project publication state

> Get original publishing progress, translated publication attempts and scheduled publications for an accessible project.

Get original publishing progress, translated publication attempts and scheduled publications for an accessible project.

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

## Authentication and permissions

<ParamField header="x-api-key" type="string" required>
  Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
  MCP, not by this REST endpoint.
</ParamField>

Required permissions: `publishing:read`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

<ParamField body="projectId" type="string" required>
  Text value.

  Minimum length: 1. Maximum length: 200. Pattern: `^[^/\\]+$`.
</ParamField>

<Accordion title="Complete input schema">
  The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

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

## Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

<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>

## Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field.

Returns the project's original publication state, public translated publication attempts and the actor's scheduled publications for that project.

<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>

## Result fields

| Field | Description |
| - | - |
| `data.projectId` | Parent project identifier. |
| `data.originalPublish` | Public original publication state, or null when the project has none. |
| `data.translations` | One entry per translated version with workId, translatedVersionId, targetLanguage, attempts and publishedVideos. Empty attempt and publication lists are returned as \[]. |
| `data.translations[].attempts` | Optional array of public publication attempts: id, status, origin, plus optional scheduledAt, processingStartedAt, publishedAt, failedAt, privacyStatus, url, videoId, errorMessage. |
| `data.translations[].publishedVideos` | Optional array with type, videoId, privacyStatus and optional url, datePublished, origin, scheduledAt, plannedPublicationId. |
| `data.scheduled` | Scheduled publication records belonging to the authenticated actor and this project. Includes id, optional workId and translatedVersionId, platform, status, scheduledAt, title and optional publishedVideoUrl. |
| `data.scheduled[].scheduledAt` | Scheduled time in Unix milliseconds. |
| `data.originalPublish.id` | Original publication attempt identifier. |
| `data.originalPublish.workId` | Optional language-work identifier used by the original publishing workflow. |
| `data.originalPublish.title` | Publication title. |
| `data.originalPublish.description` | Optional description. |
| `data.originalPublish.status` | idle, scheduled, in-progress, completed, or failed. |
| `data.originalPublish.useDynamicSubtitles` | Whether the original publishing workflow requested dynamic subtitles. |
| `data.originalPublish.dynamicSubtitlesVideoUrl` | Optional generated subtitle-video URL. |
| `data.originalPublish.scheduledAt` | Optional scheduled time in Unix milliseconds. |
| `data.originalPublish.createdAt` | Creation time in Unix milliseconds. |
| `data.originalPublish.updatedAt` | Latest update time in Unix milliseconds. |
| `data.originalPublish.channels` | Per-channel state with channelId, platform, status and optional videoId, videoUrl, scheduledAt. |

## Operation notes

* originalPublish is null when the project has no original publishing state. Its projection excludes stored credit accounting, channel authentication, privacy configuration and raw error messages.
* Each translations entry has attempts and publishedVideos arrays, including \[] when no records exist.
* scheduled is filtered both by projectId and the authenticated actor, not by the effective team billing owner.
* This is the resource-state polling action after a publishing action has finished its request-level execution.
* Stored failures return VoiceCheap error codes and fixed messages. Use the code and current resource state to decide how to recover.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `VALIDATION_ERROR` | Correct the input using the schema. Invalid or inconsistent values are rejected before execution. |
| 401 | `API_KEY_EXPIRED` | The API key has expired. |
| 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. |
| 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | `USER_NOT_FOUND` | The credential's account no longer exists. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `FORBIDDEN` | The authenticated actor cannot access this project. |
| 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 404 | `PROJECT_NOT_FOUND` | The project does not exist in the accessible account. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. |
| 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |

```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.