Account

Get plan and usage

The workspace's plan, its limits, and what this month has used. Read it before a run of writes: drafts.remaining is what a draft costs you.

GEThttps://api.vidrys.com/v1/plan

Plan: Grow and above
Key: read
Rate cost: 1 unit
MCP tool: get_plan_usage

Meters reset on the 1st (UTC). A null quota or limit means unlimited on this plan; billing_scope of account means several workspaces share these numbers.

Get plan and usage

curl --request GET \
  --url "https://api.vidrys.com/v1/plan" \
  --header "Authorization: Bearer $VIDRYS_API_KEY"

200 · success

{
  "plan": "grow",
  "plan_name": "Grow",
  "monthly_price_inr": 18999,
  "engines": 3,
  "sweep_interval_days": 2,
  "billing_scope": "organization",
  "answers": {
    "used": 640,
    "quota": 1800,
    "remaining": 1160
  },
  "drafts": {
    "used": 12,
    "quota": 80,
    "remaining": 68
  },
  "max_prompts": 40,
  "projects": 3,
  "max_seats": 10,
  "max_competitors": 25,
  "monthly_audits": 1000,
  "reports_per_month": 100,
  "max_api_keys": 1,
  "retention_days": 545
}

Authorization

Sent as a header on every request.

Authorizationstringrequired

A Vidrys API key, sent as Bearer vidrys_sk_…. A read key is enough. See Authentication.

Response · 200

application/json

planstring

Plan key.

Values:solotrackgrowscalecustom

plan_namestring

Plan name as shown on the dashboard, e.g. Grow.

monthly_price_inrnumber

The plan's monthly price in rupees, before GST.

enginesinteger

AI engines measured on every sweep.

sweep_interval_daysinteger

Days between sweeps: 1 is daily, 2 alternate days, 7 weekly.

billing_scopestring

Where the plan is bought. account means several workspaces share one plan, and the limits and meters below are pooled across them.

Values:accountorganization

answersobject

AI answers analyzed — the plan's billing unit.

+Show child attributes

usedinteger

Answers used this calendar month (UTC).

quotaintegernullable

The monthly allowance. Null means unlimited.

remainingintegernullable

What's left this month. Null when the quota is unlimited.

draftsobject

Content credits. One draft spends one credit.

+Show child attributes

usedinteger

Credits used this calendar month (UTC).

quotaintegernullable

The monthly allowance. Null means unlimited.

remainingintegernullable

What's left this month. Null when the quota is unlimited.

max_promptsintegernullable

Tracked prompts allowed. Null means unlimited.

projectsintegernullable

Projects (brands) allowed. Null means unlimited.

max_seatsintegernullable

Members allowed. Null means unlimited.

max_competitorsintegernullable

Tracked competitors allowed. Null means unlimited.

monthly_auditsintegernullable

Site audits a month. Null means unlimited.

reports_per_monthintegernullable

Reports a month. Null means unlimited.

max_api_keysintegernullable

Active API keys allowed: 1 on Grow, 2 on Scale, 10 on Custom.

retention_daysintegernullable

Days of history the plan keeps visible. Older results are hidden, not deleted. Null means unlimited.

Errors

401 unauthorized	No key was sent, or the key is unknown, revoked or expired, or the member who created it has left the workspace or been deactivated.
402 plan_required	The workspace's plan doesn't include API access. It's included on Grow, Scale and Custom.
403 workspace_not_approved	The workspace is still waiting for approval, or wasn't approved.
429 rate_limited	Too many requests this minute. Wait for the number of seconds in the `Retry-After` header, then retry.

Every code, and what to retry, is in Errors.