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

# Pobierz projekt

> Pobierz szczegóły projektu, ustawienia dostępne do edycji, rewizję segmentów, adresy URL wyników i wersje tłumaczenia.

Pobierz szczegóły projektu, ustawienia dostępne do edycji, rewizję segmentów, adresy URL wyników i wersje tłumaczenia.

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

## Uwierzytelnianie i uprawnienia

<ParamField header="x-api-key" type="string" required>
  Wyślij klucz API VoiceCheap w tym nagłówku. Obsługiwany jest również nagłówek Authorization: Bearer z tym samym kluczem API. Tokeny dostępu OAuth są
  akceptowane tylko przez MCP, a nie przez ten endpoint REST.
</ParamField>

Wymagane uprawnienia: `projects:read`.

Wymagana jest aktywna płatna subskrypcja. Uprawnienia nie zmieniają ról w zespole, własności zasobów, kredytów na multimedia ani limitów planu.

## Parametry

<ParamField body="projectId" type="string" required>
  Wartość tekstowa.

  Minimalna długość: 1. Maksymalna długość: 200. Wzorzec: `^[^/\\]+$`.
</ParamField>

<Accordion title="Pełny schemat danych wejściowych">
  Poniższy JSON Schema zachowuje dokładne nazwy pól, typy zagnieżdżone, wartości domyślne, ograniczenia i akceptowane wartości udostępniane przez mechanizm wykrywania. Dodatkowe reguły zależności między polami znajdują się w uwagach do operacji.

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

## Przykłady żądań

