@j3lte/frigate-api
Version:
Get Frigate data from the Frigate Data API
2,289 lines (2,288 loc) • 122 kB
TypeScript
/**
* Frigate API
*
* Auto generated using the frigate-api.yaml and [openapi-typescript](https://openapi-ts.dev/introduction)
*
* @see https://github.com/blakeblackshear/frigate/blob/dev/docs/static/frigate-api.yaml
*/
export interface paths {
"/auth": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Auth */
get: operations["auth_auth_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/profile": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Profile */
get: operations["profile_profile_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logout": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Logout */
get: operations["logout_logout_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/login": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Login */
post: operations["login_login_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Users */
get: operations["get_users_users_get"];
put?: never;
/** Create User */
post: operations["create_user_users_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/users/{username}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Delete User */
delete: operations["delete_user_users__username__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/users/{username}/password": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Update Password */
put: operations["update_password_users__username__password_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/users/{username}/role": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Update Role */
put: operations["update_role_users__username__role_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/faces": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Faces */
get: operations["get_faces_faces_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/faces/reprocess": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Reclassify Face */
post: operations["reclassify_face_faces_reprocess_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/faces/train/{name}/classify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Train Face */
post: operations["train_face_faces_train__name__classify_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/faces/{name}/create": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create Face */
post: operations["create_face_faces__name__create_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/faces/{name}/register": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Register Face */
post: operations["register_face_faces__name__register_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/faces/recognize": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Recognize Face */
post: operations["recognize_face_faces_recognize_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/faces/{name}/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deregister Faces */
post: operations["deregister_faces_faces__name__delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lpr/reprocess": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Reprocess License Plate */
put: operations["reprocess_license_plate_lpr_reprocess_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/reindex": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Reindex Embeddings */
put: operations["reindex_embeddings_reindex_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/review": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Review */
get: operations["review_review_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/review_ids": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Review Ids */
get: operations["review_ids_review_ids_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/review/summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Review Summary */
get: operations["review_summary_review_summary_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/reviews/viewed": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Set Multiple Reviewed */
post: operations["set_multiple_reviewed_reviews_viewed_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/reviews/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Delete Reviews */
post: operations["delete_reviews_reviews_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/review/activity/motion": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Motion Activity
* @description Get motion and audio activity.
*/
get: operations["motion_activity_review_activity_motion_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/review/event/{event_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Review From Event */
get: operations["get_review_from_event_review_event__event_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/review/{review_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Review */
get: operations["get_review_review__review_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/review/{review_id}/viewed": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Set Not Reviewed */
delete: operations["set_not_reviewed_review__review_id__viewed_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Is Healthy */
get: operations["is_healthy__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/schema.json": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Config Schema */
get: operations["config_schema_config_schema_json_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/go2rtc/streams": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Go2Rtc Streams */
get: operations["go2rtc_streams_go2rtc_streams_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/go2rtc/streams/{camera_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Go2Rtc Camera Stream */
get: operations["go2rtc_camera_stream_go2rtc_streams__camera_name__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/version": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Version */
get: operations["version_version_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/stats": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Stats */
get: operations["stats_stats_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/stats/history": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Stats History */
get: operations["stats_history_stats_history_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/metrics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Metrics
* @description Expose Prometheus metrics endpoint and update metrics with latest stats
*/
get: operations["metrics_metrics_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Config */
get: operations["config_config_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/raw": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Config Raw */
get: operations["config_raw_config_raw_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/save": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Config Save */
post: operations["config_save_config_save_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/set": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Config Set */
put: operations["config_set_config_set_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/ffprobe": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Ffprobe */
get: operations["ffprobe_ffprobe_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vainfo": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Vainfo */
get: operations["vainfo_vainfo_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/nvinfo": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Nvinfo */
get: operations["nvinfo_nvinfo_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logs/{service}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Logs
* @description Get logs for the requested service (frigate/nginx/go2rtc)
*/
get: operations["logs_logs__service__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/restart": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Restart */
post: operations["restart_restart_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/labels": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Labels */
get: operations["get_labels_labels_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sub_labels": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Sub Labels */
get: operations["get_sub_labels_sub_labels_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/plus/models": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Plusmodels */
get: operations["plusModels_plus_models_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recognized_license_plates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Recognized License Plates */
get:
operations["get_recognized_license_plates_recognized_license_plates_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/timeline": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Timeline */
get: operations["timeline_timeline_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/timeline/hourly": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Hourly Timeline
* @description Get hourly summary for timeline.
*/
get: operations["hourly_timeline_timeline_hourly_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/preview/{camera_name}/start/{start_ts}/end/{end_ts}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Preview Ts
* @description Get all mp4 previews relevant for time period.
*/
get: operations[
"preview_ts_preview__camera_name__start__start_ts__end__end_ts__get"
];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/preview/{year_month}/{day}/{hour}/{camera_name}/{tz_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Preview Hour
* @description Get all mp4 previews relevant for time period given the timezone
*/
get: operations[
"preview_hour_preview__year_month___day___hour___camera_name___tz_name__get"
];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/preview/{camera_name}/start/{start_ts}/end/{end_ts}/frames": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Preview Frames From Cache
* @description Get list of cached preview frames
*/
get: operations[
"get_preview_frames_from_cache_preview__camera_name__start__start_ts__end__end_ts__frames_get"
];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/notifications/pubkey": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Vapid Pub Key */
get: operations["get_vapid_pub_key_notifications_pubkey_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/notifications/register": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Register Notifications */
post: operations["register_notifications_notifications_register_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/exports": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Exports */
get: operations["get_exports_exports_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/export/{camera_name}/start/{start_time}/end/{end_time}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Export Recording */
post: operations[
"export_recording_export__camera_name__start__start_time__end__end_time__post"
];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/export/{event_id}/rename": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Export Rename */
patch: operations["export_rename_export__event_id__rename_patch"];
trace?: never;
};
"/export/{event_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Export Delete */
delete: operations["export_delete_export__event_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/exports/{export_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Export */
get: operations["get_export_exports__export_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Events */
get: operations["events_events_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/explore": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Events Explore */
get: operations["events_explore_events_explore_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/event_ids": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Event Ids */
get: operations["event_ids_event_ids_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/search": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Events Search */
get: operations["events_search_events_search_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Events Summary */
get: operations["events_summary_events_summary_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Event */
get: operations["event_events__event_id__get"];
put?: never;
post?: never;
/** Delete Event */
delete: operations["delete_event_events__event_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/retain": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Set Retain */
post: operations["set_retain_events__event_id__retain_post"];
/** Delete Retain */
delete: operations["delete_retain_events__event_id__retain_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/plus": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Send To Plus */
post: operations["send_to_plus_events__event_id__plus_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/false_positive": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** False Positive */
put: operations["false_positive_events__event_id__false_positive_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/sub_label": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Set Sub Label */
post: operations["set_sub_label_events__event_id__sub_label_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/description": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Set Description */
post: operations["set_description_events__event_id__description_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/description/regenerate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Regenerate Description */
put: operations[
"regenerate_description_events__event_id__description_regenerate_put"
];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Delete Events */
delete: operations["delete_events_events__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{camera_name}/{label}/create": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create Event */
post: operations["create_event_events__camera_name___label__create_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/end": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** End Event */
put: operations["end_event_events__event_id__end_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Mjpeg Feed */
get: operations["mjpeg_feed__camera_name__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/ptz/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Camera Ptz Info */
get: operations["camera_ptz_info__camera_name__ptz_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/latest.{extension}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Latest Frame */
get: operations["latest_frame__camera_name__latest__extension__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/recordings/{frame_time}/snapshot.{format}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Snapshot From Recording */
get: operations[
"get_snapshot_from_recording__camera_name__recordings__frame_time__snapshot__format__get"
];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/plus/{frame_time}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Submit Recording Snapshot To Plus */
post: operations[
"submit_recording_snapshot_to_plus__camera_name__plus__frame_time__post"
];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recordings/storage": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Recordings Storage Usage */
get: operations["get_recordings_storage_usage_recordings_storage_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recordings/summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* All Recordings Summary
* @description Returns true/false by day indicating if recordings exist
*/
get: operations["all_recordings_summary_recordings_summary_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/recordings/summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Recordings Summary
* @description Returns hourly summary for recordings of given camera
*/
get: operations["recordings_summary__camera_name__recordings_summary_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/recordings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Recordings
* @description Return specific camera recordings between the given 'after'/'end' times. If not provided the last hour will be used
*/
get: operations["recordings__camera_name__recordings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/start/{start_ts}/end/{end_ts}/clip.mp4": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Recording Clip
* @description For iOS devices, use the master.m3u8 HLS link instead of clip.mp4. Safari does not reliably process progressive mp4 files.
*/
get: operations[
"recording_clip__camera_name__start__start_ts__end__end_ts__clip_mp4_get"
];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vod/{camera_name}/start/{start_ts}/end/{end_ts}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Vod Ts */
get:
operations["vod_ts_vod__camera_name__start__start_ts__end__end_ts__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vod/{year_month}/{day}/{hour}/{camera_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Vod Hour No Timezone
* @description VOD for specific hour. Uses the default timezone (UTC).
*/
get: operations[
"vod_hour_no_timezone_vod__year_month___day___hour___camera_name__get"
];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vod/{year_month}/{day}/{hour}/{camera_name}/{tz_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Vod Hour */
get: operations[
"vod_hour_vod__year_month___day___hour___camera_name___tz_name__get"
];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vod/event/{event_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Vod Event */
get: operations["vod_event_vod_event__event_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/snapshot.jpg": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Event Snapshot */
get: operations["event_snapshot_events__event_id__snapshot_jpg_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/thumbnail.{extension}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Event Thumbnail */
get:
operations["event_thumbnail_events__event_id__thumbnail__extension__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/grid.jpg": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Grid Snapshot */
get: operations["grid_snapshot__camera_name__grid_jpg_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/snapshot-clean.png": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Event Snapshot Clean */
get: operations[
"event_snapshot_clean_events__event_id__snapshot_clean_png_get"
];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/clip.mp4": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Event Clip */
get: operations["event_clip_events__event_id__clip_mp4_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/events/{event_id}/preview.gif": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Event Preview */
get: operations["event_preview_events__event_id__preview_gif_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/start/{start_ts}/end/{end_ts}/preview.gif": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Preview Gif */
get: operations[
"preview_gif__camera_name__start__start_ts__end__end_ts__preview_gif_get"
];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/start/{start_ts}/end/{end_ts}/preview.mp4": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Preview Mp4 */
get: operations[
"preview_mp4__camera_name__start__start_ts__end__end_ts__preview_mp4_get"
];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/review/{event_id}/preview": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Review Preview */
get: operations["review_preview_review__event_id__preview_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/preview/{file_name}/thumbnail.webp": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Preview Thumbnail
* @description Get a thumbnail from the cached preview frames.
*/
get: operations["preview_thumbnail_preview__file_name__thumbnail_webp_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/preview/{file_name}/thumbnail.jpg": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Preview Thumbnail
* @description Get a thumbnail from the cached preview frames.
*/
get: operations["preview_thumbnail_preview__file_name__thumbnail_jpg_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/{label}/thumbnail.jpg": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Label Thumbnail */
get: operations["label_thumbnail__camera_name___label__thumbnail_jpg_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/{label}/best.jpg": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Label Thumbnail */
get: operations["label_thumbnail__camera_name___label__best_jpg_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/{label}/clip.mp4": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Label Clip */
get: operations["label_clip__camera_name___label__clip_mp4_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{camera_name}/{label}/snapshot.jpg": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Label Snapshot
* @description Returns the snapshot image from the latest event for the given camera and label combo
*/
get: operations["label_snapshot__camera_name___label__snapshot_jpg_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
/** AppConfigSetBody */
AppConfigSetBody: {
/**
* Requires Restart
* @default 1
*/
requires_restart: number;
};
/** AppPostLoginBody */
AppPostLoginBody: {
/** User */
user: string;
/** Password */
password: string;
};
/** AppPostUsersBody */
AppPostUsersBody: {
/** Username */
username: string;
/** Password */
password: string;
/**
* Role
* @default viewer
*/
role: string | null;
};
/** AppPutPasswordBody */
AppPutPasswordBody: {
/** Password */
password: string;
};
/** AppPutRoleBody */
AppPutRoleBody: {
/** Role */
role: string;
};
/** Body_recognize_face_faces_recognize_post */
Body_recognize_face_faces_recognize_post: {
/**
* File
* Format: binary
*/
file: string;
};
/** Body_register_face_faces__name__register_post */
Body_register_face_faces__name__register_post: {
/**
* File
* Format: binary
*/
file: string;
};
/** DayReview */
DayReview: {
/**
* Day
* Format: date-time
*/
day: string;
/** Reviewed Alert */
reviewed_alert: number;
/** Reviewed Detection */
reviewed_detection: number;
/** Total Alert */
total_alert: number;
/** Total Detection */
total_detection: number;
};
/** EventCreateResponse */
EventCreateResponse: {
/** Success */
success: boolean;
/** Message */
message: string;
/** Event Id */
event_id: string;
};
/** EventMultiDeleteResponse */
EventMultiDeleteResponse: {
/** Success */
success: boolean;
/** Deleted Events */
deleted_events: string[];
/** Not Found Events */
not_found_events: string[];
};
/** EventResponse */
EventResponse: {
/** Id */
id: string;
/** Label */
label: string;
/** Sub Label */
sub_label: string | null;
/** Camera */
camera: string;
/** Start Time */
start_time: number;
/** End Time */
end_time: number | null;
/** False Positive */
false_positive: boolean | null;
/** Zones */
zones: string[];
/** Thumbnail */
thumbnail: string | null;
/** Has Clip */
has_clip: boolean;
/** Has Snapshot */
has_snapshot: boolean;
/** Retain Indefinitely */
retain_indefinitely: boolean;
/** Plus Id */
plus_id: string | null;
/** Model Hash */
model_hash: string | null;
/** Detector Type */
detector_type: string | null;
/** Model Type */
model_type: string | null;
/** Data */
data: Record<string, never>;
};
/** EventUploadPlusResponse */
EventUploadPlusResponse: {
/** Success */
success: boolean;
/** Plus Id */
plus_id: string;
};
/** EventsCreateBody */
EventsCreateBody: {
/**
* Source Type
* @default api
*/
source_type: string | null;
/** Sub Label */
sub_label?: string | null;
/**
* Score
* @default 0
*/
score: number | null;
/**
* Duration
* @default 30
*/
duration: number | null;
/**
* Include Recording
* @default true
*/
include_recording: boolean | null;
/**
* Draw
* @default {}
*/
draw: Record<string, never> | null;
};
/** EventsDeleteBody */
EventsDeleteBody: {
/** The event IDs to delete */
event_ids: string[];
};
/** EventsDescriptionBody */
EventsDescriptionBody: {
/** The description of the event */
description: string | null;
};
/** EventsEndBody */
EventsEndBody: {
/** End Time */
end_time?: number | null;
};
/** EventsSubLabelBody */
EventsSubLabelBody: {
/** Sub label */
subLabel: string;
/** Score for sub label */
subLabelScore?: number | null;
/** Camera this object is detected on. */
camera?: string | null;
};
/** ExportRecordingsBody */
ExportRecordingsBody: {
/**
* Playback factor
* @default realtime
*/
playback: components["schemas"]["PlaybackFactorEnum"];
/**
* Playback source
* @default recordings
*/
source: components["schemas"]["PlaybackSourceEnum"];
/** Friendly name */
name?: string;
/** Image Path */
image_path?: string;
};
/** ExportRenameBody */
ExportRenameBody: {
/** Friendly name */
name: string;
};
/**
* Extension
* @enum {string}
*/
Extension: "webp" | "png" | "jpg" | "jpeg";
/** GenericResponse */
GenericResponse: {
/** Success */
success: boolean;
/** Message */
message: string;
};
/** HTTPValidationError */
HTTPValidationError: {
/** Detail */
detail?: components["schemas"]["ValidationError"][];
};
/** Last24HoursReview */
Last24HoursReview: {
/** Reviewed Alert */
reviewed_alert: number;
/** Reviewed Detection */
reviewed_detection: number;
/** Total Alert */
total_alert: number;
/** Total Detection */
total_detection: number;
};
/**
* PlaybackFactorEnum
* @enum {string}
*/
PlaybackFactorEnum: "realtime" | "timelapse_25x";
/**
* PlaybackSourceEnum
* @enum {string}
*/
PlaybackSourceEnum: "recordings" | "preview";
/**
* RegenerateDescriptionEnum
* @enum {string}
*/
RegenerateDescriptionEnum: "thumbnails" | "snapshot";
/** ReviewActivityMotionResponse */
ReviewActivityMotionResponse: {
/** Start Time */
start_time: number;
/** Motion */
motion: number;
/** Camera */
camera: string;
};
/** ReviewModifyMultipleBody */
ReviewModifyMultipleBody: {
/** Ids */
ids: string[];
};
/** ReviewSegmentResponse */
ReviewSegmentResponse: {
/** Id */
id: string;
/** Camera */
camera: string;
/**
* Start Time
* Format: date-time
*/
start_time: string;
/**
* End Time
* Format: date-time
*/
end_time: string;
/** Has Been Reviewed */
has_been_reviewed: boolean;
severity: components["schemas"]["SeverityEnum"];
/** Thumb Path */
thumb_path: string;
/** Data */
data: unknown;
};
/** ReviewSummaryResponse */
ReviewSummaryResponse: {
last24Hours: components["schemas"]["Last24HoursReview"];
/** Root */
root: {
[key: string]: components["schemas"]["DayReview"];
};
};
/**
* SeverityEnum
* @enum {string}
*/
SeverityEnum: "alert" | "detection";
/** SubmitPlusBody */
SubmitPlusBody: {
/**
* Include Annotation
* @default 1
*/
include_annotation: number;
};
/** ValidationError */
ValidationError: {
/** Location */
loc: (string | number)[];
/** Message */
msg: string;
/** Error Type */
type: string;
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
auth_auth_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
profile_profile_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
logout_logout_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
login_login_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AppPostLoginBody"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_users_users_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
create_user_users_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBo