Stream EstateStream Estate
Démarrage

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 :

La création de compte se fait aujourd'hui via connexion GitHub ou Google.

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) et results (résultats renvoyés) sur la période, plus credits si 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 (DIRECT pour les appels HTTP directs, MCP pour ceux passés par le serveur MCP) ;
  • byAlert — les notifications de vos alertes, une ligne par alerte et par canal d'envoi (channel) : notifications, delivered, failed, attempts. Une alerte supprimée depuis garde sa ligne, son nom (alertName) et ses chiffres, avec deleted: true ; une alerte qui existe encore, active ou non, porte deleted: false. Les notifications envoyées avant d'être rattachées à leur alerte forment une seule ligne, sans alertId ni deleted.

Paramètres de requête :

ParamètreRôle
startDate / endDateBornes 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.
apiKeyIdNe compte que les appels d'une de vos clés (UUID public).
channelNe compte que les appels d'un canal : DIRECT ou MCP.
granularityLargeur de chaque point de timeSeries : YEAR, MONTH ou DAY. Ce paramètre ne regroupe rien.
groupByDimension 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.

Version 0.32.429Dernière mise à jour

Sur cette page