Docs / API v1 · Get indexed by AI

API Reference

Technical documentation of the /api/v1/* endpoints used by the plugin.

Authentication

All endpoints (except GET /api/v1/health) require Authorization: Bearer GC22-XXXX-XXXX-XXXX. The license key is hashed (SHA-256) and compared against licenses.key_hash.

Method	Endpoint	Tier	Purpose
GET	/api/v1/health	public	Health check / API version
POST	/api/v1/license/validate	all	Validates license key + returns tier info
POST	/api/v1/license/refresh	all	Refresh license status (12h plugin cron)
GET	/api/v1/credits/balance	Premium	Current credit balance
POST	/api/v1/credits/consume	Premium	Credit consumption (idempotent)
POST	/api/v1/ai/generate	Premium	Managed AI proxy (idempotent)

Error codes

Errors are standardized via the error.code field:

LICENSE_NOT_FOUND
LICENSE_SUSPENDED
LICENSE_EXPIRED
LICENSE_REVOKED
TIER_NOT_ALLOWED
SITE_LIMIT_EXCEEDED
INSUFFICIENT_CREDITS
IDEMPOTENCY_CONFLICT
AI_PROVIDERS_UNAVAILABLE
AI_TOOL_USE_MALFORMED
PAYLOAD_TOO_LARGE
RATE_LIMIT_EXCEEDED

Rate limiting

Rate limit per license key. On overage: HTTP 429 with Retry-After header. Quota details and backoff strategies are exposed in webapp roadmap phase 5a.

API v1 stabilizing

L'implementazione degli endpoint arriva in Fase 5a-5b del roadmap. Questa pagina documenta il contratto API come definito nella spec 1.2.0; scostamenti verranno documentati nel changelog.