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_idindex_idvideo_idsevent_typesbatch_sizeLast-Event-IDrequest header
Each SSE event includes:
event_idevent_typeuser_idrun_idvideo_idsegment_idindex_idcreated_atpayload
The server also emits heartbeat comments and a processing.stream_error event if the stream terminates unexpectedly.
Marker endpoints
| Method | Path | Purpose |
|---|---|---|
GET | /api/v2/markers | List user markers |
PUT | /api/v2/markers | Upsert 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:
| Method | Path | Purpose |
|---|---|---|
GET | /api/v2/videos/{video_id}/gif | Retrieve a media preview GIF |
GET | /api/v2/videos/segments/{segment_id}/thumbnail | Retrieve 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/batchPOST /api/v2/videos/batch/statusPOST /api/v2/videos/batch/segments
The Python SDK exposes these as:
client.videos.batch_retrieveclient.videos.batch_statusclient.videos.batch_segments
Playground helpers
Playground-specific retrieval surfaces are public and documented on other pages:
GET /api/v2/playground/videosPOST /api/v2/playground/searchPOST /api/v2/search/filter/playground
Internal queue, automation trigger, and billing routes are intentionally excluded from this page even when they exist in the backend, because they are not part of the supported public integration contract.
Related documentation
Indexes are top-level collections. Media resources include uploaded or registered videos, audio files, images, segment listings, batch helpers, and playground-only media.
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.
