Videos
Model properties
- Name
id
- Type
- string
- Description
Unique identifier for the video.
- Name
is_ready
- Type
- boolean
- Description
Whether or not the video has been muted.
- Name
download_url
- Type
- timestamp
- Description
Timestamp of when the video was last active.
- Name
stream_url
- Type
- timestamp
- Description
Timestamp of when the video was last active.
- Name
metadata
- Type
- object
- Description
Timestamp of when the video was last opened by the authenticated user.
- Name
timestamp
- Type
- timestamp
- Description
Timestamp of when the video finished processing.
List all videos
This endpoint allows you to retrieve a paginated list of all your videos. By default, a maximum of ten videos are shown per page.
Optional attributes
- Name
limit
- Type
- integer
- Description
Limit the number of videos returned.
- Name
muted
- Type
- boolean
- Description
Only show videos that are muted when set to
true
.
Request
curl -G https://api.editframe.com/v2/videos \
-H "Authorization: Bearer {token}" \
-d limit=10
Response
{
"has_more": false,
"data": [
{
"id": "PgQQX3hrtZ",
"is_ready": true,
"download_url": "https://api.editframe.com/v2/videos/PgQQX3hrtZ/download",
"stream_url": "https://api.editframe.com/v2/videos/PgQQX3hrtZ/stream",
"metadata": { ... },
"timestamp": 692233200,
},
{
// ...
}
]
}
Retrieve a video
This endpoint allows you to retrieve an individual video by providing the video id. Refer to the list at the top of this page to see which properties are included with video objects.
Request
curl https://api.editframe.com/v2/videos/PgQQX3hrtZ \
-H "Authorization: Bearer {token}"
Response
{
"id": "PgQQX3hrtZ",
"is_ready": true,
"download_url": "https://api.editframe.com/v2/videos/PgQQX3hrtZ/download",
"stream_url": "https://api.editframe.com/v2/videos/PgQQX3hrtZ/stream",
"metadata": { ... },
"timestamp": 692233200,
},
Delete a video
This endpoint allows you to delete your videos in Editframe. Note: This will permanently delete the video model and the stored video file.
Request
curl -X DELETE https://api.editframe.com/v2/videos/PgQQX3hrtZ \
-H "Authorization: Bearer {token}"