docs
API da área pessoal

API da área pessoal

Markdown

Métodos da área pessoal: início de sessão, perfil, chaves e histórico de despesas.

Guia completo

Endereços e autorização

  • Área pessoal: https://ailoot.ai (início de sessão com credenciais, token da área pessoal)
  • API de modelos: https://api.ailoot.ai (chave sk-…)
AspetoEndereçoAutorização
API da área pessoalhttps://ailoot.ai/api/v1Authorization: Bearer $TOKEN — token da área pessoal após iniciar sessão
API de modeloshttps://api.ailoot.ai/v1Chave sk-… da secção «Chaves de API»; ver Chaves e endereço da API

Chave sk-… não substitui o token da área pessoal, e o token da área pessoal não dá acesso à API de modelos. O caminho completo está indicado em cada método.

Consultar o seu perfil
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

Formato da resposta e erros

A resposta contém code, message e data. Os erros podem incluir reason e metadata. A paginação em data contém items, total, page, page_size e pages. O formato de cada método está indicado na respetiva descrição.

Estrutura da resposta com paginação
{
  "code": 0,
  "message": "success",
  "data": {
    "items": [],
    "total": 0,
    "page": 1,
    "page_size": 20,
    "pages": 1
  }
}

O token da área pessoal é validado quanto à validade e ao estado ativo do utilizador; se a vinculação da sessão estiver ativada, são também verificados o IP e o navegador. Os códigos TOKEN_EXPIRED, TOKEN_REVOKED, USER_INACTIVE, INVALID_TOKEN e FORBIDDEN distinguem problemas de sessão e de permissões. O limite de frequência e a confirmação adicional por 2FA podem bloquear um pedido específico.

Como ler a referência

  • Cada entrada contém o método HTTP, o caminho completo, o acesso, os parâmetros, os campos do corpo e a resposta.
  • Obtenha os identificadores da resposta anterior: KEY_ID de GET /api/v1/keys, ID do pedido de GET /api/v1/usage.
  • Os campos dos objetos e os respetivos tipos estão nas páginas «Esquemas de dados».
  • Os modelos apresentam os nomes e os tipos dos campos. PLACEHOLDER e TOKEN são marcadores; não há dados reais aqui.
  • O carregamento de saldo está na secção «Tarifários» da área pessoal: como carregar o saldo.

Saldo e frozen_balance

O perfil contém balance e frozen_balance. frozen_balance é o valor reservado para pedidos por concluir. Consulte ambos os campos em conjunto com o histórico.

Chaves e limites

GET /api/v1/keys devolve as suas chaves. Os campos quota e quota_used — limite de despesas da chave e parte já utilizada; ip_whitelist, ip_blacklist, status e expires_at controlam a utilização da chave; rate_limit_5h, rate_limit_1d e rate_limit_7d — limites de despesas por janela.

Lista e chave própria
curl --fail-with-body "https://ailoot.ai/api/v1/keys" \
  -H "Authorization: Bearer $TOKEN"

# KEY_ID — id da sua própria chave na resposta da listagem
curl --fail-with-body "https://ailoot.ai/api/v1/keys/$KEY_ID" \
  -H "Authorization: Bearer $TOKEN"

Despesas e segurança

O histórico e o dashboard mostram actual_cost — o débito efetivo; total_cost — o custo ao preço normal. Os filtros de data, modelo, chave e tipo de pedido estão indicados no método. A alteração da palavra-passe, TOTP e passkey exigem as confirmações descritas nos métodos correspondentes.

Nesta secção: 39 métodos.

Ainda tem dúvidas? Envie o Request ID e uma descrição — ajudamos a esclarecer.Contactar o suporte