Sign in Try now

Docs / API reference

Import jobs

Create, inspect, list, and cancel VideoVector import jobs that bring cloud storage media into an index.

api/routes.pysdk/videovector/resources/import_jobs.pyapi/import_job_controllers.py

Summary

Import jobs bring cloud storage media into a target index. Use automations when the same connector path should feed recurring media intake.

Import job endpoints

Method	Path	Purpose
`POST`	`/api/v2/import-jobs`	Create an import job
`GET`	`/api/v2/import-jobs`	List import jobs
`GET`	`/api/v2/import-jobs/{job_id}`	Retrieve one import job
`POST`	`/api/v2/import-jobs/{job_id}/cancel`	Cancel a running job

Request fields

Field	Notes
`connector_id`	Source connector
`index_id`	Target index
`source_prefix`	Optional path prefix
`file_pattern`	Glob pattern such as `*.mp4`
`recursive`	Recurse into subdirectories

Example: create an import job

curl -X POST /api/v2/import-jobs \
  -H "X-API-Key: sk_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: import-job-archive-2026-04-20" \
  -d '{
    "connector_id": "conn_archive",
    "index_id": "idx_archive",
    "source_prefix": "incoming/2026/04/",
    "file_pattern": "*.mp4",
    "recursive": true
  }'

Lifecycle

The SDK type model exposes these public statuses:

pending
scanning
importing
completed
failed
cancelled

Use GET /api/v2/import-jobs/{job_id} to inspect job progress, imported media IDs, failed files, skipped files, and terminal error details.

SDK equivalents

client.import_jobs.create
client.import_jobs.retrieve
client.import_jobs.list
client.import_jobs.cancel

Note

For recurring ingestion from the same connector path, prefer import automations instead of repeatedly creating one-off import jobs.

Previous

Go to previous page

Next

Go to next page

Related documentation

Guides

Create import jobs and import automations

This guide covers one-time import jobs and persistent index-level import automations that watch a storage location and trigger processing with a prompt preset.

API reference

Connectors are the public storage integration boundary for import and export workflows. The API supports provider-specific creation, listing, retrieval, testing, browsing, update, and deletion.

API reference

Automations watch connector paths, trigger prompt presets, and deliver index exports for recurring VideoVector workflows.