canonical: https://jentic.com/apis/cruisecontrol.ai/cruisecontrol

# Cruise Control API

Jentic publishes the only available OpenAPI specification for Cruise Control API, keeping it validated and agent-ready. Cruise Control automates customer review collection by sending feedback requests via SMS or email after e-commerce or invoicing events. The API exposes 25 endpoints covering contact management, trigger broadcasts, message and call records, event-type catalogs, and rule presets that decide which customers receive review prompts. Authentication uses bearer tokens issued by the `/auth/login` endpoint.

## For AI agents

Manage customer contacts, trigger review-request broadcasts, and configure event-driven messaging rules for the Cruise Control review collection platform.

## Scope

Does not handle product reviews display, sentiment analysis, or social media publishing - use for outbound review-request messaging only.

## Capabilities

- Authenticate against Cruise Control with email and password to obtain a bearer token
- Add and search customer contacts by email or phone number
- Execute trigger broadcasts that send review requests over SMS or email
- Inspect call and message logs by phone number or UUID
- Define event-type field catalogs and alias mappings for incoming platform events
- Author, dry-run, and AI-generate rule presets that gate which customers get contacted

## Use cases

### Automated Post-Purchase Review Requests

Send review-request SMS or email automatically when an e-commerce order ships by firing trigger broadcasts against contacts created via the /contacts endpoint. Cruise Control routes the message and tracks delivery in the calls and messages logs.

Example prompt: Create a contact for customer jane@example.com with phone +14155550101, then call POST /trigger-execution with the order_completed trigger and verify a message appears in GET /messages.

### Rule-Based Review Targeting

Use rule presets to filter which customers receive review prompts based on event payload values such as order total, region, or product category. Rules can be authored manually or generated from natural-language instructions via the AI rule generator.

Example prompt: Call POST `/event-types/order_completed/rules/generate` with the instruction 'only request reviews for orders over $50 from US customers' and dry-run it against a sample payload.

### Event Catalog Mapping

Standardise incoming event payloads from multiple e-commerce or invoicing platforms by defining field aliases that map vendor-specific keys (e.g. customer_email, buyer_phone) to the Cruise Control catalog so rules and triggers work consistently across sources.

Example prompt: POST a field alias to `/event-types/order_completed/catalog/aliases` mapping 'buyer_email' to the canonical 'email' field, then GET the catalog to confirm.

### Agent-Driven Review Operations

Allow an AI agent to manage the entire review-collection lifecycle through Jentic: add contacts, fire trigger broadcasts, inspect logs, and adjust rules without the developer hard-coding the Cruise Control endpoint paths or storing the bearer token in agent memory.

Example prompt: Search Jentic for 'send a customer review request', load the trigger-execution operation schema, and execute it with the customer's phone number and order ID.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/auth/login` | Obtain a bearer access token |
| POST | `/contacts` | Add customer contacts |
| GET | `/contacts/search` | Search contacts by email or phone |
| POST | `/trigger-execution` | Execute a trigger broadcast |
| GET | `/messages` | List sent messages |
| POST | `/event-types/{eventType}/rules` | Create or update a rule preset |
| POST | `/event-types/{eventType}/rules/generate` | Generate a rule from natural language |

## Key resources

- **Authentication** — Login, logout, and current-user lookup endpoints that issue and revoke bearer tokens.
- **Contacts** — Add, list, and search customer contact records by email or phone.
- **Broadcasts** — Execute triggers and list available trigger definitions.
- **Calls** — Retrieve, list, and delete voice call records by phone number or UUID.
- **Messages** — List sent SMS and email message records.
- **Event Types** — Manage event-type catalogs, sample payloads, and field aliases.
- **Rules** — Create, dry-run, AI-generate, and list rule presets that govern when triggers fire.

## Why Jentic

- **Setup:** Wiring Cruise Control by hand means running its `/auth/login` exchange for a bearer token and posting contact, trigger-execution, and event-rule payloads yourself. Through Jentic you install once, import Cruise Control from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Cruise Control puts the event type in the URL path (`/event-types/{eventType}/rules`), so a rule can pin your agent to one event type for rule creation. You choose the operations it may call, so trigger-execution or contact writes are not included unless you add them.
- **Credential handling:** Your Cruise Control bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time, including the login exchange. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a customer review request' or 'add a contact', and Jentic returns the matching Cruise Control operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Crunchbase API** — Enrich customer contact records with company firmographics before targeting review requests.
- **Crustdata API** — Pull company and people data to enrich Cruise Control contacts.
- **Crush The Memory API** — Another niche customer-engagement API in the same vendor neighbourhood.

## FAQ

### Why is there no official OpenAPI spec for Cruise Control API?

Cruise Control does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cruise Control API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Cruise Control API use?

The API uses HTTP bearer token authentication. Tokens are issued by POST `/auth/login` in exchange for email and password credentials and revoked via GET `/auth/logout.` Through Jentic, the bearer token is stored encrypted in the vault and never enters the agent's prompt context.

### Can I trigger SMS review requests with the Cruise Control API?

Yes. POST /trigger-execution fires a configured trigger broadcast that delivers the review request via SMS or email depending on the contact's channel preference. Use GET /triggers first to list which triggers are available in your account.

### How do I generate a targeting rule with AI through the Cruise Control API?

Call POST `/event-types/{eventType}/rules/generate` with a natural-language instruction (for example, 'only request reviews from US customers spending over $50'). The endpoint returns a structured rule that you can dry-run via `/rules/dry-run` before saving.

### What are the rate limits for the Cruise Control API?

The OpenAPI specification does not document numeric rate limits. Inspect the response headers on live calls for any X-RateLimit values, and contact Cruise Control support for production quotas before bulk-sending review requests.

### How do I send a review request through Jentic?

Install the SDK with pip install jentic, then search for 'send a customer review request', load the returned trigger-execution operation, and execute it with your contact identifier and trigger name. Jentic handles auth and schema lookup so the agent only supplies business inputs.

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

Yes. Because you run Jentic One yourself, your own rules decide which Cruise Control operations and which stored bearer token the agent may use. Since Cruise Control puts the event type in the URL path, such as `/event-types/{eventType}/rules`, you can pin the agent to rule creation for a single event type while leaving write operations like POST /trigger-execution or POST /contacts out unless you explicitly add them. The agent can only call the operations you have granted, so it cannot fire review broadcasts or edit contacts that you have not allowed.