Vue d'ensemble de l'API

URL de base

Environnement	URL
Production	`https://api.openmodex.com/v1`
Sandbox	`https://api-sandbox.openmodex.com/v1`

Utilisez l’environnement Sandbox pour le développement et les tests — il se comporte de manière identique à la Production mais ne génère pas de frais. Tous les endpoints API sont compatibles OpenAI. Si vous utilisez déjà l’API OpenAI, vous pouvez basculer en changeant l’URL de base et la clé API.

Authentification

Incluez votre clé API dans l’en-tête Authorization :

Authorization: Bearer omx_sk_YOUR_API_KEY

Endpoints

Méthode	Endpoint	Description
`POST`	`/chat/completions`	Créer une complétion de chat
`POST`	`/completions`	Créer une complétion de texte (hérité)
`POST`	`/embeddings`	Créer des embeddings
`GET`	`/models`	Lister les modèles disponibles
`GET`	`/models/:id`	Récupérer un modèle
`GET`	`/models/compare`	Comparer des modèles côte à côte

Format de requête

Toutes les requêtes POST acceptent des corps JSON avec Content-Type: application/json.

Format de réponse

Toutes les réponses renvoient du JSON. Les réponses réussies incluent les données directement. Les réponses d’erreur suivent ce format :

{
  "error": {
    "message": "Human-readable error message",
    "type": "invalid_request_error",
    "code": "invalid_api_key"
  }
}

Codes de statut HTTP

Code	Description
`200`	Succès
`400`	Requête invalide — vérifiez vos paramètres
`401`	Non autorisé — clé API invalide ou manquante
`403`	Interdit — permissions insuffisantes
`404`	Non trouvé — endpoint ou modèle invalide
`429`	Limite de débit — ralentissez ou passez au niveau supérieur
`500`	Erreur serveur — retentez avec un backoff
`502`	Passerelle défaillante — erreur du fournisseur amont
`503`	Service indisponible — interruption temporaire

Métadonnées de réponse OpenModex

Chaque réponse inclut un champ optionnel openmodex avec les métadonnées de routage et de performance :

{
  "id": "chatcmpl-abc123",
  "choices": [...],
  "usage": {...},
  "openmodex": {
    "request_id": "req_abc123",
    "model_used": "gpt-4o-2024-08-06",
    "provider": "openai",
    "cache_hit": false,
    "routing_strategy": "cost_optimized",
    "fallback_used": false,
    "latency_ms": 1250
  }
}

Idempotence

Pour les requêtes POST, vous pouvez passer un en-tête Idempotency-Key pour garantir que la même requête n’est pas traitée deux fois :

curl https://api.openmodex.com/v1/chat/completions \
  -H "Authorization: Bearer omx_sk_..." \
  -H "Idempotency-Key: my-unique-key-123" \
  -H "Content-Type: application/json" \
  -d '...'

Les clés d’idempotence sont valides pendant 24 heures.

Aperçu

Chat

Complétions

Embeddings

Modèles

Vue d'ensemble de l'API

URL de base

Authentification

Endpoints

Format de requête

Format de réponse

Codes de statut HTTP

Métadonnées de réponse OpenModex

Idempotence

​URL de base

​Authentification

​Endpoints

​Format de requête

​Format de réponse

​Codes de statut HTTP

​Métadonnées de réponse OpenModex

​Idempotence

URL de base

Authentification

Endpoints

Format de requête

Format de réponse

Codes de statut HTTP

Métadonnées de réponse OpenModex

Idempotence