`invarium_usage`

Show your current plan usage and remaining limits. Displays how many agents, test case generations, simulation credits, and API keys you have used this month versus your plan limits.

When to Use

Call invarium_usage before starting a batch of test generations to verify you have enough quota remaining. It is also useful when you want to check your plan tier or see how close you are to a limit.

The invarium_generate_tests tool consumes one test case generation per call. Checking usage proactively helps you plan your testing budget and avoid hitting limits mid-workflow.

See Quick Start for the recommended workflow sequence.

Parameters

This tool takes no parameters. It returns usage data for the authenticated user’s workspace.

invarium_usage

Show your current plan usage and remaining limits. Displays how many agents, test case generations, simulation credits, and API keys you've used this month vs your plan limits.

Returns

Formatted string with plan name, usage breakdown per category, remaining counts, and reset dates.

Example

Plan: Pro

Usage (current month):
  Agents: 3/10 (30%)  [7 remaining]
  Test case generations: 45/100 (45%)  [55 remaining]
  Simulation credits: 12/50 (24%)  [38 remaining]
  API keys: 2/5 (40%)  [3 remaining]
    Resets: 2026-04-01

Manage plan: https://app.invarium.dev/settings

Response

The tool returns a formatted text overview of your plan and usage:

Plan: Pro

Usage (current month):
  Agents: 3/10 (30%)  [7 remaining]
  Test case generations: 45/100 (45%)  [55 remaining]
  Simulation credits: 12/50 (24%)  [38 remaining]
  API keys: 2/5 (40%)  [3 remaining]
    Resets: 2026-04-01

Manage plan: https://app.invarium.dev/settings

Response Fields

Field	Description
Plan	Your current plan tier (e.g., Free, Pro, Team, Enterprise).
Agents	Number of registered agents versus your plan limit.
Test case generations	Monthly test generation calls used versus limit. Each `invarium_generate_tests` call consumes one generation.
Simulation credits	Simulation runs used versus limit.
API keys	Active API keys versus limit.
Resets	The date when monthly usage counters reset.

Usage Warnings

The response includes inline warnings when you are approaching a limit:

Indicator	Meaning
`-- running low`	Usage is at 75% or above of the limit. Consider upgrading or spacing out generations.
`-- at limit!`	Usage is at 90% or above. You may be blocked from further operations in this category.

When a category has no limit (unlimited plan), the response shows used (unlimited) instead of a ratio.

Examples

Basic Usage

Call with no arguments to see your current usage:

"Show me my current Invarium usage."

Check Before Batch Generation

Before generating tests for multiple scenarios, verify you have enough test case generation quota:

"How many test case generations do I have left this month?"

After Hitting a Limit

If invarium_generate_tests returns a rate limit error, call invarium_usage to see which limit was reached and when it resets.

Error Responses

Error	Cause	Fix
`Authentication failed: invalid API key`	Invalid or missing API key.	Verify your `INVARIUM_API_KEY` is set correctly. Run `invarium_connect` first.
`Failed to fetch usage: ...`	Backend API error or network issue.	Check your connection and try again. See status.invarium.dev for outages.

See Error Codes for the full error reference.

Was this page helpful?

invarium_connect invarium_dashboard