Sign in
Project Templates

✨ Create project from template

<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.
post/api/project-templates/{id}/create-project

Path parameters

idinteger required

Request body

descriptionstring nullable

A description for the project.

titlestring required

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

workspace_idinteger

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

Response

Project created successfully

agreement_methodology'consensus' | 'pairwise'
  • consensus - Consensus
  • pairwise - Pairwise Averaging
agreement_thresholdstring decimal nullable

Agreement threshold

annotation_limit_countinteger nullable

Limit by number of tasks

annotation_limit_percentstring decimal nullable

Limit by percentage of tasks

annotator_evaluation_continuous_tasksinteger

Continuous Evaluation: Required tasks

annotator_evaluation_enabledboolean

Evaluate all annotators against ground truth

annotator_evaluation_metric'gt_agreement' | 'acceptance_score' | 'rejection_rate'
  • gt_agreement - Ground truth agreement
  • acceptance_score - Acceptance score
  • rejection_rate - Rejection rate
annotator_evaluation_minimum_scorestring decimal nullable

Score required to pass evaluation

annotator_evaluation_minimum_tasksinteger nullable

Number of tasks for evaluation

annotator_evaluation_onboarding_tasksinteger

Onboarding Evaluation: Required tasks

collection_modestring nullable required

Data Collection project mode (assigned/open); null for non-collection projects. Set at creation only.

colorstring nullable

Color

comment_classification_configstring
config_has_control_tagsboolean required

Flag to detect is project ready for labeling

config_suitable_for_bulk_annotationboolean required

Flag to detect is project ready for bulk annotation

control_weightsobject nullable

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_atstring date-time required
custom_interface_codestring nullable
custom_interface_compiledstring nullable
{"stackTrail":"components:schemas:LseProject:properties:custom_interface_params","oasType":"schema","type":"unknown","nullable":true}
custom_scriptstring

Plugins

custom_task_lock_ttlinteger nullable

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

data_typesobject nullable required
descriptionstring nullable

Description (Public)

duplication_doneboolean
duplication_statusstring
enable_empty_annotationboolean

Allow empty annotations

evaluate_predictions_automaticallyboolean

Retrieve and display predictions when loading a task

expert_instructionstring nullable

Instructions

finished_task_numberinteger required

Finished tasks

ground_truth_numberinteger required

Honeypot annotation number in project

idinteger required
{"stackTrail":"components:schemas:LseProject:properties:input_schema","oasType":"schema","type":"unknown","nullable":true}
is_dimensions_enabledboolean required
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 nullable

Labeling Configuration

max_additional_annotators_assignableinteger nullable

Maximum additional annotators

maximum_annotationsinteger

Annotations per task

membersobject[] required
members_countinteger required
min_annotations_to_start_traininginteger

Minimum number of completed tasks after which model training is started

model_versionstring nullable

Machine learning model version

num_tasks_with_annotationsinteger nullable required
organizationinteger nullable
{"stackTrail":"components:schemas:LseProject:properties:output_schema","oasType":"schema","type":"unknown","nullable":true}
overlap_cohort_percentageinteger

Annotations per task coverage

parsed_label_configobject required

JSON-formatted labeling configuration

pause_on_failed_annotator_evaluationboolean nullable

Pause annotator on failed evaluation

permissionsstring[] required
pinned_atstring date-time nullable

Pinned date and time

promptsobject[] nullable required
queue_doneinteger required

Annotator-only: tasks this user has completed in the labeling queue for the project.

queue_leftinteger required

Reviewer-only: remaining tasks in this user's manually assigned review queue. Returns 0 when no manual assignments apply; the project card then uses review_total_tasks and reviewed_number for auto-review progress. Not the same as the project-wide tasks_pending_review KPI.

queue_totalinteger required

Role-dependent queue size. Annotators: total tasks in the labeling queue. Reviewers (list/counts): total manually assigned review tasks (same pool as reviewer_queue_total). Not the same as task_number (all project tasks) or review_total_tasks (auto-review stream pool).

require_comment_on_skipboolean

Require comment to skip

reveal_preannotations_interactivelyboolean

Reveal pre-annotations interactively

reviewer_queue_totalinteger required

Tasks manually assigned to this user for review (reviewer_queue_total_count). Null for annotators.

