API Reference

Every route, generated from the application’s own OpenAPI document.

Generated from the application's own OpenAPI document, which a test in the app keeps honest: a route without documentation fails the build. There are 433 paths and 510 operations, in 10 groups.

The API listens on 127.0.0.1:9100 and needs a bearer token. Read yours with culling --print-api-token, or set CULLING_API_TOKEN before launching to choose one.

export CULLING_API_TOKEN=$(culling --print-api-token)
curl -H "Authorization: Bearer $CULLING_API_TOKEN" http://127.0.0.1:9100/api/status

Everything here is also available through the TypeScript SDK, which is usually shorter — see API & automation for the worked examples.

Develop 66
Every adjustment, masks, crop, looks and presets, copy and paste, snapshots and the undo history, the RAW decode and its steps, and the camera looks the app learns.
View 56
What is on screen: view mode, zoom, overlays and the exposure aid, panels, windows and workspaces, compare and survey, the slideshow, video and audio playback.
Analyze 46
What the app works out: the library and its duplicates, bursts, race numbers, HDR and panorama merges, the models behind them, and what you keep.
App 57
The app itself: settings, license, setup, about, the console, and running scripts.
Deliver 99
Send pictures on: upload connections and their queue, workflows, tether, denoise, newspaper deliveries, galleries and eventphotos.
Files 53
Open folders, import, export and convert, move, rename and trash pictures, and the jobs that run them.
Mark 12
One picture's stars, flag, colour label, mask, tag and rotation, or the same on many at once.
Metadata 57
IPTC and its templates, keywords, people, places and GPS, capture time, captions, race numbers on a picture, and what Lightroom wrote.
Navigate 17
Move to another picture — by step, by index or by name — through bursts, virtual copies and the compare anchor, or press a key the app answers itself.
Select & Filter 47
Choose pictures by hand or by criteria, filter and sort the list, and keep albums and saved searches in the library.