Zastąp przykładowe identyfikatory zasobów i klucze multimediów wartościami zwróconymi dla Twojego konta. Przy ponawianiu tej samej operacji zmieniającej dane zachowaj identyfikator żądania.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_get' \
    --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/projects_get', {
    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/projects_get",
      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>

## Odpowiedź

Pierwsze pomyślne wykonanie zwraca HTTP 200 z wynikiem operacji w data. Ponowienie może zamiast tego zwrócić zapisany stan żądania. Przykład przedstawia jedną obsługiwaną odpowiedź, bez wszystkich opcjonalnych pól.

Zwraca publiczne szczegóły projektu, ustawienia klienta, bieżącą rewizję struktury źródłowej i każdą przetłumaczoną wersję wynikową.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "projectId": "project_launch_2026",
      "projectName": "Product launch",
      "status": "success",
      "workflow": "translation",
      "originalVideoUrl": "https://media.example.com/launch/original.mp4",
      "originalLanguage": "fr",
      "targetLanguages": [
        "english"
      ],
      "duration": 75,
      "createdAt": 1792152000000,
      "progress": {
        "step": "done",
        "transcriptionProgress": 100,
        "transcriptionStatus": "success"
      },
      "translations": [
        {
          "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
          "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
          "targetLanguage": "english",
          "status": "completed",
          "currentStep": "done",
          "progress": 100,
          "createdAt": 1792152060000,
          "completedAt": 1792152300000,
          "translatedVideoUrl": "https://media.example.com/launch/english.mp4",
          "translatedAudioUrl": "https://media.example.com/launch/english.mp3",
          "settings": {
            "voiceCloning": true,
            "uploadType": "video",
            "keepBackgroundMusic": true,
            "keepOriginalVoice": false,
            "originalVoiceVolume": 30,
            "subtitles": {
              "isEnable": false,
              "source": "translated"
            },
            "smartSync": true,
            "dubbingMode": "translate",
            "voiceIsolatorOption": "studio"
          }
        }
      ],
      "segmentStructureRevision": 3,
      "numberOfSpeakers": 1,
      "translationInstructions": "",
      "isReadyForDubbing": true,
      "settings": {
        "voiceCloning": true,
        "customVoice": false,
        "customVoiceId": "",
        "keepBackgroundMusic": true,
        "keepOriginalVoice": false,
        "originalVoiceVolume": 30,
        "activeSpeakerDetectionEnabled": false,
        "subtitles": {
          "isEnable": false,
          "source": "translated"
        },
        "smartSync": true,
        "voiceIsolatorOption": "studio",
        "voiceCloningSettings": {
          "stability": 0.5,
          "similarity": 0.75
        }
      }
    }
  }
  ```
</ResponseExample>

## Pola wyniku

| Pole | Opis |
| - | - |
| `data.projectId` | Identyfikator dostępnego projektu. |
| `data.projectName` | Nazwa projektu widoczna dla klienta. |
| `data.status` | Podsumowanie projektu: processing, success lub failed. |
| `data.workflow` | transcription dla projektów obejmujących wyłącznie transkrypcję; translation dla projektów dubbingowych. |
| `data.originalVideoUrl` | Pierwotnie zapisany adres URL multimediów, również dla projektów audio; pusty ciąg znaków, jeśli go nie ma. |
| `data.originalLanguage` | Wykryty lub wybrany język źródłowy; unknown, gdy niedostępny. |
| `data.targetLanguages` | Tablica nazw języków docelowych. |
| `data.duration` | Czas trwania oryginalnych multimediów w sekundach. |
| `data.createdAt` | Czas utworzenia projektu w milisekundach czasu Unix. |
| `data.progress` | Publiczny etap transkrypcji, opcjonalne transcriptionProgress i transcriptionStatus. |
| `data.translations` | Wszystkie przetłumaczone wersje ze wszystkich wersji językowych, uporządkowane od najnowszych według ujednoliconego createdAt. |
| `data.segmentStructureRevision` | Bieżąca rewizja struktury segmentów źródłowych, domyślnie 0. Przekaż tę wartość jako expectedSegmentStructureRevision do segments\_delete lub segments\_merge. |
| `data.numberOfSpeakers` | Zapisana liczba mówców w źródle, jeśli jest dostępna. |
| `data.translationInstructions` | Bieżące instrukcje tłumaczenia projektu; pusty ciąg znaków, gdy nie zapisano żadnych. |
| `data.isReadyForDubbing` | true tylko wtedy, gdy zapisany projekt jest oznaczony jako gotowy do dubbingu. |
| `data.settings` | Opcjonalne ustawienia klienta wybrane z ustawień dubbingu projektu lub starszych ustawień. Zwracane są tylko zapisane pola; nieobecne wartości opcjonalne są pomijane. |
| `data.settings.voiceCloning` | Opcjonalna preferencja klonowania głosu w projekcie. |
| `data.settings.customVoice` | Opcjonalna preferencja własnego głosu. |
| `data.settings.customVoiceId` | Opcjonalny identyfikator własnego głosu. |
| `data.settings.keepBackgroundMusic` | Opcjonalna preferencja dźwięku w tle. |
| `data.settings.keepOriginalVoice` | Opcjonalna preferencja oryginalnej mowy. |
| `data.settings.originalVoiceVolume` | Opcjonalna głośność oryginalnej mowy. |
| `data.settings.activeSpeakerDetectionEnabled` | Opcjonalna preferencja wykrywania aktywnego mówcy. |
| `data.settings.subtitles` | Opcjonalna preferencja napisów \{isEnable,source}. |
| `data.settings.smartSync` | Opcjonalna preferencja SmartSync. |
| `data.settings.voiceIsolatorOption` | Opcjonalna preferencja izolacji głosu studio lub realistic. |
| `data.settings.voiceCloningSettings` | Opcjonalne preferencje klonowania głosu \{stability,similarity}. |
| `data.error` | Opcjonalne publiczne \{code,message} dla błędu przetwarzania na poziomie projektu. |
| `data.translations[].workId` | Identyfikator wersji językowej zawierającej tę wersję. |
| `data.translations[].translatedVersionId` | Identyfikator określonej wersji wyniku dubbingu. |
| `data.translations[].targetLanguage` | Język docelowy wersji, z użyciem języka jej wersji językowej jako wartości zastępczej. |
| `data.translations[].status` | Zapisany stan wersji: not-started, in-progress, completed lub failed. |
| `data.translations[].currentStep` | Opcjonalny etap procesu dubbingu; progress to opcjonalna liczbowa wartość postępu. |
| `data.translations[].progress` | Opcjonalna wartość postępu dubbingu. |
| `data.translations[].createdAt` | Czas utworzenia ujednolicony do milisekund Unix; w razie braku używany jest czas utworzenia wersji językowej. |
| `data.translations[].completedAt` | Opcjonalny czas ukończenia w milisekundach Unix. |
| `data.translations[].failedAt` | Opcjonalny czas niepowodzenia w milisekundach Unix. |
| `data.translations[].timedOutAt` | Opcjonalny czas przekroczenia limitu czasu w milisekundach Unix. |
| `data.translations[].translatedVideoUrl` | Zapisany adres URL przetłumaczonego wideo lub pusty ciąg znaków, gdy jest niedostępny. |
| `data.translations[].translatedAudioUrl` | Zapisany adres URL przetłumaczonego audio lub pusty ciąg znaków, gdy jest niedostępny. |
| `data.translations[].error` | Opcjonalne \{code,message}, gdy wersja zakończyła się błędem. |
| `data.translations[].settings` | Publiczne ustawienia wersji: voiceCloning, uploadType, keepBackgroundMusic, keepOriginalVoice, originalVoiceVolume, subtitles, smartSync, dubbingMode, voiceIsolatorOption oraz opcjonalne translationQualityMode, cutBecauseFreeUser, originalDurationSeconds, cutDurationSeconds, voiceCloningSettings. |
| `data.translations[].settings.dubbingMode` | translate lub dub-only. SmartSync ma wartość false dla wersji dub-only. |
| `data.translations[].lipSync` | Opcjonalne \{latest,history}; każdy wpis zawiera jobId, status, videoUrl, errorMessage, type, createdAt oraz opcjonalne requestedAt, retryRequestedAt, completedAt, failedAt, timedOutAt, activeSpeakerDetectionEnabled, isRetried. Czasy synchronizacji ruchu ust są zapisanymi ciągami znaków ISO. |
| `data.translations[].dynamicSubtitles` | Opcjonalny obiekt z used, inProgress, magicZooms, magicBrolls, magicBrollsPercentage, videoUrl, errorMessage oraz opcjonalnymi removeSilencePace, removeBadTakes, templateName, requestedAt, rerunCount. requestedAt to czas Unix w milisekundach. |
| `data.translations[].publicationAttempts` | Opcjonalna tablica publicznych prób publikacji: id, status, origin oraz opcjonalnie scheduledAt, processingStartedAt, publishedAt, failedAt, privacyStatus, url, videoId, errorMessage. |
| `data.translations[].publishedVideos` | Opcjonalna tablica z type, videoId, privacyStatus oraz opcjonalnymi url, datePublished, origin, scheduledAt, plannedPublicationId. |

## Uwagi do operacji

* Ta akcja nie zwraca tekstu transkrypcji ani surowych dokumentów segmentów. Użyj transcripts\_get, aby pobrać treść transkrypcji, oraz translations\_list, aby pobrać metadane wersji językowych.
* Brakujące opcjonalne pola zagnieżdżone są pomijane w serializowanym JSON. Adresy URL wyników są pustymi ciągami znaków, dopóki odpowiedni wynik nie będzie dostępny.
* Stan projektu podsumowuje proces i najnowszą przetłumaczoną wersję; przy zarządzaniu kilkoma językami sprawdzaj poszczególne wpisy translations\[].
* Pole error opisuje zapisany błąd przetwarzania; udane pobranie projektu zakończonego błędem nadal zwraca zwykły wynik.
* Zapisane błędy zwracają kody błędów VoiceCheap i stałe komunikaty. Użyj kodu i aktualnego stanu zasobu, aby zdecydować, jak wznowić działanie.

## Wykorzystanie

Każde pomyślne wywołanie zużywa jedno wywołanie z miesięcznego limitu API/MCP. Obowiązują również kredyty na multimedia oraz limity generowania danej operacji.

## Błędy

| Status HTTP | Kod | Znaczenie lub sposób rozwiązania |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Dane uwierzytelniające zostały podane w parametrze zapytania access\_token lub api\_key. Wysyłaj dane uwierzytelniające w nagłówkach. |
| 400 | `VALIDATION_ERROR` | Popraw dane wejściowe zgodnie ze schematem. Nieprawidłowe lub niespójne wartości są odrzucane przed wykonaniem. |
| 401 | `API_KEY_EXPIRED` | Klucz API wygasł. |
| 401 | `INVALID_API_KEY` | Podaj prawidłowy, niewygasły klucz API. |
| 401 | `INVALID_CREDENTIAL` | Nagłówek Authorization ma nieprawidłowy format lub jest sprzeczny z x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Nie podano użytecznych danych uwierzytelniających w nagłówku lub przekroczyły one 4096 znaków. |
| 401 | `USER_NOT_FOUND` | Konto powiązane z poświadczeniem już nie istnieje. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | Użytkownik, do którego należą dane uwierzytelniające, należy do więcej niż jednego zespołu, więc kontekst rozliczeniowy jest niejednoznaczny. |
| 403 | `FORBIDDEN` | Uwierzytelniony podmiot wykonujący akcję nie ma dostępu do tego projektu. |
| 403 | `INSUFFICIENT_SCOPE` | Nadaj wszystkie wymagane uprawnienia lub wybierz inne dane uwierzytelniające. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Nie udało się zweryfikować limitów integracji konta. |
| 403 | `SUBSCRIPTION_REQUIRED` | Użyj aktywnej płatnej subskrypcji. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Nie znaleziono konta faktycznego właściciela zespołu. |
| 404 | `PROJECT_NOT_FOUND` | Projekt nie istnieje na dostępnym koncie. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Poczekaj na odnowienie miesięcznego limitu lub zmień plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Jeśli występuje nagłówek Retry-After, odczekaj wskazany czas i stosuj rosnące odstępy między ponowieniami. |
| 500 | `INTERNAL_ERROR` | Sprawdź stan zapisanego żądania i historię zasobu przed podjęciem decyzji o ponowieniu operacji zmieniającej dane. |
| 503 | `SERVER_RESTARTING` | Serwer jest uruchamiany ponownie. Spróbuj ponownie wkrótce i zachowaj ten sam identyfikator żądania dla operacji zmieniającej dane. |

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


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