curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/usage \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Usage logs fetched successfully",
"pagination": {
"page": 1,
"limit": 20,
"offset": 0,
"count": 2,
"hasMore": false
}
},
"data": [
{
"_id": "6721c0a4b5d6e7f8a9b0c1d2",
"organizationId": "66a0f1e2d3c4b5a697887766",
"feature": "worker_run",
"creditsUtilized": 5,
"objectId": "9f2c4e7a1b3d4f6a8c0e2b4d6f8a0c1e",
"objectType": "orchestrator_run",
"sourceService": "agent",
"description": "worker account_researcher in run 9f2c4e7a1b3d4f6a8c0e2b4d6f8a0c1e",
"metadata": {
"workerId": "6720f3a1b2c3d4e5f6a7b8c9",
"tool": "account_researcher"
},
"meta": {
"organizationId": "66a0f1e2d3c4b5a697887766",
"feature": "worker_run",
"sourceService": "agent"
},
"createdAt": "2026-11-04T10:12:40.000Z"
},
{
"_id": "6721bf02a3b4c5d6e7f8a9b0",
"organizationId": "66a0f1e2d3c4b5a697887766",
"feature": "company_enrichment",
"creditsUtilized": 2,
"sourceService": "agent",
"description": "Company enrichment",
"metadata": {},
"meta": {
"organizationId": "66a0f1e2d3c4b5a697887766",
"feature": "company_enrichment",
"sourceService": "agent"
},
"createdAt": "2026-11-04T09:58:11.000Z"
}
]
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}List credit usage
Returns the workspace’s credit charges, newest first. Each entry says when credits were spent, by which feature, how many, and on what. Use it to reconcile your balance or to see what a worker run cost.
This list pages by page number: send page and limit. meta.pagination carries page,
limit, offset (rows skipped), count (all matching entries) and hasMore. There is no
cursor. To total a period, page through every entry for it and add up creditsUtilized.
Filters combine with AND. The API is read-only for usage: there is no way to add, change or refund credits through it.
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/usage \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Usage logs fetched successfully",
"pagination": {
"page": 1,
"limit": 20,
"offset": 0,
"count": 2,
"hasMore": false
}
},
"data": [
{
"_id": "6721c0a4b5d6e7f8a9b0c1d2",
"organizationId": "66a0f1e2d3c4b5a697887766",
"feature": "worker_run",
"creditsUtilized": 5,
"objectId": "9f2c4e7a1b3d4f6a8c0e2b4d6f8a0c1e",
"objectType": "orchestrator_run",
"sourceService": "agent",
"description": "worker account_researcher in run 9f2c4e7a1b3d4f6a8c0e2b4d6f8a0c1e",
"metadata": {
"workerId": "6720f3a1b2c3d4e5f6a7b8c9",
"tool": "account_researcher"
},
"meta": {
"organizationId": "66a0f1e2d3c4b5a697887766",
"feature": "worker_run",
"sourceService": "agent"
},
"createdAt": "2026-11-04T10:12:40.000Z"
},
{
"_id": "6721bf02a3b4c5d6e7f8a9b0",
"organizationId": "66a0f1e2d3c4b5a697887766",
"feature": "company_enrichment",
"creditsUtilized": 2,
"sourceService": "agent",
"description": "Company enrichment",
"metadata": {},
"meta": {
"organizationId": "66a0f1e2d3c4b5a697887766",
"feature": "company_enrichment",
"sourceService": "agent"
},
"createdAt": "2026-11-04T09:58:11.000Z"
}
]
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}heliyos_usage_get.Authorizations
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
Query Parameters
Entries per page, 1 to 100. Defaults to 20.
1 <= x <= 100The page to return, starting at 1. Defaults to 1.
x >= 1Only entries recorded at or after this time, as an ISO 8601 date or date-time. A date alone means midnight UTC at the start of that day.
Only entries recorded at or before this time, as an ISO 8601 date or date-time. A date alone means midnight UTC at the start of that day, so to include a whole day send the next day's midnight or T23:59:59.999Z.
Only entries for this feature, exact match and case-sensitive, for example worker_run or company_enrichment. See feature on the entry for the values.
100Only entries charged on this object, exact match. For a worker run, pass the run id.
100Case-insensitive text matched against feature, objectId, objectType and description. Up to 200 characters. An empty string is ignored.
200Was this page helpful?

