Billing Usage Analytics | Venice API Docs

/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"
  ]
}

Este es un endpoint en beta y puede ser inestable o cambiar sin previo aviso.

Obtén analíticas de uso agregadas para el usuario autenticado, con desgloses por fecha, modelo y API key. Este endpoint proporciona vistas resumidas de los datos de uso de tu API para crear paneles y monitorizar el consumo. Los datos se almacenan en caché durante 10 minutos.

Parámetros de consulta

Puedes especificar el periodo de tiempo para las analíticas mediante:

lookback: un periodo relativo como “7d” (7 días), “30d” (30 días), hasta “90d” (90 días)
startDate y endDate: un rango de fechas personalizado en formato YYYY-MM-DD. Ambos son obligatorios si se proporciona alguno.

Si no se especifica ningún parámetro, el periodo de lookback predeterminado es de 7 días.

Campos de respuesta

lookback

El periodo de lookback utilizado para la consulta. Puede estar en formato “Nd” (p. ej., “7d”) o “startDate:endDate”.

byDate

Totales de uso diarios para el periodo solicitado.

date: la fecha en formato YYYY-MM-DD
USD: uso total en USD para ese día
DIEM: uso total en DIEM para ese día

byModel

Desglose de uso por modelo, ordenado por gasto total (mayor primero).

modelName: nombre del modelo para mostrar (p. ej., “GLM 5”)
unitType: tipo de unidades consumidas (tokens, images, chars, minutes, seconds)
modelType: tipo de modelo (LLM, IMAGE, TTS, ASR, VIDEO), o null
totalUsd: total en USD gastado en este modelo
totalDiem: total en DIEM gastado en este modelo
totalUnits: total de unidades consumidas para este modelo
breakdown: array de desgloses de uso por tipo (solo presente si hay múltiples tipos). Cada entrada contiene:
- type: tipo de token (p. ej., “Input”, “Output”, “Cache Read”, “Cache Write”)
- usd: importe en USD para este desglose
- diem: importe en DIEM para este desglose
- units: número de unidades para este desglose

byModelDaily

Datos de gráfico diarios para los 8 modelos principales. Cada entrada contiene una “date” (timestamp) más los nombres de modelo como claves con valores de uso en DIEM.

topModels

Array de los 8 nombres de modelos principales por uso, para leyendas de gráficos.

byKey

Desglose de uso por API key, ordenado por gasto total (mayor primero).

apiKeyId: el ID de la API key, o null si el uso provino de la aplicación web
description: descripción de la API key o “Web App”
totalUsd: total en USD gastado mediante esta clave
totalDiem: total en DIEM gastado mediante esta clave
totalUnits: total de unidades consumidas mediante esta clave

byKeyDaily

Datos de gráfico diarios para las 8 API keys principales. Cada entrada contiene una “date” (timestamp) más las descripciones de las claves como claves con valores de uso en DIEM.

topKeyNames

Array de las 8 descripciones de API key principales por uso, para leyendas de gráficos.

Ejemplo de uso

# Obtener analíticas de uso de los últimos 7 días (predeterminado)
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Obtener analíticas de uso de los últimos 30 días
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics?lookback=30d" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Obtener analíticas de uso para un rango de fechas específico
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"

Autorizaciones

Authorization

string

header

requerido

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

Parámetros de consulta

lookback

string

predeterminado:7d

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

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

Ejemplo:

"7d"

startDate

string

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

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

Ejemplo:

"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}$

Ejemplo:

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

Respuesta

Successful response with aggregated usage analytics

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

lookback

string

requerido

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

Ejemplo:

"7d"

byDate

object[]

requerido

Daily usage totals for the requested period

Show child attributes

byModel

object[]

requerido

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

Show child attributes

byModelDaily

object[]

requerido

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

Show child attributes

topModels

string[]

requerido

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

byKey

object[]

requerido

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

Show child attributes

byKeyDaily

object[]

requerido

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

Show child attributes

topKeyNames

string[]

requerido

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

API de uso de facturación (Beta)Saldo X402

⌘I

​Parámetros de consulta

​Campos de respuesta

​lookback

​byDate

​byModel

​byModelDaily

​topModels

​byKey

​byKeyDaily

​topKeyNames

​Ejemplo de uso

Autorizaciones

Parámetros de consulta

Respuesta

Parámetros de consulta

Campos de respuesta

lookback

byDate

byModel

byModelDaily

topModels

byKey

byKeyDaily

topKeyNames

Ejemplo de uso