Skip navigation
Kinescope help center

Projects and folders

Workspace structure for organizing content.

Projects

The project object

FieldTypeDescription
idstringUnique identifier for the object.
namestringProject name
folders[]FolderList project folders
created_atdatetime
updated_atdatetime

Create project

POST https://api.kinescope.io/v1/projects

Creates a new project. Returns the newly created object on success.

Create new project

FieldTypeDescription
namestringrequired
privacy_typestringrequired
privacy_domains[]stringrequired
player_iduuidnot required
encryptedbooleannot required
catalog_typestringvod or live
Request body (json)
{
  "name": "Project custom",
  "privacy_type": "custom",
  "privacy_domains": [
    "custom.domain.com"
  ],
  "player_id": "e51e55a1-7615-493e-9055-10ac9cc44ccd",
  "encrypted": false,
  "catalog_type": "vod"
}

Projects list

GET https://api.kinescope.io/v1/projects

Returns a list of projects. Results are paginated and can be filtered via query parameters.

Responses
{
 "meta": {
  "pagination": {
   "page": 1,
   "per_page": 100,
   "total": 34
  },
  "order": {"name":"asc"}
 },
 "data": [
  {
   "id": "<UUID>",
   "name": "111",
   "folders": [],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 38927956038,
   "items_count": 122,
   "created_at": "2022-11-08T13:32:22.466173Z",
   "updated_at": "2026-04-14T20:17:43.725423Z",
   "encrypted": true
  },
  {
   "id": "<UUID>",
   "name": "A-test",
   "folders": [],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 0,
   "items_count": 0,
   "created_at": "2026-04-03T11:48:48.599771Z",
   "updated_at": "2026-04-13T14:19:33.919518Z",
   "encrypted": false
  },
  {
   "id": "<UUID>",
   "name": "chat_history_forward_link_bug",
   "folders": [
    {
     "id": "<UUID>",
     "name": "  ",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 1723003012,
     "items_count": 2,
     "created_at": "2026-04-21T16:20:59.711708Z",
     "updated_at": null,
     "deleted_at": null
    }
   ],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 13277281933,
   "items_count": 4,
   "created_at": "2026-03-20T14:32:08.589836Z",
   "updated_at": "2026-04-13T14:19:32.35553Z",
   "encrypted": false
  },
  {
   "id": "<UUID>",
   "name": "Clearkey",
   "folders": [],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 5932541497,
   "items_count": 10,
   "created_at": "2024-09-25T06:55:35.484068Z",
   "updated_at": "2026-04-03T12:24:59.524157Z",
   "encrypted": true
  },
  {
   "id": "<UUID>",
   "name": "Codec Samples",
   "folders": [
    {
     "id": "<UUID>",
     "name": "AV1",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 120194940,
     "items_count": 9,
     "created_at": "2025-07-23T18:47:00.409285Z",
     "updated_at": null,
     "deleted_at": null
    },
    {
     "id": "<UUID>",
     "name": "H264",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 151215623,
     "items_count": 6,
     "created_at": "2025-07-23T15:16:26.447068Z",
     "updated_at": null,
     "deleted_at": null
    },
    {
     "id": "<UUID>",
     "name": "HEVC",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 122554144,
     "items_count": 9,
     "created_at": "2025-07-23T15:29:28.890618Z",
     "updated_at": null,
     "deleted_at": null
    },
    {
     "id": "<UUID>",
     "name": "VP9",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 208857361,
     "items_count": 9,
     "created_at": "2025-07-23T15:08:12.764331Z",
     "updated_at": null,
     "deleted_at": null
    }
   ],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 614998534,
   "items_count": 34,
   "created_at": "2025-07-23T15:00:22.560116Z",
   "updated_at": "2026-04-03T18:46:13.017069Z",
   "encrypted": false
  },
  {
   "id": "<UUID>",
   "name": "encr",
   "folders": [
    {
     "id": "<UUID>",
     "name": "123",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 372110777,
     "items_count": 1,
     "created_at": "2026-04-13T08:47:27.759934Z",
     "updated_at": null,
     "deleted_at": null
    }
   ],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 372110777,
   "items_count": 1,
   "created_at": "2026-01-22T14:37:32.142745Z",
   "updated_at": "2026-04-03T07:11:48.452395Z",
   "encrypted": true
  },
  {
   "id": "<UUID>",
   "name": "Encrypted",
   "folders": [
    {
     "id": "<UUID>",
     "name": "New folder",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 53543990,
     "items_count": 4,
     "created_at": "2022-09-27T13:53:53.850129Z",
     "updated_at": "2025-12-03T17:30:08.24509Z",
     "deleted_at": null
    }
   ],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 36641090232,
   "items_count": 74,
   "created_at": "2022-05-30T13:15:49.351933Z",
   "updated_at": "2026-04-03T07:11:46.900705Z",
   "encrypted": true
  },
  {
   "id": "<UUID>",
   "name": "Livekit",
   "folders": [],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 5715708552,
   "items_count": 60,
   "created_at": "2024-08-07T11:57:53.631918Z",
   "updated_at": "2024-11-13T08:36:09.921481Z",
   "encrypted": false
  },
  {
   "id": "<UUID>",
   "name": "Meetings",
   "folders": [],
   "privacy_type": "anywhere",
   "privacy_domains": [
    "druzh.ru"
   ],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 4260648813,
   "items_count": 63,
   "created_at": "2024-09-24T12:30:07.300799Z",
   "updated_at": "2025-05-05T18:17:43.426001Z",
   "encrypted": false
  },
  {
   "id": "<UUID>",
   "name": "My first project2",
   "folders": [
    {
     "id": "<UUID>",
     "name": "Test",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 0,
     "items_count": 0,
     "created_at": "2022-06-01T06:40:41.77392Z",
     "updated_at": null,
     "deleted_at": null
    },
    {
     "id": "<UUID>",
     "name": "Videos for test sites",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 1989379249,
     "items_count": 2,
     "created_at": "2021-11-29T15:25:12.484474Z",
     "updated_at": "2022-01-20T09:32:21.838166Z",
     "deleted_at": null
    },
    {
     "id": "<UUID>",
     "name": "new folder",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 742749555,
     "items_count": 14,
     "created_at": "2022-04-12T22:21:43.405874Z",
     "updated_at": null,
     "deleted_at": null
    },
    {
     "id": "<UUID>",
     "name": "test folder",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 18402007828,
     "items_count": 10,
     "created_at": "2021-02-08T10:35:42.310194Z",
     "updated_at": null,
     "deleted_at": null
    }
   ],
   "privacy_type": "nowhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 207273768257,
   "items_count": 339,
   "created_at": "2020-09-16T22:01:05.18814Z",
   "updated_at": "2025-12-24T14:15:41.832531Z",
   "encrypted": false
  },
  {
   "id": "<UUID>",
   "name": "New project Restream Speak",
   "folders": [],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 0,
   "items_count": 0,
   "created_at": "2025-05-26T14:10:17.55122Z",
   "updated_at": "2026-04-01T07:13:47.243006Z",
   "encrypted": false
  },
  {
   "id": "<UUID>",
   "name": "Restream VOD",
   "folders": [],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 556115506,
   "items_count": 4,
   "created_at": "2022-11-15T21:06:28.691855Z",
   "updated_at": null,
   "encrypted": false
  },
  {
   "id": "<UUID>",
   "name": "Speak Records",
   "folders": [
    {
     "id": "<UUID>",
     "name": "New folder",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 1846701232,
     "items_count": 2,
     "created_at": "2026-04-13T08:46:21.785564Z",
     "updated_at": null,
     "deleted_at": null
    }
   ],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 58643200289,
   "items_count": 216,
   "created_at": "2025-06-25T12:08:14.268278Z",
   "updated_at": null,
   "encrypted": false
  },
  {
   "id": "<UUID>",
   "name": "subtitles",
   "folders": [
    {
     "id": "<UUID>",
     "name": "New folder",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 578021274,
     "items_count": 3,
     "created_at": "2026-04-22T08:11:00.588416Z",
     "updated_at": null,
     "deleted_at": null
    }
   ],
   "privacy_type": "anywhere",
   "privacy_domains": [],
   "privacy_email_domains": [],
   "privacy_share": {
 
   },
   "player_id": "<UUID>",
   "favorite": false,
   "size": 578021274,
   "items_count": 1,
   "created_at": "2026-02-04T11:15:27.858112Z",
   "updated_at": "2026-04-13T14:19:39.710022Z",
   "encrypted": false
  },
  {
   "id": "<UUID>",
   "name": "Test",
   "folders": [
    {
     "id": "<UUID>",
     "name": "3",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 1519538159,
     "items_count": 2,
     "created_at": "2023-01-23T10:55:32.210786Z",
     "updated_at": null,
     "deleted_at": null
    },
    {
     "id": "<UUID>",
     "name": "111",
     "project_id": "<UUID>",
     "parent_id": "<UUID>",
     "size": 1494193183,
     "items_count": 2,
     "created_at": "2024-10-20T09:43:22.606387Z",
     "updated_at": null,
     "deleted_at": null
// … truncated

Get project

GET https://api.kinescope.io/v1/projects/:project_id

Retrieves the details of a single project by its unique ID.

Responses
{
  "data": {
    "id": "<UUID>",
    "name": "chat_history_forward_link_bug",
    "folders": [
      {
        "id": "<UUID>",
        "name": "  ",
        "project_id": "<UUID>",
        "parent_id": "<UUID>",
        "size": 1723003012,
        "items_count": 2,
        "created_at": "2026-04-21T16:20:59.711708Z",
        "updated_at": null,
        "deleted_at": null
      }
    ],
    "privacy_type": "anywhere",
    "privacy_domains": [],
    "privacy_email_domains": [],
    "privacy_share": {},
    "player_id": "<UUID>",
    "favorite": false,
    "size": 13277281933,
    "items_count": 4,
    "created_at": "2026-03-20T14:32:08.589836Z",
    "updated_at": "2026-04-13T14:19:32.35553Z",
    "encrypted": false
  }
}
{
  "error": {
    "code": 400404,
    "message": "not found"
  }
}

Update project

PUT https://api.kinescope.io/v1/projects/:project_id

Updates the specified project. Only fields provided in the request body are changed; others are left unchanged.

Request body (json)
{
  "name": "Project name updated",
  "privacy_type": "anywhere",
  "privacy_domains": [],
  "apply_to_videos": false,
  "player_id": "e51e55a1-7615-493e-9055-10ac9cc44ccd"
}
Responses
{
  "data": {
    "id": "<UUID>",
    "name": "Project name updated",
    "folders": [
      {
        "id": "<UUID>",
        "name": "New folder",
        "project_id": "<UUID>",
        "created_at": "2020-08-31T10:14:28.422193Z",
        "updated_at": null,
        "deleted_at": null
      }
    ],
    "created_at": "2020-06-04T21:08:35.432107Z",
    "updated_at": "2020-08-31T10:15:09.685516Z"
  }
}

Delete project

DELETE https://api.kinescope.io/v1/projects/:project_id

Permanently deletes the project. This action cannot be undone.

Folders

The folder object

FieldTypeDescription
idstringUnique identifier for the object.
namestringFolder name
project_idstring
created_atdatetime
updated_atdatetime

Create folder

POST https://api.kinescope.io/v1/projects/:project_id/folders

Creates a new folder. Returns the newly created object on success.

Request body (json)
{
  "name": "New folder 1",
  "parent_id": "<UUID>"
}
Responses
{
  "data": {
    "id": "spuavLLtW44iUmHbL75z2u",
    "name": "New folder",
    "project_id": "mNFQz2wYTBhLkPBCo9oS8m",
    "created_at": "2020-08-31T10:14:28.422193Z",
    "updated_at": null,
    "deleted_at": null
  }
}

Folders list

GET https://api.kinescope.io/v1/projects/:project_id/folders

Returns a list of folders. Results are paginated and can be filtered via query parameters.

Responses
{
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 10,
      "total": 1
    },
    "order": {
      "created_at": "desc"
    }
  },
  "data": [
    {
      "id": "<UUID>",
      "name": "  ",
      "project_id": "<UUID>",
      "parent_id": "<UUID>",
      "size": 1723003012,
      "items_count": 2,
      "created_at": "2026-04-21T16:20:59.711708Z",
      "updated_at": null,
      "deleted_at": null
    }
  ]
}

Get folder

GET https://api.kinescope.io/v1/projects/:project_id/folders/:folder_id

Retrieves the details of a single folder by its unique ID.

Responses
{
  "data": {
    "id": "<UUID>",
    "name": "  ",
    "project_id": "<UUID>",
    "parent_id": "<UUID>",
    "size": 1723003012,
    "items_count": 2,
    "created_at": "2026-04-21T16:20:59.711708Z",
    "updated_at": null,
    "deleted_at": null
  }
}
{
  "error": {
    "code": 400404,
    "message": "not found"
  }
}

Update folder

PUT https://api.kinescope.io/v1/projects/:project_id/folders/:folder_id

Updates the specified folder. Only fields provided in the request body are changed; others are left unchanged.

Request body (json)
{
  "name": "New folder updated"
}
Responses
{
  "data": {
    "id": "spuavLLtW44iUmHbL75z2u",
    "name": "New folder updated",
    "project_id": "mNFQz2wYTBhLkPBCo9oS8m",
    "created_at": "2020-08-31T10:14:28.422193Z",
    "updated_at": "2020-08-31T10:16:24.737994Z",
    "deleted_at": null
  }
}

Delete folder

DELETE https://api.kinescope.io/v1/projects/:project_id/folders/:folder_id

Permanently deletes the folder. This action cannot be undone.

Responses
{
  "data": {
    "id": "spuavLLtW44iUmHbL75z2u",
    "name": "New folder",
    "project_id": "mNFQz2wYTBhLkPBCo9oS8m",
    "created_at": "2020-08-31T10:14:28.422193Z",
    "updated_at": null,
    "deleted_at": null
  }
}