Authentification
S'authentifier auprès de l'API Stream Estate avec une clé API
L'API Stream Estate utilise une clé API transmise dans l'en-tête X-API-KEY sur chaque requête.
Obtenir une clé API
Créez un compte sur la console, puis générez une clé v2 depuis l'écran des clés :
- 🔑 Écran des clés — console.stream.estate/api-keys
- 🆕 Pas encore de compte — console.stream.estate/signup
La création de compte se fait aujourd'hui via connexion GitHub ou Google. Un flux non-interactif (device-code / création de clé par API) pour les agents et la CI est prévu — voir le changelog.
En-tête requis
X-API-KEY: <votre_clé>Exemple cURL
curl https://api-v2.stream.estate/sources \
-H "X-API-KEY: <votre_clé>"Contrôle d'usage
L'endpoint GET /account/api-usage (tag Account) expose les agrégats de consommation facturable de votre compte. C'est la source de vérité pour suivre votre consommation côté facturation. La réponse contient :
period— la fenêtre effectivement couverte (start,end,granularity) ;totals—calls(appels) etresults(résultats renvoyés) sur la période, pluscreditssi votre compte est facturé en crédits ;timeSeries— un point par intervalle de temps ;byApiKey,byRoute,byChannel— la même consommation ventilée par clé, par route, et par canal d'appel (DIRECTpour les appels HTTP directs,MCPpour ceux passés par le serveur MCP).
Paramètres de requête :
| Paramètre | Rôle |
|---|---|
startDate / endDate | Bornes de la période (ISO 8601, début inclus, fin exclue ; une date nue couvre la journée entière en UTC). Défaut : 30 derniers jours / maintenant. |
apiKeyId | Ne compte que les appels d'une de vos clés (UUID public). |
channel | Ne compte que les appels d'un canal : DIRECT ou MCP. |
granularity | Largeur de chaque point de timeSeries : YEAR, MONTH ou DAY. Ce paramètre ne regroupe rien. |
groupBy | Dimension qui scinde chaque point de timeSeries : API_KEY, ROUTE ou CHANNEL. Chaque ligne porte alors le champ correspondant (apiKeyId / apiKeyName, route / routeType, channel). |
Voir la référence pour le schéma complet.
Traitez votre clé comme un mot de passe. Ne la commitez jamais dans un dépôt Git public.