Platform Integration API Reference CLI Benchmarks

Sources

Get all sources

Retrieve a list of all sources with optional filtering and pagination. Supports filtering by various media properties like duration, dimensions, codecs, etc.

GET

/api/sources

Authorization

Authorization

header

string

required

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

Query Parameters

id

string

Filter by source 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

Required range: 0 <= x <= 8192

width.gte

integer

Filter by width greater than or equal

Required range: 0 <= x <= 8192

width.gt

integer

Filter by width greater than

Required range: 0 <= x <= 8192

width.lte

integer

Filter by width less than or equal

Required range: 0 <= x <= 8192

width.lt

integer

Filter by width less than

Required range: 0 <= x <= 8192

height.eq

integer

Filter by exact height

Required range: 0 <= x <= 8192

height.gte

integer

Filter by height greater than or equal

Required range: 0 <= x <= 8192

height.gt

integer

Filter by height greater than

Required range: 0 <= x <= 8192

height.lte

integer

Filter by height less than or equal

Required range: 0 <= x <= 8192

height.lt

integer

Filter by height less than

Required range: 0 <= x <= 8192

size.eq

integer

Filter by exact file size

Required range: x >= 0

size.gte

integer

Filter by file size greater than or equal

Required range: x >= 0

size.gt

integer

Filter by file size greater than

Required range: x >= 0

size.lte

integer

Filter by file size less than or equal

Required range: x >= 0

size.lt

integer

Filter by file size less than

Required range: x >= 0

audio_codec

string

Filter by audio codec

video_codec

string

Filter by video codec

device

string

Filter by device (apple/android)

Available options:

appleandroidunknown

created.sort

default: "asc"

string

Sort by creation date (asc/desc)

Available options:

ascdesc

metadata

array[]

Filter by metadata

Responses

application/json

data

object[]

required

Data contains the paginated source 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

OK

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 source of client.sources.list()) {
  console.log(source.id);
}
from chunkify import Chunkify

client = Chunkify(
    project_access_token="My Project Access Token",
)

# Automatically fetches more pages as needed.
for source in client.sources.list():
   print(source.id)
<?php

use Chunkify\Client;

$client = new Client(
    projectAccessToken: 'My Project Access Token',
);

