Enterprise
Quick Start
Search...
/
API Reference
Tutorials
Introduction
Getting started
API Reference
Annotations
GET
Get annotation by its ID
DEL
Delete annotation
PATCH
Update an annotation
GET
Get all task annotations
POST
Create annotation
Users
POST
Reset user token
GET
Get user token
GET
Retrieve my user
GET
List users
POST
Create a user
GET
Get user info
DEL
Delete user
PATCH
Update user details
Actions
GET
Get actions
POST
Post actions
Views
GET
List views
POST
Create view
DEL
Delete all project views
GET
Get view details
DEL
Delete view
PATCH
Update view
Files
GET
Get file upload
DEL
Delete file upload
PATCH
Update file upload
GET
Get files list
DEL
Delete files
GET
Download file
Projects
GET
List all projects
POST
Create new project
GET
Get project by ID
DEL
Delete project
PATCH
Update a project
POST
Import tasks
POST
Validate project labeling config
Exports
GET
Easy export of tasks and annotations
GET
Get export formats
GET
List all export snapshots
POST
Create new export snapshot
GET
Get export snapshot by ID
DEL
Delete export snapshot
POST
Export conversion
GET
Download export snapshot
ML
GET
List ML backends
POST
Add ML backend
GET
Get ML backend
DEL
Remove ML backend
PATCH
Update ML backend
POST
Request interactive annotations
POST
Start training
GET
Get model versions
Predictions
GET
List predictions
POST
Create prediction
GET
Get prediction details
DEL
Delete prediction
PATCH
Update prediction
Tasks
GET
Get project import info
DEL
Delete all tasks
GET
Get task list
POST
Create task
GET
Get task
DEL
Delete task
PATCH
Update task
Import Storage
GET
List all import storages types
Azure
GET
List import storages
POST
Create new storage
POST
Validate import storage
GET
Get import storage
DEL
Delete import storage
PATCH
Update import storage
POST
Sync import storage
Gcs
GET
List import storages
POST
Create import storage
POST
Validate import storage
GET
Get import storage
DEL
Delete import storage
PATCH
Update import storage
POST
Sync import storage
Local
GET
List import storages
POST
Create import storage
POST
Validate import storage
GET
Get import storage
DEL
Delete import storage
PATCH
Update import storage
POST
Sync import storage
Redis
GET
List import storages
POST
Create import storage
POST
Validate import storage
GET
Get import storage
DEL
Delete import storage
PATCH
Update import storage
POST
Sync import storage
S3
GET
List import storages
POST
Create import storage
POST
Validate import storage
GET
Get import storage
DEL
Delete import storage
PATCH
Update import storage
POST
Sync import storage
S3s
GET
List import storages
POST
Create import storage
GET
Get import storage
DEL
Delete import storage
PATCH
Update import storage
POST
Validate import storage
POST
Sync import storage
Export Storage
GET
List all export storages types
Azure
GET
List export storages
POST
Create new storage
POST
Validate export storage
GET
Get export storage
DEL
Delete export storage
PATCH
Update export storage
POST
Sync export storage
Gcs
GET
List export storages
POST
Create new storage
POST
Validate export storage
GET
Get export storage
DEL
Delete export storage
PATCH
Update export storage
POST
Sync export storage
Local
GET
List export storages
POST
Create new storage
POST
Validate export storage
GET
Get export storage
DEL
Delete export storage
PATCH
Update export storage
POST
Sync export storage
Redis
GET
List export storages
POST
Create new storage
POST
Validate export storage
GET
Get export storage
DEL
Delete export storage
PATCH
Update export storage
POST
Sync export storage
S3
GET
List export storages
POST
Create new storage
POST
Validate export storage
GET
Get export storage
DEL
Delete export storage
PATCH
Update export storage
POST
Sync export storage
S3s
GET
List export storages
POST
Create export storage
GET
Get export storage
DEL
Delete export storage
PATCH
Update export storage
POST
Validate export storage
Webhooks
GET
List all webhooks
POST
Create a webhook
GET
Get all webhook actions
GET
Get webhook info
DEL
Delete webhook
PATCH
Update webhook info
Workspaces
GET
List workspaces
POST
Create workspace
GET
Get workspace
DEL
Delete workspace
PATCH
Update workspace
Members
GET
List workspace memberships
POST
Create workspace membership
DEL
Delete workspace membership
Enterprise
Quick Start
API Reference
Users
Retrieve my user
GET
http://
localhost:8080
/
api
/
current-user
/
whoami
Get information about your user account, such as your username, email, and user ID.
Response
This endpoint returns an object
username
string
id
integer
Optional
first_name
string
Optional
last_name
string
Optional
email
string
Optional
last_activity
datetime
Optional
avatar
string
Optional
initials
string
Optional
phone
string
Optional
active_organization
integer
Optional
allow_newsletters
boolean
Optional
Allow sending newsletters to user
Built with