> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/multimedia.md).

# Video

List, download and stream video from a tracker's cameras: event clips, memory card recordings, and live video.

Trackers with cameras record video to their own memory card. These operations list the recordings, upload the ones you need to Navixy, and download them. They also start and stop a live stream.

Two device families support video: Jimi JC400 and JC261 dashcams and most Howen video recorders. To check a model, look for `multimedia` in its entry in [`tracker/list_models`](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker.md#post-tracker-list_models): it lists the model's cameras and video features. For other models, most of these operations return error 214.

Every operation needs the `video_monitoring` right. Master users have it. A sub-user needs a [security group](https://navixy.com/docs/navixy-api/user-api/resources/commons/subuser/security_group.md) that grants it.

For the steps to get event clips and memory card recordings, see [Get dashcam video](https://navixy.com/docs/navixy-api/user-api/guides/data-retrieval/dashcam-video.md).

{% hint style="warning" %}
Every upload and live stream uses the camera's mobile data. Request the recordings you need rather than whole days.
{% endhint %}

## Video object structure

## The VideoFile object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"VideoFile":{"type":"object","description":"A recording that a camera has listed, whether or not it has been uploaded to Navixy yet.","properties":{"id":{"type":"integer","description":"Navixy ID of the recording."},"file_name":{"type":"string","description":"File name on the camera."},"multimedia_file_type":{"type":"string","description":"`video` for a regular recording, `alarm_video` for a clip the camera recorded on an event.","enum":["video","alarm_video","photo","alarm_photo","config","unknown"]},"camera":{"type":"string","description":"The camera that recorded the file. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has.","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]},"state":{"type":"string","description":"Where the recording is. `LISTED_ON_DEVICE`: on the camera only. `REQUESTED_FOR_DOWNLOAD`: Navixy has asked the camera to upload it. `RECEIVED`: uploaded to Navixy.","enum":["LISTED_ON_DEVICE","REQUESTED_FOR_DOWNLOAD","RECEIVED"]},"start":{"type":"string","description":"When the recording starts."},"end":{"type":"string","description":"When the recording ends."},"file":{"allOf":[{"$ref":"#/components/schemas/TrackerFile"}],"description":"The uploaded file. Present only once the upload to Navixy is complete."},"metadata":{"type":"string","description":"Extra details from the device, as a JSON string. Howen recorders send the file size and type here. Jimi dashcams send nothing, and the field is absent."}}},"TrackerFile":{"type":"object","description":"A file that a device uploaded to Navixy, such as a video recording or a photo. Returned only once the upload is complete.","properties":{"id":{"type":"integer","description":"File ID in Navixy file storage."},"storage_id":{"type":"integer","description":"ID of the storage holding the file."},"user_id":{"type":"integer","description":"ID of the user who owns the file."},"subuser_id":{"type":["integer","null"],"description":"ID of the sub-user the file belongs to, if any."},"type":{"type":"string","description":"`image` for a picture, `file` for anything else, including video.","enum":["image","file"]},"created":{"type":"string","description":"When the file record was created."},"uploaded":{"type":"string","description":"When the upload finished."},"name":{"type":"string","description":"File name."},"size":{"type":"integer","description":"Size in bytes."},"mime_type":{"type":"string","description":"MIME type of the file."},"storage_data":{"type":"object","description":"Storage details for internal use. Don't rely on its contents.","additionalProperties":true},"metadata":{"type":["object","null"],"description":"Metadata for the file. For an image this has `orientation`, the EXIF orientation.","additionalProperties":true},"state":{"type":"string","description":"Where the file is in its lifecycle. Always `uploaded` here.","enum":["created","in_progress","uploaded","deleted"]},"previews":{"type":"array","description":"Preview images, each with a `download_url`. Present only when previews exist.","items":{"type":"object","additionalProperties":true}},"download_url":{"type":"string","description":"Signed link to download the file, valid for 7 days from the request. Request the file again for a fresh link instead of storing this one."},"view_url":{"type":"string","description":"Signed link to view an image in the browser. Present for images only."},"file_source_key":{"type":"string","description":"The camera that recorded the file. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has."}}}}}}
```

## The TrackerFile object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"TrackerFile":{"type":"object","description":"A file that a device uploaded to Navixy, such as a video recording or a photo. Returned only once the upload is complete.","properties":{"id":{"type":"integer","description":"File ID in Navixy file storage."},"storage_id":{"type":"integer","description":"ID of the storage holding the file."},"user_id":{"type":"integer","description":"ID of the user who owns the file."},"subuser_id":{"type":["integer","null"],"description":"ID of the sub-user the file belongs to, if any."},"type":{"type":"string","description":"`image` for a picture, `file` for anything else, including video.","enum":["image","file"]},"created":{"type":"string","description":"When the file record was created."},"uploaded":{"type":"string","description":"When the upload finished."},"name":{"type":"string","description":"File name."},"size":{"type":"integer","description":"Size in bytes."},"mime_type":{"type":"string","description":"MIME type of the file."},"storage_data":{"type":"object","description":"Storage details for internal use. Don't rely on its contents.","additionalProperties":true},"metadata":{"type":["object","null"],"description":"Metadata for the file. For an image this has `orientation`, the EXIF orientation.","additionalProperties":true},"state":{"type":"string","description":"Where the file is in its lifecycle. Always `uploaded` here.","enum":["created","in_progress","uploaded","deleted"]},"previews":{"type":"array","description":"Preview images, each with a `download_url`. Present only when previews exist.","items":{"type":"object","additionalProperties":true}},"download_url":{"type":"string","description":"Signed link to download the file, valid for 7 days from the request. Request the file again for a fresh link instead of storing this one."},"view_url":{"type":"string","description":"Signed link to view an image in the browser. Present for images only."},"file_source_key":{"type":"string","description":"The camera that recorded the file. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has."}}}}}}
```

## The VideoInterval object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"VideoInterval":{"type":"object","description":"A part of a recording that is ready to play.","properties":{"start":{"type":"string","description":"When this part starts."},"end":{"type":"string","description":"When this part ends."},"file":{"allOf":[{"$ref":"#/components/schemas/TrackerFile"}],"description":"The uploaded file with this part of the recording."}}},"TrackerFile":{"type":"object","description":"A file that a device uploaded to Navixy, such as a video recording or a photo. Returned only once the upload is complete.","properties":{"id":{"type":"integer","description":"File ID in Navixy file storage."},"storage_id":{"type":"integer","description":"ID of the storage holding the file."},"user_id":{"type":"integer","description":"ID of the user who owns the file."},"subuser_id":{"type":["integer","null"],"description":"ID of the sub-user the file belongs to, if any."},"type":{"type":"string","description":"`image` for a picture, `file` for anything else, including video.","enum":["image","file"]},"created":{"type":"string","description":"When the file record was created."},"uploaded":{"type":"string","description":"When the upload finished."},"name":{"type":"string","description":"File name."},"size":{"type":"integer","description":"Size in bytes."},"mime_type":{"type":"string","description":"MIME type of the file."},"storage_data":{"type":"object","description":"Storage details for internal use. Don't rely on its contents.","additionalProperties":true},"metadata":{"type":["object","null"],"description":"Metadata for the file. For an image this has `orientation`, the EXIF orientation.","additionalProperties":true},"state":{"type":"string","description":"Where the file is in its lifecycle. Always `uploaded` here.","enum":["created","in_progress","uploaded","deleted"]},"previews":{"type":"array","description":"Preview images, each with a `download_url`. Present only when previews exist.","items":{"type":"object","additionalProperties":true}},"download_url":{"type":"string","description":"Signed link to download the file, valid for 7 days from the request. Request the file again for a fresh link instead of storing this one."},"view_url":{"type":"string","description":"Signed link to view an image in the browser. Present for images only."},"file_source_key":{"type":"string","description":"The camera that recorded the file. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has."}}}}}}
```

## The VideoCoverage object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"VideoCoverage":{"type":"object","description":"A period for which a camera has recordings.","properties":{"start":{"type":"string","description":"Start of the earliest recording in the group."},"end":{"type":"string","description":"End of the latest recording in the group. Gaps between recordings inside the group are not shown."},"group_start":{"type":"string","description":"Start of the day, hour or minute this group belongs to, as set by `group_by`."},"files_locations":{"type":"array","description":"Where the recordings in this group are. `device`: on the camera only, so playing them needs an upload. `local_storage`: already uploaded to Navixy.","items":{"type":"string","enum":["device","local_storage"]}}}}}}}
```

## The VideoStream object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"VideoStream":{"type":"object","description":"A live stream from one camera.","properties":{"link":{"type":"string","description":"Playlist address of the stream, in [HLS](https://datatracker.ietf.org/doc/html/rfc8216) (HTTP Live Streaming) format. The address is returned before the camera starts sending, so the playlist can take a few seconds to become available."},"camera":{"type":"string","description":"The camera this stream comes from. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has.","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]}}}}}}
```

## API actions

API base path: `/tracker/multimedia`.

***

## List camera recordings

> List the recordings that the camera has reported for a period, including event clips. Each item says whether the recording is still on the camera only or already uploaded to Navixy, and an uploaded one has a download link.\
> \
> A recording is included when it starts inside the period. The camera reports its recordings on its own every 12 hours. To refresh the list sooner, call \`tracker/multimedia/file/search/create\`. On a Howen video recorder, the 1-minute parts that \`tracker/multimedia/video/search\` requested appear as items of their own.\
> \
> Navixy deletes an uploaded file after a retention period, and the item disappears from this list along with it.\
> \
> Requires the \`video\_monitoring\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Trackers","description":"Trackers, the devices the platform tracks, together with the geo links that share their live location with people outside the account. Resources under the /tracker/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"VideoFile":{"type":"object","description":"A recording that a camera has listed, whether or not it has been uploaded to Navixy yet.","properties":{"id":{"type":"integer","description":"Navixy ID of the recording."},"file_name":{"type":"string","description":"File name on the camera."},"multimedia_file_type":{"type":"string","description":"`video` for a regular recording, `alarm_video` for a clip the camera recorded on an event.","enum":["video","alarm_video","photo","alarm_photo","config","unknown"]},"camera":{"type":"string","description":"The camera that recorded the file. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has.","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]},"state":{"type":"string","description":"Where the recording is. `LISTED_ON_DEVICE`: on the camera only. `REQUESTED_FOR_DOWNLOAD`: Navixy has asked the camera to upload it. `RECEIVED`: uploaded to Navixy.","enum":["LISTED_ON_DEVICE","REQUESTED_FOR_DOWNLOAD","RECEIVED"]},"start":{"type":"string","description":"When the recording starts."},"end":{"type":"string","description":"When the recording ends."},"file":{"allOf":[{"$ref":"#/components/schemas/TrackerFile"}],"description":"The uploaded file. Present only once the upload to Navixy is complete."},"metadata":{"type":"string","description":"Extra details from the device, as a JSON string. Howen recorders send the file size and type here. Jimi dashcams send nothing, and the field is absent."}}},"TrackerFile":{"type":"object","description":"A file that a device uploaded to Navixy, such as a video recording or a photo. Returned only once the upload is complete.","properties":{"id":{"type":"integer","description":"File ID in Navixy file storage."},"storage_id":{"type":"integer","description":"ID of the storage holding the file."},"user_id":{"type":"integer","description":"ID of the user who owns the file."},"subuser_id":{"type":["integer","null"],"description":"ID of the sub-user the file belongs to, if any."},"type":{"type":"string","description":"`image` for a picture, `file` for anything else, including video.","enum":["image","file"]},"created":{"type":"string","description":"When the file record was created."},"uploaded":{"type":"string","description":"When the upload finished."},"name":{"type":"string","description":"File name."},"size":{"type":"integer","description":"Size in bytes."},"mime_type":{"type":"string","description":"MIME type of the file."},"storage_data":{"type":"object","description":"Storage details for internal use. Don't rely on its contents.","additionalProperties":true},"metadata":{"type":["object","null"],"description":"Metadata for the file. For an image this has `orientation`, the EXIF orientation.","additionalProperties":true},"state":{"type":"string","description":"Where the file is in its lifecycle. Always `uploaded` here.","enum":["created","in_progress","uploaded","deleted"]},"previews":{"type":"array","description":"Preview images, each with a `download_url`. Present only when previews exist.","items":{"type":"object","additionalProperties":true}},"download_url":{"type":"string","description":"Signed link to download the file, valid for 7 days from the request. Request the file again for a fresh link instead of storing this one."},"view_url":{"type":"string","description":"Signed link to view an image in the browser. Present for images only."},"file_source_key":{"type":"string","description":"The camera that recorded the file. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tracker/multimedia/video/list":{"post":{"tags":["Trackers"],"summary":"List camera recordings","description":"List the recordings that the camera has reported for a period, including event clips. Each item says whether the recording is still on the camera only or already uploaded to Navixy, and an uploaded one has a download link.\n\nA recording is included when it starts inside the period. The camera reports its recordings on its own every 12 hours. To refresh the list sooner, call `tracker/multimedia/file/search/create`. On a Howen video recorder, the 1-minute parts that `tracker/multimedia/video/search` requested appear as items of their own.\n\nNavixy deletes an uploaded file after a retention period, and the item disappears from this list along with it.\n\nRequires the `video_monitoring` right.","operationId":"trackerMultimediaVideoList","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked."},"from":{"type":"string","description":"Start of the period, in the account timezone."},"to":{"type":"string","description":"End of the period. Must not be before `from`. The period may be up to 120 days long."},"cameras":{"type":"array","description":"Cameras to list recordings from. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has.","items":{"type":"string","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]}},"file_types":{"type":"array","description":"Optional. Default `video` and `alarm_video`. Kinds of files to list: `video` for regular recordings, `alarm_video` for event clips.","items":{"type":"string","enum":["video","alarm_video","photo","alarm_photo","config","unknown"]}}},"required":["tracker_id","from","to","cameras"]}}}},"responses":{"200":{"description":"The recordings","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","description":"Recordings that start inside the period. Empty when there are none.","items":{"$ref":"#/components/schemas/VideoFile"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the user lacks the `video_monitoring` right. Error 201: no tracker with this ID belongs to the account. Error 208: the tracker exists but is blocked, normally because its tariff ended. Error 211: the period is longer than 120 days. Error 214: the device model has no video support, or lacks one of the requested cameras.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](https://navixy.com/docs/navixy-api/general/errors.md#error-codes):

* 13 - The user lacks the `video_monitoring` right.
* 201 - No tracker with this ID belongs to the account.
* 208 - The tracker exists but is blocked, normally because its tariff ended.
* 211 - The period is longer than 120 days.
* 214 - The device model has no video support, or lacks one of the requested cameras.

***

{% hint style="info" %}
An upload takes time. Repeat the same request until `has_files_in_progress` is `false`.
{% endhint %}

## Get the recording at a moment

> Get the recording that covers a moment, from each requested camera. If the recording is still on the camera only, Navixy asks the camera to upload it.\
> \
> The upload takes time, so repeat the same request until \`has\_files\_in\_progress\` is \`false\`. Then each camera in \`data\` has the parts of the recording that are ready, with their download links. If an upload request gets no answer within 20 minutes, the next call sends it again.\
> \
> The camera must be online for the request to reach it, so check its connection with \`tracker/get\_state\` first. When it is offline, the call doesn't fail, and nothing reaches the camera:\
> \
> \* \*\*Jimi dashcams:\*\* \`has\_files\_in\_progress\` stays \`false\`.\
> \* \*\*Howen video recorders:\*\* Navixy still records a pending upload, so \`has\_files\_in\_progress\` is \`true\` for the next 20 minutes although the recorder received nothing.\
> \
> How much is uploaded depends on the device:\
> \
> \* \*\*Jimi dashcams\*\* upload the 1-minute recording that contains the moment. Pass a moment inside the minute, such as \`09:15:30\`: a moment at second 00 also matches the previous recording, which ends at that second, and the earliest match is used.\
> \* \*\*Howen video recorders\*\* upload from the moment to the end of its minute. The returned part still shows the whole minute. For a full minute, pass a moment at second 00, such as \`09:15:00\`.\
> \
> Every upload uses the camera's mobile data. Only regular recordings are searched: an event clip that the camera hasn't uploaded can't be requested through the API.\
> \
> Requires the \`video\_monitoring\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Trackers","description":"Trackers, the devices the platform tracks, together with the geo links that share their live location with people outside the account. Resources under the /tracker/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"VideoInterval":{"type":"object","description":"A part of a recording that is ready to play.","properties":{"start":{"type":"string","description":"When this part starts."},"end":{"type":"string","description":"When this part ends."},"file":{"allOf":[{"$ref":"#/components/schemas/TrackerFile"}],"description":"The uploaded file with this part of the recording."}}},"TrackerFile":{"type":"object","description":"A file that a device uploaded to Navixy, such as a video recording or a photo. Returned only once the upload is complete.","properties":{"id":{"type":"integer","description":"File ID in Navixy file storage."},"storage_id":{"type":"integer","description":"ID of the storage holding the file."},"user_id":{"type":"integer","description":"ID of the user who owns the file."},"subuser_id":{"type":["integer","null"],"description":"ID of the sub-user the file belongs to, if any."},"type":{"type":"string","description":"`image` for a picture, `file` for anything else, including video.","enum":["image","file"]},"created":{"type":"string","description":"When the file record was created."},"uploaded":{"type":"string","description":"When the upload finished."},"name":{"type":"string","description":"File name."},"size":{"type":"integer","description":"Size in bytes."},"mime_type":{"type":"string","description":"MIME type of the file."},"storage_data":{"type":"object","description":"Storage details for internal use. Don't rely on its contents.","additionalProperties":true},"metadata":{"type":["object","null"],"description":"Metadata for the file. For an image this has `orientation`, the EXIF orientation.","additionalProperties":true},"state":{"type":"string","description":"Where the file is in its lifecycle. Always `uploaded` here.","enum":["created","in_progress","uploaded","deleted"]},"previews":{"type":"array","description":"Preview images, each with a `download_url`. Present only when previews exist.","items":{"type":"object","additionalProperties":true}},"download_url":{"type":"string","description":"Signed link to download the file, valid for 7 days from the request. Request the file again for a fresh link instead of storing this one."},"view_url":{"type":"string","description":"Signed link to view an image in the browser. Present for images only."},"file_source_key":{"type":"string","description":"The camera that recorded the file. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tracker/multimedia/video/search":{"post":{"tags":["Trackers"],"summary":"Get the recording at a moment","description":"Get the recording that covers a moment, from each requested camera. If the recording is still on the camera only, Navixy asks the camera to upload it.\n\nThe upload takes time, so repeat the same request until `has_files_in_progress` is `false`. Then each camera in `data` has the parts of the recording that are ready, with their download links. If an upload request gets no answer within 20 minutes, the next call sends it again.\n\nThe camera must be online for the request to reach it, so check its connection with `tracker/get_state` first. When it is offline, the call doesn't fail, and nothing reaches the camera:\n\n* **Jimi dashcams:** `has_files_in_progress` stays `false`.\n* **Howen video recorders:** Navixy still records a pending upload, so `has_files_in_progress` is `true` for the next 20 minutes although the recorder received nothing.\n\nHow much is uploaded depends on the device:\n\n* **Jimi dashcams** upload the 1-minute recording that contains the moment. Pass a moment inside the minute, such as `09:15:30`: a moment at second 00 also matches the previous recording, which ends at that second, and the earliest match is used.\n* **Howen video recorders** upload from the moment to the end of its minute. The returned part still shows the whole minute. For a full minute, pass a moment at second 00, such as `09:15:00`.\n\nEvery upload uses the camera's mobile data. Only regular recordings are searched: an event clip that the camera hasn't uploaded can't be requested through the API.\n\nRequires the `video_monitoring` right.","operationId":"trackerMultimediaVideoSearch","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked."},"cameras":{"type":"array","description":"Cameras to get the recording from. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has.","items":{"type":"string","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]}},"date_time":{"type":"string","description":"The moment to get the recording for, in the account timezone."},"forced_full_file_request":{"type":"boolean","description":"Optional. Default `false`. When `true`, request every recording that covers the moment, not only the earliest one for each camera. In this mode an upload request without an answer is not sent again, and a Howen video recorder uploads whole recordings rather than 1-minute parts, which uses more mobile data."}},"required":["tracker_id","cameras","date_time"]}}}},"responses":{"200":{"description":"The parts that are ready, and whether uploads are still running","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"data":{"type":"array","description":"One item per camera that has an uploaded part ready. Empty when no recording covers the moment, or while the upload is still running.","items":{"type":"object","properties":{"camera":{"type":"string","description":"The camera.","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]},"intervals":{"type":"array","description":"Uploaded parts of the recording.","items":{"$ref":"#/components/schemas/VideoInterval"}}}}},"has_files_in_progress":{"type":"boolean","description":"`true` while an upload is still running. Repeat the request until it is `false`."}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the user lacks the `video_monitoring` right. Error 201: no tracker with this ID belongs to the account. Error 208: the tracker exists but is blocked, normally because its tariff ended. Error 214: the device model has no video support, or lacks one of the requested cameras. Error 8: the request could not be passed to the device, retry later.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](https://navixy.com/docs/navixy-api/general/errors.md#error-codes):

* 8 - The request could not be passed to the device. Retry later.
* 13 - The user lacks the `video_monitoring` right.
* 201 - No tracker with this ID belongs to the account.
* 208 - The tracker exists but is blocked, normally because its tariff ended.
* 214 - The device model has no video support, or lacks one of the requested cameras.

***

## Find periods with recordings

> Find the periods for which the cameras have recordings, grouped by day, hour or minute. Use it to see what is available before you request a recording with \`tracker/multimedia/video/search\`. Only regular recordings are counted, not event clips.\
> \
> The cameras in \`cameras\` are combined into one result, so call once per camera to see each one separately. Groups follow the account timezone. A group is included when it starts inside the period.\
> \
> For a device model without video support, the list is empty rather than an error.\
> \
> Requires the \`video\_monitoring\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Trackers","description":"Trackers, the devices the platform tracks, together with the geo links that share their live location with people outside the account. Resources under the /tracker/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"VideoCoverage":{"type":"object","description":"A period for which a camera has recordings.","properties":{"start":{"type":"string","description":"Start of the earliest recording in the group."},"end":{"type":"string","description":"End of the latest recording in the group. Gaps between recordings inside the group are not shown."},"group_start":{"type":"string","description":"Start of the day, hour or minute this group belongs to, as set by `group_by`."},"files_locations":{"type":"array","description":"Where the recordings in this group are. `device`: on the camera only, so playing them needs an upload. `local_storage`: already uploaded to Navixy.","items":{"type":"string","enum":["device","local_storage"]}}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tracker/multimedia/video/interval/search":{"post":{"tags":["Trackers"],"summary":"Find periods with recordings","description":"Find the periods for which the cameras have recordings, grouped by day, hour or minute. Use it to see what is available before you request a recording with `tracker/multimedia/video/search`. Only regular recordings are counted, not event clips.\n\nThe cameras in `cameras` are combined into one result, so call once per camera to see each one separately. Groups follow the account timezone. A group is included when it starts inside the period.\n\nFor a device model without video support, the list is empty rather than an error.\n\nRequires the `video_monitoring` right.","operationId":"trackerMultimediaVideoIntervalSearch","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked."},"from":{"type":"string","description":"Start of the period, in the account timezone."},"to":{"type":"string","description":"End of the period. Must not be before `from`. The period may be up to 120 days long."},"cameras":{"type":"array","description":"Cameras to search. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has.","items":{"type":"string","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]}},"group_by":{"type":"string","description":"Optional. Default `day`. How to group the periods.","enum":["day","hour","minute"]}},"required":["tracker_id","from","to","cameras"]}}}},"responses":{"200":{"description":"The periods with recordings","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","description":"One item per group. Empty when there are no recordings.","items":{"$ref":"#/components/schemas/VideoCoverage"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the user lacks the `video_monitoring` right. Error 201: no tracker with this ID belongs to the account. Error 208: the tracker exists but is blocked, normally because its tariff ended. Error 211: the period is longer than 120 days.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](https://navixy.com/docs/navixy-api/general/errors.md#error-codes):

* 13 - The user lacks the `video_monitoring` right.
* 201 - No tracker with this ID belongs to the account.
* 208 - The tracker exists but is blocked, normally because its tariff ended.
* 211 - The period is longer than 120 days.

***

## Ask the camera for its file list

> Ask the camera to report the recordings on its memory card. The call returns as soon as the request is sent. The recordings appear in \`tracker/multimedia/video/list\` and \`tracker/multimedia/video/interval/search\` once the camera answers.\
> \
> Navixy also asks for the list on its own every 12 hours, so call this only when you need recordings newer than that.\
> \
> How the filters apply depends on the device:\
> \
> \* \*\*Jimi dashcams\*\* ignore the filters. Models with newer firmware, whose model code ends in \`\_fw163\`, report the last 30 days. Other Jimi models report the last 5 days.\
> \* \*\*Howen video recorders\*\* apply the filters. Without filters they report regular recordings and event clips from all channels, starting 24 hours ago.\
> \
> Requires the \`video\_monitoring\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Trackers","description":"Trackers, the devices the platform tracks, together with the geo links that share their live location with people outside the account. Resources under the /tracker/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tracker/multimedia/file/search/create":{"post":{"tags":["Trackers"],"summary":"Ask the camera for its file list","description":"Ask the camera to report the recordings on its memory card. The call returns as soon as the request is sent. The recordings appear in `tracker/multimedia/video/list` and `tracker/multimedia/video/interval/search` once the camera answers.\n\nNavixy also asks for the list on its own every 12 hours, so call this only when you need recordings newer than that.\n\nHow the filters apply depends on the device:\n\n* **Jimi dashcams** ignore the filters. Models with newer firmware, whose model code ends in `_fw163`, report the last 30 days. Other Jimi models report the last 5 days.\n* **Howen video recorders** apply the filters. Without filters they report regular recordings and event clips from all channels, starting 24 hours ago.\n\nRequires the `video_monitoring` right.","operationId":"trackerMultimediaFileSearchCreate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked."},"start_date":{"type":"string","description":"Optional. Start of the period to report."},"end_date":{"type":"string","description":"Optional. End of the period to report."},"file_types":{"type":"array","description":"Optional. Default `video` and `alarm_video`. Kinds of files to report.","items":{"type":"string","enum":["video","alarm_video","photo","alarm_photo","config","unknown"]}},"cameras":{"type":"array","description":"Optional. Cameras to report. All cameras when absent. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has.","items":{"type":"string","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]}}},"required":["tracker_id"]}}}},"responses":{"200":{"description":"The request was sent to the camera","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the user lacks the `video_monitoring` right. Error 201: no tracker with this ID belongs to the account. Error 208: the tracker exists but is blocked, normally because its tariff ended. Error 213: the device is offline. Error 214: the device model can't report its files. Error 8: the request could not be passed to the device, retry later.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](https://navixy.com/docs/navixy-api/general/errors.md#error-codes):

* 8 - The request could not be passed to the device. Retry later.
* 13 - The user lacks the `video_monitoring` right.
* 201 - No tracker with this ID belongs to the account.
* 208 - The tracker exists but is blocked, normally because its tariff ended.
* 213 - The device is offline.
* 214 - The device model can't report its files.

***

## Start a live stream

> Ask the camera to start streaming live video, and get an HLS playlist address for each requested camera. The stream uses the camera's mobile data until it is stopped with \`tracker/multimedia/video/live\_stream/delete\`.\
> \
> A Jimi dashcam streams the camera requested when there is one, and both cameras when \`cameras\` has both.\
> \
> Requires the \`video\_monitoring\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Trackers","description":"Trackers, the devices the platform tracks, together with the geo links that share their live location with people outside the account. Resources under the /tracker/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"VideoStream":{"type":"object","description":"A live stream from one camera.","properties":{"link":{"type":"string","description":"Playlist address of the stream, in [HLS](https://datatracker.ietf.org/doc/html/rfc8216) (HTTP Live Streaming) format. The address is returned before the camera starts sending, so the playlist can take a few seconds to become available."},"camera":{"type":"string","description":"The camera this stream comes from. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has.","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tracker/multimedia/video/live_stream/create":{"post":{"tags":["Trackers"],"summary":"Start a live stream","description":"Ask the camera to start streaming live video, and get an HLS playlist address for each requested camera. The stream uses the camera's mobile data until it is stopped with `tracker/multimedia/video/live_stream/delete`.\n\nA Jimi dashcam streams the camera requested when there is one, and both cameras when `cameras` has both.\n\nRequires the `video_monitoring` right.","operationId":"trackerMultimediaVideoLiveStreamCreate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked."},"cameras":{"type":"array","description":"Cameras to stream. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has.","items":{"type":"string","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]}}},"required":["tracker_id","cameras"]}}}},"responses":{"200":{"description":"The stream addresses","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"video_streams":{"type":"array","description":"One stream per requested camera.","items":{"$ref":"#/components/schemas/VideoStream"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the user lacks the `video_monitoring` right. Error 201: no tracker with this ID belongs to the account. Error 208: the tracker exists but is blocked, normally because its tariff ended. Error 213: the device is offline. Error 214: the device model has no live video, or lacks one of the requested cameras. Error 8: the request could not be passed to the device, retry later.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](https://navixy.com/docs/navixy-api/general/errors.md#error-codes):

* 8 - The request could not be passed to the device. Retry later.
* 13 - The user lacks the `video_monitoring` right.
* 201 - No tracker with this ID belongs to the account.
* 208 - The tracker exists but is blocked, normally because its tariff ended.
* 213 - The device is offline.
* 214 - The device model has no live video, or lacks one of the requested cameras.

***

## Stop a live stream

> Ask the camera to stop streaming live video. The playlist address can keep answering for some minutes after the stop, with no new video in it.\
> \
> How it applies depends on the device:\
> \
> \* \*\*Jimi dashcams\*\* stop every camera, whatever \`cameras\` lists.\
> \* \*\*Howen video recorders\*\* don't receive a stop request, although the call succeeds.\
> \
> Requires the \`video\_monitoring\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Trackers","description":"Trackers, the devices the platform tracks, together with the geo links that share their live location with people outside the account. Resources under the /tracker/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tracker/multimedia/video/live_stream/delete":{"post":{"tags":["Trackers"],"summary":"Stop a live stream","description":"Ask the camera to stop streaming live video. The playlist address can keep answering for some minutes after the stop, with no new video in it.\n\nHow it applies depends on the device:\n\n* **Jimi dashcams** stop every camera, whatever `cameras` lists.\n* **Howen video recorders** don't receive a stop request, although the call succeeds.\n\nRequires the `video_monitoring` right.","operationId":"trackerMultimediaVideoLiveStreamDelete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked."},"cameras":{"type":"array","description":"Optional. Cameras to stop. A Jimi dashcam has `front_camera` and `inward_camera`. A Howen video recorder has `channel_1` up to the number of channels its model has.","items":{"type":"string","enum":["front_camera","inward_camera","channel_1","channel_2","channel_3","channel_4","channel_5","channel_6","channel_7","channel_8"]}}},"required":["tracker_id"]}}}},"responses":{"200":{"description":"The stop request was sent","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 13: the user lacks the `video_monitoring` right. Error 201: no tracker with this ID belongs to the account. Error 208: the tracker exists but is blocked, normally because its tariff ended. Error 213: the device is offline. Error 214: the device model has no live video, or lacks one of the requested cameras. Error 8: the request could not be passed to the device, retry later.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](https://navixy.com/docs/navixy-api/general/errors.md#error-codes):

* 8 - The request could not be passed to the device. Retry later.
* 13 - The user lacks the `video_monitoring` right.
* 201 - No tracker with this ID belongs to the account.
* 208 - The tracker exists but is blocked, normally because its tariff ended.
* 213 - The device is offline.
* 214 - The device model has no live video, or lacks one of the requested cameras.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/multimedia.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
