List all labeling sessions from a project
You can combine any of the parameters to filter the results.
Path Parameters
- project_id integer required
ID of the project
Query Parameters
- mode string
Labeling mode. Any combination of ANNOTATION or CORRECTION
- status string
Labeling status. Any of CREATED, STARTED, ANNOTATING, FAILED, FINISHED, SAMPLING, PREDICTING or DELETING
- 200
- 401
- 403
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema array
- created date-time
When the session was started.
- finished date-time
When the session was finished.
- document_count integer
Total of documents
- document_group_id integer
ID of the document group related to the session, if any
- organization_id integer
ID of the organization to which the session belongs.
- user_id integer
ID of the user to which the session belongs.
- project_id integer
ID of the project to which the session belongs.
- uuid uuid
The unique ID of the session.
- id integer
The ID of the session.
- name string
The session's name.
- progress float
The session's progress.
- model_id integer
The ID of the model used by that session. This property only makes sense for correction sessions
- status string
Possible values: [
CREATED
,STARTED
,ANNOTATING
,FAILED
,FINISHED
,SAMPLING
,PREDICTING
,DELETING
]The session's status.
- mode string
Possible values: [
ANNOTATION
,CORRECTION
]The session's mode.
- type string
Possible values: [
ABSA
,CLASS
,LABEL
,CLASSLABEL
]The session's classification type.
- description string
The session's description.
- classes string[]
All classes that belong to the session
- labels string[]
All labels that belong to the session
[
{
"created": "2023-11-02",
"finished": "2023-11-02",
"document_count": 100,
"document_group_id": 87,
"organization_id": 1,
"user_id": 1,
"project_id": 1,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": 1,
"name": "This is my first labeling session",
"progress": 87.7,
"model_id": 10,
"status": "CREATED",
"mode": "ANNOTATION",
"type": "ABSA",
"description": "string",
"classes": [
"Comfort"
],
"labels": [
"POS"
]
}
]
User is not authenticated. This means token is either not present or invalid
User does not have the minimal required project role "VIEWER"
Something is wrong with the API.