guide
- Get started
- Label Studio features
- Billing & Usage
- Release notes
Security and Privacy
- Secure Label Studio
Install and Upgrade
- Install and upgrade Label Studio
- Database setup
- Start Label Studio
- Troubleshooting
Deploy and Install Enterprise
- Install Label Studio Enterprise
- Set up persistent storage
- Set up an ingress controller
- Install with Docker
- Deploy on Kubernetes
- Install on airgapped server
- Install on Amazon EKS
- Available Helm values
Manage Users
- Set up user accounts
- Manage access
- Set up authentication
- Set up SCIM2
Import Data
- Import data
- Import pre-annotations
- Cloud storage setup
Labeling and Projects
- Project setup
- Manage data
- Set up your labeling interface
- Label and annotate data
- Comments and notifications
Manage Annotations
- Review annotations
- Annotation statistics
- Custom agreement metric
- Export annotations
Machine Learning Setup
- Machine learning integration
- Write your own ML backend
- ML Examples and Tutorials
- Active learning loop
- Troubleshoot machine learning
Integrations
- Webhook Setup
- Webhooks Event Reference
- Custom Webhooks
- Python SDK Tutorial
- Backend API
Advanced Development
- Frontend library
- Frontend reference
- Update scripts and API calls
API Reference for Label Studio
You can use the Label Studio API to import data for labeling, export annotations, set up machine learning with Label Studio, and sync tasks with cloud storage.
See the API reference documentation for further guidance and interactive examples. If you want to write Python scripts using the API, use the Label Studio Python SDK.
The Label Studio Enterprise API shares many endpoints with the Label Studio Community Edition API, but includes extra payload options and additional endpoints specific to Enterprise features. Access the full Label Studio Enterprise API reference documentation by doing the following:
- Log in to Label Studio Enterprise
- Open the menu and click API
Authenticate to the API
You must retrieve your access token so that you can authenticate to the API.
- In the Label Studio UI, click the user icon in the upper right.
- Click Account & Settings.
- Copy the access token.
In your first API call, specify the access token in the headers:
curl -X <method> <Label Studio URL>/api/<endpoint> -H 'Authorization: Token <token>'
You can also retrieve the access token using the command line.
- From the command line, run the following:
label-studio user --username <username>
- In the output returned in your terminal, the token for the user is listed as part of the user info.
See API documentation for authentication.
List all projects
To perform most tasks with the Label Studio API, you must specify the project ID, sometimes referred to as the pk
, or primary key. If you don’t know what your project ID is, you might want to get a list of all projects in Label Studio that you can access. See the List your projects API endpoint documentation.
Create and set up a project
Create a project and set up the labeling interface in Label Studio using the API. See the Create new project API endpoint documentation.
If you want to make sure the configuration for your labeling interface is valid before submitting it using the API, you can use the validate label config API endpoint.
Import tasks using the API
To import tasks using the API, make sure you know the project ID that you want to add tasks to. See additional examples and parameter descriptions in the import data endpoint documentation
Retrieve tasks
Retrieve a paginated list of tasks for a specific project. If you want, you can also retrieve tasks and annotations using this API endpoint, as an alternative to exporting annotations. See details and parameters in the list project tasks endpoint documentation.
Export annotations
To export annotations, first see which formats are available to export for your project.
Choose your selected format from the response and then call the export endpoint. See the export annotations endpoint documentation for more details.

If you found an error, you can file an issue on GitHub!