HydraCore
API by router

Usage

Budget Status

GET
/v1/usage/budget-status

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Query Parameters

instance_id*Instance Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
budget_daily_usd*number|null
by_model*
instance_id*Instance Id
Formatuuid
remaining_usd*number|null
spent_today_usd*Spent Today Usd
Example Request
curl -X GET 'https://example.com/v1/usage/budget-status?instance_id=497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "budget_daily_usd": 0,  "by_model": {},  "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",  "remaining_usd": 0,  "spent_today_usd": 0}

Usage Summary

GET
/v1/usage/summary

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Query Parameters

period?Period

today|week|month

Default"today"
group_by?Group By

Group by: customer, instance, model, or key_source

Default"customer"
customer_id?|null
instance_id?|null

Response Body

Successful Response

application/json
  1. response
Example Request
curl -X GET 'https://example.com/v1/usage/summary'
Example Response
{}