API

Use the Agent SP-API with named, revocable API keys.

Contract update (March 4, 2026): legacy bare-array responses were removed in favor of data, links, and meta envelopes.

Quickstart

Discover links with GET /api/v1

curl -sS https://www.agentspapi.com/api/v1 \
  -H "Authorization: Bearer {{API_KEY}}"

Base URL

https://www.agentspapi.com

Public endpoints are versioned under /api/v1. Backward-incompatible changes are released under a new major path (for example, /api/v2).

Endpoint Inventory

Method Path Auth Description Status Codes
GET /api/v1 Bearer API key API entrypoint with discoverable links. 200, 401, 429
GET /api/v1/me Bearer API key Verify API key and return caller context plus navigation links. 200, 401, 429
GET /api/v1/tables Bearer API key List queryable tables/views with per-table query links. 200, 401, 409, 429
GET /api/v1/query/:table_name Bearer API key Query a table or view with SQL-REST style filters and pagination. 200, 400, 401, 404, 409, 429
GET /api/spapi/sales/v1/orderMetrics Bearer API key Proxy SP-API Sales orderMetrics with caching. Accepts marketplace_ids, start_date, end_date, granularity, and optional filters. 200, 400, 401, 429
GET /api/spapi/fba/inventory/v1/summaries Bearer API key Proxy SP-API FBA Inventory summaries with caching. Accepts seller_skus, details, granularity_type, and optional filters. 200, 400, 401, 429
GET /api/v1/docs None (public) Machine-readable API documentation for LLM/AI agents. Returns JSON. 200

Quickstart

  1. In the app, open API Keys from the user menu (/developer/api_keys).
  2. Create a named key (example: Production Agent).
  3. Copy the plaintext key once and store it in a secret manager.
  4. Call /api/v1 and use links to discover next actions.
  5. Follow links.tables to discover relation resources and per-table query URLs.
  6. Call /api/v1/query/:table_name with filters like ?data_start_time=gt.2026-01-01.

Query Examples

curl -sS "https://www.agentspapi.com/api/v1" \
  -H "Authorization: Bearer {{API_KEY}}"
curl -sS "https://www.agentspapi.com/api/v1/query/sales_traffic_sku_month_summaries?data_start_time=gt.2026-01-01&order=data_start_time.desc&limit=100" \
  -H "Authorization: Bearer {{API_KEY}}"
curl -sS "https://www.agentspapi.com/api/v1/query/settlements?select=settlement_id,total_amount_cents&total_amount_cents=gt.0" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Prefer: count=exact"

Envelope Shape

{
  "data": {},
  "links": {
    "self": { "href": "https://www.agentspapi.com/api/v1/me", "method": "GET" }
  },
  "meta": {
    "request_id": "2d172d8f-4c9a-4d7d-a6b3-65ff746f41be",
    "contract_version": "2026-03-04"
  }
}

OpenAPI

Next