OpenAI-compatible chat completion

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "openai/gpt-5-nano",
  "messages": [
    {
      "content": "<string>"
    }
  ],
  "temperature": 123,
  "max_tokens": 123,
  "stream": true,
  "models": [
    "<string>"
  ],
  "fallback_models": [
    "<string>"
  ],
  "redundancy": {},
  "smltp_policy": "<string>",
  "prompt_shield": {}
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/v1/chat/completions"

payload = {
    "model": "openai/gpt-5-nano",
    "messages": [{ "content": "<string>" }],
    "temperature": 123,
    "max_tokens": 123,
    "stream": True,
    "models": ["<string>"],
    "fallback_models": ["<string>"],
    "redundancy": {},
    "smltp_policy": "<string>",
    "prompt_shield": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'openai/gpt-5-nano',
    messages: [{content: '<string>'}],
    temperature: 123,
    max_tokens: 123,
    stream: true,
    models: ['<string>'],
    fallback_models: ['<string>'],
    redundancy: {},
    smltp_policy: '<string>',
    prompt_shield: {}
  })
};

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

POST

chat

completions

OpenAI-compatible chat completion

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "openai/gpt-5-nano",
  "messages": [
    {
      "content": "<string>"
    }
  ],
  "temperature": 123,
  "max_tokens": 123,
  "stream": true,
  "models": [
    "<string>"
  ],
  "fallback_models": [
    "<string>"
  ],
  "redundancy": {},
  "smltp_policy": "<string>",
  "prompt_shield": {}
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/v1/chat/completions"

payload = {
    "model": "openai/gpt-5-nano",
    "messages": [{ "content": "<string>" }],
    "temperature": 123,
    "max_tokens": 123,
    "stream": True,
    "models": ["<string>"],
    "fallback_models": ["<string>"],
    "redundancy": {},
    "smltp_policy": "<string>",
    "prompt_shield": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'openai/gpt-5-nano',
    messages: [{content: '<string>'}],
    temperature: 123,
    max_tokens: 123,
    stream: true,
    models: ['<string>'],
    fallback_models: ['<string>'],
    redundancy: {},
    smltp_policy: '<string>',
    prompt_shield: {}
  })
};

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

Endpoint compatível com OpenAI

SecureAI expõe uma superfície compatível com OpenAI para que você possa integrar com qualquer SDK OpenAI alterando apenas o URL base e a chave de API — sem alterações de código. A pilha de segurança SecureAI completa (autenticação de chave de API, listas de permissões de modelo/índice, aplicação de política SMLTP + direitos, Prompt Shield, PII/DLP, faturamento de pontos e o mecanismo de redundância de modelo) é executado abaixo.

Ponto final

POST /api/external/v1/chat/completions
GET  /api/external/v1/models

Aponte o base_url do seu cliente OpenAI para:

https://{customer.name}.hiperai.ai/api/external/v1

Somente Conhecimento ZeroEsta superfície não suporta RAG/bases de conhecimento. As solicitações são fixadas em Zero-Knowledge. Se você precisar de recuperação da base de conhecimento, use o endpoint clássico Chat Completion.

Autenticação

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

Usando um SDK OpenAI

Python (`openai`)

from openai import OpenAI

client = OpenAI(
    api_key="sk-your-api-key-here",
    base_url="https://{customer.name}.hiperai.ai/api/external/v1",
)

resp = client.chat.completions.create(
    model="openai/gpt-5-nano",
    messages=[{"role": "user", "content": "Hello!"}],
    # SecureAI extensions travel via extra_body
    extra_body={
        "smltp_policy": "internal",
        "fallback_models": ["anthropic/claude-sonnet-4"],
    },
)
print(resp.choices[0].message.content)
print(resp.model_extra["secureai"]["served_model"])

JavaScript (`openai`)

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'sk-your-api-key-here',
  baseURL: 'https://{customer.name}.hiperai.ai/api/external/v1',
});

const resp = await client.chat.completions.create({
  model: 'openai/gpt-5-nano',
  messages: [{ role: 'user', content: 'Hello!' }],
  // @ts-expect-error — SecureAI extension fields
  smltp_policy: 'internal',
  fallback_models: ['anthropic/claude-sonnet-4'],
});
console.log(resp.choices[0].message.content);

Corpo da solicitação

