Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CVAT jobs API

Assignable annotation units that subdivide a task.

CVAT jobs API is one of 8 APIs that CVAT publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against 2 base URLs: https://app.cvat.ai/api, http://localhost:8080/api.

3 operations 2 paths 5 schemas 2 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://app.cvat.ai/api
Authentication
API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

CVAT jobs API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • tokenAuth — Token authentication. Send the header Authorization: Token where the key is obtained from POST /auth/login.
  • basicAuth — HTTP Basic authentication with CVAT username and password.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

jobs 3

Assignable annotation units that subdivide a task.

GET
/jobs
List jobs
jobs_list 3 params → 200
GET
/jobs/{id}
Retrieve a job
jobs_retrieve 1 param → 200
PATCH
/jobs/{id}
Update a job
jobs_partial_update 1 param body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Job (9 properties), PaginatedBase (4 properties), BasicUser (4 properties), JobWriteRequest (3 properties). Each schema is shown below with its type and property counts.

BasicUser
object
4 properties
Job
object
9 properties
PaginatedJobList
PaginatedBase
object
4 properties
JobWriteRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cvat-jobs-api-openapi.yml Raw ↑

Other APIs CVAT publishes across the network.

CVAT annotations API
CVAT cloudstorages API
CVAT labels API
CVAT memberships API
CVAT organizations API
CVAT projects API
CVAT tasks API