Sign in
Sessions

Create a session

Changed on

Create a session as a child to the current session. This endpoint is used for casting.

post/sessions

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/sessions
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Request body

deviceOSstring

Device OS

deviceTypestring

Device type

durationinteger

Session duration in seconds

Response

appVersionstring nullable required

App version

createdAtstring required

Creation date

currentboolean required

Is current session

deviceOSstring required

Device OS

deviceTypestring required

Device type

expiresAtstring

Expiration date

idstring uuid required

Session ID

isPendingSyncResetboolean required

Is pending sync reset

tokenstring required

Session token

updatedAtstring required

Last update date

Changes

  • 2cd7bd44a940Revision changes
    • info

      the response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

  • 446a035db458Revision changes
    • breaking

      the request property type changed from number to integer

    • warning

      the request property's max was set to 9007199254740991.00