Agent guide

Read endpoints need no key. All money is integer US cents. Express prices are fixed offers for the listed VIN while it is listed, before tax and fees, available only by requesting the car through Swiftly Cars (not at the dealership directly), with no negotiation; a person confirms availability.

1. Find vehicles

curl 'https://swiftlycars.com/api/v1/inventory?modelId=q8&sort=price-asc&limit=25'

modelId selects one exact source model (Q8, SQ8 and RS Q8 SUV performance are separate ids). The response’s facets.models lists every id with its name and count; facets.trim, ext, int, status and year list the accepted values for those filters. Also available: q (VIN, stock number or keyword), priceMin/priceMax (whole dollars on the express price) and sort (price-asc, price-desc, year-desc, model-az). status is the source listing’s own label, not confirmed availability. Legacy parameters still work: family groups related models (for example q8 = Q8 + SQ8 + RS Q8) and is ignored when modelId is set;model is a loose name match. Unknown values return 400 invalid_query. The Inventory page accepts the same filters and returns the same VINs in the same order.

Response items carry VIN, model, colors, source status, MSRP and the express price. snapshot.coverage says how complete the data is; check snapshot.freshness before telling a buyer a car is available.

2. Read one VIN

curl 'https://swiftlycars.com/api/v1/inventory/WAUGUDGY0TA150658'

pricePreview holds the arithmetic and the rule set version.

3. Describe a car that is not listed

curl -X POST 'https://swiftlycars.com/api/v1/sourcing/parse' \
  -H 'content-type: application/json' \
  -d '{"text":"White Q5, brown interior, Black Optic package; need it this week"}'

You get a structured spec, up to two follow-up questions and matches from our inventory. Ask your user the questions; do not guess answers.

4. Hand off to your user

When your user wants to go ahead, give them a link and let them finish on the site themselves. They give their own email and consent there, and a person from our team follows up. Do not submit a buyer's name, email, phone or trade-in details on their behalf.

POST /api/v1/sourcing-requests saves a request only for a signed-in customer with consent; agents cannot sign in for a buyer. Our chat endpoints are for the website itself and are not part of the agent API.

Limits

Machine-readable: openapi.json, llms.txt, sitemap.xml.