Os campos OpenAI padrão são suportados. messages é obrigatório (não há prompt nesta superfície). max_completion_tokens é aceito como um alias para max_tokens. Os seguintes parâmetros OpenAI são passados para o provedor no estado em que se encontram: tools, tool_choice, parallel_tool_calls, response_format, stop, top_p, frequency_penalty, presence_penalty, seed, logprobs, top_logprobs, user.

Campos de extensão SecureAI

Envie-os como campos de corpo extras (via extra_body nos SDKs OpenAI):

Campo	Descrição
`smltp_policy`	Política de segurança SMLTP para esta chamada.
`prompt_shield`	`{ enabled?, policy? }` — substituição do Prompt Shield por chamada.
`models` / `fallback_models`	Cadeia de modelo redundância.
`redundancy`	`{ timeout_ms, first_token_timeout_ms, on[] }`.
`user_id`	Faturar para um usuário diferente (controlado pelo administrador).

Resposta

Forma OpenAI padrão chat.completion, mais um objeto de extensão secureai.

{
  "id": "chatcmpl-1a2b3c...",
  "object": "chat.completion",
  "created": 1705312200,
  "model": "anthropic/claude-sonnet-4",
  "choices": [
    { "index": 0, "message": { "role": "assistant", "content": "Hello!" }, "finish_reason": "stop" }
  ],
  "usage": { "prompt_tokens": 9, "completion_tokens": 3, "total_tokens": 12 },
  "secureai": {
    "served_model": "anthropic/claude-sonnet-4",
    "requested_model": "openai/gpt-5-nano",
    "failover": { "occurred": true, "attempts": [ ... ] },
    "smltp_policy_used": "internal",
    "smltp_policy_source": "request",
    "smltp_policy_hash": "a1b2c3...",
    "prompt_shield_policy": null,
    "smltp_bundle_id": "bnd_..."
  }
}

secureai.smltp_bundle_id (quando presente) pode ser trocado por um [recibo] de conformidade assinado(/pt/api/receipts).

Transmissão

Defina stream: true. Os frames são objetos OpenAI nativos chat.completion.chunk terminados por data: [DONE]. A extensão secureai é anexada ao primeiro pedaço. choices (incluindo tool_calls deltas e finish_reason) passam intocados.

Erros

Os erros deste manipulador usam o envelope OpenAI:

{ "error": { "message": "you must provide a model parameter", "type": "invalid_request_error", "code": null } }

Quando toda uma cadeia de redundância falha, o erro usa code: "all_models_failed" e status 429 (todos os limites de taxa) ou 502 (caso contrário). As rejeições de middleware de segurança mantêm o formato SecureAI { "success": false, ... }; ambos sempre carregam um message.

Relacionado

Conclusão de bate-papo — a superfície clássica (adiciona RAG).
Redundância e failover
API Prompt Shield

Autorizações

Authorization

string

header

obrigatório

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

Corpo

application/json

model

string

obrigatório

Exemplo:

"openai/gpt-5-nano"

messages

object[]

obrigatório

Show child attributes

temperature

number

max_tokens

integer

stream

boolean

models

string[]

fallback_models

string[]

redundancy

object

{ timeout_ms, first_token_timeout_ms, on[] }

smltp_policy

string

prompt_shield

object

{ enabled?, policy? } per-call Prompt Shield override

Resposta

OpenAI chat.completion object plus a secureai extension

Primeiros Passos & Configuração

Modelos & Geração de IA

Knowledge Base & RAG

Segurança, Guardrails & Auditoria

Usuários & Acesso (IAM)

Faturamento, Cotas & Webhooks

Compatibilidade com OpenAI

Endpoint compatível com OpenAI

Ponto final

Autenticação

Usando um SDK OpenAI

Python (`openai`)

JavaScript (`openai`)

Corpo da solicitação

Campos de extensão SecureAI

Resposta

Transmissão

Erros

Relacionado

Autorizações

Corpo

Resposta

​Endpoint compatível com OpenAI

​Ponto final

​Autenticação

​Usando um SDK OpenAI

​Python (openai)

​JavaScript (openai)

​Corpo da solicitação

​Campos de extensão SecureAI

​Resposta

​Transmissão

​Erros

​Relacionado

Autorizações

Corpo

Resposta

Endpoint compatível com OpenAI

Ponto final

Autenticação

Usando um SDK OpenAI

Python (`openai`)

JavaScript (`openai`)

Corpo da solicitação

Campos de extensão SecureAI

Resposta

Transmissão

Erros

Relacionado