# Iminify API

**Canonical:** https://apis.io/apis/iminify-com/iminify-com-api/  
**Provider:** Iminify — https://apis.io/providers/iminify-com/  
**Documentation:** https://www.iminify.com/docs

Iminify API is one of 2 APIs that [Iminify](https://apis.io/providers/iminify-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Iminify API as documented publicly: 61 operations. Contract generated from the documentation by API Evangelist (2026-11-12); not the provider's own document.

## Operations (60 of 61)

| Method | Path | Summary |
|---|---|---|
| GET | `/account` | Retrieve account limits and usage |
| GET | `/api/v1` | GET /api/v1 |
| GET | `/api/v1/account` | GET /api/v1/account |
| GET | `/api/v1/crawls` | GET /api/v1/crawls |
| POST | `/api/v1/crawls` | POST /api/v1/crawls |
| DELETE | `/api/v1/crawls/{id}` | Delete a site crawl |
| GET | `/api/v1/crawls/{id}` | Get a site crawl |
| GET | `/api/v1/crawls/{id}/download` | Download a site crawl as a zip |
| GET | `/api/v1/groups` | List upload groups |
| POST | `/api/v1/groups` | POST /api/v1/groups |
| DELETE | `/api/v1/groups/{id}` | Delete an upload group |
| GET | `/api/v1/groups/{id}` | Get an upload group |
| GET | `/api/v1/groups/{id}/download` | Download an upload group as a zip |
| POST | `/api/v1/groups/{id}/source` | Send a group's source |
| GET | `/api/v1/images` | GET /api/v1/images |
| POST | `/api/v1/images` | POST /api/v1/images |
| PATCH | `/api/v1/images/9d3c5b8e-6f0a-4c1e-9b7d-2a4e8f1c6b35` | PATCH /api/v1/images/9d3c5b8e-6f0a-4c1e-9b7d-2a4e8f1c6b35 |
| POST | `/api/v1/images/download` | POST /api/v1/images/download |
| POST | `/api/v1/images/rename` | POST /api/v1/images/rename |
| DELETE | `/api/v1/images/{id}` | Delete an image – an image stays on your account until you delete it. |
| GET | `/api/v1/images/{id}` | Get an image – one image, with its status. This is the call to poll while an image is compressing. |
| POST | `/api/v1/images/{id}/alt-text` | Write an image's alt text |
| POST | `/api/v1/images/{id}/cancel` | Cancel an image |
| GET | `/api/v1/images/{id}/download` | Download an image – the optimized copy, or with type=original the file exactly as it was uploaded. |
| POST | `/api/v1/images/{id}/recompress` | Compress an image again |
| GET | `/api/v1/images/{id}/responsive.zip` | Download every responsive size – every width of the image's responsive sizes in one zip. |
| GET | `/api/v1/images/{id}/responsive/{width}` | Download one responsive size – one width of the image's responsive sizes. |
| POST | `/api/v1/images/{id}/retry` | Retry an image |
| DELETE | `/api/v1/images/{id}/share` | Stop sharing an image |
| POST | `/api/v1/images/{id}/share` | Share an image |
| GET | `/api/v1/monitors` | GET /api/v1/monitors |
| POST | `/api/v1/monitors` | POST /api/v1/monitors |
| DELETE | `/api/v1/monitors/{id}` | Stop a weekly site check |
| GET | `/api/v1/monitors/{id}` | Get a weekly site check |
| PATCH | `/api/v1/monitors/{id}` | Update a weekly site check |
| GET | `/api/v1/scans` | GET /api/v1/scans |
| POST | `/api/v1/scans` | POST /api/v1/scans |
| DELETE | `/api/v1/scans/{id}` | DELETE /api/v1/scans/{id} deletes a scan |
| GET | `/api/v1/scans/{id}` | GET /api/v1/scans/{id} returns one scan with every image it found, newest first, and its page audit |
| POST | `/api/v1/scans/{id}/cancel` | POST /api/v1/scans/{id}/cancel calls off a scan still waiting in the queue |
| GET | `/api/v1/scans/{id}/download` | GET /api/v1/scans/{id}/download returns one zip with the optimized copy of every image of the scan that has finished |
| GET | `/api/v1/scans/{id}/report.csv` | Download a page report as CSV |
| GET | `/api/v1/scans/{id}/report.pdf` | Download a page report as PDF |
| POST | `/api/v1/scans/{id}/retry` | POST /api/v1/scans/{id}/retry queues a failed or cancelled scan again with the settings it had |
| DELETE | `/api/v1/scans/{id}/share` | Stop sharing a page report |
| POST | `/api/v1/scans/{id}/share` | POST /api/v1/scans/{id}/share gives the scan's page report a public page at an address nobody can guess, returned as share_url |
| POST | `/crawls` | Starting one |
| DELETE | `/crawls/{id}` | Reading what a check found |
| GET | `/crawls/{id}` | Reading what a check found |
| GET | `/crawls/{id}/download` | GET /crawls/{id}/download gives one zip with a folder for each page. |
| POST | `/groups` | Open an upload group |
| POST | `/images` | Upload an image for compression |
| DELETE | `/images/{id}` | Deleting images once saved – send DELETE /images/{id} once it has written the result. |
| GET | `/images/{id}` | Poll GET /images/{id} until the status is no longer queued or optimizing. |
| POST | `/images/{id}/alt-text` | Later: an image sent without one, whose alt text failed, or that was skipped can get one with POST /images/{id}/alt-text. |
| POST | `/pricing` | POST /pricing |
| GET | `/scans/{id}` | Get status of a page scan |
| GET | `/scans/{id}/report.csv` | GET /scans/{id}/report.csv has one row per image address with the fields audit.images has, findings separated by spaces, the bytes of the file the scan downl... |
| GET | `/scans/{id}/report.pdf` | GET /scans/{id}/report.pdf prints the report for a client: the findings with their fixes, the page's largest paint and formats, then every image to fix |
| DELETE | `/scans/{id}/share` | DELETE /scans/{id}/share switches off the public link for the scan report |

…and 1 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/iminify-com/openapi/_ae-authored/iminify-com-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/iminify-com/json-schema/iminify-com-patch-api-v1-images9-d3-c5-b8-e6-f0-a4-c1-e9-b7-d2-a4-e8-f1-c6-b35-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/iminify-com/json-schema/iminify-com-get-api-v1-monitors-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/iminify-com/json-schema/iminify-com-post-api-v1-images-id-recompress-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/iminify-com/json-schema/iminify-com-post-api-v1-groups-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/iminify-com/json-schema/iminify-com-post-crawls-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/iminify-com/json-schema/iminify-com-post-crawls-request-schema.json

## Other Iminify APIs (1)

- [Iminify API](https://apis.io/apis/iminify-com/iminify-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/iminify-com/iminify-com-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/iminify-com/.