TAtavily

Get organization usage across all API keys

Changed on

Retrieve usage (credits), pay-as-you-go USD cost, and request counts for every API key under an organization you own, mirroring the platform's Usage analytics page.

Identify the organization by name in the request body. Authenticate with the organization owner's personal API key — the key from the owner's own personal account, not an organization or enterprise API key. Supports date-range, project, and depth filtering.

post/org-usage

Request

  • Base URL
    https://api.tavily.com
  • URL
    https://api.tavily.com/org-usage
  • Auth
    HTTP bearer

Request body

organization_namestring required

Exact organization name (case-sensitive). You must be the owner of this organization.

start_datestring date

Inclusive start of the usage window (YYYY-MM-DD). Defaults to the start of the current billing cycle.

end_datestring date

Inclusive end of the usage window (YYYY-MM-DD). Defaults to today.

project_idstring

Scope usage to a single project.

depth'basic' | 'advanced' | 'fast' | 'pro' | 'mini' | 'auto' | 'ultra-fast'

Scope usage to a single request depth.

Example request

{
  "organization_name": "Acme Inc",
  "start_date": "2026-05-01",
  "end_date": "2026-05-27",
  "depth": "advanced"
}

Response

Organization usage returned successfully

Example response

{
  "organization": {
    "name": "Acme Inc",
    "filters": {
      "start_date": "2026-05-01",
      "end_date": "2026-05-27"
    }
  },
  "totals": {
    "usage": 1820,
    "paygo_cost_usd": 12.71,
    "request_count": 1760,
    "by_type": {
      "search": {
        "usage": 543,
        "paygo_cost_usd": 4.34,
        "request_count": 528
      },
      "crawl": {
        "usage": 543,
        "paygo_cost_usd": 4.34,
        "request_count": 528
      },
      "extract": {
        "usage": 543,
        "paygo_cost_usd": 4.34,
        "request_count": 528
      },
      "map": {
        "usage": 543,
        "paygo_cost_usd": 4.34,
        "request_count": 528
      },
      "research": {
        "usage": 543,
        "paygo_cost_usd": 4.34,
        "request_count": 528
      }
    }
  },
  "keys": [
    {
      "key": "...AB3xQ",
      "name": "production-key",
      "usage": 543,
      "paygo_cost_usd": 4.34,
      "request_count": 528,
      "by_type": {
        "search": {
          "usage": 543,
          "paygo_cost_usd": 4.34,
          "request_count": 528
        },
        "crawl": {
          "usage": 543,
          "paygo_cost_usd": 4.34,
          "request_count": 528
        },
        "extract": {
          "usage": 543,
          "paygo_cost_usd": 4.34,
          "request_count": 528
        },
        "map": {
          "usage": 543,
          "paygo_cost_usd": 4.34,
          "request_count": 528
        },
        "research": {
          "usage": 543,
          "paygo_cost_usd": 4.34,
          "request_count": 528
        }
      }
    }
  ]
}

Changes