FLOGVIT
.photosuite
Rejoindre la bêta

Navigate — Référence de l’API

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.

La référence de l’API est en anglais : elle est générée à partir du document OpenAPI de l’application.

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.

17 operations. Generated from the application's own OpenAPI document.

POST /api/burst/collapse-all

Collapse all burst groups

Body

FieldTypeRequiredDescription
collapsedbooleanExplicit state; toggles when omitted
curl -X POST http://127.0.0.1:9100/api/burst/collapse-all \
  -H "Authorization: Bearer $CULLING_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"collapsed":true}'

Responses

  • 200 — Collapse/expand all burst groups (ToggleAll semantics when body omits collapsed)

GET /api/burst/groups

Burst groups

curl -X GET http://127.0.0.1:9100/api/burst/groups \
  -H "Authorization: Bearer $CULLING_API_TOKEN"

Responses

  • 200 — Burst detection state and group list

POST /api/burst/groups/{id}/collapse

Collapse burst group

ParameterInTypeDescription
idpathnumberBurst group id

Body

FieldTypeRequiredDescription
collapsedbooleanExplicit state; toggles when omitted
curl -X POST http://127.0.0.1:9100/api/burst/groups/<id>/collapse \
  -H "Authorization: Bearer $CULLING_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"collapsed":true}'

Responses

  • 200 — Collapse/expand one burst group (toggle when body omits collapsed)

POST /api/burst/next-to-do

Next burst to do

curl -X POST http://127.0.0.1:9100/api/burst/next-to-do \
  -H "Authorization: Bearer $CULLING_API_TOKEN"

Responses

  • 200 — At the first frame of the next burst still to do (#808)
  • 400 — No burst left to do

POST /api/burst/pick-margin

Show the pick's margin

Body

FieldTypeRequiredDescription
enabledbooleanyes
curl -X POST http://127.0.0.1:9100/api/burst/pick-margin \
  -H "Authorization: Bearer $CULLING_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

Responses

  • 200 — The burst's pick shown with how far ahead it is, or not

POST /api/burst/queue

Go through bursts one by one

Body

FieldTypeRequiredDescription
enabledbooleanyes
curl -X POST http://127.0.0.1:9100/api/burst/queue \
  -H "Authorization: Bearer $CULLING_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

Responses

  • 200 — The burst queue on or off

POST /api/burst/split

Split bursts by subject

Body

FieldTypeRequiredDescription
enabledbooleanyes
curl -X POST http://127.0.0.1:9100/api/burst/split \
  -H "Authorization: Bearer $CULLING_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

Responses

  • 200 — Bursts split where the number, camera or lens changes, or by time alone

POST /api/compare/anchor

Set Compare anchor

curl -X POST http://127.0.0.1:9100/api/compare/anchor \
  -H "Authorization: Bearer $CULLING_API_TOKEN"

Responses

  • 200 — Compare anchor set to current image

POST /api/compare/swap

Swap Compare pictures

curl -X POST http://127.0.0.1:9100/api/compare/swap \
  -H "Authorization: Bearer $CULLING_API_TOKEN"

Responses

  • 200 — Anchor and candidate swapped

GET /api/images

Pictures in the folder

curl -X GET http://127.0.0.1:9100/api/images \
  -H "Authorization: Bearer $CULLING_API_TOKEN"

Responses

  • 200 — List of visible images

GET /api/images/{id}

Picture

ParameterInTypeDescription
idpathnumberImage index
curl -X GET http://127.0.0.1:9100/api/images/<id> \
  -H "Authorization: Bearer $CULLING_API_TOKEN"

Responses

  • 200 — Image metadata
  • 404 — Image not found

GET /api/images/current

Picture on screen

curl -X GET http://127.0.0.1:9100/api/images/current \
  -H "Authorization: Bearer $CULLING_API_TOKEN"

Responses

  • 200 — Current image metadata
  • 404 — No images loaded

POST /api/keys/press

Press a key

Body

FieldTypeRequiredDescription
key"next" | "previous" | "down" | "up" | "first" | "last" | "enter" | "escape" | "swap_compare" | "next_survey_page" | "previous_survey_page" | "larger" | "smaller" | "split_horizontal" | "split_vertical" | "reset_zoom" | "before_after"yesThe key: next, previous, down, up, first, last, enter, escape, swap_compare, next_survey_page, previous_survey_page, larger, smaller, split_horizontal, split_vertical, reset_zoom, before_after
curl -X POST http://127.0.0.1:9100/api/keys/press \
  -H "Authorization: Bearer $CULLING_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key":"next"}'

Responses

  • 200 — Did what the key does in the view on screen: → the next picture (the next cell in Survey), Enter opens Develop from Grid, sets Compare's anchor, applies a crop
  • 400 — The key does nothing in this view

POST /api/navigate

Go to picture

Body

FieldTypeRequiredDescription
targetanyyes
curl -X POST http://127.0.0.1:9100/api/navigate \
  -H "Authorization: Bearer $CULLING_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":null}'

Responses

  • 200 — Navigated to image
  • 400 — Invalid target

GET /api/status

Status

curl -X GET http://127.0.0.1:9100/api/status \
  -H "Authorization: Bearer $CULLING_API_TOKEN"

Responses

  • 200 — Application status

POST /api/virtual-copies/toggle-all-stacks

Collapse all virtual-copy stacks

curl -X POST http://127.0.0.1:9100/api/virtual-copies/toggle-all-stacks \
  -H "Authorization: Bearer $CULLING_API_TOKEN"

Responses

  • 200 — Collapse all virtual-copy stacks when any is expanded, else expand all

POST /api/virtual-copies/toggle-stack

Collapse virtual-copy stack

Body

FieldTypeRequiredDescription
indexnumberFlat image index; current image when omitted
curl -X POST http://127.0.0.1:9100/api/virtual-copies/toggle-stack \
  -H "Authorization: Bearer $CULLING_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"index":0}'

Responses

  • 200 — Collapse/expand a virtual-copy stack
esc
    ↑↓ naviguer↵ ouvrir