For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
EnterpriseQuick Start
API ReferenceTutorials
  • Introduction
    • Getting started
  • API Reference
      • GETList projects
      • POSTCreate a project
      • GETList projects' counts
      • GETGet project by ID
      • DELDelete project
      • PATCHUpdate project details
      • GETList unique annotators for project
      • POST✨ Duplicate project
      • POSTImport tasks
      • POSTImport predictions
      • POSTValidate project label config
LogoLogo
EnterpriseQuick Start
API ReferenceProjects

Get project by ID

GET
http://localhost:8000/api/projects/:id/
GET
/api/projects/:id/
$curl http://localhost:8000/api/projects/1/ \
>     -H "Authorization: Token  <api_key>" \
>     -H "Content-Type: application/json"
200Retrieved
1{
2  "allow_stream": true,
3  "assignment_settings": {
4    "id": 1,
5    "label_stream_task_distribution": "auto_distribution",
6    "project": 1
7  },
8  "config_has_control_tags": true,
9  "config_suitable_for_bulk_annotation": true,
10  "created_at": "2024-01-15T09:30:00Z",
11  "data_types": {
12    "text": "string",
13    "image": "url"
14  },
15  "finished_task_number": 150,
16  "ground_truth_number": 20,
17  "id": 1,
18  "is_dimensions_enabled": "enabled",
19  "members": "Alice, Bob, Charlie",
20  "members_count": 3,
21  "num_tasks_with_annotations": 140,
22  "parsed_label_config": {
23    "type": "View",
24    "children": [
25      {
26        "type": "Text",
27        "name": "text",
28        "value": "$text"
29      }
30    ]
31  },
32  "prompts": "Please label the sentiment of the text.",
33  "queue_done": 120,
34  "queue_left": 30,
35  "queue_total": 150,
36  "ready": true,
37  "rejected": 5,
38  "review_settings": {
39    "id": 1,
40    "requeue_rejected_tasks_to_annotator": true,
41    "anonymize_annotations": true,
42    "instruction": "Review annotations carefully for accuracy.",
43    "only_finished_tasks": true,
44    "project": 1,
45    "requeue_rejected_tasks_mode": "requeue",
46    "require_comment_on_reject": true,
47    "review_criteria": "all",
48    "review_only_manual_assignments": true,
49    "review_task_limit_percent": "50.00",
50    "sampling": "task_id",
51    "show_agreement_to_reviewers": true,
52    "show_data_manager_to_reviewers": true,
53    "show_instruction": true,
54    "show_unused_data_columns_to_reviewers": true
55  },
56  "review_total_tasks": 100,
57  "reviewed_number": 80,
58  "reviewer_queue_total": 20,
59  "skipped_annotations_number": 3,
60  "start_training_on_annotation_update": true,
61  "state": "active",
62  "task_number": 200,
63  "total_annotations_number": 450,
64  "total_predictions_number": 120,
65  "useful_annotation_number": 430,
66  "workspace": "Marketing Team",
67  "workspace_title": "Marketing",
68  "agreement_methodology": "consensus",
69  "agreement_threshold": "0.85",
70  "annotation_limit_count": 100,
71  "annotation_limit_percent": "75.00",
72  "annotator_evaluation_continuous_tasks": 5,
73  "annotator_evaluation_enabled": true,
74  "annotator_evaluation_minimum_score": "95.00",
75  "annotator_evaluation_minimum_tasks": 10,
76  "annotator_evaluation_onboarding_tasks": 3,
77  "color": "#4A90E2",
78  "comment_classification_config": "{\"type\": \"text\", \"labels\": [\"Positive\", \"Negative\"]}",
79  "control_weights": {
80    "quality_check": {
81      "overall": 0.7,
82      "type": "Choices",
83      "labels": {
84        "pass": 1,
85        "fail": 0
86      }
87    }
88  },
89  "created_by": {
90    "avatar": "https://labelstud.io/static/avatar1.png",
91    "id": 42,
92    "username": "janedoe",
93    "email": "jane.doe@example.com",
94    "first_name": "Jane",
95    "last_name": "Doe"
96  },
97  "custom_interface_code": "<CustomInterface>...</CustomInterface>",
98  "custom_interface_compiled": "compiled_code_placeholder",
99  "custom_interface_params": null,
100  "custom_script": "console.log('Custom plugin loaded');",
101  "custom_task_lock_ttl": 300,
102  "description": "Project for annotating customer feedback data.",
103  "duplication_done": false,
104  "duplication_status": "pending",
105  "enable_empty_annotation": true,
106  "evaluate_predictions_automatically": true,
107  "expert_instruction": "Please follow the guidelines carefully to ensure high quality annotations.",
108  "input_schema": null,
109  "is_draft": false,
110  "is_published": true,
111  "label_config": "<View><Text name=\"text\" value=\"$text\"/></View>",
112  "max_additional_annotators_assignable": 5,
113  "maximum_annotations": 3,
114  "min_annotations_to_start_training": 50,
115  "model_version": "v1.2.3",
116  "organization": 7,
117  "output_schema": null,
118  "overlap_cohort_percentage": 10,
119  "pause_on_failed_annotator_evaluation": false,
120  "pinned_at": "2024-02-01T12:00:00Z",
121  "require_comment_on_skip": false,
122  "reveal_preannotations_interactively": true,
123  "sampling": "Sequential sampling",
124  "show_annotation_history": true,
125  "show_collab_predictions": true,
126  "show_instruction": true,
127  "show_overlap_first": true,
128  "show_skip_button": true,
129  "show_unused_data_columns_to_annotators": false,
130  "skip_queue": "REQUEUE_FOR_ME",
131  "source_interface_id": 2,
132  "source_interface_version": 5,
133  "strict_task_overlap": true,
134  "task_data_login": "project_user",
135  "task_data_password": "securepassword123",
136  "title": "Customer Feedback Sentiment Analysis",
137  "use_custom_interface": false,
138  "show_ground_truth_first": true
139}
Retrieve information about a project by project ID.
Was this page helpful?
Previous

