API ReferenceProjects

Create a project

Create a project for a specific organization.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
colorstringOptional<=16 characters
control_weightsanyOptional
created_byobjectOptional
Project owner
descriptionstringOptional
Project description
enable_empty_annotationbooleanOptional
Allow annotators to submit empty annotations
evaluate_predictions_automaticallybooleanOptional
Retrieve and display predictions when loading a task
expert_instructionstringOptional
Labeling instructions in HTML format
is_draftbooleanOptional
Whether or not the project is in the middle of being created
is_publishedbooleanOptional
Whether or not the project is published to annotators
label_configstringOptional
Label config in XML format. See more about it in documentation
maximum_annotationsintegerOptional>=-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_trainingintegerOptional>=-2147483648<=2147483647
Minimum number of completed tasks after which model training is started
model_versionstringOptional
Machine learning model version
organizationintegerOptional
overlap_cohort_percentageintegerOptional>=-2147483648<=2147483647
pinned_atdatetimeOptional
Pinned date and time
reveal_preannotations_interactivelybooleanOptional

Reveal pre-annotations interactively

samplingenum or stringOptional
show_annotation_historybooleanOptional
Show annotation history to annotator
show_collab_predictionsbooleanOptional
If set, the annotator can view model predictions
show_ground_truth_firstbooleanOptional
show_instructionbooleanOptional
Show instructions to the annotator before they start
show_overlap_firstbooleanOptional
show_skip_buttonbooleanOptional
Show a skip button in interface and allow annotators to skip the task
skip_queueenum or stringOptional
task_data_loginstringOptional<=256 characters

Task data credentials: login

task_data_passwordstringOptional<=256 characters

Task data credentials: password

titlestringOptional>=3 characters<=50 characters
Project name. Must be between 3 and 50 characters long.
workspaceintegerOptional

Response

config_has_control_tagsboolean
Flag to detect is project ready for labeling
config_suitable_for_bulk_annotationboolean
Flag to detect is project ready for bulk annotation
created_atdatetime
finished_task_numberinteger
Finished tasks
ground_truth_numberinteger
Honeypot annotation number in project
idinteger
num_tasks_with_annotationsinteger
Tasks with annotations count
parsed_label_configany
queue_doneinteger
queue_totalinteger
skipped_annotations_numberinteger
Skipped by collaborators annotation number in project
start_training_on_annotation_updateboolean
Start model training after any annotations are submitted or updated
task_numberinteger
Total task number in project
total_annotations_numberinteger

Total annotations number in project including skipped_annotations_number and ground_truth_number.

total_predictions_numberinteger

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

useful_annotation_numberinteger

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

colorstring or null<=16 characters
control_weightsany or null
created_byobject or null
Project owner
descriptionstring or null
Project description
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
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
pinned_atdatetime or null
Pinned date and time
reveal_preannotations_interactivelyboolean or null

Reveal pre-annotations interactively

samplingenum or string or null
show_annotation_historyboolean or null
Show annotation history to annotator
show_collab_predictionsboolean or null
If set, the annotator can view model predictions
show_ground_truth_firstboolean or null
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
skip_queueenum or string or null
task_data_loginstring or null<=256 characters

Task data credentials: login

task_data_passwordstring or null<=256 characters

Task data credentials: password

titlestring or null>=3 characters<=50 characters
Project name. Must be between 3 and 50 characters long.
workspaceinteger or null