Advanced

Setting Up API Access

6 min read

Eevy AI now lets you connect external tools directly to your store's review data. Whether you want an AI agent to answer questions about your reviews, a dashboard that pulls product coverage stats, or an automation that monitors your review pipeline — it all starts with an API token.

This guide walks you through creating a token, connecting your first tool, and what you can do once you're set up.

Why Use API Access?

API access opens up your Eevy data to tools outside of the Eevy dashboard. Here are a few things merchants are using it for:

AI agents: Let an AI assistant query your reviews, find trends, or answer questions like "which products have the most 1-star reviews?" — all in natural language.

Dashboards: Pull review counts, product coverage, and store sync data into your own reporting tools.

Automations: Build workflows that react to your review data — for example, flagging products with low review coverage or alerting you when a product crosses a review threshold.

The API is read-only, so your data is safe. Nothing can be modified or deleted through the API.

Creating Your API Token

Creating a token takes about 30 seconds:

1. Open the Eevy AI app in your Shopify admin
2. Go to Settings
3. Click the API Access tab
4. Click Create experiment token
5. Copy the token immediately — it is only shown once

The token is tied to your current experiment, which means it can only access data for that specific experiment. This keeps things secure: if you share a token with an external tool, it can only see what you intended.

If you run multiple stores with Multi-Store Sync, you can also create a token scoped to your entire sync group, giving a tool access to all connected stores at once.

Connecting a Tool or Agent

Once you have your token, connecting it to an external tool is straightforward. Most tools will ask you for two things:

Base URL: https://eevy-v3-532047863820.europe-west3.run.app/api/external/v1

API Token: The token you just created (starts with eevy_live_)

The tool sends the token in a header with each request. If you are setting this up yourself or handing it to a developer, the token goes in either:

Authorization: Bearer eevy_live_...

or

X-API-Key: eevy_live_...

Both work identically. Most tools will handle this for you — you just paste the token in.

Preferred token-scoped endpoints:
POST /api/external/v1/query
GET /api/external/v1/experiment/reviews
GET /api/external/v1/experiment/products/data-coverage?data_type=reviews
GET /api/external/v1/shop-sync-group

What You Can Do With the API

Once connected, here is what tools can access:

Ask questions in plain English: Use POST /api/external/v1/query. This prompt endpoint understands natural-language queries like "show me 5-star reviews mentioning shipping" or "which products have the most reviews?" Your AI agent sends a question, and the API returns the interpreted query plus results. For experiment-scoped tokens, the experiment is inferred automatically.

Browse reviews: Use GET /api/external/v1/experiment/reviews. Filter and search reviews by star rating, product handle, keyword, testing status, or verified purchase status without sending an experiment ID.

Check product coverage: Use GET /api/external/v1/experiment/products/data-coverage?data_type=reviews. This shows which products have review data and how much, again using the experiment linked to the token.

View store sync overview: Use GET /api/external/v1/shop-sync-group. If you use multi-store sync, this returns connected stores and their experiments using the ShopSync scope linked to the token.

Advanced explicit-ID routes: If you already know the IDs, the API still supports GET /api/external/v1/experiments/:experimentID/reviews, GET /api/external/v1/experiments/:experimentID/products/data-coverage, and GET /api/external/v1/shop-sync-groups/:shopSyncID.

Discover the full API: Use GET /api/external/v1 for the API index and GET /api/external/v1/openapi.json for the OpenAPI spec.

Making Your First API Call

The fastest way to test the API is the prompt endpoint. Use your external token in the Authorization header and send a question in plain English:

curl -sS "https://eevy-v3-532047863820.europe-west3.run.app/api/external/v1/query" \
  -H "Authorization: Bearer eevy_live_..." \
  -H "Content-Type: application/json" \
  -d '{"prompt":"Return reviews mentioning \"Ising\"","limit":10}'

You can also call the structured token-scoped endpoints directly. For example, to fetch reviews: GET /api/external/v1/experiment/reviews?ratings=5,4&search=Ising. For data coverage: GET /api/external/v1/experiment/products/data-coverage?data_type=reviews. For multi-store tokens: GET /api/external/v1/shop-sync-group.

Managing Your Tokens

You can create multiple tokens — for example, one for each tool you connect. This makes it easy to revoke access for a specific tool without affecting others.

To manage your tokens, go to Settings → API Access in the Eevy AI app. You will see a list of all active tokens, including when each was last used. Click any token to revoke it. Revoked tokens stop working immediately.

Best practices:
• Create a separate token for each tool or integration
• Use experiment-scoped tokens unless you specifically need multi-store access
• Revoke tokens you are no longer using
• If a token is accidentally exposed, revoke it and create a new one

Wrapping Up

API access turns your Eevy review data into a building block for AI agents, automations, and custom dashboards. Set up takes under a minute, and because everything is read-only, there is no risk to your data. Start with the prompt endpoint to see how an AI agent can answer questions about your reviews — it is the fastest way to see the value.

Free — 30 seconds