sampling'Sequential sampling' | 'Uniform sampling' | 'Uncertainty sampling'
  • 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)
show_annotation_historyboolean

Show Data Manager to Annotators

show_collab_predictionsboolean

Use predictions to pre-label Tasks

show_ground_truth_firstboolean

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

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 nullable

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_queue'REQUEUE_FOR_ME' | 'REQUEUE_FOR_OTHERS' | 'IGNORE_SKIPPED'
  • REQUEUE_FOR_ME - Requeue for me
  • REQUEUE_FOR_OTHERS - Requeue for others
  • IGNORE_SKIPPED - Ignore skipped
skipped_annotations_numberinteger required

Skipped by collaborators annotation number in project

source_interface_idinteger nullable
source_interface_versioninteger nullable

Stable version ID of the saved interface snapshot used by this project.

start_training_on_annotation_updateboolean required

Start model training after any annotations are submitted or updated

statestring required
strict_task_overlapboolean

Enforce strict overlap limit

task_data_loginstring nullable

Login

task_data_passwordstring nullable

Password

task_numberinteger required

Total task number in project

titlestring nullable

Project Name

total_annotations_numberinteger required

Total annotations number in project including skipped_annotations_number and ground_truth_number.

total_predictions_numberinteger required

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

use_custom_interfaceboolean
useful_annotation_numberinteger required

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

workspaceinteger required
workspace_titlestring nullable required

Changes

Changed in 9 of the 97 revisions of this API.13112

  • c7f605974c951See the full diff
    • ○

      added the required property collection_mode to the response with the 201 status

      response-required-property-added

  • 1b113b8df95011See the full diff
    • ●

      added the new by_annotator enum value to the review_settings/sampling/allOf[ReviewSettingsSamplingEnum]/ response property for the response status 201

      response-property-enum-value-added

    • ○

      added the optional property review_settings/annotator_batch_percent to the response with the 201 status

      response-optional-property-added

  • e1ba2ecdbabb24See the full diff
    • ▲

      request body became required

      request-body-became-required

    • ▲

      the title request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ○

      added the media type application/x-www-form-urlencoded to the request body

      request-body-media-type-added

    • ○

      added the media type multipart/form-data to the request body

      request-body-media-type-added

    • ○

      the request property description became nullable

      request-property-became-nullable

    • ○

      the request property workspace_id became optional

      request-property-became-optional

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0bb2c2fc7ae21See the full diff
    • ○

      added the optional property annotator_evaluation_metric to the response with the 201 status

      response-optional-property-added

  • 4a1086d6dd001See the full diff
    • ○

      added the required property permissions to the response with the 201 status

      response-required-property-added

  • 32a5de4a180c1See the full diff
    • ○

      added the required property internal_description to the response with the 201 status

      response-required-property-added

  • b5f055b9d45b11See the full diff
    • ▲

      the response property created_by/allOf[UserSimple]/avatar became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property prompts became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property workspace_title became nullable for the status 201

      response-property-became-nullable

    • ▲

      the is_dimensions_enabled response's property type/format changed from string/ to boolean/ for status 201

      response-property-type-changed

    • ▲

      the members response's property type/format changed from string/ to array/ for status 201

      response-property-type-changed

    • ▲

      the prompts response's property type/format changed from string/ to array/ for status 201

      response-property-type-changed

    • ▲

      the queue_done response's property type/format changed from string/ to integer/ for status 201

      response-property-type-changed

    • ▲

      the queue_left response's property type/format changed from string/ to integer/ for status 201

      response-property-type-changed

    • ▲

      the queue_total response's property type/format changed from string/ to integer/ for status 201

      response-property-type-changed

    • ▲

      the reviewer_queue_total response's property type/format changed from string/ to integer/ for status 201

      response-property-type-changed

    • ▲

      the workspace response's property type/format changed from string/ to integer/ for status 201

      response-property-type-changed

  • 04ff286141b52See the full diff
    • ○

      added ProjectSamplingEnum to the sampling response property allOf list for the response status 201

      response-property-all-of-added

    • ○

      removed SamplingDe5Enum from the sampling response property allOf list for the response status 201

      response-property-all-of-removed

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b7b3b45888a81See the full diff
    • ○

      added the optional property output_schema to the response with the 201 status

      response-optional-property-added

Of the 97 revisions, 1 has no diff computed.