API de Créditos

Consulte os custos dos endpoints e verifique seu saldo de créditos programaticamente.

Casos de uso
Planejamento de orçamento

Calcule os custos antes de fazer chamadas à API para gerenciar seus gastos com créditos.

Integração com painel

Exiba o saldo em tempo real e informações de custos no seu próprio painel de administração.

Automação inteligente

Verifique o saldo antes de trabalhos em lote para evitar o esgotamento de créditos durante a execução.

99.9 % Disponibilidade
Resposta
20 req/s
0 Créditos / requisição

Look up endpoint cost


POST https://api.yeb.to/v1/credits/cost
ParâmetroTipoObrig.Descrição
api_key string sim Your API key
endpoint string opc. Single endpoint key, e.g. youtube/channel/audit
endpoints array opc. Array of up to 50 endpoint keys (use instead of endpoint)

Exemplo

curl -X POST https://api.yeb.to/v1/credits/cost \
  -H "Content-Type: application/json" \
  -d '{
  "api_key": "YOUR_KEY",
  "endpoint": "youtube/channel/audit"
}'

Exemplo de resposta

{
  "endpoint": "youtube/channel/audit",
  "credits": 0.01,
  "credits_spent": 0.0001,
  "credits_left": 142.5,
  "response_code": 200,
  "response_time_ms": 12
}
{"error":"Provide \"endpoint\" (string) or \"endpoints\" (array).","code":422}

Códigos de resposta

CódigoDescrição
200 SuccessRequisição processada OK.
400 Bad RequestValidação de entrada falhou.
401 UnauthorizedChave API em falta ou incorreta.
403 ForbiddenChave inativa ou não permitida.
429 Rate LimitDemasiadas requisições.
500 Server ErrorErro inesperado.

Look up cost

credits/cost 0.0001 credits

Parameters

API Key
body · string · required
Endpoint
body · string
Endpoints
body · string

Code Samples


                
                
                
            

Response

Status:
Headers

                
Body

                

Check credit balance


POST https://api.yeb.to/v1/credits/balance
ParâmetroTipoObrig.Descrição
api_key string sim Your API key

Exemplo

curl -X POST https://api.yeb.to/v1/credits/balance \
  -H "Content-Type: application/json" \
  -d '{
  "api_key": "YOUR_KEY"
}'

Exemplo de resposta

{
  "credits": 142.5,
  "credits_spent": 0.0001,
  "credits_left": 142.5,
  "response_code": 200,
  "response_time_ms": 8
}
{"error":"Cannot resolve user from API key.","code":401}

Códigos de resposta

CódigoDescrição
200 SuccessRequisição processada OK.
400 Bad RequestValidação de entrada falhou.
401 UnauthorizedChave API em falta ou incorreta.
403 ForbiddenChave inativa ou não permitida.
429 Rate LimitDemasiadas requisições.
500 Server ErrorErro inesperado.

Check balance

credits/balance 0.0001 credits

Parameters

API Key
body · string · required

Code Samples


                
                
                
            

Response

Status:
Headers

                
Body

                

API de Créditos — Practical Guide

Look up how many credits any API endpoint costs and check your balance — all programmatically. Ideal for budget control, dashboards, and pre-flight checks before batch jobs.

#What the Credits API does

The Credits API lets you look up endpoint costs and check your balance without making an actual API call. Use it to build cost-aware workflows, display pricing in your UI, or validate you have enough credits before launching a batch job.

Each Credits API call costs only 0.0001 credits — essentially free.

#Endpoints

# POST /v1/credits/cost

  • Best for: Looking up the credit cost of any endpoint before calling it.
  • Single lookup: Send "endpoint": "youtube/channel/audit" to get one cost.
  • Bulk lookup: Send "endpoints": ["screenshot/capture", "qr/code"] for up to 50 at once.

# POST /v1/credits/balance

  • Best for: Checking your current credit balance from code.
  • Returns: Your total available credits.

#Quick start

# Look up a single endpoint cost
curl -X POST "https://api.yeb.to/v1/credits/cost" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{"endpoint": "screenshot/capture"}'
# Bulk lookup (up to 50 endpoints)
curl -X POST "https://api.yeb.to/v1/credits/cost" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{"endpoints": ["youtube/channel/audit", "qr/code", "geoip/city"]}'
# Check your balance
curl -X POST "https://api.yeb.to/v1/credits/balance" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>"

#Parameters

Cost endpoint

Param Type Required Description
endpoint string One of the two Single endpoint key, e.g. youtube/channel/audit
endpoints array One of the two Array of up to 50 endpoint keys for bulk lookup

