Label Studio API参考文档
您可以使用Label Studio API导入待标注数据、导出标注结果、配置机器学习功能,并与云存储同步任务。
查看API参考文档获取更多指导和交互式示例。如果想使用API编写Python脚本,请使用Label Studio Python SDK。
提示
如需获取使用我们API的更多指导,请参阅5 Tips and Tricks for Label Studio’s API and SDK。
API认证
您必须获取访问令牌才能向API进行身份验证。
- 在Label Studio界面中,点击右上角的用户图标。
- 点击账户与设置。
- 复制访问令牌。更多信息请参阅Access tokens。
在您的首次API调用中,请在请求头中指定访问令牌:
curl -X <method> <Label Studio URL>/api/<endpoint> -H 'Authorization: Bearer <token>'
查看API文档以进行身份验证。
列出所有项目
要使用Label Studio API执行大多数任务,您必须指定项目ID,有时也称为pk
或主键。如果您不知道项目ID是什么,可能需要获取您可访问的Label Studio中所有项目的列表。请参阅列出您的项目API端点文档。
创建并设置项目
使用API在Label Studio中创建项目并设置标注界面。详情请参阅创建新项目API端点文档。
如果希望在通过API提交前确保标注界面的配置有效,可以使用validate label config API端点进行验证。
通过API导入任务
要通过API导入任务,请确保您知道要添加任务的项目ID。更多示例和参数说明请参阅导入数据端点文档
获取任务
获取特定项目的分页任务列表。如果需要,您也可以使用此API端点来获取任务和标注,作为导出标注的替代方案。详情和参数请参阅列出项目任务端点文档。
导出标注
要导出标注,首先请查看您的项目支持哪些导出格式。
从响应中选择您所需的格式,然后调用导出接口。详情请参阅导出标注接口文档。