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

# Cloverly Carbon Offset API

Jentic publishes the only available OpenAPI specification for Cloverly Carbon Offset API, keeping it validated and agent-ready. The Cloverly API calculates the carbon impact of shipping, vehicle transport, direct carbon weight, and currency-based activities, then lets businesses purchase verified offsets to neutralise that impact in real time. It exposes parallel estimate and purchase endpoints for each activity type, plus account, listing, retrieval, and cancellation endpoints. Authentication uses an API key passed as a Bearer token, and offsets are sourced from a portfolio of verified carbon credit projects.

## For AI agents

Estimate and purchase carbon offsets for shipping, vehicle transport, raw carbon weight, or currency-based emissions, sourced from verified carbon credit projects.

## Scope

Does not handle emission factor calculation across arbitrary activities, sustainability reporting frameworks, or supply-chain audit - use for estimating and purchasing verified carbon offsets only.

## Capabilities

- Estimate the carbon offset cost for a shipping leg given origin, destination, and weight
- Estimate offsets for vehicle transport based on distance and vehicle type
- Estimate offsets for a known carbon weight in kilograms or pounds
- Estimate currency-based offsets that translate spend into a carbon equivalent
- Convert any existing estimate into a purchase to retire the corresponding credits
- List, retrieve, and cancel previous estimates and purchases tied to the account

## Use cases

### Carbon-Neutral E-Commerce Checkout

E-commerce platforms that want to offer customers a carbon-neutral checkout option call POST `/estimates/shipping` during cart calculation with the parcel weight, origin, and destination, then call POST `/purchases/shipping` when the customer accepts the offset add-on. Cloverly returns the estimated cost in cents and the corresponding verified offset, and the purchase response includes a receipt that can be shown on the order confirmation page. End-to-end this typically adds well under a second to checkout.

Example prompt: Call POST `/estimates/shipping` for a 2.5 kg parcel from 30309 to SW1A 1AA, then convert it to a purchase via POST `/purchases/shipping` when the customer adds offset to their order

### Fleet and Logistics Emissions Reporting

Logistics teams measuring scope 3 emissions across vehicle journeys use POST `/estimates/vehicle` to translate distance and vehicle type into carbon weight and an offset price. The same flow with POST `/purchases/vehicle` then retires offsets matching the reported emissions, and GET /purchases produces a record suitable for sustainability reporting. Estimates are deterministic for the same inputs, so the same trip recorded twice produces the same emission figure.

Example prompt: Estimate vehicle offsets for 350 miles in a midsize diesel van via POST `/estimates/vehicle`, then purchase the offset and store the slug against the trip record

### Currency-Based Sustainability Programmes

Companies running 'we offset $X of every transaction' or annual sustainability programmes use POST `/estimates/currency` to convert a monetary amount into the equivalent carbon offset, and POST `/purchases/currency` to retire the credits. This is useful when emissions cannot be measured directly per transaction but the business wants to commit a known dollar amount each month or quarter. Estimates and purchases are listed via GET /estimates and GET /purchases for finance reconciliation.

Example prompt: Run POST `/estimates/currency` for $5,000 USD then convert it into a purchase via POST `/purchases/currency` once finance approves the monthly offset budget

### AI Agent Buying Offsets via Jentic

AI agents working on order fulfilment, expense reporting, or sustainability automation can call Cloverly through Jentic to attach an offset to any carbon-producing event. The agent expresses an intent like 'offset a shipment' or 'offset 50 kg of CO2', and Jentic loads the matching Cloverly operation, supplies the Bearer token from the vault, and returns the estimate or purchase response. The same flow handles cancellations and account checks without the agent reading Cloverly's documentation.

