Skip to content
Browse the docs

GET /usage

This period usage, per key: budget, consumed, remaining, rate window, last used.

The bill, made legible.

Request

The same call in curl, Node and Python. A path id in the sample is a placeholder.

curl

curl -sS -X GET https://api.agentisend.com/usage \
  -H "Authorization: Bearer $AGENTISEND_API_KEY"

Node

import { AgentiSend } from 'agentisend';

const client = new AgentiSend(process.env.AGENTISEND_API_KEY);
const result = await client.request({
  method: 'GET',
  path: '/usage',
});

Python

import json, os, urllib.request

url = 'https://api.agentisend.com/usage'
headers = {'Authorization': 'Bearer ' + os.environ['AGENTISEND_API_KEY']}
request = urllib.request.Request(url, headers=headers, method='GET')
print(urllib.request.urlopen(request).read().decode())

Tag: usage. Generated from openapi.json; the anchor get-usage is the id the console's error fix links point at.

Parameters

This operation takes no parameters.

Responses

  • 200 — Success
  • 401 — No usable credential was sent. Codes: agent_signup_code_rejected, missing_api_key, session_required, mfa_required, appsumo_signature_invalid.
  • 403 — The credential may not do this, or the account or key is stopped. Codes: sending_domain_blocked, young_domain_held, domain_sending_disabled, inbound_sender_refused, domain_not_verified, onboarding_recipient_not_a_member, onboarding_sender_unavailable, account_suspended, account_sandboxed, agent_unconfirmed, recipient_ramp, human_action_required, csrf_origin_rejected, charge_not_this_account, invalid_api_key, restricted_api_key, insufficient_role, invite_email_mismatch, domain_scope_violation, dedicated_ip_assigned_by_us, approval_required, staff_review_required, trust_paused, kill_switch_active.
  • 429 — A rate, quota or ramp ceiling was reached. Codes: onboarding_daily_cap_reached, trust_throttled, invite_limit_reached, rate_ceiling_exceeded, daily_quota_exceeded, monthly_quota_exceeded, rate_limit_exceeded, support_rate_limited, appsumo_lookup_limited.
  • 500 — Something failed on our side. Codes: internal_server_error.

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
accountobjectyes
account.bounced_30dintegeryes
account.complained_30dintegeryes
account.sent_24hintegeryes
account.sent_30dintegeryes
automation_runsobjectyes
automation_runs.limitinteger | nullyes
automation_runs.resets_atstringyes
automation_runs.usedintegeryes
broadcastsobjectyes
broadcasts.limitnullyes
broadcasts.usedintegeryes
contactsobjectyes
contacts.limitinteger | nullyes
contacts.usedintegeryes
domainsobjectyes
domains.limitinteger | nullyes
domains.usedintegeryes
emailsobjectyes
emails.dailyobjectyes
emails.monthlyobjectyes
keysarray<object>yes
keys[].budget_per_periodinteger | nullyes
keys[].consumed_in_periodintegeryes
keys[].consumed_in_windowintegeryes
keys[].expires_atstring | nullyes
keys[].idstringyes
keys[].key_countinteger | nullyes
keys[].last_used_atstring | nullyes
keys[].namestringyes
keys[].pausedbooleanyes
keys[].period"hourly" | "daily" | "monthly"yes
keys[].period_started_atstringyes
keys[].rate_ceiling_per_minuteinteger | nullyes
keys[].remaininginteger | nullyes
keys[].resets_atstringyes
keys[].revokedbooleanyes
keys[].used_percentnumber | nullyes
objectstringyes
period_started_atstringyes
rate_limitobjectyes
rate_limit.durationstringyes
rate_limit.limitintegeryes
segmentsobjectyes
segments.limitinteger | nullyes
segments.usedintegeryes

Response example

200
{
  "account": {
    "bounced_30d": -9007199254740991,
    "complained_30d": -9007199254740991,
    "sent_24h": -9007199254740991,
    "sent_30d": -9007199254740991
  },
  "automation_runs": {
    "limit": -9007199254740991,
    "resets_at": "2026-09-04T09:14:00.000Z",
    "used": -9007199254740991
  },
  "broadcasts": {
    "limit": null,
    "used": -9007199254740991
  },
  "contacts": {
    "limit": -9007199254740991,
    "used": -9007199254740991
  },
  "domains": {
    "limit": -9007199254740991,
    "used": -9007199254740991
  },
  "emails": {
    "daily": {
      "limit": -9007199254740991,
      "received": -9007199254740991,
      "resets_at": "2026-09-04T09:14:00.000Z",
      "sent": -9007199254740991,
      "used": -9007199254740991
    },
    "monthly": {
      "limit": -9007199254740991,
      "received": -9007199254740991,
      "resets_at": "2026-09-04T09:14:00.000Z",
      "sent": -9007199254740991,
      "used": -9007199254740991
    }
  },
  "keys": [],
  "object": "usage",
  "period_started_at": "2026-09-04T09:14:00.000Z",
  "rate_limit": {
    "duration": "example",
    "limit": -9007199254740991
  },
  "segments": {
    "limit": -9007199254740991,
    "used": -9007199254740991
  }
}

Errors

The codes this operation can answer with, and what to do about each. Every one arrives with its code, message, fix and docs_url.

  • internal_server_error (500, internal_server_error) — Unexpected error. Fix: Retry ONCE after a short pause, with the same Idempotency-Key so the retry cannot double-send. If it fails again, stop retrying and report the x-request-id from the response — that id is what identifies this exact failure in support.
  • invalid_api_key (403, invalid_api_key) — API key is invalid or revoked. Fix: Create a new key with POST /api-keys; deleted keys cannot be restored.
  • mfa_required (401) — This session has not completed two-factor authentication. Fix: Finish signing in at https://console.agentisend.com/verify with a code from your authenticator app, or one of your recovery codes. Manage the second factor in the console under Settings, Security.
  • missing_api_key (401, missing_api_key) — Missing API key in authorization header. Fix: Create an API key at https://console.agentisend.com/api-keys and send "Authorization: Bearer as_...". MCP clients can connect with OAuth instead of a key.
  • rate_limit_exceeded (429, rate_ceiling_exceeded, rate_limit_exceeded) — Too many requests. Fix: Back off and retry honoring the Retry-After header.
  • restricted_api_key (403, restricted_api_key) — This API key is restricted to sending only. Fix: Use a full_access key (POST /api-keys with permission=full_access) for management endpoints.