CreateTaskRequest

priorityinteger,null<int32>nullable

Priority level (higher = more urgent)

Example: 0

scheduled_forstring,null<date-time>nullable

When to run the task (defaults to now)

Example: 2024-01-15T12:00:00Z

task_type objectrequired

Type of task to create

oneOf

object

library_idstring<uuid>required

modestring

typestringrequired

Possible values: [scan_library]

object

book_idstring<uuid>required

forceboolean

typestringrequired

Possible values: [analyze_book]

object

series_idstring<uuid>required

typestringrequired

Possible values: [analyze_series]

object

library_idstring<uuid>required

typestringrequired

Possible values: [purge_deleted]

object

book_idstring<uuid>required

sourcestringrequired

typestringrequired

Possible values: [refresh_metadata]

object

forceboolean

library_idstring,null<uuid>nullable

series_idstring,null<uuid>nullable

typestringrequired

Possible values: [generate_thumbnails]

object

book_idstring<uuid>required

forceboolean

typestringrequired

Possible values: [generate_thumbnail]

object

typestringrequired

Possible values: [find_duplicates]

object

book_idstring<uuid>required

thumbnail_pathstring | nullnullable

Optional thumbnail path (if known at deletion time)

typestringrequired

Possible values: [cleanup_book_files]

object

series_idstring<uuid>required

typestringrequired

Possible values: [cleanup_series_files]

object

typestringrequired

Possible values: [cleanup_orphaned_files]

CreateTaskRequest

{
  "priority": 0,
  "scheduled_for": "2024-01-15T12:00:00Z",
  "task_type": {
    "library_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "mode": "string",
    "type": "scan_library"
  }
}