Example prompt: Through Jentic, search for 'estimate carbon offset for a shipment', load the cloverly.com `/estimates/shipping` operation, and execute it for the parcel details, then call `/purchases/shipping` with the returned slug

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/estimates/shipping` | Estimate shipping offset |
| POST | `/estimates/vehicle` | Estimate vehicle offset |
| POST | `/estimates/carbon` | Estimate offset for a known carbon weight |
| POST | `/estimates/currency` | Estimate currency-based offset |
| POST | `/purchases/shipping` | Purchase shipping offset |
| POST | `/purchases/carbon` | Purchase carbon weight offset |
| GET | `/purchases` | List all purchases |
| GET | `/account` | Get account information |

## Key resources

- **Account** — Account information and remaining credit balance
- **Estimates** — Pre-purchase quotes for shipping, vehicle, carbon weight, and currency offsets
- **Purchases** — Confirmed offset purchases retiring verified carbon credits

## Why Jentic

- **Setup:** Wiring Cloverly by hand means learning its bearer auth, targeting the dated api.cloverly.com/2019-03-beta host, and handling retries around estimate and purchase calls yourself. Through Jentic you install once, import the Cloverly Carbon Offset API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Cloverly carries no resource id in the URL path, so scope the agent to the operations it needs, such as estimating a shipping or carbon offset. You choose that set, so purchase operations like `/purchases/carbon` are not included unless you add them.
- **Credential handling:** Your Cloverly key is stored once, encrypted, by your own Jentic One instance and injected as a Bearer token at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'estimate a carbon offset' or 'purchase carbon credits', and Jentic returns the matching Cloverly operation with its input schema so the agent calls the right endpoint without reading Cloverly's documentation.

## Related APIs

- **Climatiq API** — Climatiq provides a large emission factor database for calculating carbon footprints across many activity types
- **Shopify API** — Shopify provides the storefront and order data that Cloverly offsets are calculated against at checkout
- **Stripe API** — Stripe handles the payment for the offset add-on at checkout while Cloverly retires the offset credits

## FAQ

### Why is there no official OpenAPI spec for Cloverly Carbon Offset API?

Cloverly does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cloverly Carbon Offset 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 Cloverly Carbon Offset API use?

The Cloverly API uses an HTTP bearer scheme: the API key is sent as a Bearer token in the Authorization header. Through Jentic the key is stored encrypted in the vault and applied at execution time, so the agent never sees the raw token.

### Can I estimate a shipping offset before charging the customer?

Yes. POST `/estimates/shipping` with the parcel weight, origin, and destination returns an estimate including price and the corresponding verified offset. The estimate is held under a slug, and you can convert it into a purchase via POST `/purchases/shipping` when the customer confirms.

### What carbon-producing activities can I offset with the Cloverly Carbon Offset API?

Four parallel flows are supported: shipping (`/estimates/shipping` and `/purchases/shipping`), vehicle transport (`/estimates/vehicle`, `/purchases/vehicle`), raw carbon weight (`/estimates/carbon`, `/purchases/carbon`), and currency-based (`/estimates/currency`, `/purchases/currency`).

### What are the rate limits for the Cloverly Carbon Offset API?

The OpenAPI specification does not declare explicit rate limit headers or a 429 response. Cloverly applies plan-based limits documented in its developer portal, and high-volume integrations should batch estimates per cart rather than per item. Through Jentic, retries and backoff are handled by the SDK.

### How do I purchase a carbon offset through the Cloverly API via Jentic?

Install the SDK with pip install jentic, search for 'purchase a carbon offset', load the cloverly.com `/purchases/shipping` (or `/purchases/vehicle`, `/purchases/carbon`, `/purchases/currency`) operation, and execute it with the slug from a prior estimate. Jentic supplies the Bearer token automatically and returns the purchase receipt.

### Can I cancel an estimate or a purchase?

Estimates and purchases each support DELETE `/estimates/{slug}` and DELETE `/purchases/{slug}` for cancellation. Cancellation rules and timing depend on whether the underlying credits have been retired, which is reflected in the response.

### Can I limit what my agent is allowed to do with the Cloverly Carbon Offset API?

Yes. Because you run Jentic One yourself, your own rules decide which Cloverly operations and credentials the agent may use. Cloverly carries no resource id in the URL path, so you scope the agent to the exact operations it needs, such as estimating a shipping or carbon offset, and leave the rest out. Purchase operations like POST `/purchases/carbon` and cancellations like DELETE `/purchases/{slug}` are excluded unless you explicitly add them.