Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.lemondata.cc/llms.txt

Use this file to discover all available pages before exploring further.

Visão geral

A API de gerenciamento permite consultar os totais de saldo da organização, gerenciar as API Keys da organização e consultar uso e faturamento por chave sem usar uma API Key padrão de inferência. Você pode emitir e rotacionar o token de gerenciamento na página Settings do Dashboard.
Authorization: Bearer mt-your-management-token
Tokens de gerenciamento são diferentes de API Keys de inferência. Use mt-... para /v1/management/* e sk-... para endpoints de inferência como /v1/responses.

Endpoints disponíveis

EndpointMethodDescrição
/v1/management/balanceGETRetorna os totais atuais de saldo da organização
/v1/management/api-keysGETLista as API Keys de usuário da organização atual
/v1/management/api-keysPOSTCria uma nova API Key de usuário
/v1/management/api-keys/{keyId}PATCHAtualiza nome, limite de uso, modelos permitidos, expiração ou status
/v1/management/api-keys/{keyId}/usageGETRetorna o detalhamento paginado de uso para uma chave específica
/v1/management/api-keys/{keyId}/billingGETRetorna o detalhamento agregado de faturamento para uma chave específica

Contrato de filtros de uso

GET /v1/management/api-keys/{keyId}/usage aceita os seguintes parâmetros de query.
ParâmetroTipoPadrões / limitesDescrição
pageintegerpadrão 1, mínimo 1Número da página começando em 1
limitintegerpadrão 50, mínimo 1, máximo 100Tamanho da página
logicalModelstringcomprimento máximo 100Nome do modelo lógico solicitado
modelVendorstringcomprimento máximo 100Fornecedor público do modelo
sceneenum-chat, image, audio, video, embedding, rerank, translation, music, 3d
accessChannelenum-platform ou byok
startDatestring-Limite inferior inclusivo; aceita RFC3339 com fuso horário ou YYYY-MM-DD
endDatestring-Limite superior inclusivo; aceita RFC3339 com fuso horário ou YYYY-MM-DD
Se startDate e endDate forem enviados juntos, startDate deve ser anterior ou igual a endDate.

Contrato do corpo da API Key

POST /v1/management/api-keys

CampoTipoPadrões / limitesDescrição
namestringobrigatório, padrão Default Key, tamanho 1-50Nome de exibição; o servidor remove espaços no início e no fim
limitAmountnumber | nullmínimo 0, máximo de entrada 1000000null ou omitido = ilimitado, 0 = quota zero. Valores positivos são normalizados para um teto armazenado que não pode exceder 100000 USD equivalente.
limitCurrencyenumdefault USDApenas USD. Enviar CNY retorna 400 currency_retired.
modelsstring[]padrão []Allowlist opcional de modelos lógicos
expiresAtstring | nulldatetime RFC3339null significa sem expiração

PATCH /v1/management/api-keys/

CampoTipoPadrões / limitesDescrição
statusenum-active, inactive, suspended, revoked
namestringtamanho 1-50Nome de exibição atualizado
limitAmountnumber | nullmínimo 0, máximo de entrada 1000000null = ilimitado, 0 = quota zero. Valores positivos são normalizados para um teto armazenado que não pode exceder 100000 USD equivalente.
limitCurrencyenumdefault USDApenas USD. Enviar CNY retorna 400 currency_retired.
modelsstring[]-Allowlist atualizada de modelos lógicos
expiresAtstring | nulldatetime RFC3339null remove a expiração
A requisição PATCH deve incluir pelo menos um campo.

Contrato monetário

Semântica de reporting

  • logicalModel se refere ao modelo lógico público solicitado por quem faz a chamada.
  • modelVendor se refere ao fornecedor público do modelo, e não à rota física oculta.
  • scene é a cena pública da solicitação derivada do endpoint ou do tipo de tarefa.
  • accessChannel=platform significa que a solicitação foi cobrada pelo canal de plataforma da LemonData.
  • accessChannel=byok significa que a solicitação usou sua própria chave do provedor upstream.
As respostas expõem apenas campos públicos de faturamento e reporting. Os detalhes internos de roteamento e a metadata física do provedor permanecem ocultos.
  • Itens de /usage podem incluir billing_transaction_id assim que a requisição subjacente atingir o estado de liquidação concluída. Use request_id + billing_transaction_id para reconciliação por requisição.

Nota sobre paginação de billing

/usage é paginado. /billing atualmente é um endpoint agregado e não retorna metadata de paginação no estilo page / limit. Se você precisar de registros detalhados linha a linha, use /usage.

Exemplo rápido

Comece consultando o saldo da organização com o token de gerenciamento atual.
curl -X GET "https://api.lemondata.cc/v1/management/balance" \
  -H "Authorization: Bearer mt-your-management-token"
Em seguida, liste as API Keys disponíveis para esse mesmo token de gerenciamento.
curl "https://api.lemondata.cc/v1/management/api-keys" \
  -H "Authorization: Bearer mt-your-management-token"
{
  "object": "list",
  "data": [
    {
      "id": "key_abc123def456",
      "name": "Backend Worker",
      "key_prefix": "sk-abc123...",
      "status": "active",
      "limit_amount": 500.0,
      "used_amount": 148.25,
      "models": ["gpt-4o-mini", "claude-3-7-sonnet"],
      "expires_at": "2026-04-30T00:00:00.000Z",
      "last_used_at": "2026-03-27T08:12:45.000Z",
      "created_at": "2026-03-01T10:00:00.000Z"
    }
  ]
}

Próximos passos