API Reference
Use the Beaconed API to programmatically manage products, generate AI optimizations, calculate readiness scores, and configure webhooks. Authenticate with a Bearer token and get started in minutes.
Getting started
To get started, create an API key in your account settings, then authenticate all requests with a Bearer token. Read the quickstart for a complete walkthrough.
Guides
Authentication
Learn how to authenticate your API requests using Bearer tokens.
Pagination
Understand how to work with paginated list responses.
Errors
Read about the error codes and response format.
Quickstart
Make your first API request in under a minute.
Resources
Products
Sync, update, and optimize your product listings.
Scores
Calculate and retrieve AI readiness scores for products.
Optimizations
Generate, review, and apply AI-powered improvements.
Webhooks
Subscribe to real-time events for optimizations and scores.
Bulk Optimizations
Optimize multiple products in a single request.
Settings
Retrieve account configuration and usage limits.