Platform Integration API Reference CLI Benchmarks

Projects

Get a single project

Retrieve details of a specific project by its slug

GET

/api/projects/{projectId}

Authorization

Authorization

header

string

required

Enter the team access token with the Bearer prefix, e.g. "Bearer team_access_token"

Path Parameters

projectId

string

required

Project 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({
  teamAccessToken: 'My Team Access Token',
});

const project = await client.projects.retrieve('projectId');

console.log(project);
from chunkify import Chunkify

client = Chunkify(
    team_access_token="My Team Access Token",
)
project = client.projects.retrieve(
    "projectId",
)
print(project)
<?php

use Chunkify\Client;

$client = new Client(
    teamAccessToken: 'My Team Access Token',
);

$project = $client->projects->retrieve('projectId');

var_dump($project);
package main

import (
  "context"
  "fmt"

  "github.com/chunkifydev/chunkify-go"
  "github.com/chunkifydev/chunkify-go/option"
)

func main() {
  client := chunkify.NewClient(
    option.WithTeamAccessToken("My Team Access Token"),
  )
  project, err := client.Projects.Get(context.TODO(), "projectId")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", project)
}

{
  "data": {
    "created_at": "2025-01-01T12:00:00Z",
    "id": "proj_2vPYfWPSk3Uejm1HHaMoDqogcVJ",
    "name": "My Video Project",
    "slug": "my-video-project",
    "storage_id": "stor_chunkify_S1cce6120E56e7Tu9ioP09Nhjk1"
  },
  "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 project > Retrieve details of a specific project by its slug ```json { "path": "/api/projects/{projectId}", "method": "get", "schema": { "description": "Retrieve details of a specific project by its slug", "operationId": "getProject", "parameters": [ { "description": "Project Id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResponse" } } }, "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": [ { "TeamAccessToken": [] } ], "summary": "Get a single project", "tags": [ "Projects" ], "x-codeSamples": [ { "lang": "JavaScript", "source": "import Chunkify from '@chunkify/chunkify';\n\nconst client = new Chunkify({\n teamAccessToken: 'My Team Access Token',\n});\n\nconst project = await client.projects.retrieve('projectId');\n\nconsole.log(project);" }, { "lang": "Python", "source": "from chunkify import Chunkify\n\nclient = Chunkify(\n team_access_token=\"My Team Access Token\",\n)\nproject = client.projects.retrieve(\n \"projectId\",\n)\nprint(project)" }, { "lang": "php", "source": "\u003c?php\n\nuse Chunkify\\Client;\n\n$client = new Client(\n teamAccessToken: 'My Team Access Token',\n);\n\n$project = $client-\u003eprojects-\u003eretrieve('projectId');\n\nvar_dump($project);" }, { "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.WithTeamAccessToken(\"My Team Access Token\"),\n )\n project, err := client.Projects.Get(context.TODO(), \"projectId\")\n if err != nil {\n panic(err.Error())\n }\n fmt.Printf(\"%+v\\n\", project)\n}\n" } ] } } ``` ```json #/components/schemas/ProjectResponse { "properties": { "data": { "$ref": "#/components/schemas/Project", "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/Project { "properties": { "created_at": { "description": "Timestamp when the project was created", "examples": [ "2025-01-01T12:00:00Z" ], "format": "date-time", "type": "string" }, "id": { "description": "Id is the unique identifier for the project.", "examples": [ "proj_2vPYfWPSk3Uejm1HHaMoDqogcVJ" ], "type": "string" }, "name": { "description": "Name of the project", "examples": [ "My Video Project" ], "type": "string" }, "slug": { "description": "Slug is the slug for the project.", "examples": [ "my-video-project" ], "type": "string" }, "storage_id": { "description": "StorageId identifier where project files are stored", "examples": [ "stor_chunkify_S1cce6120E56e7Tu9ioP09Nhjk1" ], "type": "string" } }, "required": [ "id", "name", "slug", "storage_id", "created_at" ], "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/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" } ```