✨ Create project from template | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Create a project from a specific project template by ID for an organization.

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Create a project from a specific project template by ID for an organization.

Authentication

Authorizationstring

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]”

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

Request

This endpoint expects an object.

titlestringRequired

The title of the project to be created from the template.

workspace_idintegerRequired

A unique integer value identifying the workspace in which to create the project.

descriptionstringOptional

A description for the project.

Response

Project created successfully

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

membersstringRead-only

members_countintegerRead-only

num_tasks_with_annotationsinteger or nullRead-only

parsed_label_configmap from strings to anyRead-only

JSON-formatted labeling configuration

promptsstringRead-only

queue_donestringRead-only

queue_leftstringRead-only

queue_totalstringRead-only

review_settingsobject

reviewer_queue_totalstringRead-only

skipped_annotations_numberintegerRead-only

Skipped by collaborators annotation number in project

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 annotations number in project including skipped_annotations_number and ground_truth_number.

total_predictions_numberintegerRead-only

Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.

useful_annotation_numberintegerRead-only

Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number

workspacestringRead-only

workspace_titlestringRead-only

agreement_methodologyenum or null

consensus - Consensus
pairwise - Pairwise Averaging

* `consensus` - Consensus * `pairwise` - Pairwise Averaging

Allowed values:

agreement_thresholdstring or nullformat: "decimal"

Minimum percent agreement threshold for which minimum number of annotators must agree

annotation_limit_countinteger or null>=1

annotation_limit_percentstring or nullformat: "decimal"

annotator_evaluation_continuous_tasksinteger or null>=0Defaults to 0

annotator_evaluation_enabledboolean or null

Enable annotator evaluation for the project

annotator_evaluation_minimum_scorestring or nullformat: "decimal"Defaults to 95.00

annotator_evaluation_minimum_tasksinteger or null>=0Defaults to 10

annotator_evaluation_onboarding_tasksinteger or null>=0Defaults to 0

colorstring or null<=16 characters

comment_classification_configstring or null

control_weightsmap from strings to any or null

Dict of weights for each control tag in metric calculation.

created_byobject or null

Project owner

custom_scriptstring or null

custom_task_lock_ttlinteger or null1-86400

TTL in seconds for task reservations, on new and existing tasks

descriptionstring or null

Project description

duplication_doneboolean or nullDefaults to false

duplication_statusstring or null

enable_empty_annotationboolean or null

Allow annotators to submit empty annotations

evaluate_predictions_automaticallyboolean or null

Retrieve and display predictions when loading a task

expert_instructionstring or null

Labeling instructions in HTML format

is_draftboolean or null

Whether or not the project is in the middle of being created

is_publishedboolean or null

Whether or not the project is published to annotators

label_configstring or null

Label config in XML format. See more about it in documentation

max_additional_annotators_assignableinteger or null

Maximum number of additional annotators that can be assigned to a low agreement task

maximum_annotationsinteger or null-2147483648-2147483647

Maximum number of annotations for one task. If the number of annotations per task is equal or greater to this value, the task is completed (is_labeled=True)

min_annotations_to_start_traininginteger or null-2147483648-2147483647

Minimum number of completed tasks after which model training is started

model_versionstring or null

Machine learning model version

organizationinteger or null

overlap_cohort_percentageinteger or null-2147483648-2147483647

pause_on_failed_annotator_evaluationboolean or nullDefaults to false

pinned_atdatetime or null

Pinned date and time

require_comment_on_skipboolean or nullDefaults to false

reveal_preannotations_interactivelyboolean or null

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)

