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));

Point de terminaison compatible OpenAI

SecureAI expose une surface compatible OpenAI afin que vous puissiez intégrer n’importe quel SDK OpenAI en modifiant uniquement l’URL de base et la clé API — aucune modification de code. La pile de sécurité complète SecureAI (authentification par clé API, listes d’autorisation de modèle/index, application de la politique SMLTP + droits, Prompt Shield, PII/DLP, facturation des points et le moteur de redondance de modèle) s’exécute en dessous.

Point de terminaison

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

Pointez le base_url de votre client OpenAI vers :

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

Zéro-Connaissance uniquementCette surface ne prend pas en charge les RAG/bases de connaissances. Les demandes sont épinglées sur Zero-Knowledge. Si vous avez besoin d’une récupération de base de connaissances, utilisez le point de terminaison classique Chat Completion.

Authentification

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

Utilisation d’un 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);

Corps de la demande

Les champs OpenAI standard sont pris en charge. messages est requis (il n’y a pas de prompt sur cette surface). max_completion_tokens est accepté comme alias pour max_tokens. Les paramètres OpenAI suivants sont transmis tels quels au fournisseur : tools, tool_choice, parallel_tool_calls, response_format, stop, top_p, frequency_penalty, presence_penalty, seed, logprobs, top_logprobs, user.

Champs d’extension SecureAI

Envoyez-les sous forme de champs de corps supplémentaires (via extra_body dans les SDK OpenAI) :

Champ	Descriptif
`smltp_policy`	Politique de sécurité SMLTP pour cet appel.
`prompt_shield`	`{ enabled?, policy? }` — remplacement du bouclier d’invite par appel.
`models` / `fallback_models`	Modèle de chaîne de redondance.
`redundancy`	`{ timeout_ms, first_token_timeout_ms, on[] }`.
`user_id`	Facturer à un autre utilisateur (admin-gated).

Réponse

Forme OpenAI standard chat.completion, plus un objet d’extension 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 (lorsqu’il est présent) peut être échangé contre un [reçu] de conformité signé (/fr/en/api/receipts).

Diffusion

Réglez stream: true. Les cadres sont des objets natifs OpenAI chat.completion.chunk terminés par data: [DONE]. L’extension secureai est attachée au premier morceau. choices (y compris les deltas tool_calls et finish_reason) traversent intacts.

Erreurs

Les erreurs de ce gestionnaire utilisent l’enveloppe OpenAI :

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

Lorsqu’une chaîne de redondance entière échoue, l’erreur utilise code: "all_models_failed" et l’état 429 (toutes les limites de débit) ou 502 (sinon). Les rejets de middleware de sécurité conservent la forme SecureAI { "success": false, ... } ; les deux portent toujours un message.

Connexes

Chat Completion — la surface classique (ajoute RAG).
Redondance & Failover
API Prompt Shield

Autorisations

Authorization

string

header

requis

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

Corps

application/json

model

string

requis

Exemple:

"openai/gpt-5-nano"

messages

object[]

requis

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

Réponse

OpenAI chat.completion object plus a secureai extension

Premiers Pas & Configuration

Modèles & Génération IA

Base de Connaissances & RAG

Sécurité, Guardrails & Audit

Utilisateurs & Accès (IAM)

Facturation, Quotas & Webhooks

Point de terminaison compatible OpenAI

Point de terminaison compatible OpenAI

Point de terminaison

Authentification

Utilisation d’un SDK OpenAI

Corps de la demande

Champs d’extension SecureAI

Réponse

Diffusion

Erreurs

Connexes

Autorisations

Corps

Réponse

​Point de terminaison compatible OpenAI

​Point de terminaison

​Authentification

​Utilisation d’un SDK OpenAI

​Corps de la demande

​Champs d’extension SecureAI

​Réponse

​Diffusion

​Erreurs

​Connexes

Autorisations

Corps

Réponse

Point de terminaison compatible OpenAI

Point de terminaison

Authentification

Utilisation d’un SDK OpenAI

Corps de la demande

Champs d’extension SecureAI

Réponse

Diffusion

Erreurs

Connexes