CAcardinalapps
Jobs

🛡️ Create a new job.

Changed on

The job will automatically start running.<br /><hr /><h3>🛡️ Requires Capabilities: <code>Jobs.Create</code></h3>

post/api/v1/job

Request

Request body

type'album_art_thumbnails' | 'photo_variations' | 'photo_thumbnails' | 'generate_waveforms' required

Response

jobIdstring required
type'album_art_thumbnails' | 'photo_variations' | 'photo_thumbnails' | 'generate_waveforms' required
status'draft' | 'preparing' | 'in_queue' | 'running' | 'paused' | 'canceled' | 'completed' | 'errored' required
parametersobject
completedTasksnumber required
remainingTasksnumber required
totalTasksnumber required
completedAtstring date-time required
errorMessagestring required
idnumber required
createdAtstring date-time required
updatedAtstring date-time required
deletedAtstring date-time required

Changes

  • ae7d637d1803Revision changes
    • breaking

      removed the enum value generate_waveform of the request property

    • warning

      added the new generate_waveforms enum value to the response property for the response status

    • info

      added the new generate_waveforms enum value to the request property

    • info

      removed the generate_waveform enum value from the response property for the response status

  • 404b6308c09aRevision changes
    • warning

      added the new generate_waveform enum value to the response property for the response status

    • info

      added the new generate_waveform enum value to the request property