API reference

REST API for the PickTheRobot matcher. All endpoints require a valid API key from a Starter or Pro subscription.

Base URL: /api/v1 · Download OpenAPI JSON

Authentication

Send your API key on every request using X-API-Key or Authorization: Bearer <key>.

Missing or invalid keys return 401. Rate limits and monthly match quotas return 429 with Retry-After and usage headers.

Tier limits

Limit	Starter	Pro
Match calls / month	2,000	10,000
Requests / minute	30	60
Vendors per match	3	5

POST/api/v1/match

Run the matcher. Send a flat JSON body with category plus category-specific wizard fields (warehouse, cleaning, or restaurant).

Returns robot type fit, acquisition guidance, ranked vendors with tracked clickUrl values, and cleaning ROI on cleaning matches. Pro includes runner-up matches and extended vendor fields.

curl -X POST https://picktherobot.com/api/v1/match \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_KEY" \
  --data-binary "@match-cleaning.json"

GET/api/v1/vendors

Browse the vendor catalog. Requires category query param (warehouse, cleaning, or restaurant). Optional region (default US).

curl "https://picktherobot.com/api/v1/vendors?category=cleaning&region=US" \
  -H "X-API-Key: YOUR_KEY"

GET/api/v1/openapi.json

Machine-readable OpenAPI 3.1 spec. Import into Postman, Swagger UI, or your codegen tool. No API key required.

← Back to Developers