CLcloudglue
Bulk Imports

Run a bulk import

Changed on

Trigger a new run of a saved import. mode and delete_missing default to the definition's saved values. Only one run may be active per collection at a time, so triggering while any run in the collection is active returns a 409. Rerunning is also how a media import resumes after it stopped on exhausted credits or a usage limit: an append run skips files it already imported and retries the rest.

post/collections/{collection_id}/imports/{import_id}/runs

Request

  • Base URL
    https://api.cloudglue.dev/v1
  • Auth
    HTTP bearer

Path parameters

collection_idstring uuid required

The ID of the metadata collection

import_idstring uuid required

The ID of the metadata import

Request body

mode'append' | 'refresh'
delete_missingboolean
max_filesinteger

Override the definition's max_files for this run

include_thumbnailsboolean

Override the definition's include_thumbnails for this run. Metadata imports only — setting it on a media import is a 400.

enrich_metadataboolean

Override the definition default for this run.

Response

The created run

object'metadata_import_run'
idstring uuid
import_idstring uuid
import_type'metadata' | 'media'

What this run ingests, inherited from the import definition: metadata indexes source metadata only (free); media ingests and processes the actual files (billed per file).

mode'append' | 'refresh'

append imports new files and retries previously-failed ones; refresh re-imports everything the filters match. For media imports, refresh re-syncs the source metadata of files it already imported — media bytes are never re-downloaded.

delete_missingboolean

Whether this run sweeps files this import previously brought in that the source no longer returns (refresh runs only)

status'pending' | 'processing' | 'completed' | 'failed' | 'cancelled'
errorstring nullable

User-facing failure reason when status is failed

started_atnumber nullable

Unix timestamp in milliseconds

completed_atnumber nullable

Unix timestamp in milliseconds

created_atnumber

Unix timestamp in milliseconds

max_filesinteger nullable

The cap this run executed with; null means unbounded

include_thumbnailsboolean

Whether this run copied poster thumbnails

enrich_metadataboolean

Whether this run backfills omitted source-metadata fields (see the import-level property).

Changes

  • 23d3f240819fRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • e401e330a58fRevision changes
    • info

      api tag Bulk Imports added

    • info

      api tag Metadata Imports removed

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status