Pular para o conteúdo principal
Uma chave Admin pode gerenciar todas as suas outras chaves de API pela API. Dê a cada app, ambiente ou cliente sua própria chave de Inference, limite quanto cada uma pode gastar, acompanhe o uso por chave e altere ou revogue chaves sem abrir o painel.

Criar

Emita uma chave com limite de gasto

Acompanhar

Veja quanto cada chave gasta

Alterar

Aumente um limite ou estenda uma expiração

Revogar

Desative uma chave imediatamente

Como funciona

Chave AdminSua chave de controleCria, altera e revoga chavesLê uso e cobrançaFica no seu servidor
Inferencecust:acme$50 / mêsApenas modelos privados
Inferencecust:globex$5 / mêsApenas de 11.22.33.0/24
Inferencestaging$10 / diaExpira em 30 de jun.
Chaves Admin podem chamar todos os endpoints, incluindo os que gerenciam chaves e leem dados de cobrança. Chaves de Inference podem chamar modelos, mas não podem gerenciar chaves nem ler dados de cobrança, por isso são as chaves que você distribui.
Crie sua primeira chave Admin no painel: siga Gerando uma chave de API e escolha Admin como tipo de chave. Mantenha-a em um armazenamento de segredos do lado do servidor, nunca em código do lado do cliente.
Os exemplos desta página leem a chave Admin de VENICE_ADMIN_KEY:

Criar uma chave

Este exemplo cria uma chave de Inference para um cliente, com limite de $50 por mês e expiração em 30 de junho de 2027:
Response
data.apiKey é o segredo da chave, e esta resposta é a única vez em que você o verá. Armazene-o imediatamente. Se ele for perdido, revogue a chave e crie uma nova. Guarde também o data.id: todas as outras chamadas desta página o utilizam.

Configurações da chave

Defina estas configurações ao criar uma chave ou altere-as depois com PATCH /api_keys. O corpo da requisição é estrito, então um campo desconhecido retorna 400. Você pode criar até 20 chaves por minuto e manter até 500 chaves ativas. Entre em contato com o suporte se precisar de mais.
Está construindo um agente? Uma carteira com VVV em staking na Base pode emitir sua própria chave sem uma conta Venice. Consulte Criação de chave de API por agente autônomo.

Acompanhar o uso

Uma chave

Response (trimmed)
Esta chave usou $12,50 dos seus $50 do mês. currentPeriodUsage só aparece em chaves com limite em USD ou DIEM, e os valores de uso são strings com quatro casas decimais. As respostas retornam consumptionLimits (plural), enquanto as requisições enviam consumptionLimit (singular).

Gasto por chave ao longo do tempo

GET /billing/usage-analytics retorna os totais por chave em byKey e uma linha por dia em byKeyDaily, prontos para gráficos. Passe lookback (7d por padrão, até 90d) ou um par startDate e endDate que abranja até 90 dias. Os resultados ficam em cache por 10 minutos.
cURL
Response (trimmed)

Cada cobrança, por chave

GET /billing/usage-history lista cada cobrança, e cada entrada traz o apiKeyId ao qual foi faturada. Use-o para conciliar gastos ou cobrar seus próprios clientes. As entradas são retornadas da mais antiga para a mais recente. Envie nextCursor de volta como cursor, sozinho, até que ele seja null. Envie Accept: text/csv para receber CSV.
As cobranças têm amount negativo, então o loop o subtrai para obter um total positivo por chave e moeda. Entradas sem apiKeyId vêm do app web da Venice ou são lançamentos da conta, como compras de créditos.

Se uma chave pode gastar agora

GET /api_keys/rate_limits funciona com qualquer chave e informa sobre a chave que o chama. accessPermitted indica se a chave pode gastar agora, e balances mostra quanto ela ainda tem para gastar.
cURL
GET /api_keys/rate_limits/log, com uma chave Admin, retorna as suas últimas 50 ocorrências de limite de taxa, cada uma com seu apiKeyId e modelId.

Alterar limites e configurações

Envie o id da chave e apenas os campos que você quer alterar. Todo o resto permanece como está. Este exemplo aumenta o limite para $100 por mês:
Em vez disso, envie qualquer um destes campos para fazer outras alterações: Um novo limitPeriod entra em vigor imediatamente, então mudar para LIFETIME contabiliza todo o gasto anterior da chave no limite. apiKeyType não pode ser alterado; crie uma nova chave em vez disso.

Revogar ou rotacionar uma chave

A resposta é { "success": true }. A revogação é imediata: a próxima requisição da chave recebe 401 Authentication failed, e a chave deixa de aparecer em GET /api_keys. As cobranças anteriores dela permanecem no histórico de uso. Para rotacionar uma chave sem tempo de inatividade:
1

Crie a substituta

Crie uma nova chave com as mesmas configurações e armazene o segredo dela.
2

Implante-a

Mude seu app para usar o novo segredo.
3

Revogue a chave antiga

Quando o lastUsedAt da chave antiga em GET /api_keys parar de mudar, exclua-a.

Erros que seus chamadores podem ver

Consulte Códigos de erro para a lista completa.

Boas práticas

  • Mantenha as chaves Admin no seu servidor e distribua apenas chaves de Inference.
  • Dê a cada app, ambiente e cliente sua própria chave, para que cada uma possa ser acompanhada e revogada individualmente.
  • Coloque seu próprio identificador em description. As análises de uso identificam as chaves por ele.
  • Defina limite e expiração para toda chave que você entregar a outra pessoa, e restrinja chaves de servidor para servidor aos seus IPs com ipAllowlist.

Referência da API

Criar chave de API

Todos os campos aceitos na criação.

Atualizar chave de API

Altere limites, expiração, privacidade e IPs.

Listar chaves de API

Todas as chaves ativas com seu uso.

Excluir chave de API

Revogue uma chave.

Análise de uso

Gasto por chave, modelo e dia.

Histórico de uso

Cada cobrança, com sua chave de API.