Quickstart

Get up and running with the Beaconed API in under a minute. This guide walks you through creating an API key and making your first request.

Get your API key

First, create an account if you don't have one yet. Then head to your API keys page to generate a key. Each key is shown once at creation — store it securely.

Your API key is a JWT bearer token. Include it in every request as Authorization: Bearer YOUR_KEY.

Make your first request

List your products to verify everything works. The response includes each product's title, status, and AI readiness score.

Request

GET /v1/products

curl https://beaconed.ai/api/v1/products \
  -H "Authorization: Bearer YOUR_API_KEY"

require "net/http"
require "json"

uri = URI("https://beaconed.ai/api/v1/products")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
products = JSON.parse(response.body)

const response = await fetch("https://beaconed.ai/api/v1/products", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const products = await response.json();

Check the response

A successful response returns a JSON array of products with pagination headers.

Response

{
  "success": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "shopify_id": 7982561779890,
      "title": "Organic Cotton T-Shirt",
      "status": "active",
      "readiness_score": 85,
      "grade": "B",
      "optimized_at": "2026-03-15T14:30:00Z",
      "created_at": "2026-03-01T10:00:00Z"
    }
  ]
}

What's next?

Now that you've made your first request, explore the full API to optimize your products.

Products Authentication