Platform Integration API Reference CLI Benchmarks

Files

Get a single file

Retrieve details of a specific file by its ID, including metadata, media properties, and associated jobs.

GET

/api/files/{fileId}

Authorization

Authorization

header

string

required

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

Path Parameters

fileId

string

required

File ID

Responses

application/json

data

object

required

Data contains the response object

status

"success"

string

required

Status indicates the response status "success"

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"

Resource not found

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',
});

const file = await client.files.retrieve('fileId');

console.log(file);
from chunkify import Chunkify

client = Chunkify(
    project_access_token="My Project Access Token",
)
file = client.files.retrieve(
    "fileId",
)
print(file)
<?php

use Chunkify\Client;

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

$file = $client->files->retrieve('fileId');

var_dump($file);
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"),
  )
  file, err := client.Files.Get(context.TODO(), "fileId")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", file)
}

{
  "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
  },
  "status": "success"
}
{
  "error": {
    "code": 401,
    "message": "Authentication error: invalid token or subscription inactive",
    "type": "AuthenticationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 404,
    "message": "Ressource not found",
    "type": "NotFoundError"
  },
  "status": "error"
}
{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded",
    "type": "TooManyRequestsError"
  },
  "status": "error"
}

# Get a single file > Retrieve details of a specific file by its ID, including metadata, media properties, and associated jobs. ```json { "path": "/api/files/{fileId}", "method": "get", "schema": { "description": "Retrieve details of a specific file by its ID, including metadata, media properties, and associated jobs.", "operationId": "getFile", "parameters": [ { "description": "File ID", "in": "path", "name": "fileId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponse" } } }, "description": "OK" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorAuthentication" } } }, "description": "Authentication error: invalid token or subscription inactive" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorNotFound" } } }, "description": "Resource not found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorTooManyRequests" } } }, "description": "Rate limit exceeded" } }, "security": [ { "ProjectAccessToken": [] } ], "summary": "Get a single file", "tags": [ "Files" ], "x-codeSamples": [ { "lang": "JavaScript", "source": "import Chunkify from '@chunkify/chunkify';\n\nconst client = new Chunkify({\n projectAccessToken: 'My Project Access Token',\n});\n\nconst file = await client.files.retrieve('fileId');\n\nconsole.log(file);" }, { "lang": "Python", "source": "from chunkify import Chunkify\n\nclient = Chunkify(\n project_access_token=\"My Project Access Token\",\n)\nfile = client.files.retrieve(\n \"fileId\",\n)\nprint(file)" }, { "lang": "php", "source": "\u003c?php\n\nuse Chunkify\\Client;\n\n$client = new Client(\n projectAccessToken: 'My Project Access Token',\n);\n\n$file = $client-\u003efiles-\u003eretrieve('fileId');\n\nvar_dump($file);" }, { "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 file, err := client.Files.Get(context.TODO(), \"fileId\")\n if err != nil {\n panic(err.Error())\n }\n fmt.Printf(\"%+v\\n\", file)\n}\n" } ] } } ``` ```json #/components/schemas/ResponseErrorNotFound { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 404, "description": "Code is the HTTP status code", "examples": [ 404 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Ressource not found" ], "type": "string" }, "type": { "const": "NotFoundError", "description": "Type indicates the error category", "enum": [ "NotFoundError" ], "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" } ``` ```json #/components/schemas/FileResponse { "description": "Successful response", "properties": { "data": { "$ref": "#/components/schemas/File", "description": "Data contains the response object" }, "status": { "const": "success", "description": "Status indicates the response status \"success\"", "type": "string" } }, "required": [ "status", "data" ], "type": "object" } ``` ```json #/components/schemas/File { "properties": { "audio_bitrate": { "description": "Audio bitrate in bits per second", "examples": [ 128000 ], "type": "integer" }, "audio_codec": { "description": "Audio codec used", "examples": [ "aac" ], "type": "string" }, "cdn_url": { "description": "Stable, unsigned CDN delivery URL derived from the file's current storage configuration. Omitted when no CDN base URL is configured.", "examples": [ "https://media.example.com/path/to/file.mp4" ], "format": "uri", "nullable": true, "type": "string" }, "created_at": { "description": "Timestamp when the file was created", "examples": [ "2025-01-01T12:00:00Z" ], "format": "date-time", "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 file", "examples": [ "file_2G6MJiNz71bHQGNzGwKx5cJwPFS" ], "type": "string" }, "job_id": { "description": "ID of the job that created this file", "examples": [ "job_2G6MJiNz71bHQGNzGwKx5cJwPFS" ], "type": "string" }, "mime_type": { "description": "MIME type of the file", "examples": [ "video/mp4" ], "type": "string" }, "path": { "description": "Path to the file in storage", "examples": [ "path/to/file.mp4" ], "type": "string" }, "size": { "description": "Size of the file in bytes", "examples": [ 1234567 ], "type": "integer" }, "storage_id": { "description": "StorageId identifier where the file is stored", "examples": [ "stor_chunkify_2wLmj1fp8neUaFAWwwxvzKAT0Fa" ], "type": "string" }, "url": { "description": "Pre-signed URL to directly access the file (only included when available)", "examples": [ "https://my-bucket.s3.us-east-1.amazonaws.com/path/to/file.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256" ], "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": [ "id", "job_id", "storage_id", "path", "size", "mime_type", "duration", "width", "height", "video_bitrate", "video_codec", "video_framerate", "audio_codec", "audio_bitrate", "created_at", "url" ], "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" } ```