All URIs are relative to http://api.labelstud.io
| Method | HTTP request | Description |
|---|---|---|
| ApiTasksCreate | Post /api/tasks/ | Create task |
| ApiTasksDelete | Delete /api/tasks/{id}/ | Delete task |
| ApiTasksList | Get /api/tasks/ | Get tasks list |
| ApiTasksPartialUpdate | Patch /api/tasks/{id}/ | Update task |
| ApiTasksRead | Get /api/tasks/{id}/ | Get task |
BaseTask ApiTasksCreate(ctx, data) Create task
Create a new labeling task in Label Studio.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| data | BaseTask |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiTasksDelete(ctx, id) Delete task
Delete a task in Label Studio. This action cannot be undone!
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Task ID |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]BaseTask ApiTasksList(ctx, optional) Get tasks list
Retrieve a list of tasks with pagination for a specific view or project, by using filters and ordering.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *TasksApiApiTasksListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a TasksApiApiTasksListOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| view | optional.Int32 | View ID | |
| project | optional.Int32 | Project ID | |
| resolveUri | optional.Bool | Resolve task data URIs using Cloud Storage |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskSimple ApiTasksPartialUpdate(ctx, data, id) Update task
Update the attributes of an existing labeling task.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| data | TaskSimple | ||
| id | string | Task ID |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataManagerTaskSerializer ApiTasksRead(ctx, id) Get task
Get task data, metadata, annotations and other attributes for a specific labeling task by task ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Task ID |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]