// Automatically fetches more pages as needed.
foreach ($client->sources->list()->pagingEachItem() as $source) {
    var_dump($source->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.Sources.List(context.TODO(), chunkify.SourceListParams{})
  if err != nil {
    panic(err.Error())
  }

  // Loop through the pages and print the sources IDs
  for page != nil {
    for _, source := range page.Data {
      fmt.Printf("%+v\n", source.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",
      "device": "iPhone",
      "duration": 120,
      "height": 1080,
      "id": "src_2G6MJiNz71bHQGNzGwKx5cJwPFS",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "size": 1234567,
      "video_bitrate": 20000000,
      "video_codec": "h264",
      "video_framerate": 29.97,
      "width": 1920
    }
  ],
  "limit": "<integer>",
  "offset": "<integer>",
  "status": "success",
  "total": "<integer>"
}
{
  "error": {
    "code": 401,
    "message": "Authentication error: invalid token or subscription inactive",
    "type": "AuthenticationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded",
    "type": "TooManyRequestsError"
  },
  "status": "error"
}

# Get all sources > Retrieve a list of all sources with optional filtering and pagination. Supports filtering by various media properties like duration, dimensions, codecs, etc. ```json { "path": "/api/sources", "method": "get", "schema": { "description": "Retrieve a list of all sources with optional filtering and pagination. Supports filtering by various media properties like duration, dimensions, codecs, etc.", "operationId": "listSources", "parameters": [ { "description": "Filter by source ID", "in": "query", "name": "id", "schema": { "type": "string" } }, { "description": "Pagination offset", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Pagination limit (max 100)", "in": "query", "name": "limit", "schema": { "default": 100, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Filter by exact duration", "in": "query", "name": "duration.eq", "schema": { "minimum": 0, "type": "number" } }, { "description": "Filter by duration greater than or equal", "in": "query", "name": "duration.gte", "schema": { "minimum": 0, "type": "number" } }, { "description": "Filter by duration greater than", "in": "query", "name": "duration.gt", "schema": { "minimum": 0, "type": "number" } }, { "description": "Filter by duration less than or equal", "in": "query", "name": "duration.lte", "schema": { "minimum": 0, "type": "number" } }, { "description": "Filter by duration less than", "in": "query", "name": "duration.lt", "schema": { "minimum": 0, "type": "number" } }, { "description": "Filter by creation date greater than or equal (UNIX epoch time)", "in": "query", "name": "created.gte", "schema": { "examples": [ "1764238404" ], "format": "epoch", "minimum": 0, "type": "integer" } }, { "description": "Filter by creation date less than or equal (UNIX epoch time)", "in": "query", "name": "created.lte", "schema": { "examples": [ "1764238404" ], "format": "epoch", "minimum": 0, "type": "integer" } }, { "description": "Filter by exact width", "in": "query", "name": "width.eq", "schema": { "maximum": 8192, "minimum": 0, "type": "integer" } }, { "description": "Filter by width greater than or equal", "in": "query", "name": "width.gte", "schema": { "maximum": 8192, "minimum": 0, "type": "integer" } }, { "description": "Filter by width greater than", "in": "query", "name": "width.gt", "schema": { "maximum": 8192, "minimum": 0, "type": "integer" } }, { "description": "Filter by width less than or equal", "in": "query", "name": "width.lte", "schema": { "maximum": 8192, "minimum": 0, "type": "integer" } }, { "description": "Filter by width less than", "in": "query", "name": "width.lt", "schema": { "maximum": 8192, "minimum": 0, "type": "integer" } }, { "description": "Filter by exact height", "in": "query", "name": "height.eq", "schema": { "maximum": 8192, "minimum": 0, "type": "integer" } }, { "description": "Filter by height greater than or equal", "in": "query", "name": "height.gte", "schema": { "maximum": 8192, "minimum": 0, "type": "integer" } }, { "description": "Filter by height greater than", "in": "query", "name": "height.gt", "schema": { "maximum": 8192, "minimum": 0, "type": "integer" } }, { "description": "Filter by height less than or equal", "in": "query", "name": "height.lte", "schema": { "maximum": 8192, "minimum": 0, "type": "integer" } }, { "description": "Filter by height less than", "in": "query", "name": "height.lt", "schema": { "maximum": 8192, "minimum": 0, "type": "integer" } }, { "description": "Filter by exact file size", "in": "query", "name": "size.eq", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Filter by file size greater than or equal", "in": "query", "name": "size.gte", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Filter by file size greater than", "in": "query", "name": "size.gt", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Filter by file size less than or equal", "in": "query", "name": "size.lte", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Filter by file size less than", "in": "query", "name": "size.lt", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Filter by audio codec", "in": "query", "name": "audio_codec", "schema": { "type": "string" } }, { "description": "Filter by video codec", "in": "query", "name": "video_codec", "schema": { "type": "string" } }, { "description": "Filter by device (apple/android)", "in": "query", "name": "device", "schema": { "enum": [ "apple", "android", "unknown" ], "type": "string" } }, { "description": "Sort by creation date (asc/desc)", "in": "query", "name": "created.sort", "schema": { "default": "asc", "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Filter by metadata", "in": "query", "name": "metadata", "schema": { "items": { "items": { "examples": [ "key1:value1", "key2:value2" ], "pattern": "^[^:]+:[^:]+$", "type": "string" }, "type": "array" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceListResponse" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorAuthentication" } } }, "description": "Authentication error: invalid token or subscription inactive" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorTooManyRequests" } } }, "description": "Rate limit exceeded" } }, "security": [ { "ProjectAccessToken": [] } ], "summary": "Get all sources", "tags": [ "Sources" ], "x-codeSamples": [ { "lang": "JavaScript", "source": "import Chunkify from '@chunkify/chunkify';\n\nconst client = new Chunkify({\n projectAccessToken: 'My Project Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const source of client.sources.list()) {\n console.log(source.id);\n}" }, { "lang": "Python", "source": "from chunkify import Chunkify\n\nclient = Chunkify(\n project_access_token=\"My Project Access Token\",\n)\n\n# Automatically fetches more pages as needed.\nfor source in client.sources.list():\n print(source.id)" }, { "lang": "php", "source": "\u003c?php\n\nuse Chunkify\\Client;\n\n$client = new Client(\n projectAccessToken: 'My Project Access Token',\n);\n\n// Automatically fetches more pages as needed.\nforeach ($client-\u003esources-\u003elist()-\u003epagingEachItem() as $source) {\n var_dump($source-\u003eid);\n}" }, { "lang": "Go", "source": "package main\n\nimport (\n \"context\"\n \"fmt\"\n\n \"github.com/chunkifydev/chunkify-go\"\n \"github.com/chunkifydev/chunkify-go/option\"\n)\n\nfunc main() {\n client := chunkify.NewClient(\n option.WithProjectAccessToken(\"My Project Access Token\"),\n )\n page, err := client.Sources.List(context.TODO(), chunkify.SourceListParams{})\n if err != nil {\n panic(err.Error())\n }\n\n // Loop through the pages and print the sources IDs\n for page != nil {\n for _, source := range page.Data {\n fmt.Printf(\"%+v\\n\", source.ID)\n }\n page, err = page.GetNextPage()\n if err != nil {\n panic(err.Error())\n }\n }\n}\n" } ] } } ``` ```json #/components/schemas/SourceListResponse { "description": "Paginated response containing a list of sources", "properties": { "data": { "description": "Data contains the paginated source items", "items": { "$ref": "#/components/schemas/Source" }, "type": "array" }, "limit": { "description": "Limit indicates the maximum number of items in the current response", "type": "integer" }, "offset": { "description": "Offset indicates the offset of the first item in the current response", "type": "integer" }, "status": { "const": "success", "description": "Status indicates the response status \"success\"", "type": "string" }, "total": { "description": "Total indicates the total number of items", "type": "integer" } }, "required": [ "data", "limit", "offset", "status", "total" ], "type": "object" } ``` ```json #/components/schemas/Source { "properties": { "audio_bitrate": { "description": "Audio bitrate in bits per second", "examples": [ 128000 ], "type": "integer" }, "audio_codec": { "description": "Audio codec used", "examples": [ "aac" ], "type": "string" }, "created_at": { "description": "Timestamp when the source was created", "examples": [ "2025-01-01T12:00:00Z" ], "format": "date-time", "type": "string" }, "device": { "description": "Device used to record the video", "examples": [ "iPhone" ], "type": "string" }, "duration": { "description": "Duration of the video in seconds", "examples": [ 120 ], "type": "integer" }, "height": { "description": "Height of the video in pixels", "examples": [ 1080 ], "type": "integer" }, "id": { "description": "Unique identifier of the source", "examples": [ "src_2G6MJiNz71bHQGNzGwKx5cJwPFS" ], "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "Additional metadata for the source", "examples": [ { "key1": "value1", "key2": "value2" } ], "type": "object" }, "path": { "description": "Exact object key in the configured bucket, 1 to 1024 UTF-8 bytes. The output base_prefix is not added.", "maxLength": 1024, "minLength": 1, "type": "string" }, "size": { "description": "Size of the source file in bytes", "examples": [ 1234567 ], "type": "integer" }, "storage_id": { "description": "Connected Storage belonging to this Project.", "minLength": 1, "type": "string" }, "url": { "description": "URL where the source video can be accessed", "examples": [ "https://example.com/video.mp4" ], "type": "string" }, "video_bitrate": { "description": "Video bitrate in bits per second", "examples": [ 20000000 ], "type": "integer" }, "video_codec": { "description": "Video codec used", "examples": [ "h264" ], "type": "string" }, "video_framerate": { "description": "Video framerate in frames per second", "examples": [ 29.97 ], "type": "number" }, "width": { "description": "Width of the video in pixels", "examples": [ 1920 ], "type": "integer" } }, "required": [ "audio_bitrate", "audio_codec", "created_at", "device", "duration", "height", "id", "metadata", "size", "video_bitrate", "video_codec", "video_framerate", "width" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorAuthentication { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 401, "description": "Code is the HTTP status code", "examples": [ 401 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Authentication error: invalid token or subscription inactive" ], "type": "string" }, "type": { "const": "AuthenticationError", "description": "Type indicates the error category", "enum": [ "AuthenticationError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorTooManyRequests { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 429, "description": "Code is the HTTP status code", "examples": [ 429 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Rate limit exceeded" ], "type": "string" }, "type": { "const": "TooManyRequestsError", "description": "Type indicates the error category", "enum": [ "TooManyRequestsError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ```