---
title: "Check portrait readiness"
method: GET
path: "/api/portrait/status"
tags: ["portrait"]
---

# Check portrait readiness

`GET /api/portrait/status`

## Request

- Base URL: `https://leafle.org` (the document declares no server; this is the origin it was published from)
- URL: `https://leafle.org/api/portrait/status`
- Auth: HTTP bearer

**Access: read token.**

A lightweight readiness check. Compare the opaque `version` value with your last value to detect a changed portrait; do not parse it.

## Query parameters

- `reader_id` integer, nullable

## Response `200`

Successful Response

- PortraitStatus: Readiness and an opaque portrait version. Compare it; do not parse it.
  - `ready` boolean, required
  - `version` string, nullable, required

## Other responses

- `401`: Missing or unusable credential.
- `403`: Insufficient token scope or the reader is outside your account.
- `422`: Validation Error

---

[API](https://skmtc.dev/leafle/apis/leafle-api.md) · [All operations](https://skmtc.dev/leafle/apis/leafle-api/llms.txt) · [OpenAPI document](https://skmtc.dev/leafle/apis/leafle-api/revisions/f2e56cb74495?raw)