Get credit usage
heliyos_usage_getLists workspace credit usage newest first, showing when credits were used, by feature, amount, and record. Filter by date range, feature, record or text; read-only.
Instructions
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}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Only usage at or before this date (ISO 8601); a date alone includes that whole day (UTC). | |
| from | No | Only usage at or after this date (ISO 8601). | |
| limit | No | Entries per page, 1 to 100. Default 20. | |
| cursor | No | next_cursor from the previous page, with the same limit. Omit for the first page. | |
| search | No | Plain words matched against features, descriptions and object types. Symbols such as + ( ) [ ] * ? can cause an error. | |
| feature | No | 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. | |
| record_id | No | Only usage on this record. | |
| response_format | No | "concise" (default) returns date, feature, credits and record; "detailed" returns descriptions and sources too. | concise |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entries | Yes | ||
| next_cursor | No | ||
| page_credits | Yes | Credits used by the entries on this page. | |
| total_entries | No | Entries matching the filters, across all pages. |