This package provides a Javascript client library for the CVAT server. It can be useful for workflow automation and writing custom CVAT server clients.
The SDK API includes several layers:
- Server API wrappers. Located in at
cvat-sdk
. - TODO: High-level tools (
Core
). Located atcvat-sdk/core
.
Package documentation is available here.
To install a prebuilt package, run the following command in the terminal:
npm install cvat-sdk # or yarn add cvat-sdk
After installation, you can import the package:
import { Configuration, TasksApi } from 'cvat-sdk';
const configuration = new Configuration({
username: CONFIG.CVAT.USERNAME,
password: CONFIG.CVAT.PASSWORD,
});
const tasksApi = new TasksApi(configuration);
const task = await tasksApi.tasksRetrieve({
id: 1,
});