> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage

> 1 tool: heliyos_usage_get.

| Tool | What it does | Kind |
| - | - | - |
| [`heliyos_usage_get`](#heliyos-usage-get) | Get credit usage | Read |

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

**from** `string`

Only usage at or after this date (ISO 8601). Up to 40 characters.

**to** `string`

Only usage at or before this date (ISO 8601); a date alone includes that whole day (UTC). Up to 40 characters.

**feature** `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`.

**record\_id** `string`

Only usage on this record. A 24-character hex id.

**search** `string`

Plain words matched against features, descriptions and object types. Symbols such as + ( ) \[ ] \* ? can cause an error. Up to 200 characters.

**limit** `integer` (default: 20)

Entries per page, 1 to 100. Default 20. From 1 to 100.

**cursor** `string`

next\_cursor from the previous page, with the same limit. Omit for the first page. Up to 200 characters.

**response\_format** `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, plus `structuredContent` with `entries`, `page_credits`, `total_entries`, `next_cursor`.

### API endpoints

* [List credit usage](https://docs.heliyos.ai/api-reference/workspace/list-credit-usage.md) · `GET /v1/platform/usage`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.