All URIs are relative to http://api.labelstud.io
| Method | HTTP request | Description |
|---|---|---|
| ApiAnnotationsDelete | Delete /api/annotations/{id}/ | Delete annotation |
| ApiAnnotationsPartialUpdate | Patch /api/annotations/{id}/ | Update annotation |
| ApiAnnotationsRead | Get /api/annotations/{id}/ | Get annotation by its ID |
| ApiTasksAnnotationsCreate | Post /api/tasks/{id}/annotations/ | Create annotation |
| ApiTasksAnnotationsList | Get /api/tasks/{id}/annotations/ | Get all task annotations |
ApiAnnotationsDelete(ctx, id) Delete annotation
Delete an annotation. This action can't be undone!
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | A unique integer value identifying this annotation. |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Annotation ApiAnnotationsPartialUpdate(ctx, id, data) Update annotation
Update existing attributes on an annotation.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | A unique integer value identifying this annotation. | |
| data | Annotation |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Annotation ApiAnnotationsRead(ctx, id) Get annotation by its ID
Retrieve a specific annotation for a task using the annotation result ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | A unique integer value identifying this annotation. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Annotation ApiTasksAnnotationsCreate(ctx, data, id) Create annotation
Add annotations to a task like an annotator does. The content of the result field depends on your labeling configuration. For example, send the following data as part of your POST request to send an empty annotation with the ID of the user who completed the task: json { \"result\": {}, \"was_cancelled\": true, \"ground_truth\": true, \"lead_time\": 0, \"task\": 0 \"completed_by\": 123 }
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| data | Annotation | ||
| id | int32 | Task ID |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Annotation ApiTasksAnnotationsList(ctx, id) Get all task annotations
List all annotations for a task.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | Task ID |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]