Última atualização
Créditos
Todo espaço de trabalho tem uma carteira de créditos que é recarregada a cada período de cobrança. As chamadas à API e as leituras no painel usam a mesma carteira; a referência indica a classe de cada operação.
Quanto custa uma operação
| Classe | Créditos por chamada | Abrange |
|---|---|---|
| Leitura em cache | 1 | Toda leitura de dados armazenados: rankings, criadores, insights, vídeos, comentários, tendências, sessões de LIVE. Listar chaves de API (GET /v1/api-keys) também é uma leitura em cache. |
| Lista de seguidos | 4,000 | GET /v1/creators/{uid}/following ou /followers quando a lista precisa ser coletada de novo (em vez de 1). |
| Comentários | 500 | GET /v1/videos/{id}/comments quando os comentários precisam ser coletados de novo (em vez de 1). |
| Resolução de perfil | 1,250 | GET /v1/creators/{uid} quando um perfil desatualizado é resolvido de novo, além da leitura. Cobrado só se um perfil for retornado. |
| Atualização ao vivo | 1,250 | POST /v1/live/creators/{uid}/refresh: pede aos workers que verifiquem um criador agora. |
| Exportação | 2,500 | POST /v1/exports: gera um arquivo CSV ou Excel. |
| Entrega de webhook | 1 | Cada webhook entregue por uma regra de alerta, inclusive o enviado por um teste de regra. |
| Grátis | 0 | Gerenciar regras de alerta, listar e baixar exportações, criar e revogar chaves, direitos do plano e uso. |
Cada operação na referência mostra sua classe ao lado do escopo. Uma resposta 202 (coleta ainda em andamento) é cobrada como leitura em cache.
Franquia mensal
A cada mês civil (UTC), o plano do espaço de trabalho concede sua franquia, na primeira chamada cobrada ou leitura da carteira do mês. O gasto em um mês não pode passar da franquia. Veja os planos em preços.
| Plano | Créditos por mês |
|---|---|
| Free | 150,000 |
| Starter | 450,000 |
| Pro | 3,000,000 |
| Scale | 12,000,000 |
| Agency / Enterprise | 36,000,000 |
Quando a carteira fica vazia
Uma chamada cobrada que ultrapassaria o limite responde 402 com o código credit_cap_exceeded no envelope de erro de sempre. As operações gratuitas continuam funcionando. A carteira é recarregada no início do mês seguinte; fazer upgrade no meio do mês aumenta o limite.
4xx ou 5xx não custa nada. Uma 2xx ou 3xx é cobrada.Consultar a carteira
GET /v1/entitlements retorna o plano, os limites e a carteira do período atual; GET /v1/usage detalha o gasto por operação. Os dois são gratuitos e exigem o escopo keys:manage.
curl "https://api.toktokdata.live/v1/entitlements" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY" # data.credits: { "period": "2026-11-01", "monthlyAllotment": …, "hardCap": …, "spent": …, "remaining": … }