Skip to main content
POST
Consulte o nome de uma pasta, suas instruções de tradução, IDs de projetos e métricas opcionais de projetos no seu espaço de trabalho ativo.

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: folders: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
obrigatório
Valor de texto.Comprimento mínimo: 1. Comprimento máximo: 200. Padrão: ^[^/]+$.
boolean
Valor booleano.Valor padrão: false.
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 os detalhes da pasta, com as métricas atuais dos projetos quando solicitadas.

Campos do resultado

Notas da operação

  • includeProjectMetrics tem false como padrão. As métricas são omitidas, a menos que sejam solicitadas.
  • Para convidados da equipe, projectIds e as métricas solicitadas incluem apenas projetos que eles criaram pela API na equipe ativa. Os resultados salvos e as repetições aplicam as mesmas verificações de acesso aos projetos.

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