* `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 or null

Show annotation history to annotator

show_collab_predictionsboolean or null

If set, the annotator can view model predictions

show_instructionboolean or null

Show instructions to the annotator before they start

show_overlap_firstboolean or null

show_skip_buttonboolean or null

Show a skip button in interface and allow annotators to skip the task

show_unused_data_columns_to_annotatorsboolean or null

skip_queueenum or null

REQUEUE_FOR_ME - Requeue for me
REQUEUE_FOR_OTHERS - Requeue for others
IGNORE_SKIPPED - Ignore skipped

* `REQUEUE_FOR_ME` - Requeue for me * `REQUEUE_FOR_OTHERS` - Requeue for others * `IGNORE_SKIPPED` - Ignore skipped

Allowed values:

strict_task_overlapboolean or nullDefaults to true

task_data_loginstring or null<=256 characters

Task data credentials: login

task_data_passwordstring or null<=256 characters

Task data credentials: password

titlestring or null3-50 characters

Project name. Must be between 3 and 50 characters long.

show_ground_truth_firstboolean or nullDeprecated

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

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	base_url="http://localhost:8000",
5	api_key="YOUR_API_KEY_HERE"
6	)
7
8	client.project_templates.create_project_from_template(
9	id=1,
10	title="Customer Feedback Analysis",
11	workspace_id=42
12	)

1	{
2	"assignment_settings": {
3	"id": 101,
4	"label_stream_task_distribution": "auto_distribution",
5	"project": 1234
6	},
7	"config_has_control_tags": true,
8	"config_suitable_for_bulk_annotation": true,
9	"created_at": "2024-06-01T10:00:00Z",
10	"data_types": {},
11	"finished_task_number": 150,
12	"ground_truth_number": 10,
13	"id": 1234,
14	"members": "John Doe, Jane Smith, Alice Johnson",
15	"members_count": 3,
16	"num_tasks_with_annotations": 140,
17	"parsed_label_config": {},
18	"prompts": "Please review the comments carefully before labeling.",
19	"queue_done": "150",
20	"queue_left": "50",
21	"queue_total": "200",
22	"review_settings": {
23	"id": 555,
24	"requeue_rejected_tasks_to_annotator": true,
25	"anonymize_annotations": false,
26	"instruction": "<p>Review annotations for accuracy and consistency.</p>",
27	"only_finished_tasks": true,
28	"project": 1234,
29	"requeue_rejected_tasks_mode": "requeue",
30	"require_comment_on_reject": true,
31	"review_criteria": "all",
32	"review_only_manual_assignments": false,
33	"review_task_limit_percent": "25.00",
34	"sampling": "task_id",
35	"show_agreement_to_reviewers": true,
36	"show_data_manager_to_reviewers": true,
37	"show_instruction": true,
38	"show_unused_data_columns_to_reviewers": false
39	},
40	"reviewer_queue_total": "50",
41	"skipped_annotations_number": 5,
42	"start_training_on_annotation_update": true,
43	"state": "active",
44	"task_number": 200,
45	"total_annotations_number": 450,
46	"total_predictions_number": 460,
47	"useful_annotation_number": 440,
48	"workspace": "workspace_42",
49	"workspace_title": "Marketing Analytics",
50	"agreement_methodology": "pairwise",
51	"agreement_threshold": "0.85",
52	"annotation_limit_count": 5,
53	"annotation_limit_percent": "75.00",
54	"annotator_evaluation_continuous_tasks": 20,
55	"annotator_evaluation_enabled": true,
56	"annotator_evaluation_minimum_score": "90.00",
57	"annotator_evaluation_minimum_tasks": 15,
58	"annotator_evaluation_onboarding_tasks": 5,
59	"color": "#4A90E2",
60	"comment_classification_config": "<View><Text name=\"comment\" value=\"$text\"/></View>",
61	"control_weights": {},
62	"created_by": {
63	"avatar": "https://example.com/avatars/jdoe.png",
64	"id": 7,
65	"email": "jdoe@example.com",
66	"first_name": "John",
67	"last_name": "Doe"
68	},
69	"custom_script": "function validateAnnotation() { return true; }",
70	"custom_task_lock_ttl": 3600,
71	"description": "Project to analyze customer feedback comments for sentiment and categorization.",
72	"duplication_done": false,
73	"duplication_status": "pending",
74	"enable_empty_annotation": false,
75	"evaluate_predictions_automatically": true,
76	"expert_instruction": "<p>Please label the sentiment of each comment as Positive, Negative, or Neutral.</p>",
77	"is_draft": false,
78	"is_published": true,
79	"label_config": "<View><Labels name=\"sentiment\" toName=\"text\"><Label value=\"Positive\"/><Label value=\"Negative\"/><Label value=\"Neutral\"/></Labels><Text name=\"text\" value=\"$text\"/></View>",
80	"max_additional_annotators_assignable": 3,
81	"maximum_annotations": 3,
82	"min_annotations_to_start_training": 50,
83	"model_version": "v1.2.3",
84	"organization": 9,
85	"overlap_cohort_percentage": 20,
86	"pause_on_failed_annotator_evaluation": false,
87	"pinned_at": "2024-06-01T12:00:00Z",
88	"require_comment_on_skip": true,
89	"reveal_preannotations_interactively": true,
90	"sampling": "Sequential sampling",
91	"show_annotation_history": true,
92	"show_collab_predictions": true,
93	"show_instruction": true,
94	"show_overlap_first": true,
95	"show_skip_button": true,
96	"show_unused_data_columns_to_annotators": false,
97	"skip_queue": "REQUEUE_FOR_ME",
98	"strict_task_overlap": true,
99	"task_data_login": "data_user",
100	"task_data_password": "securePass123!",
101	"title": "Customer Feedback Analysis",
102	"show_ground_truth_first": false
103	}