SigmentDocs

Account and credits

Check the workspace, balance and prices, and send the user a top-up link.

View .mdOpen in Claude

Start every session with get_account, and call quote_cost before any paid tool.

get_account

get_accountread-only

Workspaces, plan, credit balance, prices and today's agent spend. Call this first.

ParameterTypeDefaultLimits
workspace_idstring1–100 chars

quote_cost

quote_costread-only

Price an action before doing it. For analysis pass the creator handles (new analysis) or analysis_id (re-run): re-analyses of creators seen in the last 30 days cost 5 instead of 15.

ParameterTypeDefaultLimits
actionrequired"discovery" | "analysis"
platform"instagram" | "youtube" | "tiktok""instagram"
handlesstring[]1–50 items
analysis_idstring1–100 chars
workspace_idstring1–100 chars

get_credit_history

get_credit_historyread-only

Recent credit charges, refunds and top-ups for the workspace.

ParameterTypeDefaultLimits
limitinteger201–100
workspace_idstring1–100 chars
get_topup_linkwrite

A Stripe checkout link for the HUMAN user to buy credits. Agents cannot pay: give the user the URL.

ParameterTypeDefaultLimits
package_id"starter" | "growth" | "scale""starter"
workspace_idstring1–100 chars

On this page