# ImageGrid

> ImageGrid is a hosted image-processing API for uploads, asynchronous jobs, resize, optimization, tile generation, artifact metadata, and signed downloads.

Use the web UI for account signup, email verification, plan activation, billing, and API key management. Services, CLIs, and LLM agents should use customer-provided API keys against the API host. This file does not grant any special access.

## Docs

- [Getting Started](https://imagegrid.dev/docs/getting-started.md): Activate an account, create a key, and send the first upload/job request.
- [WordPress Grid Integration](https://imagegrid.dev/docs/wordpress-grid-integration.md): Connect a WordPress grid workflow to ImageGrid for hosted rendering and optional CDN tile delivery.
- [Authentication](https://imagegrid.dev/docs/authentication.md): Understand API keys, session auth, and what `api_runtime` and `api_admin` actually do.
- [API Reference](https://imagegrid.dev/docs/api-reference.md): Look up each supported public endpoint with auth, payload, status, and response details.
- [Operations](https://imagegrid.dev/docs/operations.md): Reference the supported resize, optimize, tile, grid_render, and tile_patch option schemas.
- [Errors](https://imagegrid.dev/docs/errors.md): Understand validation failures, retry semantics, signed-download errors, and async job failure fields.
- [Uploads and Jobs](https://imagegrid.dev/docs/uploads-and-jobs.md): Upload images, create async jobs, and structure resize, optimize, tile, grid_render, or tile_patch requests.
- [Integration Checklist](https://imagegrid.dev/docs/integration-checklist.md): Move a client toward production with host, auth, retry, polling, artifact, and logging guidance.
- [Animated Image Support](https://imagegrid.dev/docs/animated-image-support.md): Check current still-image behavior and the planned path for preserving animation.
- [Artifacts and Downloads](https://imagegrid.dev/docs/artifacts-and-downloads.md): Poll jobs, read artifact metadata, and use signed download URLs correctly.
- [Accounts and Plans](https://imagegrid.dev/docs/workspaces-and-plans.md): Understand paid access, billing state, processing credits, add-ons, and technical limits.
- [Large Workloads](https://imagegrid.dev/docs/large-workloads.md): Decide when a workload can stay self-serve and when to request capacity review before launch.
- [FAQ](https://imagegrid.dev/docs/launch-faq.md): Check current scope, support expectations, product limits, and the fastest docs-to-contact path.
- [Roadmap](https://imagegrid.dev/docs/roadmap.md): See what is available now and what is planned next.

## Optional

- [Docs home](https://imagegrid.dev/docs): Human-readable docs index.
- [Docs home markdown](https://imagegrid.dev/docs/index.html.md): Markdown index of the public docs set.
- [OpenAPI JSON](https://imagegrid.dev/docs/openapi.json): Generated public API spec for customer-facing endpoints.