Get Available Models

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/models \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/models', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "models": [
    {
      "id": "openai/gpt-4.1-mini",
      "name": "openai/gpt-4.1-mini",
      "provider": "openai"
    },
    {
      "id": "anthropic/claude-sonnet-4",
      "name": "anthropic/claude-sonnet-4",
      "provider": "anthropic"
    }
  ],
  "user_license": "Growth",
  "restrictions": {
    "allowed_models": "all"
  },
  "filters": {
    "provider": "openai"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Rate limit exceeded",
  "message": "Please reduce your request rate",
  "reset_time": "2024-01-15T11:00:00.000Z"
}

GET

models

Get Available Models

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/models \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/models', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "models": [
    {
      "id": "openai/gpt-4.1-mini",
      "name": "openai/gpt-4.1-mini",
      "provider": "openai"
    },
    {
      "id": "anthropic/claude-sonnet-4",
      "name": "anthropic/claude-sonnet-4",
      "provider": "anthropic"
    }
  ],
  "user_license": "Growth",
  "restrictions": {
    "allowed_models": "all"
  },
  "filters": {
    "provider": "openai"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Rate limit exceeded",
  "message": "Please reduce your request rate",
  "reset_time": "2024-01-15T11:00:00.000Z"
}

Get Available Models

Retrieve available AI models based on your API key permissions and user license.

Endpoint

GET /models

Description

Retrieve available AI models based on your API key permissions and user license.

Authentication

Required: API Key

Authorization: Bearer sk-your-api-key-here

Parameters

Parameter	Type	Required	Description	Example
`provider`	string	No	Filter models by provider	`"openai"`

Request

Basic Request

curl -X GET "https://{customer.name}.hiperai.ai/api/external/models" \
  -H "Authorization: Bearer sk-your-api-key-here"

Filter by Provider

curl -X GET "https://{customer.name}.hiperai.ai/api/external/models?provider=openai" \
  -H "Authorization: Bearer sk-your-api-key-here"

Response

Success Response (200)

{
  "success": true,
  "models": [
    {
      "id": "openai/gpt-5-nano",
      "name": "openai/gpt-5-nano",
      "provider": "openai"
    },
    {
      "id": "anthropic/claude-sonnet-4.6",
      "name": "anthropic/claude-sonnet-4.6",
      "provider": "anthropic"
    }
  ],
  "user_license": "Pro",
  "restrictions": {
    "allowed_models": "all"
  },
  "filters": {
    "provider": "openai"
  }
}

Response Fields

Field	Type	Description	Example
`success`	boolean	Always true for successful requests	`true`
`models`	array	List of available models	See example
`user_license`	string	User’s license tier	`"Pro"`
`restrictions`	object	Model access restrictions	See example
`filters`	object	Applied filters	See example

Model Object

Field	Type	Description	Example
`id`	string	Unique model identifier	`"openai/gpt-5-nano"`
`name`	string	Model display name	`"openai/gpt-5-nano"`
`provider`	string	Model provider	`"openai"`

Restrictions Object

Field	Type	Description	Example
`allowed_models`	string	Model access level	`"all"`

Filters Object

Field	Type	Description	Example
`provider`	string	Applied provider filter	`"openai"`

Error Responses

401 Unauthorized

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked"
}

429 Rate Limit Exceeded

{
  "success": false,
  "error": "Rate limit exceeded",
  "message": "Please reduce your request rate",
  "reset_time": "2024-01-15T11:00:00.000Z"
}

Example Usage

JavaScript/Node.js

const response = await fetch('https://{customer.name}.hiperai.ai/api/external/models', {
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here'
  }
});

const data = await response.json();
console.log('Available Models:', data.models);
console.log('User License:', data.user_license);

Python

import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here'
}

response = requests.get('https://{customer.name}.hiperai.ai/api/external/models', headers=headers)
data = response.json()

print('Available Models:', data['models'])
print('User License:', data['user_license'])

Filter by Provider

import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here'
}

params = {
    'provider': 'openai'
}

response = requests.get('https://{customer.name}.hiperai.ai/api/external/models', 
                      headers=headers, params=params)
