API Documentation - Honeyglaze

Getting Started

Base URL

https://api.honeyglaze.store/v1

Authentication

All API requests require a Bearer token in the Authorization header. Generate your API key from the Honeyglaze dashboard under Settings > API Keys.

Authorization: Bearer hg_live_your_api_key_here

Rate Limits

Rate limits depend on your plan:

Starter: 100 requests/minute
Growth: 500 requests/minute
Enterprise: Custom limits

Rate limit headers are included in every response: X-RateLimit-Remaining and X-RateLimit-Reset.

Endpoints

GET /stores

List all connected stores for your account.

Example Request

curl -X GET https://api.honeyglaze.store/v1/stores \
  -H "Authorization: Bearer hg_live_your_api_key_here"

Response

{
  "data": [
    {
      "id": "store_8x7kq2m",
      "name": "My Shopify Store",
      "platform": "shopify",
      "status": "active",
      "sku_count": 1247,
      "agent_status": "running",
      "created_at": "2026-03-15T08:00:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 20
  }
}

POST /agent/goals

Set or update the agent's optimization goals for a specific store.

Request Body

curl -X POST https://api.honeyglaze.store/v1/agent/goals \
  -H "Authorization: Bearer hg_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "store_id": "store_8x7kq2m",
    "goals": {
      "target_revenue_daily": 50000,
      "min_margin_percent": 25,
      "max_ad_spend_daily": 5000,
      "target_roas": 4.0
    },
    "guardrails": {
      "max_price_change_percent": 15,
      "require_approval_above": 10000
    }
  }'

Response

{
  "id": "goal_9f3ka1n",
  "store_id": "store_8x7kq2m",
  "status": "active",
  "goals": {
    "target_revenue_daily": 50000,
    "min_margin_percent": 25,
    "max_ad_spend_daily": 5000,
    "target_roas": 4.0
  },
  "updated_at": "2026-06-21T12:00:00Z"
}

GET /agent/actions

Retrieve the agent's recent actions and decision log for a store.

Query Parameters

store_id (required) - The store identifier
type (optional) - Filter by action type: pricing, ads, inventory, customer_service
limit (optional) - Number of results (default: 50, max: 200)

Example Request

curl -X GET "https://api.honeyglaze.store/v1/agent/actions?store_id=store_8x7kq2m&type=pricing&limit=5" \
  -H "Authorization: Bearer hg_live_your_api_key_here"

Response

{
  "data": [
    {
      "id": "act_k29xm1",
      "type": "pricing",
      "sku": "SKU-10432",
      "action": "price_decreased",
      "old_value": 29.99,
      "new_value": 26.99,
      "reason": "Competitor price drop detected on Amazon",
      "confidence": 0.92,
      "executed_at": "2026-06-21T09:15:00Z"
    }
  ],
  "meta": { "total": 847, "page": 1 }
}

GET /analytics/overview

Get a high-level performance overview for a store over a specified time range.

Example Request

curl -X GET "https://api.honeyglaze.store/v1/analytics/overview?store_id=store_8x7kq2m&period=7d" \
  -H "Authorization: Bearer hg_live_your_api_key_here"

Response

{
  "store_id": "store_8x7kq2m",
  "period": "7d",
  "revenue": 312450.00,
  "orders": 4821,
  "avg_order_value": 64.81,
  "ad_spend": 31200.00,
  "roas": 4.18,
  "agent_actions_taken": 12847,
  "approvals_pending": 3
}

POST /agent/approve

Approve or reject a pending agent action that exceeded your guardrail thresholds.

Example Request

curl -X POST https://api.honeyglaze.store/v1/agent/approve \
  -H "Authorization: Bearer hg_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "action_id": "act_pending_x92k",
    "decision": "approved",
    "note": "Proceed with the bulk price adjustment"
  }'

Response

{
  "action_id": "act_pending_x92k",
  "decision": "approved",
  "executed_at": "2026-06-21T12:05:00Z",
  "status": "completed"
}

SDKs

Official client libraries are available for the following languages:

Python

pip install honeyglaze

Node.js

npm install @honeyglaze/sdk

Ruby

gem install honeyglaze

go get github.com/honeyglaze/sdk-go

Need help with integration?

Our solutions team can walk you through the setup and help you get the agent running in your environment.

Talk to Us