v1

latestOpenAPI 3.1.02026-07-266827131.9 KB

List Videos

post/serve/api/v1/list_videos

Request body

pageinteger

One-based page number. Must be > 0.

sizeinteger

Items per page. Must be > 0.

video_namestring

Exact-match filter on the stored video name.

video_nostring

Exact-match filter on a single video identifier.

video_nosstring[]

Restrict results to a specific set of video identifiers. Combined via AND with other filters; intersected with the metadata-filter result when both are used.

status'PARSE' | 'UNPARSE' | 'FAILED'

Filter by processing status.

camera_modelstring

Metadata filter: exact-match on the camera_model supplied at upload time.

tagstring

Metadata filter: single tag that must be present on the video.

datetime_takeninteger

Metadata filter: minimum capture timestamp in milliseconds since epoch. Matches videos whose capture_timestamp >= this value.

latitudenumber double

Metadata filter: decimal latitude. Must be supplied together with longitude.

longitudenumber double

Metadata filter: decimal longitude. Must be supplied together with latitude. ~20 km geo-within radius.

folder_idinteger

Optional. Restrict results to a single folder. Omit to query across your entire account. -1 is the Default folder; a positive id must belong to your account.

Example request

{
  "video_nos": [
    "VI606404158946574336",
    "VI606402870447996928"
  ],
  "camera_model": "Canon EOS 5D",
  "tag": "holiday",
  "datetime_taken": 1729388400000,
  "latitude": 39.9042,
  "longitude": 116.4074,
  "folder_id": 671631448308117500
}

Response

Successful response

codestring
msgstring
successboolean
failedboolean

Example response

{
  "code": "0000",
  "msg": "success",
  "data": {
    "current_page": 1,
    "page_size": 20,
    "total_count": 2,
    "videos": [
      {
        "video_no": "VI606404158946574336",
        "video_name": "182082-867762198_tiny",
        "duration": 12,
        "size": 3284512,
        "status": "PARSE",
        "create_time": 1754037217992,
        "datetime_taken": 1729388400000,
        "camera_model": "Canon EOS 5D",
        "latitude": 39.9042,
        "longitude": 116.4074,
        "tags": [
          "holiday",
          "beijing",
          "api"
        ],
        "bucket": "mavi-resource",
        "blob": "VI606404158946574336.mp4"
      },
      {
        "video_no": "VI606402870447996928",
        "video_name": "test_video_gz_visual_understanding_s36",
        "duration": 61,
        "size": 5324808,
        "status": "PARSE",
        "create_time": 1754036910783,
        "bucket": "mavi-resource",
        "blob": "VI606402870447996928.mp4"
      }
    ]
  },
  "success": true,
  "failed": false
}