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

# CheetahO Image Optimization API

Jentic publishes the only available OpenAPI specification for CheetahO Image Optimization API, keeping it validated and agent-ready. CheetahO compresses and resizes JPEG, PNG, and GIF images using lossy or lossless algorithms, with WebP conversion and custom quality controls. The API exposes a single optimisation endpoint that accepts a source image and returns an optimised version, plus an account endpoint for plan and quota information. It is designed for teams that need to shrink images at the point of upload, in a build pipeline, or before delivering them through a CDN.

## For AI agents

Compress, resize, and convert images to WebP through one optimisation endpoint, with an account endpoint for quota lookup.

## Scope

Does not handle video transcoding, image hosting, or CDN delivery - use for compressing, resizing, and converting JPEG, PNG, and GIF images only.

## Capabilities

- Compress JPEG, PNG, and GIF images using lossy or lossless settings
- Resize an image to a target width or height as part of the same optimisation call
- Convert images to WebP for smaller payloads on supporting clients
- Set a custom quality level per image to trade size against fidelity
- Retrieve account data including plan and remaining optimisation quota

## Use cases

### Build-Pipeline Image Optimisation

Wire CheetahO into a static-site or front-end build so every image is compressed and optionally converted to WebP at deploy time. POST `/api/v2/media/optimization` accepts the source image plus optimisation parameters and returns the optimised result. The build step replaces a manual round of image squashing in a desktop tool and keeps page weight low without ongoing maintenance.

Example prompt: Optimise the file 'hero.png' with lossy=true and resize_width=1600, save the response, and report the size reduction in bytes.

### User-Generated Content Compression

Compress photos uploaded by end users (marketplaces, community sites, classifieds) before they hit object storage. The API accepts each upload, returns a smaller file, and the application persists only the optimised copy. WebP conversion is offered for clients that support it, with fallbacks served in the original format. Reduces storage and bandwidth costs without writing custom image-magick pipelines.

Example prompt: Send a user-uploaded JPEG to `/api/v2/media/optimization` with quality=82 and return the optimised binary.

### Quota Monitoring and Plan Sizing

GET `/api/v2/user` returns account data including plan and usage figures, so a team can monitor quota burn-down and decide whether to upgrade before hitting limits. A nightly cron calls the endpoint, writes results to a metrics store, and alerts when remaining quota falls below a threshold. Avoids surprise overages on busy launch days.

Example prompt: Call GET `/api/v2/user` once a day, store the remaining-credits figure, and trigger a Slack alert when it falls below 1000.

### AI Agent Asset Pipelines

Through Jentic, an AI agent can be asked to 'shrink these product images and convert them to WebP' as part of a larger e-commerce or content workflow. The agent searches for 'optimize an image', loads the CheetahO schema, and executes per file without ever holding the raw API key. Pair with a storage or CDN API to fetch sources and write outputs in the same agent run.

Example prompt: Search Jentic for 'optimize an image', load the CheetahO schema, and run the call against three product photos with lossless=true.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v2/media/optimization` | Optimise an image |
| GET | `/api/v2/user` | Get user account and quota data |

## Key resources

- **Optimization** — Run image compression, resizing, and WebP conversion against a source image
- **Account** — Read plan and usage data for the authenticated CheetahO account

## Why Jentic

- **Setup:** Wiring CheetahO by hand means handling its key header and posting image jobs, then polling account usage separately. Through Jentic you install once, import the CheetahO Image Optimization API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** CheetahO takes its image target in the request body rather than the URL path, so scope the agent to the operations it needs, such as submitting an optimization job and reading account usage. You choose that set, so the agent runs only the calls you allow.
- **Credential handling:** Your CheetahO API key is stored once, encrypted, by your own Jentic One instance and injected into the key header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'optimize an image' or 'get account usage', and Jentic returns the matching CheetahO operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Cloudinary Upload API** — Cloudinary is a full media platform with optimisation, transformation, and CDN delivery built in.
- **Filestack API** — Filestack handles file uploads and basic transformations, often paired with a dedicated optimiser.
- **Bunny.net API** — Bunny.net's CDN and storage deliver the optimised images CheetahO produces.

## FAQ

### Why is there no official OpenAPI spec for CheetahO Image Optimization API?

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

The API uses an API key passed in the 'key' header. Keys are issued from the API Credentials section of the CheetahO dashboard. Through Jentic, the key is stored encrypted in the credential vault and injected at execute time, so the agent never holds the raw value.

### Can I convert an image to WebP with the CheetahO API?

Yes. POST `/api/v2/media/optimization` accepts WebP conversion as part of its optimisation parameters alongside compression and resizing options. A single call can resize, compress, and convert in one round trip.

### What are the rate limits for the CheetahO Image Optimization API?

The OpenAPI spec does not declare numeric rate limits. CheetahO enforces per-plan monthly quotas; GET `/api/v2/user` returns the current usage and plan so callers can monitor burn-down rather than rely solely on 429 handling.

### How do I optimise an image and check my quota through Jentic?

Search Jentic for 'optimize an image', load the schema for POST `/api/v2/media/optimization`, and execute with the source file and parameters. Then search 'get user account', load GET `/api/v2/user`, and execute to confirm remaining credits - two operations from intent to actionable result.

### Which image formats are supported?

The API supports JPEG, PNG, and GIF inputs and can output the same formats or convert to WebP. Lossy and lossless modes are available, and a custom quality value lets callers tune the size-versus-fidelity trade-off per image.

### Can I limit what my agent is allowed to do with the CheetahO Image Optimization API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which CheetahO operations and credentials your agent may use. CheetahO exposes just two operations, submitting an optimization job with POST `/api/v2/media/optimization` and reading plan and quota data with GET `/api/v2/user`, so you can grant only the one the workflow needs. Since the image target travels in the request body rather than the URL path, you scope the agent at the operation level and it runs only the calls you allow.