VectorMethods

Docs / API reference

Advanced public utilities

Reference public VideoVector utilities for event streams, markers, signed URLs, thumbnails, GIF helpers, and batch media helpers.

api/routes.pysdk/BACKEND_PARITY_MATRIX.mdapi/marker_controllers.py

Search documentation

Search pages, API reference sections, and guide headings.

Summary

This page groups the supported public endpoints that do not fit cleanly into a primary workflow resource page but are still part of the public non-billing API surface.

Processing event stream

GET /api/v2/processing/events/stream exposes Server-Sent Events for processing lifecycle updates.

Public filters include:

  • run_id
  • index_id
  • video_ids
  • event_types
  • batch_size
  • Last-Event-ID request header

Each SSE event includes:

  • event_id
  • event_type
  • user_id
  • run_id
  • video_id
  • segment_id
  • index_id
  • created_at
  • payload

The server also emits heartbeat comments and a processing.stream_error event if the stream terminates unexpectedly.

Marker endpoints

MethodPathPurpose
GET/api/v2/markersList user markers
PUT/api/v2/markersUpsert a marker
DELETE/api/v2/markers/{marker_id}Delete a marker

Markers can be attached to prompts, runs, or extracted fields and are surfaced in SDK response models such as marker and metadata_markers.

Signed URL helper

POST /api/v2/videos/signed-url exchanges a gcs_uri for a signed URL.

curl -X POST /api/v2/videos/signed-url \
  -H "X-API-Key: sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"gcs_uri":"gs://bucket/path/to/asset.mp4"}'

Raw media helper endpoints

These endpoints are public but intentionally treated as helper surfaces rather than first-class workflow resources:

MethodPathPurpose
GET/api/v2/videos/{video_id}/gifRetrieve a media preview GIF
GET/api/v2/videos/segments/{segment_id}/thumbnailRetrieve a segment thumbnail image

Batch media helpers

These endpoints are useful when the client already has a media ID set and wants a compact fetch pattern:

  • POST /api/v2/videos/batch
  • POST /api/v2/videos/batch/status
  • POST /api/v2/videos/batch/segments

The Python SDK exposes these as:

  • client.videos.batch_retrieve
  • client.videos.batch_status
  • client.videos.batch_segments

Playground helpers

Playground-specific retrieval surfaces are public and documented on other pages:

  • GET /api/v2/playground/videos
  • POST /api/v2/playground/search
  • POST /api/v2/search/filter/playground

Related documentation

API reference

Indexes are top-level collections. Media resources include uploaded or registered videos, audio files, images, segment listings, batch helpers, and playground-only media.

API reference

Webhooks deliver VideoVector events to your HTTPS endpoint for review operations, export handoff, import monitoring, and media processing automation.

Chat sessions provide an agentic retrieval surface on top of search results and prompt-run scope. The API supports session CRUD, turn creation, optional scope narrowing, and streaming turn events over SSE for agent-search experiences.