Balance endpoint

No extra parameters — just authenticate with your API key.

#Reading responses

Single cost lookup

{
  "endpoint": "youtube/channel/audit",
  "credits": 0.01,
  "credits_spent": 0.0001,
  "credits_left": 142.5,
  "response_code": 200,
  "response_time_ms": 12
}

Bulk cost lookup

{
  "costs": {
    "screenshot/capture": 0.05,
    "qr/code": 0.009,
    "chatbot/message": 0.05
  },
  "credits_spent": 0.0001,
  "credits_left": 142.5,
  "response_code": 200,
  "response_time_ms": 8
}

Balance response

{
  "credits": 142.5,
  "credits_spent": 0.0001,
  "credits_left": 142.5,
  "response_code": 200,
  "response_time_ms": 8
}

#Endpoint key format

Endpoint keys follow the pattern module/action. Here are some examples:

KeyCreditsAPI
youtube/channel/audit0.01YouTube Channel
screenshot/capture0.05Screenshot
qr/code0.009QR Code Generator
geoip/city0.009GeoIP
chatbot/message0.05ChatBot
bot/detect/detect0.003Bot Detect
captions/transcribe1Captions
Use the /v1/credits/cost endpoint itself to discover costs for any key — if a key doesn't exist, it returns null.

#Practical recipes

  • Pre-flight check: Call /balance before a batch job. If credits < estimated cost, abort early and notify.
  • Pricing page: Fetch all costs with /cost and display them dynamically — always in sync with reality.
  • Usage dashboard: Combine /balance with your transaction history to show spend over time.

#Errors

HTTPWhenWhat to do
422 Neither endpoint nor endpoints provided Send at least one of the two parameters.
422 More than 50 endpoints in array Split into multiple requests.
401 Invalid or missing API key Check your API key in X-API-Key header or api_key param.

#API Changelog

2026-02-07
Initial release — /cost (single + bulk) and /balance endpoints.

Perguntas Frequentes

Quase — cada chamada custa 0,0001 créditos (essencialmente grátis). Isso previne abusos mantendo a acessibilidade.

Sim — envie um array "endpoints" com até 50 chaves de endpoints e obtenha todos os custos em uma única resposta.

Sim — os custos são lidos diretamente da configuração em produção, então você sempre obtém os preços atuais.

Sim. Cada requisição, mesmo as que resultam em erros, consome créditos. Seus créditos estão vinculados ao número de requisições, independentemente de sucesso ou falha. Se o erro for claramente devido a um problema da plataforma do nosso lado, restauraremos os créditos afetados (sem reembolsos em dinheiro).

Contacte-nos em [email protected]. Levamos o feedback a sério—se o seu relatório de bug ou pedido de funcionalidade for significativo, podemos corrigir ou melhorar a API rapidamente e conceder-lhe 50 créditos gratuitos como agradecimento.

Depende da API e às vezes até do endpoint. Alguns endpoints usam dados de fontes externas, que podem ter limites mais rigorosos. Também aplicamos limites para prevenir abusos e manter a nossa plataforma estável. Consulte a documentação para o limite específico de cada endpoint.

Operamos com um sistema de créditos. Créditos são unidades pré-pagas e não reembolsáveis que gasta em chamadas API e ferramentas. Os créditos são consumidos por FIFO (os mais antigos primeiro) e são válidos por 12 meses a partir da data de compra. O painel mostra cada data de compra e a sua expiração.

Sim. Todos os créditos comprados (incluindo saldos fracionários) são válidos por 12 meses a partir da compra. Créditos não utilizados expiram automaticamente e são permanentemente eliminados no final do período de validade. Créditos expirados não podem ser restaurados ou convertidos em dinheiro ou outro valor. Regra de transição: créditos comprados antes de 22 de set. de 2025 são tratados como comprados em 22 de set. de 2025 e expiram em 22 de set. de 2026 (salvo indicação de expiração anterior na compra).

Sim—dentro do período de validade. Os créditos não utilizados permanecem disponíveis e são transferidos de mês para mês até expirarem 12 meses após a compra.

Os créditos são não reembolsáveis. Compre apenas o que precisa—pode sempre recarregar depois. Se um erro da plataforma causar uma cobrança falhada, podemos restaurar os créditos afetados após investigação. Sem reembolsos em dinheiro.

Os preços são definidos em créditos, não em dólares. Cada endpoint tem o seu próprio custo—veja o selo "Créditos / requisição" acima. Saberá sempre exatamente quanto está a gastar.
← Voltar às APIs