Skip to main content
POST
/
serve
/
api
/
v1
/
list_videos
List Videos
curl --request POST \
  --url https://api.memories.ai/serve/api/v1/list_videos \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "size": 200,
  "video_name": "<string>",
  "video_no": "<string>",
  "unique_id": "default",
  "status": "PARSE"
}
'
{
  "code": "0000",
  "msg": "success",
  "data": {},
  "success": true,
  "failed": false
}

​
Prerequisites

  • You have uploaded videos to the platform using the Upload API.
  • You have a valid memories.ai API key.

​
Host URL

https://api.memories.ai

​
Endpoint

POST /serve/api/v1/list_videos 
/serve/api/v1/list_videos

​
Request Example

import requests

headers = {
    "Authorization": "<API_KEY>"
}
json_body = { 
    "page": 1, 
    "size": 200, 
    "video_name": "<VIDEO_NAME>", 
    "video_no": "<VIDEO_ID>", 
    "unique_id": "<UNIQUE_ID>", 
    "status": "<STATUS>"
}
response = requests.post(
    "https://api.memories.ai/serve/api/v1/list_videos", 
    headers=headers, 
    json=json_body
)
print(response.json())

​
Request Parameters

​
page
integer
default:"1"
Page number.
​
size
integer
default:"200"
Number of items per page.
​
video_name
string
Filter by video name.
​
video_no
string
Filter by video ID.
​
unique_id
string
Filter by unique_id scope. defaults to “default”.
​
status
string
Filter by processing status (PARSE, UNPARSE, FAILED).

​
Response Example

{ 
    "code": "0000", 
    "msg": "success", 
    "data": { 
        "videos": [ 
            { 
                "duration": "12", 
                "size": "3284512", 
                "status": "PARSE", 
                "cause": "null", 
                "video_no": "VI606404158946574336", 
                "video_name": "182082-867762198_tiny", 
                "create_time": "1754037217992" 
            }, 
            { 
                "duration": "61", 
                "size": "5324808", 
                "status": "PARSE", 
                "cause": "null", 
                "video_no": "VI606402870447996928", 
                "video_name": "test_video_gz_visual_understanding_s36", 
                "create_time": "1754036910783" 
            }
        ], 
        "current_page": 1, 
        "page_size": 200, 
        "total_count": "3" 
    }, 
    "success": true, 
    "failed": false
}

​
Response Structure

The status field in the response can be:
  • PARSE: Video heavily processed and ready.
  • UNPARSE: Video uploaded but not fully processed.
  • FAILED: Processing failed.

Authorizations

​
Authorization
string
header
required

Body

application/json
​
page
integer
default:1
​
size
integer
default:200
​
video_name
string
​
video_no
string
​
unique_id
string
default:default
​
status
enum<string>
Available options:
PARSE,
UNPARSE,
FAILED

Response

200 - application/json

Successful response

​
code
Example:

"0000"

​
msg
string
Example:

"success"

​
data
​
success
boolean
Example:

true

​
failed
boolean
Example:

false