Get License Availability
curl --request GET \
--url https://secureai.hiperai.ai/api/external/licenses/availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/licenses/availability"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/licenses/availability', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"limits": {
"Essential": 1,
"Growth": 0,
"Ultra": 2,
"Early Access": 12
},
"usage": {
"Essential": 1,
"Growth": 5,
"Ultra": 1,
"Early Access": 0
},
"remaining": {
"Essential": 0,
"Growth": 1.7976931348623157e+308,
"Ultra": 1,
"Early Access": 12
}
}{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked",
"request_id": "req-abc123"
}{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked",
"request_id": "req-abc123"
}Faturamento, Cotas & Webhooks
Disponibilidade de licenças
Recuperar limites atuais do pool de licenças, uso e restante (somente administrador)
GET
/
licenses
/
availability
Get License Availability
curl --request GET \
--url https://secureai.hiperai.ai/api/external/licenses/availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/licenses/availability"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/licenses/availability', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"limits": {
"Essential": 1,
"Growth": 0,
"Ultra": 2,
"Early Access": 12
},
"usage": {
"Essential": 1,
"Growth": 5,
"Ultra": 1,
"Early Access": 0
},
"remaining": {
"Essential": 0,
"Growth": 1.7976931348623157e+308,
"Ultra": 1,
"Early Access": 12
}
}{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked",
"request_id": "req-abc123"
}{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked",
"request_id": "req-abc123"
}Disponibilidade de licenças
Recupere os limites do pool de licenças, o uso atual e as licenças restantes para cada nível.Ponto final
GET /licenses/availability
Descrição
Retorna o status do pool de licenças para todos os níveis de licença, incluindo limites, uso atual e capacidade restante. Endpoint somente administrador.Autenticação
Obrigatório: Chave de API com privilégios de administradorAuthorization: Bearer sk-your-api-key-here
Solicitação
curl -X GET "https://{customer.name}.hiperai.ai/api/external/licenses/availability" \
-H "Authorization: Bearer sk-your-api-key-here"
Resposta
Resposta de sucesso (200)
{
"success": true,
"limits": { "Essential": 1, "Growth": 0, "Ultra": 2, "Early Access": 12 },
"usage": { "Essential": 1, "Growth": 5, "Ultra": 1, "Early Access": 0 },
"remaining": { "Essential": 0, "Growth": Infinity, "Ultra": 1, "Early Access": 12 }
}
Campos de resposta
| Campo | Tipo | Descrição |
|---|---|---|
success | booleano | Indica se a operação foi bem sucedida |
limits | objeto | Limites configurados do pool de licenças por nível |
usage | objeto | Licenças atuais atribuídas/utilizadas por nível |
remaining | objeto | Licenças restantes por nível |
Respostas de erro
401 Não autorizado
{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked"
}
403 Proibido
{
"success": false,
"error": "Access denied",
"message": "Admin access required"
}
Notas
- Endpoint somente administrador
- O restante pode ser relatado como
Infinityquando nenhum limite de pool for aplicado para esse nível - Os valores são agregados de toda a organização
Autorizações
API key authentication using Bearer token format.
Example: Authorization: Bearer sk-your-api-key-here
Resposta
License availability
Exemplo:
true
Show child attributes
Show child attributes
Exemplo:
{
"Essential": 1,
"Growth": 0,
"Ultra": 2,
"Early Access": 12
}
Show child attributes
Show child attributes
Exemplo:
{
"Essential": 1,
"Growth": 5,
"Ultra": 1,
"Early Access": 0
}
Show child attributes
Show child attributes
Exemplo:
{
"Essential": 0,
"Growth": 1.7976931348623157e+308,
"Ultra": 1,
"Early Access": 12
}

