Segments

Segments are the core analysis output. Each segment is a timestamped piece of analysis data from a specific module (e.g., a transcription snippet, a visual analysis at a given time range).

---

GET /videos/{job_id}/segments

List all analysis segments for a video, optionally filtered by module.

Auth: Required

Path Param	Type	Required	Description
job_id	string	Yes	The video’s job ID

Query Param	Type	Required	Description
module	string	No	Filter by module name (e.g. transcription)

Response: Segment array, ordered by start_time ASC

[
  {
    "id": "1",
    "job_id": "a1b2c3d4-...",
    "module": "visualelements",
    "content": "Objects Detected: person, laptop; ...",
    "start_time": 0.0,
    "end_time": 3.0,
    "metadata": null,
    "created_at": "2025-01-15T10:05:00"
  }
]

curl "https://api.lynxvizion.com/api/videos/a1b2c3d4-.../segments?module=transcription" \
  -H "Authorization: $LVZ_KEY"

---

DELETE /videos/{job_id}/segments

Delete all analysis segments for a video and reset its status to uploaded so it can be reprocessed.

Auth: Required

Path Param	Type	Required	Description
job_id	string	Yes	The video’s job ID

Response:

{
  "ok": true,
  "message": "Segments cleared"
}

curl -X DELETE https://api.lynxvizion.com/api/videos/a1b2c3d4-.../segments \
  -H "Authorization: $LVZ_KEY"

---

GET /results/job/{job_id}

Get video metadata and all segments grouped by module. This is the primary endpoint for retrieving analysis results.

Auth: Required

Path Param	Type	Required	Description
job_id	string	Yes	The video’s job ID

Response:

{
  "job_id": "a1b2c3d4-...",
  "video_name": "my-video.mp4",
  "duration": 120.5,
  "status": "completed",
  "processing_time": 45.2,
  "segments": [...],
  "visualelements": [...],
  "transcription": [...],
  "scenes": [...]
}

The response includes a flat segments array and also each module’s segments as a top-level key.

curl https://api.lynxvizion.com/api/results/job/a1b2c3d4-... \
  -H "Authorization: $LVZ_KEY"

---

GET /aggregated_results/{job_id}

Get all segments grouped by module, optimized for download/export.

Auth: Required

Path Param	Type	Required	Description
job_id	string	Yes	The video’s job ID

Response:

{
  "job_id": "a1b2c3d4-...",
  "video_name": "my-video.mp4",
  "status": "completed",
  "total_segments": 342,
  "modules": {
    "visualelements": [...],
    "transcription": [...],
    "scenes": [...]
  }
}

curl https://api.lynxvizion.com/api/aggregated_results/a1b2c3d4-... \
  -H "Authorization: $LVZ_KEY"

---

GET /scene_grouping/{job_id}

Get scene-related segments only (scenes, shots, grouped_shots, video_reasoning).

Auth: Required

Path Param	Type	Required	Description
job_id	string	Yes	The video’s job ID

Response:

{
  "job_id": "a1b2c3d4-...",
  "video_name": "my-video.mp4",
  "total_segments": 28,
  "modules": {
    "scenes": [...],
    "video_reasoning": [...]
  }
}

curl https://api.lynxvizion.com/api/scene_grouping/a1b2c3d4-... \
  -H "Authorization: $LVZ_KEY"

---

GET /download/combined-report/{job_id}

Download all segments as a JSON report file (Content-Disposition: attachment).

Auth: Required

Path Param	Type	Required	Description
job_id	string	Yes	The video’s job ID

Response: JSON file download

curl -o report.json https://api.lynxvizion.com/api/download/combined-report/a1b2c3d4-... \
  -H "Authorization: $LVZ_KEY"

---

GET /download/report/{job_id}

Download segments for a specific module as JSON or CSV.

Auth: Required

Path Param	Type	Required	Description
job_id	string	Yes	The video’s job ID

Query Param	Type	Required	Description
module	string	Yes	Module name (e.g. transcription)
format	string	No	json (default) or csv

Response: JSON or CSV file download

# Download as JSON
curl -o transcription.json \
  "https://api.lynxvizion.com/api/download/report/a1b2c3d4-...?module=transcription" \
  -H "Authorization: $LVZ_KEY"

# Download as CSV
curl -o transcription.csv \
  "https://api.lynxvizion.com/api/download/report/a1b2c3d4-...?module=transcription&format=csv" \
  -H "Authorization: $LVZ_KEY"