data = response.json()

print('OpenAI Models:', data['models'])

cURL

# Get all models
curl -X GET "https://{customer.name}.hiperai.ai/api/external/models" \
  -H "Authorization: Bearer sk-your-api-key-here"

# Filter by provider
curl -X GET "https://{customer.name}.hiperai.ai/api/external/models?provider=openai" \
  -H "Authorization: Bearer sk-your-api-key-here"

LLM Buckets (Current)

The chat system classifies models into two execution buckets:

standard bucket
premium bucket

This reference is based on the active backend bucket mapping.

Standard Bucket

openai/gpt-oss-120b
openai/gpt-5-nano
google/gemini-3.1-flash-lite-preview
google/gemini-3-flash-preview
deepseek/deepseek-r1-distill-llama-70b
deepseek/deepseek-r1
deepseek/deepseek-v3.2
meta-llama/llama-3.3-70b-instruct
meta-llama/llama-4-maverick
meta-llama/llama-4-scout
mistralai/mistral-7b-instruct
mistralai/mistral-nemo
mistralai/ministral-14b-2512
mistralai/mistral-large-2512
x-ai/grok-3-mini
qwen/qwen3-235b-a22b-2507
qwen/qwen3-coder
qwen/qwen3-coder-next
qwen/qwen3.5-397b-a17b

Premium Bucket

anthropic/claude-3.7-sonnet
anthropic/claude-sonnet-4.6
anthropic/claude-opus-4.6
openai/o4-mini-high
openai/o4-mini
openai/gpt-5.2
openai/gpt-5.3-codex
openai/gpt-5.1
google/gemini-3.1-pro-preview
x-ai/grok-4

Available Providers

OpenAI
Anthropic
Google
Meta
Mistral
DeepSeek
xAI
Qwen

Notes

Models available depend on your subscription tier
Some models may be restricted based on your license
Use the provider filter to get models from specific providers
The response includes your current license tier and restrictions
API key restrictions (allowedModels) can further reduce the model list

Autorizações

Authorization

string

header

obrigatório

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

Parâmetros de consulta

provider

string

Filter models by provider (e.g., 'openai', 'anthropic', 'google')

Resposta

List of available models

success

boolean

Exemplo:

true

models

object[]

Show child attributes

user_license

string

Exemplo:

"Growth"

restrictions

object

Show child attributes

filters

object

Show child attributes

Primeiros Passos & Configuração

Modelos & Geração de IA

Knowledge Base & RAG

Segurança, Guardrails & Auditoria

Usuários & Acesso (IAM)

Faturamento, Cotas & Webhooks

Available Models

Get Available Models

Endpoint

Description

Authentication

Parameters

Request

Basic Request

Filter by Provider

Response

Success Response (200)

Response Fields

Model Object

Restrictions Object

Filters Object

Error Responses

401 Unauthorized

429 Rate Limit Exceeded

Example Usage

JavaScript/Node.js

Python

Filter by Provider

cURL

LLM Buckets (Current)

Standard Bucket

Premium Bucket

Available Providers

Notes

Autorizações

Parâmetros de consulta

Resposta

​Get Available Models

​Endpoint

​Description

​Authentication

​Parameters

​Request

​Basic Request

​Filter by Provider

​Response

​Success Response (200)

​Response Fields

​Model Object

​Restrictions Object

​Filters Object

​Error Responses

​401 Unauthorized

​429 Rate Limit Exceeded

​Example Usage

​JavaScript/Node.js

​Python

​Filter by Provider

​cURL

​LLM Buckets (Current)

​Standard Bucket

​Premium Bucket

​Available Providers

​Notes

Autorizações

Parâmetros de consulta

Resposta

Get Available Models

Endpoint

Description

Authentication

Parameters

Request

Basic Request

Filter by Provider

Response

Success Response (200)

Response Fields

Model Object

Restrictions Object

Filters Object

Error Responses

401 Unauthorized

429 Rate Limit Exceeded

Example Usage

JavaScript/Node.js

Python

Filter by Provider

cURL

LLM Buckets (Current)

Standard Bucket

Premium Bucket

Available Providers

Notes