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 organizations API

Organizations scoping resources for teams.

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

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

This API exposes 4 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.

4 operations 2 paths 5 schemas 1 DELETE2 GET1 POST

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 organizations 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 4

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

organizations 4

Organizations scoping resources for teams.

GET
/organizations
List organizations
organizations_list 2 params → 200
POST
/organizations
Create an organization
organizations_create body → 201
GET
/organizations/{id}
Retrieve an organization
organizations_retrieve 1 param → 200
DELETE
/organizations/{id}
Delete an organization
organizations_destroy 1 param → 204

Schemas 5

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

BasicUser
object
4 properties
PaginatedOrganizationList
PaginatedBase
object
4 properties
OrganizationWriteRequest
object
3 properties 1 required
Organization
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cvat-organizations-api-openapi.yml Raw ↑

Other APIs CVAT publishes across the network.

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