Présentation de l'API

L’API Conare utilise JSON sur HTTPS. Chaque endpoint a une page dans cet onglet, avec un playground.


URL de base	`https://api.conare.ai`
Authentification	`Authorization: Bearer $CONARE_API_KEY`
Clés	Créées dans la console ; gardez-les sur votre serveur
Corps	JSON, snake_case ; les champs inconnus renvoient `400`
Spécification	api.conare.ai/openapi.yaml

curl https://api.conare.ai/namespaces \
  -H "Authorization: Bearer $CONARE_API_KEY"

Les routes compatibles OpenAI et Cohere (/v1, /v2) ignorent les champs inconnus.

Erreurs

{
  "error": {
    "code": "invalid_request",
    "message": "documents[0].text is required",
    "request_id": "45ea7c7353368cb646e5cc2303008072"
  }
}

Statut	Signification
400	La requête est invalide ; `message` explique pourquoi
401	La clé est absente, erronée ou révoquée
403	La clé n’a pas accès à ce namespace ou à cette route
404	Introuvable
409	Un conflit de version, ou une écriture concurrente l’a emporté
413	Le corps, un document ou un fichier est trop volumineux
415	Le type de fichier n’est pas pris en charge
422	Le fichier est illisible, ou une `Idempotency-Key` a été réutilisée pour une autre requête
429	Au-delà d’une limite de débit
5xx	Un problème de notre côté

Nouvelles tentatives

Cas	Action
`429`, `503`	Réessayez après le nombre de secondes de l’en-tête `Retry-After`
Autres 5xx	Réessayez avec un backoff
Écritures et suppressions	Envoyez une `Idempotency-Key` (un UUID) ; une répétition sous 24 heures renvoie la première réponse avec `Idempotent-Replayed: true` et ne modifie rien

Le SDK réessaie et envoie Idempotency-Key pour vous.

Limites de débit

Par organisation. Les pics équivalant à 10 secondes au plus sont acceptés ; au-delà d’une limite, l’API renvoie 429 avec Retry-After.

Appels	Par seconde	Simultanés
Recherche	100	128
Écriture	100 documents	64
Embedding	100 textes	16
Rerank	20	16
Requêtes de l’API turbopuffer	1 000
Tout le reste	100

En-têtes

En-tête	Sens	Signification
`Authorization`	Requête	`Bearer` et votre clé
`Idempotency-Key`	Requête	Permet de réessayer une écriture sans risque
`X-Conare-Org`	Requête	L’organisation pour laquelle agir, avec une clé multi-organisation (les lister)
`Content-Encoding: gzip`	Requête	Un corps compressé ; les plafonds le comptent décompressé
`X-Request-Id`	Réponse	Sur chaque réponse ; incluez-le quand vous contactez le support
`Retry-After`	Réponse	Secondes à attendre, sur `429` et `503`
`Conare-Degraded`	Réponse	La requête a réussi sans une partie de son travail, comme le reranking (valeurs)
`Idempotent-Replayed`	Réponse	`true` quand une nouvelle tentative a reçu la première réponse

Santé

GET /health/deep ne requiert aucune clé : status vaut ok, degraded (tous deux HTTP 200) ou down (HTTP 503).

Response

{ "status": "ok", "checkedAt": "2026-10-21T21:39:16.729996745Z" }

Vue d'ensemble

Espaces de noms

Documents

Recherche

Fichiers

Analyse

Sources

Sources personnalisées

Modèles

Utilisateurs

Événements

Organisations

Santé

Présentation de l'API

Erreurs

Nouvelles tentatives

Limites de débit

En-têtes

Santé

​Erreurs

​Nouvelles tentatives

​Limites de débit

​En-têtes

​Santé

Erreurs

Nouvelles tentatives

Limites de débit

En-têtes

Santé