Delete project

Next
Built with

Authentication

AuthorizationToken
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired

Query parameters

members_limitintegerOptionalDefaults to 10
Maximum number of members to return

Response

Project information. Not all fields are available for all roles.
allow_streambooleanRead-only
assignment_settingsobject
config_has_control_tagsbooleanRead-only
Flag to detect is project ready for labeling
config_suitable_for_bulk_annotationbooleanRead-only
Flag to detect is project ready for bulk annotation
created_atdatetimeRead-only
data_typesmap from strings to any or nullRead-only
finished_task_numberintegerRead-only
Finished tasks
ground_truth_numberintegerRead-only
Honeypot annotation number in project
idintegerRead-only
is_dimensions_enabledstringRead-only
membersstringRead-only
members_countintegerRead-only
num_tasks_with_annotationsintegerRead-only
parsed_label_configmap from strings to anyRead-only

JSON-formatted labeling configuration

promptsstringRead-only
queue_doneintegerRead-only
queue_leftintegerRead-only
queue_totalintegerRead-only
readybooleanRead-only
rejectedintegerRead-only
review_settingsobject
review_total_tasksintegerRead-only
reviewed_numberintegerRead-only
reviewer_queue_totalintegerRead-only
skipped_annotations_numberintegerRead-only
start_training_on_annotation_updatebooleanRead-only
Start model training after any annotations are submitted or updated
statestringRead-only
task_numberintegerRead-only
Total task number in project
total_annotations_numberintegerRead-only
total_predictions_numberinteger or nullRead-only
useful_annotation_numberinteger or nullRead-only
workspacestringRead-only
workspace_titlestringRead-only
agreement_methodologyenum

Methodology (Consensus / Pairwise Averaging)

  • consensus - Consensus
  • pairwise - Pairwise Averaging
