# CVAT Functions API

**Canonical:** https://apis.io/apis/cvat/cvat-functions-api/  
**Provider:** CVAT — https://apis.io/providers/cvat/  
**Base URL:** https://app.cvat.ai/api  
**Documentation:** https://app.cvat.ai/api/docs/

CVAT Functions API is one of 28 APIs that [CVAT](https://apis.io/providers/cvat/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Functions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The functions API from CVAT — 12 operation(s) for functions.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/functions` | List functions |
| POST | `/api/functions` | Create a function |
| GET | `/api/functions/{id}` | Get function details |
| DELETE | `/api/functions/{id}` | Delete a function |
| GET | `/api/functions/{id}/preview` | Get a preview image for a function |
| POST | `/api/functions/{id}/run` | Run an interactive annotation request |
| GET | `/api/functions/info` | Get function provider metainformation |
| POST | `/api/functions/queues/{id}/requests/{request_id}/complete` | Complete an annotation request |
| POST | `/api/functions/queues/{id}/requests/{request_id}/fail` | Fail an annotation request |
| POST | `/api/functions/queues/{id}/requests/{request_id}/update` | Update an annotation request |
| POST | `/api/functions/queues/{id}/requests/acquire` | Acquire an annotation request from a queue |
| GET | `/api/functions/queues/{id}/watch` | Watch a queue |
| GET | `/api/functions/requests/` | List annotation requests |
| POST | `/api/functions/requests/` | Submit a batch annotation request |
| GET | `/api/functions/requests/{request_id}` | Get annotation request details |
| DELETE | `/api/functions/requests/{request_id}` | Cancel an annotation request |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cvat/refs/heads/main/openapi/cvat-functions-api-openapi.yml
- **Documentation** — https://docs.cvat.ai/docs/api_sdk/api/
- **APIReference** — https://app.cvat.ai/api/docs/
- **PostmanCollection** — https://raw.githubusercontent.com/api-evangelist/cvat/refs/heads/main/collections/cvat.postman_collection.json
- **OpenCollection** — https://raw.githubusercontent.com/api-evangelist/cvat/refs/heads/main/collections/cvat.opencollection.json
- **GitHub** — https://github.com/cvat-ai/cvat
- **Documentation** — https://docs.cvat.ai/docs/api_sdk/sdk/reference/apis/tasks-api/
- **Documentation** — https://docs.cvat.ai/docs/api_sdk/sdk/reference/apis/jobs-api/

## Other CVAT APIs (12)

- [CVAT Cloudstorages API](https://apis.io/apis/cvat/cvat-cloudstorages-api/)
- [CVAT Jobs API](https://apis.io/apis/cvat/cvat-jobs-api/)
- [CVAT Labels API](https://apis.io/apis/cvat/cvat-labels-api/)
- [CVAT Memberships API](https://apis.io/apis/cvat/cvat-memberships-api/)
- [CVAT Organizations API](https://apis.io/apis/cvat/cvat-organizations-api/)
- [CVAT Projects API](https://apis.io/apis/cvat/cvat-projects-api/)
- [CVAT Tasks API](https://apis.io/apis/cvat/cvat-tasks-api/)
- [CVAT Analytics API](https://apis.io/apis/cvat/cvat-analytics-api/)
- [CVAT Assets API](https://apis.io/apis/cvat/cvat-assets-api/)
- [CVAT Auth API](https://apis.io/apis/cvat/cvat-auth-api/)
- [CVAT Comments API](https://apis.io/apis/cvat/cvat-comments-api/)
- [CVAT Consensus API](https://apis.io/apis/cvat/cvat-consensus-api/)

## Tags

Functions

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cvat/cvat-functions-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cvat/.