API Reference Overview
Complete reference for Price Hero API v3, the current recommended version.
Use the version dropdown above API Reference in the sidebar to switch between v3 (this section), v2, and v1. The links under API Reference update to match. v3 is the default for new integrations; v1 and v2 are documented as legacy.
The Price Hero API is organized around REST. It accepts JSON request bodies, returns JSON responses, and uses standard HTTP status codes.
Base URL: https://api.pricehero.ai
Endpoints
| Method | Path | Description |
|---|---|---|
POST | /v3/catalog/query | Search catalog by text query |
GET | /v3/catalog/items/:id | Retrieve a specific catalog item |
POST | /v3/vision/identify | Identify an item from photos |
POST | /v3/vision/feedback | Report the product the user chose |
See the pages in this section for full request and response details:
Try the API
The interactive API Explorer (try requests against the live API with your keys) is in the developer portal. You need to be signed in as a developer. Every v3 endpoint is there with a ready-to-send body: catalog search opens as an A to Z listing so you can try sort, vision identify opens on the model step (put in your own photo URL), and after an identify call one click opens Vision feedback with its prediction_id filled in.
Versioning
| Version | Status | Notes |
|---|---|---|
v3 | Current | Full feature set, recommended; this documentation set |
v2 | Legacy | POST /api/v2/products (transitional); see v2 docs |
v1 | Legacy | GET /api/v1/products (limited access); see v1 docs |
All new integrations should use v3.
Deprecation policy
A request shape marked deprecated keeps working for the life of v3. When one is used, the response carries Deprecation: true and X-PriceHero-Deprecated: <field> headers and a warnings line naming the replacement. If a deprecated shape is ever to stop working within v3, the response will first carry a Sunset header with the date, announced at least 90 days ahead (in practice we give much more time); until a Sunset header appears, no date is set. Alternate spellings the API reads as a courtesy (a singular filter, for example) are not deprecations: they are noted in X-PriceHero-Alias-Used and warnings and carry no promise either way; use the documented spelling.