Skip to main content
POST
/
org-usage
Get organization usage across all API keys
curl --request POST \
  --url https://api.tavily.com/org-usage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_name": "Acme Inc",
  "start_date": "2026-05-01",
  "end_date": "2026-05-27",
  "project_id": "<string>",
  "depth": "advanced"
}
'
{
  "organization": {
    "name": "Acme Inc",
    "filters": {
      "start_date": "2026-05-01",
      "end_date": "2026-05-27",
      "project_id": null,
      "depth": null
    }
  },
  "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
        }
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.tavily.com/llms.txt

Use this file to discover all available pages before exploring further.

Access to this API is an enterprise feature only. Talk to an expert to learn more.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. Identify the organization by name in the request body.

Authorizations

​
Authorization
string
header
required

Bearer authentication header in the form Bearer . The token must be the organization owner's personal API key (from the owner's own personal account, not an organization key).

Body

application/json
​
organization_name
string
required

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

Example:

"Acme Inc"

​
start_date
string<date>

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

Example:

"2026-05-01"

​
end_date
string<date>

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

Example:

"2026-05-27"

​
project_id
string

Scope usage to a single project.

​
depth
enum<string>

Scope usage to a single request depth.

Available options:
basic,
advanced,
fast,
pro,
mini,
auto,
ultra-fast
Example:

"advanced"

Response

Organization usage returned successfully

​
organization
object
​
totals
object

Aggregated usage across all keys in the organization for the selected window/filters

​
keys
object[]