Precheck Usage

curl --request GET \
  --url https://api.example.com/usage/precheck \
  --header 'X-API-Key: <api-key>'

{
  "can_proceed": true,
  "quota_remaining": 123,
  "rate_remaining": 123,
  "tier": "<string>",
  "reason": "<string>",
  "upgrade_url": "<string>"
}

Usage

Precheck Usage

Pre-check if you can perform an operation before executing it.

Required scope: read

Operations:

api_call: Standard API call (default)
proposal_create: Creating a new proposal
ai_analysis: AI-powered analysis

Use this in your n8n workflows to check limits before operations:

1. Call GET /usage/precheck?operation=proposal_create
2. If can_proceed=true, call POST /proposals
3. If can_proceed=false, handle the error or trigger upgrade flow

Returns:

can_proceed: Whether the operation can be performed
reason: If can_proceed=false, explains why
quota_remaining: Remaining monthly quota (-1 = unlimited)
rate_remaining: Remaining rate limit this minute
tier: Current subscription tier
upgrade_url: URL to upgrade if limits reached

GET

usage

precheck

Precheck Usage

curl --request GET \
  --url https://api.example.com/usage/precheck \
  --header 'X-API-Key: <api-key>'

{
  "can_proceed": true,
  "quota_remaining": 123,
  "rate_remaining": 123,
  "tier": "<string>",
  "reason": "<string>",
  "upgrade_url": "<string>"
}

Authorizations

X-API-Key

string

header

required

Query Parameters

operation

enum<string>

default:api_call

Operation to check

Available options:

api_call,

proposal_create,

ai_analysis

Response

Successful Response

Response for usage precheck endpoint.

can_proceed

boolean

required

quota_remaining

integer

required

rate_remaining

integer

required

tier

string

required

reason

string | null

upgrade_url

string | null

Get Api Usage List Webhook Events Public

Documentation Index

Authorizations

Query Parameters

Response