Create Metadata Import
Create a bulk metadata import for a metadata collection: a saved definition that lists a data connector’s source files and imports each one’s source metadata as a collection file, with no media download or processing. Runs consume no credits. By default the first run starts immediately (start: false saves the definition only). The response’s latest_run is the triggered run; it is null when start is false or when another import’s run currently holds the one-active-run-per-collection slot (the definition is saved and can be run once that finishes), and it is returned with status failed when the run could not be enqueued (trigger a new run to retry). Runs page the connector with the account’s default active API key and fail with a clear error when the account has none.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the metadata collection
Body
Display name for the import
1 - 255Data connector to list files from. Supported types: google-drive, dropbox, zoom, gong, recall, grain, iconik.
Listing passes; empty (the default) means one unfiltered pass
20Mode used when a run does not specify one. append imports new files and retries previously-failed ones; refresh re-imports everything the filters match.
append, refresh On refresh runs, remove files this import previously brought in that the source no longer returns. Only files imported by this import are ever removed — manually-added files and other imports are untouched.
Upstream list requests per second. Defaults to a per-connector safe rate (e.g. gong 2, zoom 6, google-drive/dropbox 8) and is clamped to a per-connector ceiling (gong 3, iconik 12, zoom/grain/recall 10, google-drive/dropbox 20) sized to keep the whole account inside each provider's published rate budget.
1 <= x <= 50Trigger the first run immediately. false saves the definition only.
Stop each run after processing this many files from the listing. A capped run stops listing at the limit and never runs the delete-missing sweep — a truncated listing is incomplete by definition, so nothing is removed based on it.
1 <= x <= 1000000Copy connector poster images as default thumbnails for imported files, for sources that provide one (Grain and iconik today). Off by default: iconik posters need one rate-limited API lookup per file, which materially slows large imports.
Response
The created import, with latest_run reflecting the immediately-triggered first run when applicable
A saved bulk metadata import: which connector to list, how to filter it, and how runs behave. Definitions are immutable — delete and recreate to change one.
metadata_import Listing passes; an empty array means one unfiltered pass. Overlapping passes are deduplicated on import.
Mode used when a run does not specify one
append, refresh Default delete-missing behavior for refresh runs
Upstream list requests per second; null means the per-connector safe default. Clamped to a per-connector ceiling at run time.
Unix timestamp in milliseconds
Most recent run, or null when the import has never run
Per-run ceiling on files processed from the listing; null means unbounded
Whether runs copy connector poster images as default thumbnails for imported files (Grain and iconik today)