Allowed values:
agreement_thresholdstring or nullformat: "decimal"
Agreement threshold
annotation_limit_countinteger or null>=1
Limit by number of tasks
annotation_limit_percentstring or nullformat: "decimal"
Limit by percentage of tasks
annotator_evaluation_continuous_tasksinteger>=0Defaults to 0

Continuous Evaluation: Required tasks

annotator_evaluation_enabledboolean
Evaluate all annotators against ground truth
annotator_evaluation_minimum_scorestring or nullformat: "decimal"Defaults to 95.00
Score required to pass evaluation
annotator_evaluation_minimum_tasksinteger or null>=0Defaults to 10
Number of tasks for evaluation
annotator_evaluation_onboarding_tasksinteger>=0Defaults to 0

Onboarding Evaluation: Required tasks

colorstring or null<=16 characters
Color
comment_classification_configstring
control_weightsmap from strings to objects or null

Dict of weights for each control tag in metric calculation. Keys are control tag names from the labeling config. At least one tag must have a non-zero overall weight.

created_byobject
Project owner
custom_interface_codestring or null
custom_interface_compiledstring or null
custom_interface_paramsany or null
custom_scriptstring
Plugins
custom_task_lock_ttlinteger or null1-86400

Task reservation time. TTL in seconds (UI displays and edits this value in minutes).

descriptionstring or null
Description
duplication_donebooleanDefaults to false
duplication_statusstring
enable_empty_annotationboolean
Allow empty annotations
evaluate_predictions_automaticallyboolean
Retrieve and display predictions when loading a task
expert_instructionstring or null
Instructions
input_schemaany or null
is_draftboolean
Whether or not the project is in the middle of being created
is_publishedboolean
Whether or not the project is published to annotators
label_configstring or null
Labeling Configuration
max_additional_annotators_assignableinteger or null
Maximum additional annotators
maximum_annotationsinteger-2147483648-2147483647
Annotations per task
min_annotations_to_start_traininginteger-2147483648-2147483647
Minimum number of completed tasks after which model training is started
model_versionstring or null
Machine learning model version
organizationinteger or null
output_schemaany or null
overlap_cohort_percentageinteger-2147483648-2147483647
Annotations per task coverage
pause_on_failed_annotator_evaluationboolean or nullDefaults to false
Pause annotator on failed evaluation
pinned_atdatetime or null
Pinned date and time
require_comment_on_skipbooleanDefaults to false
Require comment to skip
reveal_preannotations_interactivelyboolean

Reveal pre-annotations interactively

samplingenum or null
  • Sequential sampling - Tasks are ordered by Data manager ordering
  • Uniform sampling - Tasks are chosen randomly
  • Uncertainty sampling - Tasks are chosen according to model uncertainty scores (active learning mode)
Allowed values:
show_annotation_historyboolean
Show Data Manager to Annotators
show_collab_predictionsboolean

Use predictions to pre-label Tasks

show_instructionboolean
Show instructions before labeling
show_overlap_firstboolean
Show tasks with overlap first
show_skip_buttonboolean
Allow skipping tasks
show_unused_data_columns_to_annotatorsboolean or null

Show only columns used in labeling configuration to Annotators. API uses inverse field semantics here: set false to show only used columns, set true to show all task.data columns.

skip_queueenum or null
  • REQUEUE_FOR_ME - Requeue for me
  • REQUEUE_FOR_OTHERS - Requeue for others
  • IGNORE_SKIPPED - Ignore skipped
Allowed values:
source_interface_idinteger or null
source_interface_versioninteger or null
Stable version ID of the saved interface snapshot used by this project.
strict_task_overlapbooleanDefaults to true
Enforce strict overlap limit
task_data_loginstring or null<=256 characters
Login
task_data_passwordstring or null<=256 characters
Password
titlestring or null3-50 characters
Project Name
use_custom_interfacebooleanDefaults to false
show_ground_truth_firstbooleanDeprecated

Onboarding mode (true): show ground truth tasks first in the labeling stream

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: 
curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”