Sign in
Projects

Update project details

Update the details of a specific project.

patch/api/projects/{id}/

Path parameters

idinteger required

Query parameters

members_limitinteger

Maximum number of members to return

Request body

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

colorstring nullable

Color

comment_classification_configstring
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.

custom_interface_codestring nullable
custom_interface_compiledstring nullable
{"stackTrail":"components:schemas:PatchedLseProjectUpdateRequest: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).

descriptionstring nullable

Description (Public)

enable_empty_annotationboolean

Allow empty annotations

evaluate_predictions_automaticallyboolean

Retrieve and display predictions when loading a task

expert_instructionstring nullable

Instructions

{"stackTrail":"components:schemas:PatchedLseProjectUpdateRequest:properties:input_schema","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:PatchedLseProjectUpdateRequest:properties:internal_description","oasType":"schema","type":"unknown","description":"Description (Internal)","nullable":true}
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

min_annotations_to_start_traininginteger

Minimum number of completed tasks after which model training is started

model_versionstring nullable

Machine learning model version

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

Annotations per task coverage

pause_on_failed_annotator_evaluationboolean nullable

Pause annotator on failed evaluation

pinned_atstring date-time nullable

Pinned date and time

require_comment_on_skipboolean

Require comment to skip

reveal_preannotations_interactivelyboolean

Reveal pre-annotations interactively

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
source_interface_idinteger nullable
source_interface_versioninteger nullable

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

strict_task_overlapboolean

Enforce strict overlap limit

task_data_loginstring nullable

Login

task_data_passwordstring nullable

Password

titlestring nullable

Project Name

use_custom_interfaceboolean
workspaceinteger

Workspace

Response

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

Agreement threshold

allow_streamboolean required
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:LseProjectResponse: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:LseProjectResponse: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 required

Tasks with at least one annotation. For annotators, counts only tasks this user annotated; for other roles, counts project-wide. For analytics, use annotated_tasks or related KPIs with explicit project/member filters.

organizationinteger nullable
{"stackTrail":"components:schemas:LseProjectResponse: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 nullable 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).

readyboolean required
rejectedinteger required

Annotator-only: this user's annotations rejected by reviewers.

require_comment_on_skipboolean

Require comment to skip

reveal_preannotations_interactivelyboolean

Reveal pre-annotations interactively

review_total_tasksinteger nullable required

Total tasks in this user's reviewer queue for the project (denominator for personal review progress). Respects review sampling limits when configured. Null for annotators. This is not the project-wide reviewed or pending count; see Analytics KPIs tasks_reviewed and tasks_pending_review for org-level totals.

reviewed_numberinteger nullable required

Tasks this user has reviewed in the project (personal reviewer progress shown on the project card). Includes only reviews created by the authenticated user, so the value can be lower than the project-wide reviewed total when multiple reviewers participate. Null for annotators. For all reviewed tasks in the project, use the Analytics KPI tasks_reviewed: GET /api/analytics/kpis/tasks_reviewed?projects={id}&tz=UTC.

reviewer_queue_totalinteger nullable 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
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_predictions_numberinteger nullable required
use_custom_interfaceboolean
useful_annotation_numberinteger nullable required
workspaceinteger required
workspace_titlestring nullable required

Changes

Changed in 12 of the 122 revisions of this API.13449

  • b930b1d915894See the full diff
    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • f3abe29dce2f8See the full diff
    • ○

      added the new optional request property / (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property / (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property / (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property / (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property / (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property / (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • c7f605974c951See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

  • 77d154d654624See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

  • 1b113b8df95017See the full diff
    • ●

      added the new by_annotator enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property / (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property / (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property / (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new by_annotator enum value to the request property ///// (media type: application/json)

      request-property-enum-value-added

    • ○

      added the new by_annotator enum value to the request property ///// (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • ○

      added the new by_annotator enum value to the request property ///// (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 0bb2c2fc7ae24See the full diff
    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 4a1086d6dd001See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

  • 32a5de4a180c4See the full diff
    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • ○

      added the new optional request property (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 93493def8bb7214See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      the response required property became read-only for the status

      response-required-property-became-read-only

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

  • b5f055b9d45b4See the full diff
    • ▲

      the response property ///// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response's property type changed from string to array for status

      response-property-type-changed

Of the 122 revisions, 1 has no diff computed.