Skip to main content
POST
Geef toegankelijke projecten weer met paginering, zoeken op naam en filters op taal en status. Een teamgast ziet alleen API-projecten die deze zelf heeft gemaakt.

Authenticatie en machtigingen

string
vereist
Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
Vereiste machtigingen: projects:read. Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.

Parameters

string
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 200.
integer
Gehele waarde.Minimum: 0. Maximum: 100000. Standaardwaarde: 0.
integer
Gehele waarde.Minimum: 1. Maximum: 50. Standaardwaarde: 20.
string
Tekstwaarde.Toegestane waarden: “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
Tekstwaarde.Toegestane waarden: “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
Tekstwaarde.Toegestane waarden: “awaitingProofreading”, “translated”, “failed”.
string
Tekstwaarde.Toegestane waarden: “newestFirst”, “oldestFirst”. Standaardwaarde: “newestFirst”.
string
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 200. Patroon: ^[^/\\]+$.
Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.

Voorbeeldaanvragen

Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.

Antwoord

Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Retourneert een pagina met toegankelijke projectsamenvattingen en metadata voor offsetpaginering.

Resultaatvelden

Opmerkingen bij de bewerking

  • offset is standaard 0, limit 20 (maximaal 50) en sort newestFirst. query zoekt op projectnaam; folderId, brontaal, doeltaal en status filteren de lijst.
  • De geretourneerde projectvelden zijn projectId, projectName, originalLanguage, targetLanguages, duration, createdAt, progressStep en folderId. Optionele niet-opgeslagen velden kunnen ontbreken; targetLanguages is standaard [], duration is standaard 0 en folderId is standaard null.
  • nextOffset wordt ingesteld wanneer de onderliggende opgehaalde pagina limit items bevat; het is geen totaalaantal of bewijs dat er nog een toegankelijk resultaat bestaat.
  • Teamgasten zien alleen projecten die via de API door datzelfde lid in hetzelfde team zijn aangemaakt. Door filtering kan de projects-array korter zijn, ook als nextOffset aanwezig is.
  • originalLanguage gebruikt brontaalcodes zoals fr of en (of auto-detect waar dit wordt geaccepteerd); targetLanguage gebruikt ondersteunde doeltaalnamen zoals english.

Verbruik

Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.

Fouten