Skip to main content
GET
/
files
Get list of uploaded files
curl --request GET \
  --url https://api.vidnavigator.com/v1/files \
  --header 'X-API-Key: <api-key>'
{
  "status": "success",
  "data": {
    "files": [
      {
        "id": "<string>",
        "name": "<string>",
        "size": 123,
        "type": "<string>",
        "duration": 123,
        "status": "pending",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "original_file_date": "2023-11-07T05:31:56Z",
        "has_transcript": true,
        "error_message": "<string>"
      }
    ],
    "total_count": 123,
    "limit": 123,
    "offset": 123,
    "has_more": true
  }
}
Retrieve a paginated list of all audio/video files you have uploaded.

​
Overview

Use this endpoint to get basic information on every file you have uploaded, including status and metadata. Supports pagination with limit and offset query parameters.

​
Query Parameters

  • limit (integer, default 50): Maximum number of files to return (1-100)
  • offset (integer, default 0): Number of files to skip for pagination
  • status (string): Filter by processing status (pending, processing, completed, failed, cancelled)

​
Example Request

cURL
curl -G "https://api.vidnavigator.com/v1/files" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "limit=25" \
  --data-urlencode "offset=0" \
  --data-urlencode "status=completed"

​
Success Response

{
  "status": "success",
  "data": {
    "files": [
      {
        "id": "file_abc123",
        "name": "session.mp4",
        "size": 15728640,
        "type": "video/mp4",
        "duration": 330,
        "status": "completed",
        "created_at": "2024-01-15T10:00:00Z",
        "updated_at": "2024-01-15T10:00:00Z",
        "has_transcript": true
      }
    ],
    "total_count": 1,
    "limit": 25,
    "offset": 0,
    "has_more": false
  }
}

Authorizations

​
X-API-Key
string
header
required

API key authentication. Include your VidNavigator API key in the X-API-Key header.

Query Parameters

​
limit
integer
default:50

Maximum number of files to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of files to skip for pagination

Required range: x >= 0
​
status
enum<string>

Filter by file status

Available options:
processing,
completed,
failed,
cancelled

Response

Files retrieved successfully

​
status
enum<string>
Available options:
success
​
data
object