Creating a Labeling Team¶
Function¶
This API is used to create a labeling team.
Debugging¶
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI¶
POST /v2/{project_id}/workforces
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
description | No | String | Labeling team description. The value contains 0 to 256 characters and does not support the following special characters: |
workforce_name | Yes | String | Labeling team name. The value contains 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). |
Response Parameters¶
Status code: 201
Parameter | Type | Description |
|---|---|---|
workforce_id | String | ID of a labeling team. |
Example Requests¶
The following is an example of how to create a labeling team. The labeling team name has been set to team-123.
{
"workforce_name" : "team-123",
"description" : "my team"
}
Example Responses¶
Status code: 201
Created
{
"workforce_id" : "ZUH8gqkjuaib8pxkDdz"
}
Status Codes¶
Status Code | Description |
|---|---|
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Error Codes¶
See Error Codes.