Skip to content

consumption_limit_get

Managementcatalog

Get My Consumption Limit

Not in the default tool list

This tool lives in the tool catalog. Discover it with scenario_tools_search (or enumerate everything with scenario_tools_list) and run it via scenario_tool_execute_read. To list every tool directly, connect with ?toolsets=full.

Read your own consumption cap: the Creative Units (CU) you may spend this billing period, how many you have spent, what remains, and when the period resets. An OAuth caller gets their member cap; an API key gets the key's own cap. The project's own cap is reported beside it: the given project_id, or a project key's only project. The effective cap is reported: the override a team admin set for you, else the team-wide default member cap. unlimited=true (max_consumption and remaining null) means no cap applies; it never means zero remaining. Only the caller's own figures are returned, never another member's. effective_remaining is the lower of your remaining and the project's, and limited_by names the cap that runs out first; the team plan balance can still stop generation earlier. Setting a cap stays admin-only: team_members_update with max_consumption (catalog-only, run via scenario_tool_execute_write); an API key's cap is set in the Scenario portal. Returns: { team_id, caller {kind: 'member'|'api_key', id, email?, role?, name?}, unlimited, max_consumption, consumption, remaining, cap_source ('override'|'team_default'|'none'), project? {id, name?, unlimited, max_consumption, consumption, remaining}, effective_remaining, limited_by ('member'|'project'|'none'), period? {start, end} }. period.end is the reset date; it is omitted when the API does not report it. Examples: - "How many credits do I have left this month?" -> read effective_remaining - "What is my spending limit and when does it reset?" -> read max_consumption and period.end Don't use when: You need spend broken down by model, user or date: use usage. You want every member's cap and spend: team admins use team_members_list (catalog-only, run via scenario_tool_execute_read).
read-onlyidempotentopen-world

Parameters

NameTypeRequiredDescription
team_idstring—Team ID, required for OAuth callers. An API key that reaches one team may omit it.
project_idstring—Adds this project's cap beside yours. A project API key that omits it reads its only project.
response_formatenum(json | markdown)jsonOutput format: 'json' for structured data, 'markdown' for human-readable text.