Skip to main content
POST
Wyświetl dostępne projekty z paginacją, wyszukiwaniem po nazwie i filtrami języka oraz stanu. Gość zespołu widzi tylko projekty API, które sam utworzył.

Uwierzytelnianie i uprawnienia

string
wymagane
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.
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

string
Wartość tekstowa.Minimalna długość: 1. Maksymalna długość: 200.
integer
Liczba całkowita.Minimum: 0. Maksimum: 100000. Wartość domyślna: 0.
integer
Liczba całkowita.Minimum: 1. Maksimum: 50. Wartość domyślna: 20.
string
Wartość tekstowa.Dozwolone wartości: “afrikaans”, “albanian”, “amharic”, “arabic”, “armenian”, “assamese”, “azerbaijani”, “basque”, “belarusian”, “bengali”, “bosnian”, “bulgarian”, “catalan”, “croatian”, “czech”, “danish”, “dutch”, “english”, “british english”, “estonian”, “finnish”, “french”, “french canadian”, “galician”, “german”, “greek”, “gujarati”, “hebrew”, “hindi”, “hungarian”, “icelandic”, “indonesian”, “irish”, “italian”, “japanese”, “kannada”, “kazakh”, “khmer”, “korean”, “lao”, “latvian”, “lithuanian”, “macedonian”, “malay”, “malayalam”, “mandarin”, “marathi”, “mongolian”, “nepali”, “norwegian”, “persian”, “polish”, “portuguese”, “brazilian portuguese”, “pt_brazil”, “punjabi”, “romanian”, “russian”, “serbian”, “slovak”, “slovenian”, “spanish”, “swahili”, “swedish”, “tagalog”, “tamil”, “telugu”, “thai”, “turkish”, “ukrainian”, “urdu”, “vietnamese”, “welsh”, “yoruba”, “zulu”.
string
Wartość tekstowa.Dozwolone wartości: “af”, “sq”, “am”, “ar”, “hy”, “as”, “ast”, “az”, “ba”, “eu”, “be”, “bn”, “bs”, “br”, “bg”, “my”, “ca”, “ceb”, “zh”, “hr”, “cs”, “da”, “nl”, “en”, “eo”, “at”, “et”, “fil”, “fo”, “fi”, “fr”, “fr-CA”, “fy”, “ff”, “gd”, “gl”, “lg”, “ka”, “de”, “el”, “gu”, “ht”, “ha”, “haw”, “he”, “hi”, “hu”, “is”, “ig”, “ilo”, “id”, “ia”, “ga”, “it”, “ja”, “jv”, “kea”, “kn”, “kk”, “km”, “kur”, “kir”, “ko”, “lo”, “la”, “luo”, “lv”, “lb”, “ln”, “lt”, “mk”, “mg”, “ms”, “ml”, “mt”, “mi”, “mr”, “mo”, “mn”, “ne”, “no”, “nn”, “nso”, “nya”, “oc”, “or”, “pa”, “ps”, “fa”, “pl”, “pt”, “ro”, “ru”, “sa”, “sr”, “sn”, “sd”, “si”, “sk”, “sl”, “so”, “es”, “su”, “sw”, “ss”, “sv”, “tl”, “tg”, “ta”, “tt”, “te”, “th”, “bo”, “tn”, “tr”, “tk”, “ug”, “uk”, “umb”, “ur”, “uz”, “vi”, “cy”, “wo”, “xh”, “yi”, “yo”, “zu”, “cmn”, “yue”, “en-GB”, “en-US”, “en-AU”, “auto-detect”.
string
Wartość tekstowa.Dozwolone wartości: “awaitingProofreading”, “translated”, “failed”.
string
Wartość tekstowa.Dozwolone wartości: “newestFirst”, “oldestFirst”. Wartość domyślna: “newestFirst”.
string
Wartość tekstowa.Minimalna długość: 1. Maksymalna długość: 200. Wzorzec: ^[^/\\]+$.
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.

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.

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 stronę podsumowań dostępnych projektów i metadane paginacji z przesunięciem.

Pola wyniku

Uwagi do operacji

  • offset ma domyślną wartość 0, limit ma wartość 20 (maksymalnie 50), a sort ma wartość newestFirst. query wyszukuje po nazwie projektu; folderId, język źródłowy, język docelowy i status filtrują listę.
  • Zwracane pola projektu to projectId, projectName, originalLanguage, targetLanguages, duration, createdAt, progressStep i folderId. Opcjonalne niezapisane pola mogą zostać pominięte; targetLanguages ma domyślnie wartość [], duration — 0, a folderId — null.
  • nextOffset jest ustawiane, gdy pobrana strona źródłowa zawiera limit elementów; nie jest to łączna liczba ani dowód na istnienie kolejnego dostępnego wyniku.
  • Goście zespołu widzą tylko projekty utworzone przez API przez tego samego członka w tym samym zespole. Filtrowanie może skrócić tablicę projects nawet wtedy, gdy występuje nextOffset.
  • originalLanguage używa kodów języka źródłowego, takich jak fr lub en (lub auto-detect tam, gdzie jest akceptowane); targetLanguage używa obsługiwanych nazw języka docelowego, takich jak english.

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