Skip to main content
Authenticate with a Bearer token, drop a URL, get a scored product back. Full endpoint reference at API Reference. Rate limits and credit costs depend on your plan.

API quickstart

Our API lets you score products, retrieve results, and manage your account programmatically. This page walks you through auth, your first call, and key concepts.

Authentication

All authenticated endpoints accept a Bearer token in the Authorization header. You can obtain tokens in two ways:
Generate an API key under Settings > API Keys in the platform. API keys are long-lived and suitable for server-to-server integrations.
Never expose API keys in client-side code or public repositories. Use environment variables for all credentials.

Score a product

Send a POST request to /api/score with the product URL:
The response includes the full scoring result:
The optional context field helps the scoring engine understand the product better, especially for products with minimal public-facing content. Include a brief description of what the product does and who it serves.

Retrieve results

Scoring results are accessible by ID. This endpoint is public (no auth required), supporting shareable result URLs.
To list your score history:

Product Assessment

Score a product using the Product Assessment framework:

Lifecycle assessment

Retrieve lifecycle stage definitions (public, no auth):
Submit a lifecycle self-assessment:

Rate limits and credits

Credits reset monthly. Monitor your usage with the usage endpoint:

Error codes

Health check

Verify the platform is operational:
Returns component-level status for database, auth, billing, scoring, and environment checks.

Next steps

Full API Reference

Complete endpoint documentation with request/response schemas.

SDKs

Client libraries for TypeScript and other languages.