Analyses d'utilisation de facturation

/api/v1/billing/usage-analytics

curl --request GET \
  --url https://api.venice.ai/api/v1/billing/usage-analytics \
  --header 'Authorization: Bearer <token>'

{
  "lookback": "7d",
  "byDate": [
    {
      "date": "2024-01-15T00:00:00.000Z",
      "USD": 0.5,
      "DIEM": 10.25
    },
    {
      "date": "2024-01-14T00:00:00.000Z",
      "USD": 0.3,
      "DIEM": 8.75
    }
  ],
  "byModel": [
    {
      "modelName": "GLM 5.1",
      "unitType": "tokens",
      "modelType": "LLM",
      "totalUsd": 0.4,
      "totalDiem": 12.5,
      "totalUnits": 50000,
      "breakdown": [
        {
          "type": "Output",
          "usd": 0.3,
          "diem": 10,
          "units": 35000
        },
        {
          "type": "Input",
          "usd": 0.1,
          "diem": 2.5,
          "units": 15000
        }
      ]
    }
  ],
  "byModelDaily": [
    {
      "date": 1705276800000,
      "GLM 5.1": 5.5,
      "Kimi K2.6": 3.2
    }
  ],
  "topModels": [
    "GLM 5.1",
    "Kimi K2.6"
  ],
  "byKey": [
    {
      "apiKeyId": "key_abc123",
      "description": "Production Key",
      "totalUsd": 0.8,
      "totalDiem": 15,
      "totalUnits": 75000
    },
    {
      "apiKeyId": null,
      "description": "Web App",
      "totalUsd": 0,
      "totalDiem": 4,
      "totalUnits": 25000
    }
  ],
  "byKeyDaily": [
    {
      "date": 1705276800000,
      "Production Key": 8.5,
      "Web App": 2
    }
  ],
  "topKeyNames": [
    "Production Key",
    "Web App"
  ]
}

GET

billing

usage-analytics

/api/v1/billing/usage-analytics

curl --request GET \
  --url https://api.venice.ai/api/v1/billing/usage-analytics \
  --header 'Authorization: Bearer <token>'

{
  "lookback": "7d",
  "byDate": [
    {
      "date": "2024-01-15T00:00:00.000Z",
      "USD": 0.5,
      "DIEM": 10.25
    },
    {
      "date": "2024-01-14T00:00:00.000Z",
      "USD": 0.3,
      "DIEM": 8.75
    }
  ],
  "byModel": [
    {
      "modelName": "GLM 5.1",
      "unitType": "tokens",
      "modelType": "LLM",
      "totalUsd": 0.4,
      "totalDiem": 12.5,
      "totalUnits": 50000,
      "breakdown": [
        {
          "type": "Output",
          "usd": 0.3,
          "diem": 10,
          "units": 35000
        },
        {
          "type": "Input",
          "usd": 0.1,
          "diem": 2.5,
          "units": 15000
        }
      ]
    }
  ],
  "byModelDaily": [
    {
      "date": 1705276800000,
      "GLM 5.1": 5.5,
      "Kimi K2.6": 3.2
    }
  ],
  "topModels": [
    "GLM 5.1",
    "Kimi K2.6"
  ],
  "byKey": [
    {
      "apiKeyId": "key_abc123",
      "description": "Production Key",
      "totalUsd": 0.8,
      "totalDiem": 15,
      "totalUnits": 75000
    },
    {
      "apiKeyId": null,
      "description": "Web App",
      "totalUsd": 0,
      "totalDiem": 4,
      "totalUnits": 25000
    }
  ],
  "byKeyDaily": [
    {
      "date": 1705276800000,
      "Production Key": 8.5,
      "Web App": 2
    }
  ],
  "topKeyNames": [
    "Production Key",
    "Web App"
  ]
}

Il s’agit d’un endpoint en beta qui peut être instable ou changer sans préavis.

Obtenez des analyses d’utilisation agrégées pour l’utilisateur authentifié, avec des ventilations par date, modèle et clé API. Cet endpoint fournit des vues récapitulatives de vos données d’utilisation de l’API pour construire des tableaux de bord et surveiller la consommation. Les données sont mises en cache pendant 10 minutes.

Paramètres de requête

Vous pouvez spécifier la période d’analyse en utilisant soit :

lookback : Une période relative comme “7d” (7 jours), “30d” (30 jours), jusqu’à “90d” (90 jours)
startDate et endDate : Une plage de dates personnalisée au format YYYY-MM-DD. Les deux sont requis si l’un est fourni.

Si aucun paramètre n’est spécifié, la période de lookback par défaut est de 7 jours.

Champs de la réponse

lookback

La période de lookback utilisée pour la requête. Soit au format “Nd” (par exemple “7d”), soit au format “startDate:endDate”.

