Skip to content
Shortcut: /, ⌘K or Ctrl+K

polymorfa usage

Polymorfa CLI · CLI API requests

View as Markdown

polymorfa usage gates

List usage gates and their limits.

List your usage gates with their mode, limit, usage this month and how often an action went over the limit in the last 30 days. In record mode a gate never refuses an action; in enforce mode an action over the limit fails with gate_limit_reached. Pass --session to include limits that apply per number. Gate state covers the whole team, so this needs a team API key; project API keys are refused. A limit that cannot be checked fails the action with 503 in either mode.

Usage

polymorfa usage gates [flags]

Examples

polymorfa usage gates
polymorfa usage gates --session support --json

Flags

  • --session <value>takes a value

    Include limits that apply to one number (session name).

Also accepts the global flags.

polymorfa usage records

List usage records.

List usage records, newest first. Filter by call, number, meter or calendar month. A call has one call.duration record, and an outgoing Cloud API call also a call.cloud_pulses record. Pass the printed cursor to read the next page.

Usage

polymorfa usage records [flags]

Examples

polymorfa usage records --call 3EB0C431C26A1916E07A
polymorfa usage records --session support --meter call.duration --limit 50 --json

Flags

  • --call <value>takes a value

    One call, by call ID.

  • --cursor <value>takes a value

    Continue from a previous page.

  • --limit <value>takes a value

    Records per page, 1 to 100.

  • --meter <value>takes a value

    One meter, for example call.duration.

  • --period <value>takes a value

    Calendar month in UTC as YYYY-MM.

  • --session <value>takes a value

    Limit to one number (session name).

Also accepts the global flags.

polymorfa usage summary

Show metered usage for a month.

Show metered usage for one calendar month (UTC), by meter and by number. Usage is measured, not charged: no credits are deducted for it. Requires sessions:read. A project token reads only its own project.

Usage

polymorfa usage summary [flags]

Examples

polymorfa usage summary
polymorfa usage summary --period 2026-09 --session support --json

Flags

  • --period <value>takes a value

    Calendar month in UTC as YYYY-MM. Defaults to this month.

  • --session <value>takes a value

    Limit to one number (session name).

Also accepts the global flags.