Skip to main content
POST
Liste projetos acessíveis com paginação, pesquisa por nome e filtros de idioma e status. Um convidado da equipe vê apenas os projetos da API que criou.

Autenticação e permissões

string
obrigatório
Envie uma chave de API VoiceCheap neste cabeçalho. Authorization: Bearer com a mesma chave de API também é aceito. Tokens de acesso OAuth são aceitos apenas pelo MCP, não por este endpoint REST.
Permissões necessárias: projects:read. É necessária uma assinatura paga ativa. As permissões não alteram funções na equipe, propriedade dos recursos, créditos de mídia ou limites do plano.

Parâmetros

string
Valor de texto.Comprimento mínimo: 1. Comprimento máximo: 200.
integer
Valor inteiro.Mínimo: 0. Máximo: 100000. Valor padrão: 0.
integer
Valor inteiro.Mínimo: 1. Máximo: 50. Valor padrão: 20.
string
Valor de texto.Valores aceitos: “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
Valor de texto.Valores aceitos: “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
Valor de texto.Valores aceitos: “awaitingProofreading”, “translated”, “failed”.
string
Valor de texto.Valores aceitos: “newestFirst”, “oldestFirst”. Valor padrão: “newestFirst”.
string
Valor de texto.Comprimento mínimo: 1. Comprimento máximo: 200. Padrão: ^[^/\\]+$.
O JSON Schema abaixo preserva os nomes exatos dos campos, tipos aninhados, valores padrão, limites e valores aceitos expostos pela descoberta. Regras adicionais entre campos são listadas nas notas da operação.

Exemplos de requisição

Substitua os identificadores de recursos e as chaves de mídia dos exemplos pelos valores retornados para sua conta. Mantenha o identificador da requisição ao tentar novamente a mesma alteração.

Resposta

Uma primeira execução bem-sucedida retorna HTTP 200 com o resultado da operação em data. Uma repetição pode retornar o estado salvo da requisição. O exemplo mostra uma resposta aceita, não todos os campos opcionais. Retorna uma página de resumos de projetos acessíveis e metadados de paginação por deslocamento.

Campos do resultado

Notas da operação

  • O padrão de offset é 0, o de limit é 20 (máximo 50) e o de sort é newestFirst. query busca pelo nome do projeto; folderId, idioma de origem, idioma de destino e status filtram a lista.
  • Os campos de projeto retornados são projectId, projectName, originalLanguage, targetLanguages, duration, createdAt, progressStep e folderId. Campos opcionais não armazenados podem ser omitidos; targetLanguages usa [] por padrão, duration usa 0 e folderId usa null.
  • nextOffset é definido quando a página subjacente obtida contém limit itens; ele não é uma contagem total nem prova de que existe outro resultado acessível.
  • Convidados da equipe veem apenas projetos criados pela API por esse mesmo membro na mesma equipe. A filtragem pode produzir um array projects menor, mesmo quando nextOffset está presente.
  • originalLanguage usa códigos do idioma de origem, como fr ou en (ou auto-detect, quando aceito); targetLanguage usa nomes de idiomas de destino compatíveis, como english.

Uso

Cada chamada bem-sucedida consome uma chamada mensal da API/MCP. Os créditos de mídia e as cotas de geração da própria operação também se aplicam.

Erros