canonical: https://jentic.com/apis/ekho.com/ekho

# Ekho API

The Ekho API runs vehicle commerce for dealers, covering inventory, carts, orders, and the vehicles on each order. An agent browses inventory and the vehicle catalog, builds carts from in-stock units or as build-to-order configurations, retrieves orders with their vehicles and per-vehicle action items, and tracks preorders and sales leads. It also manages dealer locations and lets you register event destinations and replay delivered webhook events.

## For AI agents

Run dealer vehicle commerce: browse inventory and the catalog, build in-stock or build-to-order carts, retrieve orders with their vehicles and action items, track preorders and leads, and manage locations and webhook event destinations.

## Scope

Does not handle payment capture, financing, or dealer accounting. Use for vehicle inventory, carts, and order management only.

## Capabilities

- Browse dealer inventory and retrieve individual inventory units
- Build carts from in-stock inventory or as build-to-order configurations
- Retrieve orders with their vehicles and per-vehicle action items
- Track preorders and cancel a preorder
- List sales leads and add or remove dealer locations
- Register event destinations and replay delivered webhook events

## Use cases

### Agent-assisted vehicle ordering

A buying agent browses dealer inventory through Ekho, builds a cart from an in-stock unit or starts a build-to-order configuration, and then tracks the resulting order and its vehicles. Each operation is discovered through Jentic by intent, so the agent moves from inventory to cart to order without reading the reference docs.

Example prompt: Find an in-stock vehicle in inventory, create a cart from it, then retrieve the resulting order and its vehicles

### Inventory and catalog browsing

An agent surfaces available vehicles by listing dealer inventory and drilling into a specific inventory unit or a catalog vehicle by its manufacturer, model, variant, and style. This lets a shopping assistant answer availability and specification questions against live dealer data.

Example prompt: List current inventory, then retrieve a specific inventory unit and its matching catalog vehicle details

### Order and action-item tracking

Keep an order moving by reading its vehicles and the action items attached to each one, then completing action items as they are resolved. An agent can monitor outstanding steps on an ordered vehicle and mark them done so the order progresses.

Example prompt: Retrieve an order's vehicles, list the action items on one vehicle, and complete an action item that is ready

### Webhook delivery and replay

Keep downstream systems in sync by registering event destinations, listing events, and replaying any event that failed to deliver. An agent can also rotate a destination's signing secret so webhook verification stays current.

Example prompt: Register an event destination, then list its events and replay one that failed to deliver

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/inventory` | List dealer inventory |
| GET | `/inventory/{item}` | Retrieve an inventory unit |
| GET | `/orders/{order}` | Retrieve an order |
| GET | `/orders/{order}/vehicles` | List an order's vehicles |
| POST | `/carts/inventory` | Create a cart from inventory |
| POST | `/carts/build-to-order` | Create a build-to-order cart |
| GET | `/preorders` | List preorders |
| GET | `/events` | List events |

## Key resources

- **Inventory** — List and retrieve dealer inventory units
- **Carts** — Create carts from inventory or as build-to-order configurations
- **Orders** — Retrieve orders, their vehicles, and per-vehicle action items
- **Preorders** — List, retrieve, and cancel preorders
- **Locations** — List, create or update, and remove dealer locations
- **Event destinations** — Register destinations, rotate signing secrets, and replay events

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 70 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 75 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 88 / 100
- **View full report:** https://jentic.com/apis/ekho.com/ekho/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Ekho API by hand means handling its scoped bearer token (shaped ekho_{env}_{hex}), choosing the production or staging host, and sequencing inventory, cart, and order calls yourself. Through Jentic you install once, import the Ekho API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Ekho puts the order id in the URL path (`/orders/{order}`), so a rule can pin your agent to one order and the operations you pick. You choose the operations it may call, so write actions like removing a location or deleting an event destination are not included unless you add them.
- **Credential handling:** Your Ekho token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list dealer inventory' or 'create a build-to-order cart', and Jentic returns the matching Ekho operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — General storefront, cart, and order management
- **Salesforce** — CRM for leads, accounts, and sales pipeline
- **Apollo** — Prospect and contact data for outreach

## FAQ

### What authentication does the Ekho API use?

The Ekho API authenticates with a scoped bearer token shaped ekho_{env}_{hex} per its OpenAPI spec. Through Jentic the token is stored encrypted by your own Jentic One instance and injected at execution time, so it never enters the agent's context.

### Can I browse dealer inventory with the Ekho API?

Yes. The inventory operations list available units and retrieve a single inventory unit, and the catalog operation returns a specific vehicle by its manufacturer, model, variant, and style for specification details.

### What are the rate limits for the Ekho API?

The OpenAPI spec does not state request rate limits. Check the Ekho documentation at https://api.ekho.com for current limits and any per-endpoint quotas.

### Is there an Ekho MCP server?

You don't need an MCP server to give your agent the Ekho API. Jentic connects it directly from the API Directory: import it, store your token once, and your agent calls the inventory, cart, and order operations it needs.

### Can I limit what my agent is allowed to do with the Ekho API?

Yes. Because Ekho carries the order id in the URL path, you can pin a rule to one order and allow only read operations, so the agent can track that order's vehicles and action items but cannot create carts, remove locations, or delete event destinations unless you add those operations. Every call the agent makes is logged.

### How do I create a cart through Jentic?

Search Jentic for 'create a build-to-order cart', and it returns the matching Ekho cart operation with its input schema; your agent supplies the configuration and calls it. To run it on your own infrastructure, install Jentic One from its GitHub repo.
