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.
Tip
For additional guidance on using our API, see 5 Tips and Tricks for Label Studio’s API and SDK.
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.