Skip to content

Usage

The Usage router tracks processing consumption per account. Each processed video records duration and action type.

Default allocation is 3,000 processing minutes (50 hours) with optional bonus minutes.


List individual usage records, optionally filtered by date range.

Auth: Required

Query ParamTypeRequiredDescription
start_datestringNoFilter from date (ISO 8601, e.g. 2025-01-01T00:00:00)
end_datestringNoFilter to date

Response: UsageResponse[]

[
{
"id": "1",
"user_id": "550e8400-...",
"job_id": "a1b2c3d4-...",
"action": "process",
"duration_minutes": 2.5,
"processing_time": 45.2,
"modules": "[\"visualelements\",\"transcription\"]",
"created_at": "2025-01-15T10:05:00"
}
]
Terminal window
curl "https://api.lynxvizion.com/api/usage?start_date=2025-01-01T00:00:00" \
-H "Authorization: $LVZ_KEY"

Get an aggregated usage summary with quota information.

Auth: Required

Response:

{
"total_jobs": 47,
"total_minutes": 125.5,
"total_duration_minutes": 125.5,
"by_action": {
"process": 42,
"reprocess": 5
},
"plan": "standard",
"trial_status": "active",
"remaining_trial_minutes": 2874.5,
"total_limit_minutes": 3000,
"usage_percentage": 4.2,
"bonus_minutes": 0,
"first_usage": "2025-01-10T08:00:00",
"total_file_size_gb": 12.34
}
FieldDescription
total_jobsTotal processing jobs run
total_minutesTotal video minutes processed
remaining_trial_minutesMinutes remaining in allocation
total_limit_minutesBase limit + bonus minutes
usage_percentagePercentage of allocation used
bonus_minutesAdditional minutes granted
trial_statusactive or expired
total_file_size_gbTotal storage used across all videos
Terminal window
curl https://api.lynxvizion.com/api/usage/summary \
-H "Authorization: $LVZ_KEY"