Skip to main content
GET
/
api
/
v1
/
billing
/
agents
Get all agents with their costs for a date range
curl --request GET \
  --url https://api.example.com/api/v1/billing/agents \
  --header 'Authorization: Bearer <token>'
{
  "agents": [
    {
      "agentId": 123,
      "agentName": "<string>",
      "cost": 123,
      "spaceId": 123
    }
  ],
  "totalRecordCount": 123,
  "totalCost": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"

​
Authorization
string
header
required

OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"

Query Parameters

​
startDate
string<date-time>

Start date for the range (ISO format, required)

​
endDate
string<date-time>

End date for the range (ISO format, required)

​
pageIndex
integer<int32>
default:1

Page number (1-based, default: 1)

​
recordsPerPage
integer<int32>
default:50

Records per page (default: 50, max: 1000)

​
sortColumn
string
default:name

Column to sort by: name, cost

​
sortOrder
integer<int32>
default:0

Sort order: 0 = ascending (default), 1 = descending

​
name
string

Filter by agent name (contains match, case-insensitive)

​
usageTypes
string

Filter by usage types (comma-separated)

Response

Returns the paginated list of agents with costs

Paginated response for agent usage list

​
agents
object[] | null

List of agents with their costs

​
totalRecordCount
integer<int32>

Total number of agents matching the filter

​
totalCost
number<double>

Total cost across all agents in the date range

​
startDate
string<date-time>

Start date of the range

​
endDate
string<date-time>

End date of the range