byDate

Totaux d’utilisation quotidienne pour la période demandée.

date : La date au format YYYY-MM-DD
USD : Utilisation totale en USD pour ce jour
DIEM : Utilisation totale en DIEM pour ce jour

byModel

Ventilation de l’utilisation par modèle, triée par dépense totale (la plus élevée d’abord).

modelName : Nom d’affichage du modèle (par exemple “GLM 5”)
unitType : Type d’unités consommées (tokens, images, chars, minutes, seconds)
modelType : Type de modèle (LLM, IMAGE, TTS, ASR, VIDEO), ou null
totalUsd : Total USD dépensé sur ce modèle
totalDiem : Total DIEM dépensé sur ce modèle
totalUnits : Unités totales consommées pour ce modèle
breakdown : Tableau des ventilations d’utilisation par type (uniquement présent si plusieurs types). Chaque entrée contient :
- type : Type de token (par exemple “Input”, “Output”, “Cache Read”, “Cache Write”)
- usd : Montant en USD pour cette ventilation
- diem : Montant en DIEM pour cette ventilation
- units : Nombre d’unités pour cette ventilation

byModelDaily

Données de graphique quotidiennes pour les 8 meilleurs modèles. Chaque entrée contient une “date” (horodatage) plus les noms des modèles comme clés avec les valeurs d’utilisation DIEM.

topModels

Tableau des 8 meilleurs noms de modèles par utilisation, pour les légendes de graphique.

byKey

Ventilation de l’utilisation par clé API, triée par dépense totale (la plus élevée d’abord).

apiKeyId : L’ID de la clé API, ou null si l’utilisation provenait de l’application web
description : Description de la clé API ou “Web App”
totalUsd : Total USD dépensé via cette clé
totalDiem : Total DIEM dépensé via cette clé
totalUnits : Unités totales consommées via cette clé

byKeyDaily

Données de graphique quotidiennes pour les 8 meilleures clés API. Chaque entrée contient une “date” (horodatage) plus les descriptions de clé comme clés avec les valeurs d’utilisation DIEM.

topKeyNames

Tableau des 8 meilleures descriptions de clé API par utilisation, pour les légendes de graphique.

Exemple d’utilisation

# Obtenir les analyses d'utilisation des 7 derniers jours (par défaut)
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Obtenir les analyses d'utilisation des 30 derniers jours
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics?lookback=30d" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Obtenir les analyses d'utilisation pour une plage de dates spécifique
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer YOUR_API_KEY"

Autorisations

Authorization

string

header

requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de requête

lookback

string

défaut:7d

Lookback period for usage data. Format: number followed by "d" (e.g., "7d", "30d"). Maximum: 90d

Pattern: ^[1-9]\d*d$

Exemple:

"7d"

startDate

string

Start date for filtering records (YYYY-MM-DD). If provided, endDate is also required.

Pattern: ^\d{4}-\d{2}-\d{2}$

Exemple:

"2024-01-01T00:00:00.000Z"

endDate

string

End date for filtering records (YYYY-MM-DD). If provided, startDate is also required.

Pattern: ^\d{4}-\d{2}-\d{2}$

Exemple:

"2024-01-31T00:00:00.000Z"

Réponse

Successful response with aggregated usage analytics

Aggregated usage analytics response with breakdowns by date, model, and API key

lookback

string

requis

The lookback period used for the query. Either "Nd" format or "startDate:endDate" format.

Exemple:

"7d"

byDate

object[]

requis

Daily usage totals for the requested period

Show child attributes

byModel

object[]

requis

Usage breakdown by model, sorted by total spend (highest first)

Show child attributes

byModelDaily

object[]

requis

Daily chart data for top 8 models. Each entry has "date" (timestamp) plus model names as keys.

Show child attributes

topModels

string[]

requis

Names of the top 8 models by usage (for chart legends)

byKey

object[]

requis

Usage breakdown by API key, sorted by total spend (highest first)

Show child attributes

byKeyDaily

object[]

requis

Daily chart data for top 8 API keys. Each entry has "date" (timestamp) plus key descriptions as keys.

Show child attributes

topKeyNames

string[]

requis

Descriptions of the top 8 API keys by usage (for chart legends)

API d'utilisation de facturation (Beta)Solde X402

⌘I

​Paramètres de requête

​Champs de la réponse

​lookback

​byDate

​byModel

​byModelDaily

​topModels

​byKey

​byKeyDaily

​topKeyNames

​Exemple d’utilisation

Autorisations

Paramètres de requête

Réponse

Paramètres de requête

Champs de la réponse

lookback

byDate

byModel

byModelDaily

topModels

byKey

byKeyDaily

topKeyNames

Exemple d’utilisation