Référence de l’API
Usage, dépenses et empreinte
Lire les traces d’usage, le rapport des dépenses et des économies, les budgets et leur consommation, et l’empreinte estimée en énergie et en carbone.
Les résumés des routes et les noms des champs sont écrits en anglais, ici comme dans le fichier.
/api/v1/usage
GET /api/v1/usage
The workspace's usage traces, newest first (paginated)
usage:readlimit · offset · cursor · since · model · agentId · status200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error · 503 service_unavailable/api/v1/report
GET /api/v1/report
The spend and savings report of the workspace
usage:readdays · subscriptionCostUsd200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 429/api/v1/budgets
GET /api/v1/budgets
The workspace's budgets and their use
budgets:read200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error/api/v1/greenops
GET /api/v1/greenops/footprint
The workspace's estimated energy and carbon footprint, over an API key
usage:readperiodDays200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error · 503 service_unavailableGET /api/v1/greenops/energy
Energy per day and per strategy, and the workspace's energy budget
workspaceId · days · feature200 · 401 api_key_missing, api_key_invalid, session_required, session_expired · 403 not_a_member, forbidden, api_key_scope_denied, ip_not_allowed · 429 · 500 internal_errorGET /api/v1/greenops/summary
GreenOps key figures (the dashboard's read)
workspaceId (obligatoire) · periodDays200 · 400 workspace_required · 401 session_required, session_expired, mfa_challenge_required · 403 not_a_member, mfa_required_by_workspace, forbidden · 500 internal_error · 503 membership_lookup_failed, service_unavailableGET /api/v1/greenops/carbon
Estimated carbon totals and their monthly trend (the dashboard's read)
workspaceId (obligatoire) · periodDays · months200 · 400 workspace_required · 401 session_required, session_expired, mfa_challenge_required · 403 not_a_member, mfa_required_by_workspace, forbidden · 500 internal_error · 503 membership_lookup_failed, service_unavailableGET /api/v1/greenops/provider-efficiency
Energy per 1,000 tokens, per provider and model (the dashboard's read)
workspaceId (obligatoire) · periodDays200 · 400 workspace_required · 401 session_required, session_expired, mfa_challenge_required · 403 not_a_member, mfa_required_by_workspace, forbidden · 500 internal_error · 503 membership_lookup_failed, service_unavailableGET /api/v1/greenops/replay-savings
Energy saved by reusing answers (the dashboard's read)
workspaceId (obligatoire) · periodDays200 · 400 workspace_required · 401 session_required, session_expired, mfa_challenge_required · 403 not_a_member, mfa_required_by_workspace, forbidden · 500 internal_error · 503 membership_lookup_failed, service_unavailableGET /api/v1/greenops/abatement
Avoided CO₂ with its traceability (the dashboard's read)
workspaceId (obligatoire) · periodDays200 · 400 workspace_required · 401 session_required, session_expired, mfa_challenge_required · 403 not_a_member, mfa_required_by_workspace, forbidden · 500 internal_error · 503 membership_lookup_failed, service_unavailableGET /api/v1/greenops
Obsolète — Deprecated: use /api/v1/greenops/summary
workspaceId (obligatoire) · periodDays200 · 400 workspace_required · 401 session_required, session_expired, mfa_challenge_required · 403 not_a_member, mfa_required_by_workspace, forbidden · 500 internal_error · 503 membership_lookup_failed, service_unavailable