Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Clusterhack Dev Images API
version: 1.3.0
description: 'Operations tagged images across 2 of this provider''s published API definitions: clusterhack-dev-openapi-original.json, clusterhack-dev-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://clusterhack.dev
description: Production. Not stated in the provider spec (no servers[]); the spec is served from https://clusterhack.dev/api/schema/ and its paths are rooted at /api/v1 and /geo-api.
tags:
- name: Images
paths:
/api/v1/images/avif/:
post:
operationId: images_avif_create
description: 'POST /api/v1/images/avif/ — multipart {image, preset?} -> the AVIF pair.
The conversion the whole site runs on, exposed on its own so a caller can
use it without owning a model field: an MCP client holding a PNG with
nowhere to put it, or a form that wants to shrink a picture before sending
it somewhere else.
JSON with base64 rather than raw bytes, because the whole API and the MCP
bridge speak JSON and the payloads are capped by the preset. A binary
response would need its own renderer here and a special case in the bridge.
Authenticated and throttled: re-encoding is CPU, and an open endpoint that
burns CPU per request is a denial-of-service primitive.'
tags:
- Images
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/ImageToAvifRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ImageToAvifRequest'
required: true
security:
- jwtAuth: []
- tokenAuth: []
- cookieAuth: []
- basicAuth: []
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: {}
description: 'Keys: `avif` and `webp` (each `{base64, bytes, content_type}`), `width`, `height`, `original_bytes`.'
'400':
content:
application/json:
schema:
type: object
additionalProperties: {}
description: '`{image|preset}` — the file is not a picture, or the preset is unknown.'
'401':
description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
headers:
WWW-Authenticate:
description: Always `Bearer realm="api"`.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetail'
'403':
description: Authenticated, but not permitted to perform this action on this object.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetail'
'429':
description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
headers:
Retry-After:
description: Seconds until the caller may retry.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetail'
'500':
description: Unhandled server error.
summary: Images avif create
x-summary-source: derived
components:
schemas:
ImageToAvifRequest:
type: object
description: 'The body of POST /api/v1/images/avif/.
`ImageField` validates with Pillow, so a file that is not a picture is
refused here with a readable message rather than deep inside the encoder.'
properties:
image:
type: string
format: binary
preset:
allOf:
- $ref: '#/components/schemas/PresetEnum'
default: screenshot
required:
- image
ErrorDetail:
type: object
description: The body DRF returns for a handled error.
properties:
detail:
type: string
description: Human-readable explanation of the failure.
required:
- detail
PresetEnum:
enum:
- attachment
- avatar
- screenshot
type: string
description: '* `attachment` - attachment
* `avatar` - avatar
* `screenshot` - screenshot'
securitySchemes:
basicAuth:
type: http
scheme: basic
cookieAuth:
type: apiKey
in: cookie
name: sessionid
jwtAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Access token from `POST /api/v1/auth/jwt/`, refreshed at `POST /api/v1/auth/jwt/refresh/`. Send as `Authorization: Bearer <access>`.'
tokenAuth:
type: apiKey
in: header
name: Authorization
description: Token-based authentication with required prefix "Token"
x-refined-from:
- clusterhack-dev-openapi-original.json
- clusterhack-dev-openapi.yml