curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/usage_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"month": "2026-10",
"usedCalls": 120,
"pendingCalls": 2,
"monthlyLimit": 500,
"remainingCalls": 378,
"requestsPerMinute": 30,
"resetsAt": 1793491200000,
"plan": "beginner"
}
}
Uso e atividade
Consultar o uso de chamadas à API e ao MCP
Consulte a cota mensal compartilhada de chamadas à API e ao MCP, as chamadas restantes, a data de renovação do limite e o limite de taxa de requisições do seu espaço de trabalho de cobrança.
POST
/
v1
/
actions
/
usage_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/usage_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"month": "2026-10",
"usedCalls": 120,
"pendingCalls": 2,
"monthlyLimit": 500,
"remainingCalls": 378,
"requestsPerMinute": 30,
"resetsAt": 1793491200000,
"plan": "beginner"
}
}
Consulte a cota mensal compartilhada de chamadas à API e ao MCP, as chamadas restantes, a data de renovação do limite e o limite de taxa de requisições do seu espaço de trabalho de cobrança.
Permissões necessárias:
POST https://api.voicecheap.ai/v1/actions/usage_get
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.
usage: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
Envie um objeto JSON vazio. Esta ação não possui campos de entrada.Esquema de entrada completo
Esquema de entrada completo
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.
{
"type": "object",
"properties": {},
"additionalProperties": false
}
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.curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/usage_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
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 a cota compartilhada de chamadas de API e MCP do espaço de trabalho ativo para o mês atual do calendário UTC.{
"data": {
"month": "2026-10",
"usedCalls": 120,
"pendingCalls": 2,
"monthlyLimit": 500,
"remainingCalls": 378,
"requestsPerMinute": 30,
"resetsAt": 1793491200000,
"plan": "beginner"
}
}
Campos do resultado
| Campo | Descrição |
|---|---|
data.month | Mês do calendário UTC no formato YYYY-MM. |
data.usedCalls | Chamadas concluídas com sucesso contabilizadas neste mês. |
data.pendingCalls | Chamadas admitidas que ainda estão reservadas e contam para a cota. |
data.monthlyLimit | Cota mensal de chamadas; null significa que não há limite mensal. |
data.remainingCalls | Cota restante após chamadas concluídas e pendentes; null quando monthlyLimit é null. |
data.requestsPerMinute | Limite compartilhado de requisições por minuto do espaço de trabalho. |
data.resetsAt | Primeiro instante do próximo mês-calendário UTC como um timestamp Unix em milissegundos. |
data.plan | Plano efetivo do espaço de trabalho. |
Notas da operação
- API e MCP consomem a mesma cota do espaço de trabalho. Chamadas mensais ilimitadas continuam sujeitas a limites de requisições e créditos de mídia.
- usage_get em si é isento do contador mensal de chamadas e continua sujeito a autenticação e limite de taxa.
Uso
Este controle de status ou uso não consome a cota mensal de chamadas da API/MCP. A autenticação, o acesso pago, a propriedade e os limites de taxa continuam se aplicando.Erros
| Status HTTP | Código | Significado ou recuperação |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Foram fornecidas credenciais em um parâmetro de consulta access_token ou api_key. Envie as credenciais nos cabeçalhos. |
| 400 | VALIDATION_ERROR | O objeto JSON contém um campo não compatível, um valor inválido ou um argumento obrigatório ausente. |
| 401 | API_KEY_EXPIRED | A chave de API expirou. |
| 401 | INVALID_API_KEY | Forneça uma chave de API válida e dentro do prazo de validade. |
| 401 | INVALID_CREDENTIAL | O cabeçalho Authorization está malformado ou entra em conflito com x-api-key. |
| 401 | MISSING_CREDENTIAL | Nenhuma credencial utilizável foi fornecida no cabeçalho, ou ela excedeu 4096 caracteres. |
| 401 | USER_NOT_FOUND | A conta da credencial não existe mais. |
| 403 | AMBIGUOUS_TEAM_API_KEY | O usuário da credencial pertence a mais de uma equipe, portanto o contexto de cobrança é ambíguo. |
| 403 | INSUFFICIENT_SCOPE | Conceda todas as permissões necessárias ou escolha outra credencial. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Não foi possível verificar o plano efetivo. |
| 403 | SUBSCRIPTION_REQUIRED | Use uma assinatura paga ativa. |
| 403 | TEAM_OWNER_NOT_FOUND | Não foi possível encontrar a conta efetiva do proprietário da equipe. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Aguarde o prazo de Retry-After, quando presente, e aumente progressivamente o intervalo entre as tentativas. |
| 500 | INTERNAL_ERROR | Verifique o estado da requisição salva e o histórico do recurso antes de decidir repetir uma alteração. |
| 503 | SERVER_RESTARTING | O servidor está reiniciando. Tente novamente em breve e mantenha o mesmo identificador de requisição para uma alteração. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["usage:read"]
}
}
Esta página foi útil?