Files

Get all files

Retrieve a list of files with optional filtering and pagination

GET

/api/files

Authorization

header

string

required

Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"

Query Parameters

string

Filter by file ID

offset

default: 0

integer

Pagination offset

Required range: x >= 0

limit

default: 100

integer

Pagination limit (max 100)

Required range: 1 <= x <= 100

duration.eq

number

Filter by exact duration

Required range: x >= 0

duration.gte

number

Filter by duration greater than or equal

Required range: x >= 0

duration.gt

number

Filter by duration greater than

Required range: x >= 0

duration.lte

number

Filter by duration less than or equal

Required range: x >= 0

duration.lt

number

Filter by duration less than

Required range: x >= 0

created.gte

integer

epoch

Filter by creation date greater than or equal (UNIX epoch time)

Required range: x >= 0

Examples:

1764238404

created.lte

integer

epoch

Filter by creation date less than or equal (UNIX epoch time)

Required range: x >= 0

Examples:

1764238404

width.eq

integer

Filter by exact width

width.gte

integer

Filter by width greater than or equal

width.gt

integer

Filter by width greater than

width.lte

integer

Filter by width less than or equal

width.lt

integer

Filter by width less than

height.eq

integer

Filter by exact height

height.gte

integer

Filter by height greater than or equal

Required range: 0 <= x <= 8192

height.gt

integer

Filter by height greater than

height.lte

integer

Filter by height less than or equal

height.lt

integer

Filter by height less than

size.eq

integer

Filter by exact file size

size.gte

integer

Filter by file size greater than or equal

size.gt

integer

Filter by file size greater than

size.lte

integer

Filter by file size less than or equal

size.lt

integer

Filter by file size less than

audio_codec

string

Filter by audio codec

video_codec

string

Filter by video codec

created.sort

default: "asc"

string

Sort by creation date (asc/desc)

Available options:

ascdesc

job_id

string

Filter by job ID

mime_type

string

Filter by mime type

storage_id

string

Filter by storage ID

path.eq

string

Filter by path

path.ilike

string

Filter by path (case insensitive)

Responses

application/json

data

object[]

required

Data contains the paginated file items

limit

integer

required

Limit indicates the maximum number of items in the current response

offset

integer

required

Offset indicates the offset of the first item in the current response

status

"success"

string

required

Status indicates the response status "success"

total

integer

required

Total indicates the total number of items

Successful response

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Authentication error: invalid token or subscription inactive

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Rate limit exceeded

import Chunkify from '@chunkify/chunkify'; const client = new Chunkify({ projectAccessToken: 'My Project Access Token', }); // Automatically fetches more pages as needed. for await (const file of client.files.list()) { console.log(file.id); }

from chunkify import Chunkify client = Chunkify( project_access_token="My Project Access Token", ) # Automatically fetches more pages as needed. for file in client.files.list(): print(file.id)

<?php use Chunkify\Client; $client = new Client( projectAccessToken: 'My Project Access Token', ); // Automatically fetches more pages as needed. foreach ($client->files->list()->pagingEachItem() as $file) { var_dump($file->id); }

package main import ( "context" "fmt" "github.com/chunkifydev/chunkify-go" "github.com/chunkifydev/chunkify-go/option" ) func main() { client := chunkify.NewClient( option.WithProjectAccessToken("My Project Access Token"), ) page, err := client.Files.List(context.TODO(), chunkify.FileListParams{}) if err != nil { panic(err.Error()) } // Loop through the pages and print the file IDs for page != nil { for _, file := range page.Data { fmt.Printf("%+v\n", file.ID) } page, err = page.GetNextPage() if err != nil { panic(err.Error()) } } }

{ "data": [ { "audio_bitrate": 128000, "audio_codec": "aac", "created_at": "2025-01-01T12:00:00Z", "duration": 120, "height": 1080, "id": "file_2G6MJiNz71bHQGNzGwKx5cJwPFS", "job_id": "job_2G6MJiNz71bHQGNzGwKx5cJwPFS", "mime_type": "video/mp4", "path": "path/to/file.mp4", "size": 1234567, "storage_id": "stor_chunkify_2wLmj1fp8neUaFAWwwxvzKAT0Fa", "url": "https://my-bucket.s3.us-east-1.amazonaws.com/path/to/file.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256", "video_bitrate": 20000000, "video_codec": "h264", "video_framerate": 29.97, "width": 1920 } ], "limit": "<integer>", "offset": "<integer>", "status": "success", "total": "<integer>" }