VectorMethods

Docs / API reference

Automations

Configure index-level import and export automations for recurring VideoVector media workflows.

api/routes.pyapi/automation_controllers.pyfrontend/src/services/api.ts

Search documentation

Search pages, API reference sections, and guide headings.

Summary

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

Import automation endpoints

MethodPathPurpose
GET/api/v2/indexes/{index_id}/automations/importRetrieve saved import automation
PUT/api/v2/indexes/{index_id}/automations/importCreate or replace import automation
POST/api/v2/indexes/{index_id}/automations/import/pausePause import automation
POST/api/v2/indexes/{index_id}/automations/import/resumeResume import automation

Export automation endpoints

MethodPathPurpose
GET/api/v2/indexes/{index_id}/automations/exportRetrieve saved export automation
PUT/api/v2/indexes/{index_id}/automations/exportCreate or replace export automation
POST/api/v2/indexes/{index_id}/automations/export/pausePause export automation
POST/api/v2/indexes/{index_id}/automations/export/resumeResume export automation

Import automation request

{
  "enabled": true,
  "paused": false,
  "connector_id": "conn_archive",
  "source_prefix": "incoming/daily/",
  "file_pattern": "*.mp4",
  "recursive": true,
  "debounce_interval": "10m",
  "prompt_preset": {
    "prompt_id": "prompt_episode_extract"
  }
}

Supported public debounce intervals are:

  • 5m
  • 10m
  • 1h
  • 1d

Export automation request

{
  "enabled": true,
  "paused": false,
  "destination_connector_id": "conn_export",
  "destination_subpath": "exports/review-team"
}

Operational behavior

  • enabled controls whether the automation is configured for execution.
  • paused is the public temporary stop control.
  • Pause and resume preserve the configuration.

Related documentation

VideoVector exposes a public workflow layer for storage integration and downstream delivery. This page explains connectors, jobs, automations, exports, and event delivery as one model.

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.

Use exports to package result data for download or connector delivery, then use export automations when the handoff should persist per index.