synthetic-quota

Retrieve information about your Synthetic API usage quotas and limits.

Prerequisites

Requires SYNTHETIC_API_KEY environment variable to be set.

API Endpoint

GET https://api.synthetic.new/v2/quotas

Note: /quotas requests do not count against your subscription limits.

Check Quota

Retrieve current quota information.

Request:

curl -s https://api.synthetic.new/v2/quotas \
  -H "Authorization: Bearer $SYNTHETIC_API_KEY"

Response:

{
  "subscription": {
    "limit": 135,
    "requests": 0,
    "renewsAt": "2025-09-21T14:36:14.288Z"
  }
}

Response Fields

Field	Type	Description
subscription.limit	number	Total request quota for the current period
subscription.requests	number	Number of requests used in the current period
subscription.renewsAt	string	ISO 8601 timestamp when the quota renews

Example Usage

# Check quota with formatted output
curl -s https://api.synthetic.new/v2/quotas \
  -H "Authorization: Bearer $SYNTHETIC_API_KEY" | jq .

# Get remaining requests
curl -s https://api.synthetic.new/v2/quotas \
  -H "Authorization: Bearer $SYNTHETIC_API_KEY" | jq '.subscription.limit - .subscription.requests'

# Check if quota renews soon (within 24 hours)
curl -s https://api.synthetic.new/v2/quotas \
  -H "Authorization: Bearer $SYNTHETIC_API_KEY" | jq '.subscription.renewsAt'

Alias

Add this to your ~/.bashrc or ~/.zshrc:

alias synthetic_quota='curl -s https://api.synthetic.new/v2/quotas \
  -H "Authorization: Bearer ${SYNTHETIC_API_KEY}" \
  | jq --color-output .'

Error Handling

The API will return appropriate HTTP status codes:

• 200 - Success
• 401 - Invalid or missing API key
• 429 - Rate limit exceeded
• 500 - Server error

Always check that SYNTHETIC_API_KEY is set before making requests.