ابدأ مجانًا →

مرجع واجهة API

الاستخدام والإنفاق والبصمة

قراءة آثار الاستخدام، وتقرير الإنفاق والوفورات، والميزانيات واستهلاكها، والبصمة التقديرية من الطاقة والكربون.

مرجع واجهة API كاملًا

ملخصات المسارات وأسماء الحقول مكتوبة بالإنجليزية، هنا وفي الملف.

/api/v1/usage

GET /api/v1/usage

The workspace's usage traces, newest first (paginated)

المصادقة
مفتاح API
نطاق المفتاح
usage:read
المعاملات
limit · offset · cursor · since · model · agentId · status

/api/v1/report

GET /api/v1/report

The spend and savings report of the workspace

المصادقة
مفتاح API
نطاق المفتاح
usage:read
المعاملات
days · subscriptionCostUsd

/api/v1/budgets

GET /api/v1/budgets

The workspace's budgets and their use

المصادقة
مفتاح API
نطاق المفتاح
budgets:read

/api/v1/greenops

GET /api/v1/greenops/footprint

The workspace's estimated energy and carbon footprint, over an API key

المصادقة
مفتاح API
نطاق المفتاح
usage:read
المعاملات
periodDays

GET /api/v1/greenops/energy

Energy per day and per strategy, and the workspace's energy budget

المصادقة
مفتاح API أو جلسة مسجّلة
المعاملات
workspaceId · days · feature

GET /api/v1/greenops/summary

GreenOps key figures (the dashboard's read)

المصادقة
جلسة مسجّلة (لوحة التحكم)
المعاملات
workspaceId (إلزامي) · periodDays

GET /api/v1/greenops/carbon

Estimated carbon totals and their monthly trend (the dashboard's read)

المصادقة
جلسة مسجّلة (لوحة التحكم)
المعاملات
workspaceId (إلزامي) · periodDays · months

GET /api/v1/greenops/provider-efficiency

Energy per 1,000 tokens, per provider and model (the dashboard's read)

المصادقة
جلسة مسجّلة (لوحة التحكم)
المعاملات
workspaceId (إلزامي) · periodDays

GET /api/v1/greenops/replay-savings

Energy saved by reusing answers (the dashboard's read)

المصادقة
جلسة مسجّلة (لوحة التحكم)
المعاملات
workspaceId (إلزامي) · periodDays

GET /api/v1/greenops/abatement

Avoided CO₂ with its traceability (the dashboard's read)

المصادقة
جلسة مسجّلة (لوحة التحكم)
المعاملات
workspaceId (إلزامي) · periodDays

GET /api/v1/greenops

مُهمَل — Deprecated: use /api/v1/greenops/summary

المصادقة
جلسة مسجّلة (لوحة التحكم)
المعاملات
workspaceId (إلزامي) · periodDays