Guides
API reference
MCP server
Changelog
Every tool on this page only reads.
Get credit usage
heliyos_usage_get · Read · Idempotent
Lists the workspace’s credit usage, newest first: when credits were used, by which feature (company_enrichment, worker_run, scout, …), how many, and on which record. Filter by date range, feature, record or text. Read-only: usage and credits cannot be changed via the API. Returns structuredContent {entries:[{at, feature, credits, record_id}], page_credits, total_entries, next_cursor}.
Inputs
string
Only usage at or after this date (ISO 8601). Up to 40 characters.
string
Only usage at or before this date (ISO 8601); a date alone includes that whole day (UTC). Up to 40 characters.
string
Only this feature (exact match): company_enrichment, people_enrichment, leadset_enrichment, leadset_match, worker_run, scout, meeting_analysis, ai_column, agent_operation. Older entries may use other names; find them with search. One of
company_enrichment, people_enrichment, leadset_enrichment, leadset_match, worker_run, scout, meeting_analysis, ai_column, agent_operation.string
Only usage on this record. A 24-character hex id.
string
Plain words matched against features, descriptions and object types. Symbols such as + ( ) [ ] * ? can cause an error. Up to 200 characters.
integer
default:"20"
Entries per page, 1 to 100. Default 20. From 1 to 100.
string
next_cursor from the previous page, with the same limit. Omit for the first page. Up to 200 characters.
string
default:"concise"
“concise” (default) returns date, feature, credits and record; “detailed” returns descriptions and sources too. One of
concise, detailed.Returns
A readable text summary, plusstructuredContent with entries, page_credits, total_entries, next_cursor.
API endpoints
- List credit usage ·
GET /v1/platform/usage