openapi: 3.2.0
info:
title: Ingest Add and Manage Tasks API
description: Public API for importing data and managing labeling tasks, cases, projects, and assets.
version: 0.1.0
servers:
- url: https://api.centaurlabs.com
tags:
- name: Add and Manage Tasks
description: Create and configure labeling tasks, including their answer classes, label class groups, and instructions.
paths:
/answers/public/v1/add:
post:
tags:
- Add and Manage Tasks
summary: Handler Add Answer Legacy
description: 'Deprecated: use /labelClasses/public/v1/add instead. Adds answer classes to a task.'
operationId: handler_add_answer_legacy_answers_public_v1_add_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddAnswerRequest'
examples:
- task_id: 456
new_answers:
- benign
- malignant
force: true
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/LabelClassValueLegacy'
type: array
title: Response Handler Add Answer Legacy Answers Public V1 Add Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
deprecated: true
security:
- APIKeyHeader: []
- BearerToken: []
/answers/public/v1/delete:
delete:
tags:
- Add and Manage Tasks
summary: Handler Delete Answer Legacy
description: 'Deprecated: use /labelClasses/public/v1/delete instead. Removes an answer class from a task.'
operationId: handler_delete_answer_legacy_answers_public_v1_delete_delete
deprecated: true
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: task_id
in: query
required: true
schema:
type: integer
title: Task Id
- name: answer
in: query
required: true
schema:
type: string
minLength: 1
maxLength: 60
title: Answer
- name: force
in: query
required: false
schema:
type: boolean
default: false
title: Force
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Handler Delete Answer Legacy Answers Public V1 Delete Delete
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/answers/public/v1/update:
patch:
tags:
- Add and Manage Tasks
summary: Update Label Classes
description: Updates the name of an existing answer class on a task.
operationId: update_label_classes_answers_public_v1_update_patch
deprecated: true
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: task_id
in: query
required: true
schema:
type: integer
description: Task ID
title: Task Id
description: Task ID
- name: force
in: query
required: false
schema:
type: boolean
default: false
title: Force
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAnswerBody'
examples:
- answer: old_label
new_answer: updated_label
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLabelClassResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/labelClasses/public/v1/add:
post:
tags:
- Add and Manage Tasks
summary: Handler Add Answer
description: Adds one or more answer classes to a task, optionally replacing existing ones.
operationId: handler_add_answer_labelClasses_public_v1_add_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddAnswerRequest'
examples:
- task_id: 456
new_answers:
- benign
- malignant
force: true
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/LabelClassValue'
type: array
title: Response Handler Add Answer Labelclasses Public V1 Add Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- BearerToken: []
/labelClasses/public/v1/delete:
delete:
tags:
- Add and Manage Tasks
summary: Handler Delete Answer
description: Removes a specific answer class from a task by task ID and answer value.
operationId: handler_delete_answer_labelClasses_public_v1_delete_delete
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: task_id
in: query
required: true
schema:
type: integer
title: Task Id
- name: answer
in: query
required: true
schema:
type: string
minLength: 1
maxLength: 60
title: Answer
- name: force
in: query
required: false
schema:
type: boolean
default: false
title: Force
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseSummary'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/labelClasses/public/v1/groups:
post:
tags:
- Add and Manage Tasks
summary: Add a new label class group
description: Creates a new label class group for a task with a prompt and initial answer class IDs.
operationId: handler_add_label_class_group_labelClasses_public_v1_groups_post
security:
- APIKeyHeader: []
- BearerToken: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddLabelClassGroupRequest'
examples:
- task_id: 456
prompt: prompt text
multi_answer: true
label_class_ids:
- 1
- 2
- 3
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AddLabelClassGroupResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Add and Manage Tasks
summary: List all label class groups for a task
description: Returns all label class groups associated with a specific task.
operationId: handler_list_label_class_groups_labelClasses_public_v1_groups_get
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: task_id
in: query
required: true
schema:
type: integer
description: Task ID
title: Task Id
description: Task ID
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GetLabelClassGroupResponse'
title: Response Handler List Label Class Groups Labelclasses Public V1 Groups Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/labelClasses/public/v1/groups/reorder:
put:
tags:
- Add and Manage Tasks
summary: Reorder the label class groups for a task
description: Reorders the label class groups for a task by providing the desired order of group IDs.
operationId: handler_reorder_label_class_groups_labelClasses_public_v1_groups_reorder_put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReorderLabelClassGroupsBody'
examples:
- task_id: 456
new_label_class_groups_order:
- 1
- 2
- 3
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Handler Reorder Label Class Groups Labelclasses Public V1 Groups Reorder Put
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- BearerToken: []
/labelClasses/public/v1/groups/{label_class_group_id}:
delete:
tags:
- Add and Manage Tasks
summary: Delete a label class group
description: All answers in the label class group will be ungrouped
operationId: handler_delete_label_class_group_labelClasses_public_v1_groups__label_class_group_id__delete
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: label_class_group_id
in: path
required: true
schema:
type: integer
description: Label Class Group ID
title: Label Class Group Id
description: Label Class Group ID
- name: task_id
in: query
required: true
schema:
type: integer
description: Task ID
title: Task Id
description: Task ID
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Handler Delete Label Class Group Labelclasses Public V1 Groups Label Class Group Id Delete
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Add and Manage Tasks
summary: Update a label class group
description: Updates the prompt or multi-answer setting of an existing label class group.
operationId: handler_update_label_class_group_labelClasses_public_v1_groups__label_class_group_id__patch
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: label_class_group_id
in: path
required: true
schema:
type: integer
description: Label Class Group ID
title: Label Class Group Id
description: Label Class Group ID
- name: task_id
in: query
required: true
schema:
type: integer
description: Task ID
title: Task Id
description: Task ID
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLabelClassGroupRequest'
examples:
- prompt: prompt text
multi_answer: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Handler Update Label Class Group Labelclasses Public V1 Groups Label Class Group Id Patch
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Add and Manage Tasks
summary: Get a label class group
description: Returns details of a specific label class group, optionally including its answer classes.
operationId: handler_get_label_class_group_labelClasses_public_v1_groups__label_class_group_id__get
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: label_class_group_id
in: path
required: true
schema:
type: integer
description: Label Class Group ID
title: Label Class Group Id
description: Label Class Group ID
- name: task_id
in: query
required: true
schema:
type: integer
description: Task ID
title: Task Id
description: Task ID
- name: label_classes
in: query
required: false
schema:
type: boolean
description: Whether to include label classes
default: false
title: Label Classes
description: Whether to include label classes
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GetLabelClassGroupResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/labelClasses/public/v1/groups/{label_class_group_id}/answers:
post:
tags:
- Add and Manage Tasks
summary: Add existing answers to a label class group
description: Adds existing answer classes to a label class group by their IDs.
operationId: handler_add_existing_answers_to_label_class_group_labelClasses_public_v1_groups__label_class_group_id__answers_post
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: label_class_group_id
in: path
required: true
schema:
type: integer
description: Label Class Group ID
title: Label Class Group Id
description: Label Class Group ID
- name: task_id
in: query
required: true
schema:
type: integer
description: Task ID
title: Task Id
description: Task ID
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: integer
minItems: 1
description: The label class IDs to add to the label class group
title: Label Class Ids
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Handler Add Existing Answers To Label Class Group Labelclasses Public V1 Groups Label Class Group Id Answers Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Add and Manage Tasks
summary: Delete answers from a label class group
description: Answers will be ungrouped from the label class group but will not be deleted from the task
operationId: handler_delete_answers_from_label_class_group_labelClasses_public_v1_groups__label_class_group_id__answers_delete
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: label_class_group_id
in: path
required: true
schema:
type: integer
description: Label Class Group ID
title: Label Class Group Id
description: Label Class Group ID
- name: task_id
in: query
required: true
schema:
type: integer
description: Task ID
title: Task Id
description: Task ID
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: integer
minItems: 1
description: The label class IDs to delete from the label class group
title: Label Class Ids To Delete
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Handler Delete Answers From Label Class Group Labelclasses Public V1 Groups Label Class Group Id Answers Delete
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/labelClasses/public/v1/reorder:
put:
tags:
- Add and Manage Tasks
summary: Reorder the answers for a task
description: Reorders the answer classes for a task by providing the desired order of answer IDs.
operationId: handler_reorder_answers_labelClasses_public_v1_reorder_put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReorderAnswersBody'
examples:
- task_id: 456
new_answers_ids_order:
- 0
- 1
- 2
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Handler Reorder Answers Labelclasses Public V1 Reorder Put
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- BearerToken: []
/labelClasses/public/v1/update:
patch:
tags:
- Add and Manage Tasks
summary: Update Label Classes
description: Updates the name of an existing answer class on a task.
operationId: update_label_classes_labelClasses_public_v1_update_patch
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: task_id
in: query
required: true
schema:
type: integer
description: Task ID
title: Task Id
description: Task ID
- name: force
in: query
required: false
schema:
type: boolean
default: false
title: Force
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAnswerBody'
examples:
- answer: old_label
new_answer: updated_label
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLabelClassResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/public/v1/add:
post:
tags:
- Add and Manage Tasks
summary: Create a new task
description: Creates a new task in the specified project with the given type, prompt, and answer classes.
operationId: task_add_public_tasks_public_v1_add_post
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TaskClassification'
- $ref: '#/components/schemas/TaskSegmentation'
- $ref: '#/components/schemas/TaskRange'
title: Body
examples:
- task_name: Image Classification
project_id: 123
task_prompt: Classify the medical condition in this image
task_type: classification
multi_answer: false
answer_classes:
- normal
- abnormal
- uncertain
task_description: This task involves segmenting the liver, kidney, and heart.
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ExistingTaskClassification'
- $ref: '#/components/schemas/ExistingTaskSegmentation'
- $ref: '#/components/schemas/ExistingTaskRange'
title: Response Task Add Public Tasks Public V1 Add Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- BearerToken: []
/tasks/public/v1/duplicate:
post:
tags:
- Add and Manage Tasks
summary: Duplicate an existing task
description: Creates a copy of an existing task, optionally copying gold standards, labels, and tags.
operationId: task_duplicate_tasks_public_v1_duplicate_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DuplicateTaskFields'
examples:
- task_id: 123
task_type: classification
task_name: Copy of Original Task
task_prompt: Classify the medical condition in this image
copy_pre_answer_explainers: true
copy_patches: true
copy_gold_standards: true
copy_internal_notes: true
copy_explanations: true
copy_tags: true
required: true
responses:
'202':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DuplicateTaskResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- BearerToken: []
/tasks/public/v1/get:
get:
tags:
- Add and Manage Tasks
summary: Retrieve information about a specific task
description: Returns detailed information about a task by its ID.
operationId: task_get_tasks_public_v1_get_get
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: task_id
in: query
required: true
schema:
type: integer
description: The task ID
title: Task Id
description: The task ID
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ExistingTaskClassification'
- $ref: '#/components/schemas/ExistingTaskSegmentation'
- $ref: '#/components/schemas/ExistingTaskRange'
title: Response Task Get Tasks Public V1 Get Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/public/v1/instructions:
post:
tags:
- Add and Manage Tasks
summary: Set instructions for a task
description: Create instruction slides for a task
operationId: task_set_instructions_tasks_public_v1_instructions_post
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: task_id
in: query
required: true
schema:
type: integer
description: The task ID
title: Task Id
description: The task ID
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SetInstructionsRequest'
examples:
- slides:
-
Welcome to this task!
- Here are the instructions...
is_major_version: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseSummary'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/public/v1/list:
get:
tags:
- Add and Manage Tasks
summary: List your available tasks
description: Returns a paginated list of tasks, optionally filtered by project, organization, or search term.
operationId: task_list_tasks_public_v1_list_get
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: search_term
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: An optional search term to filter on
title: Search Term
description: An optional search term to filter on
- name: project_id
in: query
required: false
schema:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
description: The project ID
title: Project Id
description: The project ID
- name: last_sequence_id
in: query
required: false
schema:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
description: The paging token containing the last sequence ID from the previous page
title: Last Sequence Id
description: The paging token containing the last sequence ID from the previous page
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
maximum: 1000
minimum: 1
exclusiveMinimum: 0
- type: 'null'
description: The maximum number of results per page
default: 100
title: Limit
description: The maximum number of results per page
- name: organization_id
in: query
required: false
schema:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
description: Organization ID for filtering
title: Organization Id
description: Organization ID for filtering
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/public/v1/set:
patch:
tags:
- Add and Manage Tasks
summary: Update an existing task
description: Updates properties of an existing task such as name, prompt, answer classes, and labeling stage.
operationId: task_update_public_tasks_public_v1_set_patch
security:
- APIKeyHeader: []
- BearerToken: []
parameters:
- name: task_id
in: query
required: true
schema:
type: integer
description: The task ID
title: Task Id
description: The task ID
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/UpdateTaskClassification'
- $ref: '#/components/schemas/UpdateTask'
examples:
- task_name: Updated Task Name
task_prompt: Updated task prompt for better clarity
task_description: Updated description with additional details about the task.
- task_name: Updated Task with Stage
task_labeling_stage: open
task_labeling_stage_note: Opening task for labeling
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/ExistingTaskClassification'
- $ref: '#/components/schemas/ExistingTaskSegmentation'
- $ref: '#/components/schemas/ExistingTaskRange'
title: Response Task Update Public Tasks Public V1 Set Patch
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/public/v2/add:
post:
tags:
- Add and Manage Tasks
summary: Create a new task
description: Creates a new task in the project, supporting label class groups and free-text question types.
operationId: task_add_public_tasks_public_v2_add_post
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TaskClassification_V2'
- $ref: '#/components/schemas/TaskSegmentation_V2'
- $ref: '#/components/schemas/TaskRange_V2'
title: Body
examples:
- task_name: Image Classification
project_id: 123
task_prompt: Classify the medical condition in this image
task_type: classification
multi_answer: false
answer_classes:
- normal
- abnormal
- uncertain
task_description: This task involves segmenting the liver, kidney, and heart.
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ExistingTaskClassification_V2'
- $ref: '#/components/schemas/ExistingTaskSegmentation'
- $ref: '#/components/schemas/ExistingTaskRange'
title: Response Task Add Public Tasks Public V2 Add Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- APIKeyHeader: []
- BearerToken: []
components:
schemas:
LabelClassValue:
properties:
value:
type: string
title: Value
label_class_group_id:
anyOf:
- type: integer
- type: 'null'
title: Label Class Group Id
type: object
required:
- value
title: LabelClassValue
ExistingTaskSegmentation:
properties:
task_type:
$ref: '#/components/schemas/TaskTypeSegmentation'
title:
type: string
minLength: 1
title: Title
prompt:
type: string
maxLength: 52
minLength: 1
title: Prompt
answers:
items:
type: string
type: array
minItems: 1
title: Answers
unique_items: true
is_variable_answer_choice:
type: boolean
const: false
title: Is Variable Answer Choice
default: false
description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Description
n_contexts_per_problem:
anyOf:
- type: string
- type: number
title: N Contexts Per Problem
n_targets_per_problem:
anyOf:
- type: string
- type: number
title: N Targets Per Problem
view_mapping:
anyOf:
- items:
$ref: '#/components/schemas/ViewMapping'
type: array
maxLength: 10
minLength: 1
unique_items: true
- type: 'null'
title: View Mapping
organization_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Organization Id
project_id:
type: integer
exclusiveMinimum: 0
title: Project Id
platforms:
items:
$ref: '#/components/schemas/TaskPlatform'
type: array
title: Platforms
audiences:
items:
$ref: '#/components/schemas/TaskAudience'
type: array
title: Audiences
id:
type: integer
title: Id
created_at:
type: string
title: Created At
updated_at:
type: string
title: Updated At
is_multi_answer:
type: boolean
const: true
title: Is Multi Answer
default: true
n_levels_per_problem:
type: integer
title: N Levels Per Problem
readOnly: true
is_multiple_assets:
type: boolean
title: Is Multiple Assets
readOnly: true
type: object
required:
- task_type
- title
- prompt
- answers
- project_id
- id
- created_at
- updated_at
- n_levels_per_problem
- is_multiple_assets
title: ExistingTaskSegmentation
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
TaskTypeClassification:
type: string
enum:
- classification
title: TaskTypeClassification
TaskRange:
properties:
task_type:
$ref: '#/components/schemas/TaskTypeRange'
title:
type: string
minLength: 1
title: Title
prompt:
type: string
maxLength: 52
minLength: 1
title: Prompt
answers:
items:
type: string
type: array
minItems: 1
title: Answers
unique_items: true
is_variable_answer_choice:
type: boolean
const: false
title: Is Variable Answer Choice
default: false
description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Description
n_contexts_per_problem:
anyOf:
- type: number
- type: integer
multipleOf: 2
minimum: 0
title: N Contexts Per Problem
default: 0
n_targets_per_problem:
anyOf:
- type: number
- type: integer
exclusiveMinimum: 0
title: N Targets Per Problem
default: 1
view_mapping:
anyOf:
- items:
$ref: '#/components/schemas/ViewMapping'
type: array
maxLength: 10
minLength: 1
unique_items: true
- type: 'null'
title: View Mapping
organization_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Organization Id
project_id:
type: integer
exclusiveMinimum: 0
title: Project Id
platforms:
items:
$ref: '#/components/schemas/TaskPlatform'
type: array
title: Platforms
audiences:
items:
$ref: '#/components/schemas/TaskAudience'
type: array
title: Audiences
is_multi_answer:
type: boolean
const: true
title: Is Multi Answer
default: true
additionalProperties: false
type: object
required:
- task_type
- title
- prompt
- answers
- project_id
title: TaskRange
UpdateTask:
properties:
task_name:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: Task Name
task_prompt:
anyOf:
- type: string
maxLength: 52
minLength: 1
- type: 'null'
title: Task Prompt
force:
type: boolean
title: Force
default: false
platforms:
anyOf:
- items:
$ref: '#/components/schemas/TaskPlatform'
type: array
- type: 'null'
title: Platforms
audiences:
anyOf:
- items:
$ref: '#/components/schemas/TaskAudience'
type: array
- type: 'null'
title: Audiences
task_description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Task Description
task_labeling_stage:
anyOf:
- $ref: '#/components/schemas/TaskLabelingStage'
- type: string
- type: 'null'
title: Task Labeling Stage
task_labeling_stage_note:
anyOf:
- type: string
- type: 'null'
title: Task Labeling Stage Note
additionalProperties: false
type: object
title: UpdateTask
SetInstructionsRequest:
properties:
slides:
items:
type: string
type: array
maxItems: 100
minItems: 1
title: Slides
description: List of instruction slide content (HTML strings)
is_major_version:
type: boolean
title: Is Major Version
description: Whether this is a major version
default: true
type: object
required:
- slides
title: SetInstructionsRequest
ReorderLabelClassGroupsBody:
properties:
task_id:
type: integer
exclusiveMinimum: 0
title: Task Id
description: Task ID
new_label_class_groups_order:
items:
type: integer
type: array
title: New Label Class Groups Order
description: The new order of the label class groups
type: object
required:
- task_id
- new_label_class_groups_order
title: ReorderLabelClassGroupsBody
TaskPlatform:
type: string
enum:
- web
- ios
title: TaskPlatform
UpdateLabelClassGroupRequest:
properties:
prompt:
anyOf:
- type: string
- type: 'null'
title: Prompt
description: Prompt for the label class group
multi_answer:
anyOf:
- type: boolean
- type: 'null'
title: Multi Answer
description: Whether the label class group allows multiple answers
type: object
title: UpdateLabelClassGroupRequest
TaskSegmentation_V2:
properties:
freetext_types:
anyOf:
- items:
$ref: '#/components/schemas/CaseFreetextRequest'
type: array
maxItems: 1
- type: 'null'
title: Freetext Types
description: One case-level free-text question; pixel_seg tasks only
task_type:
$ref: '#/components/schemas/TaskTypeSegmentation'
title:
type: string
minLength: 1
title: Title
prompt:
type: string
maxLength: 52
minLength: 1
title: Prompt
answers:
items:
type: string
type: array
minItems: 1
title: Answers
unique_items: true
is_variable_answer_choice:
type: boolean
const: false
title: Is Variable Answer Choice
default: false
description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Description
n_contexts_per_problem:
anyOf:
- type: number
- type: integer
multipleOf: 2
minimum: 0
title: N Contexts Per Problem
default: 0
n_targets_per_problem:
anyOf:
- type: number
- type: integer
exclusiveMinimum: 0
title: N Targets Per Problem
default: 1
view_mapping:
anyOf:
- items:
$ref: '#/components/schemas/ViewMapping'
type: array
maxLength: 10
minLength: 1
unique_items: true
- type: 'null'
title: View Mapping
organization_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Organization Id
project_id:
type: integer
exclusiveMinimum: 0
title: Project Id
platforms:
items:
$ref: '#/components/schemas/TaskPlatform'
type: array
title: Platforms
audiences:
items:
$ref: '#/components/schemas/TaskAudience'
type: array
title: Audiences
is_multi_answer:
type: boolean
const: true
title: Is Multi Answer
default: true
additionalProperties: false
type: object
required:
- task_type
- title
- prompt
- answers
- project_id
title: TaskSegmentation_V2
ResponseDetails:
properties:
messages:
items:
type: string
type: array
title: Messages
path:
anyOf:
- items:
anyOf:
- type: integer
- type: string
type: array
- type: 'null'
title: Path
data:
anyOf:
- additionalProperties: true
type: object
- items: {}
type: array
- type: string
- type: 'null'
title: Data
type: object
required:
- messages
title: ResponseDetails
ExistingTaskClassification_V2:
properties:
task_type:
$ref: '#/components/schemas/TaskTypeClassification'
title:
type: string
minLength: 1
title: Title
prompt:
type: string
maxLength: 52
minLength: 1
title: Prompt
answers:
items:
type: string
type: array
minItems: 1
title: Answers
unique_items: true
is_variable_answer_choice:
type: boolean
title: Is Variable Answer Choice
default: false
description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Description
n_contexts_per_problem:
anyOf:
- type: string
- type: number
title: N Contexts Per Problem
n_targets_per_problem:
anyOf:
- type: string
- type: number
title: N Targets Per Problem
view_mapping:
anyOf:
- items:
$ref: '#/components/schemas/ViewMapping'
type: array
maxLength: 10
minLength: 1
unique_items: true
- type: 'null'
title: View Mapping
organization_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Organization Id
project_id:
type: integer
exclusiveMinimum: 0
title: Project Id
platforms:
items:
$ref: '#/components/schemas/TaskPlatform'
type: array
title: Platforms
audiences:
items:
$ref: '#/components/schemas/TaskAudience'
type: array
title: Audiences
id:
type: integer
title: Id
created_at:
type: string
title: Created At
updated_at:
type: string
title: Updated At
is_multi_answer:
type: boolean
title: Is Multi Answer
default: false
label_class_group_ids:
items:
type: integer
type: array
title: Label Class Group Ids
n_levels_per_problem:
type: integer
title: N Levels Per Problem
readOnly: true
is_multiple_assets:
type: boolean
title: Is Multiple Assets
readOnly: true
type: object
required:
- task_type
- title
- prompt
- answers
- project_id
- id
- created_at
- updated_at
- n_levels_per_problem
- is_multiple_assets
title: ExistingTaskClassification_V2
AddLabelClassGroupRequest:
properties:
task_id:
type: integer
title: Task Id
description: Task ID
prompt:
type: string
title: Prompt
description: Prompt for the label class group
multi_answer:
type: boolean
title: Multi Answer
description: Whether the label class group allows multiple answers
default: false
label_class_ids:
anyOf:
- items:
type: integer
type: array
unique_items: true
- type: 'null'
title: Label Class Ids
description: The label class IDs for the label class group
type: object
required:
- task_id
- prompt
title: AddLabelClassGroupRequest
ViewMapping:
properties:
view:
type: string
maxLength: 20
minLength: 1
title: View
index:
type: integer
title: Index
type: object
required:
- view
- index
title: ViewMapping
AddAnswerRequest:
properties:
task_id:
type: integer
title: Task Id
new_answers:
items:
type: string
maxLength: 60
minLength: 1
type: array
minItems: 1
title: New Answers
unique_items: true
force:
type: boolean
title: Force
default: false
label_class_group_id:
anyOf:
- type: integer
- type: 'null'
title: Label Class Group Id
description: The ID of the label class group
type: object
required:
- task_id
- new_answers
title: AddAnswerRequest
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
TaskTypeSegmentation:
type: string
enum:
- circle
- box
- line
- polygon
- cuboid
- pixel_seg
- point2d
title: TaskTypeSegmentation
ReorderAnswersBody:
properties:
task_id:
type: integer
exclusiveMinimum: 0
title: Task Id
description: Task ID
new_answers_ids_order:
items:
type: integer
minimum: 0
type: array
minItems: 1
title: New Answers Ids Order
description: The new order of the answer choices IDs
type: object
required:
- task_id
- new_answers_ids_order
title: ReorderAnswersBody
GetLabelClassGroupResponse:
properties:
label_class_group_id:
type: integer
title: Label Class Group Id
description: The ID of the label class group
prompt:
type: string
title: Prompt
description: Prompt for the label class group
multi_answer:
type: boolean
title: Multi Answer
description: Whether the label class group allows multiple answers
group_order:
type: integer
title: Group Order
description: The order of the label class group
answer_classes:
items:
type: string
type: array
title: Answer Classes
description: The answers for the label class group
unique_items: true
type: object
required:
- label_class_group_id
- prompt
- multi_answer
- group_order
title: GetLabelClassGroupResponse
FreetextTypeRequest:
properties:
freetext_type:
type: string
enum:
- frame_class_freetext
- frame_class_object_freetext
title: Freetext Type
description: The type of free-text question
user_prompt:
type: string
title: User Prompt
description: The question shown to the labeler
requirement_status:
type: string
enum:
- mandatory
- optional
- disallowed
title: Requirement Status
description: Whether the labeler must, may, or cannot answer this question
prefilled_value:
anyOf:
- type: string
- type: 'null'
title: Prefilled Value
description: Optional default text
answer_class_name:
anyOf:
- type: string
- type: 'null'
title: Answer Class Name
description: If set, this question only shows when this answer class is selected. Resolved to label_class_id after task creation.
type: object
required:
- freetext_type
- user_prompt
- requirement_status
title: FreetextTypeRequest
CaseFreetextRequest:
properties:
freetext_type:
type: string
const: frame_class_freetext
title: Freetext Type
description: A case-level question is a frame_class_freetext with no answer class
user_prompt:
type: string
title: User Prompt
description: The question shown to the labeler
requirement_status:
type: string
enum:
- mandatory
- optional
title: Requirement Status
description: Whether the labeler must or may answer the question
prefilled_value:
anyOf:
- type: string
- type: 'null'
title: Prefilled Value
description: Optional default text
answer_class_name:
type: 'null'
title: Answer Class Name
description: 'Not allowed: the question applies to the whole case'
type: object
required:
- freetext_type
- user_prompt
- requirement_status
title: CaseFreetextRequest
description: The case-level free-text question a pixel_seg task takes.
DuplicateTaskResult:
properties:
task_id:
type: integer
exclusiveMinimum: 0
title: Task Id
description: The task ID
type: object
required:
- task_id
title: DuplicateTaskResult
AnswerClassGroupParams:
properties:
prompt:
type: string
title: Prompt
description: Prompt for the label class group
multi_answer:
type: boolean
title: Multi Answer
description: Whether the label class group allows multiple answers
default: false
answer_classes:
items:
type: string
maxLength: 60
minLength: 1
type: array
title: Answer Classes
description: The answers for the label class group
unique_items: true
type: object
required:
- prompt
- answer_classes
title: AnswerClassGroupParams
UpdateAnswerBody:
properties:
answer:
type: string
maxLength: 60
minLength: 1
title: Answer
new_answer:
type: string
maxLength: 60
minLength: 1
title: New Answer
type: object
required:
- answer
- new_answer
title: UpdateAnswerBody
example:
answer: old_answer
new_answer: new_answer
LabelClassValueLegacy:
properties:
value:
type: string
title: Value
type: object
required:
- value
title: LabelClassValueLegacy
UpdateLabelClassResponse:
properties:
value:
type: string
title: Value
type: object
required:
- value
title: UpdateLabelClassResponse
TaskRange_V2:
properties:
label_class_groups:
anyOf:
- items:
$ref: '#/components/schemas/AnswerClassGroupParams'
type: array
- type: 'null'
title: Label Class Groups
description: The label class groups for the task
freetext_types:
anyOf:
- items:
$ref: '#/components/schemas/FreetextTypeRequest'
type: array
- type: 'null'
title: Freetext Types
description: Free-text questions to attach to the task
task_type:
$ref: '#/components/schemas/TaskTypeRange'
title:
type: string
minLength: 1
title: Title
prompt:
type: string
maxLength: 52
minLength: 1
title: Prompt
answers:
items:
type: string
type: array
minItems: 1
title: Answers
unique_items: true
is_variable_answer_choice:
type: boolean
const: false
title: Is Variable Answer Choice
default: false
description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Description
n_contexts_per_problem:
anyOf:
- type: number
- type: integer
multipleOf: 2
minimum: 0
title: N Contexts Per Problem
default: 0
n_targets_per_problem:
anyOf:
- type: number
- type: integer
exclusiveMinimum: 0
title: N Targets Per Problem
default: 1
view_mapping:
anyOf:
- items:
$ref: '#/components/schemas/ViewMapping'
type: array
maxLength: 10
minLength: 1
unique_items: true
- type: 'null'
title: View Mapping
organization_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Organization Id
project_id:
type: integer
exclusiveMinimum: 0
title: Project Id
platforms:
items:
$ref: '#/components/schemas/TaskPlatform'
type: array
title: Platforms
audiences:
items:
$ref: '#/components/schemas/TaskAudience'
type: array
title: Audiences
is_multi_answer:
type: boolean
const: true
title: Is Multi Answer
default: true
additionalProperties: false
type: object
required:
- task_type
- title
- prompt
- answers
- project_id
title: TaskRange_V2
TaskSegmentation:
properties:
task_type:
$ref: '#/components/schemas/TaskTypeSegmentation'
title:
type: string
minLength: 1
title: Title
prompt:
type: string
maxLength: 52
minLength: 1
title: Prompt
answers:
items:
type: string
type: array
minItems: 1
title: Answers
unique_items: true
is_variable_answer_choice:
type: boolean
const: false
title: Is Variable Answer Choice
default: false
description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Description
n_contexts_per_problem:
anyOf:
- type: number
- type: integer
multipleOf: 2
minimum: 0
title: N Contexts Per Problem
default: 0
n_targets_per_problem:
anyOf:
- type: number
- type: integer
exclusiveMinimum: 0
title: N Targets Per Problem
default: 1
view_mapping:
anyOf:
- items:
$ref: '#/components/schemas/ViewMapping'
type: array
maxLength: 10
minLength: 1
unique_items: true
- type: 'null'
title: View Mapping
organization_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Organization Id
project_id:
type: integer
exclusiveMinimum: 0
title: Project Id
platforms:
items:
$ref: '#/components/schemas/TaskPlatform'
type: array
title: Platforms
audiences:
items:
$ref: '#/components/schemas/TaskAudience'
type: array
title: Audiences
is_multi_answer:
type: boolean
const: true
title: Is Multi Answer
default: true
additionalProperties: false
type: object
required:
- task_type
- title
- prompt
- answers
- project_id
title: TaskSegmentation
ExistingTaskClassification:
properties:
task_type:
$ref: '#/components/schemas/TaskTypeClassification'
title:
type: string
minLength: 1
title: Title
prompt:
type: string
maxLength: 52
minLength: 1
title: Prompt
answers:
items:
type: string
type: array
minItems: 1
title: Answers
unique_items: true
is_variable_answer_choice:
type: boolean
title: Is Variable Answer Choice
default: false
description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Description
n_contexts_per_problem:
anyOf:
- type: string
- type: number
title: N Contexts Per Problem
n_targets_per_problem:
anyOf:
- type: string
- type: number
title: N Targets Per Problem
view_mapping:
anyOf:
- items:
$ref: '#/components/schemas/ViewMapping'
type: array
maxLength: 10
minLength: 1
unique_items: true
- type: 'null'
title: View Mapping
organization_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Organization Id
project_id:
type: integer
exclusiveMinimum: 0
title: Project Id
platforms:
items:
$ref: '#/components/schemas/TaskPlatform'
type: array
title: Platforms
audiences:
items:
$ref: '#/components/schemas/TaskAudience'
type: array
title: Audiences
id:
type: integer
title: Id
created_at:
type: string
title: Created At
updated_at:
type: string
title: Updated At
is_multi_answer:
type: boolean
title: Is Multi Answer
default: false
n_levels_per_problem:
type: integer
title: N Levels Per Problem
readOnly: true
is_multiple_assets:
type: boolean
title: Is Multiple Assets
readOnly: true
type: object
required:
- task_type
- title
- prompt
- answers
- project_id
- id
- created_at
- updated_at
- n_levels_per_problem
- is_multiple_assets
title: ExistingTaskClassification
AddLabelClassGroupResponse:
properties:
task_id:
type: integer
title: Task Id
description: Task ID
prompt:
type: string
title: Prompt
description: Prompt for the label class group
multi_answer:
type: boolean
title: Multi Answer
description: Whether the label class group allows multiple answers
default: false
label_class_ids:
anyOf:
- items:
type: integer
type: array
unique_items: true
- type: 'null'
title: Label Class Ids
description: The label class IDs for the label class group
label_class_group_id:
type: integer
title: Label Class Group Id
description: The ID of the label class group
type: object
required:
- task_id
- prompt
- label_class_group_id
title: AddLabelClassGroupResponse
DuplicateTaskFields:
properties:
task_id:
type: integer
exclusiveMinimum: 0
title: Task Id
task_name:
anyOf:
- type: string
- type: 'null'
title: Task Name
task_prompt:
anyOf:
- type: string
- type: 'null'
title: Task Prompt
task_type:
anyOf:
- $ref: '#/components/schemas/TaskTypeSegmentation'
- $ref: '#/components/schemas/TaskTypeClassification'
- $ref: '#/components/schemas/TaskTypeRange'
- type: 'null'
title: Task Type
copy_pre_answer_explainers:
anyOf:
- type: boolean
- type: 'null'
title: Copy Pre Answer Explainers
default: false
copy_patches:
anyOf:
- type: boolean
- type: 'null'
title: Copy Patches
default: true
copy_gold_standards:
anyOf:
- type: boolean
- type: 'null'
title: Copy Gold Standards
default: false
copy_internal_notes:
anyOf:
- type: boolean
- type: 'null'
title: Copy Internal Notes
default: false
copy_explanations:
anyOf:
- type: boolean
- type: 'null'
title: Copy Explanations
default: false
copy_tags:
anyOf:
- type: boolean
- type: 'null'
title: Copy Tags
default: false
task_description:
anyOf:
- type: string
- type: 'null'
title: Task Description
copy_label_class_groups:
type: boolean
title: Copy Label Class Groups
default: false
type: object
required:
- task_id
title: DuplicateTaskFields
TaskAudience:
type: string
enum:
- crowd
- expert
title: TaskAudience
TaskClassification_V2:
properties:
label_class_groups:
anyOf:
- items:
$ref: '#/components/schemas/AnswerClassGroupParams'
type: array
- type: 'null'
title: Label Class Groups
description: The label class groups for the task
freetext_types:
anyOf:
- items:
$ref: '#/components/schemas/FreetextTypeRequest'
type: array
- type: 'null'
title: Freetext Types
description: Free-text questions to attach to the task
task_type:
$ref: '#/components/schemas/TaskTypeClassification'
title:
type: string
minLength: 1
title: Title
prompt:
type: string
maxLength: 52
minLength: 1
title: Prompt
answers:
items:
type: string
type: array
minItems: 1
title: Answers
unique_items: true
is_variable_answer_choice:
type: boolean
title: Is Variable Answer Choice
default: false
description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Description
n_contexts_per_problem:
anyOf:
- type: number
- type: integer
multipleOf: 2
minimum: 0
title: N Contexts Per Problem
default: 0
n_targets_per_problem:
anyOf:
- type: number
- type: integer
exclusiveMinimum: 0
title: N Targets Per Problem
default: 1
view_mapping:
anyOf:
- items:
$ref: '#/components/schemas/ViewMapping'
type: array
maxLength: 10
minLength: 1
unique_items: true
- type: 'null'
title: View Mapping
organization_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Organization Id
project_id:
type: integer
exclusiveMinimum: 0
title: Project Id
platforms:
items:
$ref: '#/components/schemas/TaskPlatform'
type: array
title: Platforms
audiences:
items:
$ref: '#/components/schemas/TaskAudience'
type: array
title: Audiences
is_multi_answer:
type: boolean
title: Is Multi Answer
default: false
additionalProperties: false
type: object
required:
- task_type
- title
- prompt
- answers
- project_id
title: TaskClassification_V2
TaskLabelingStage:
type: string
enum:
- pending
- assignment
- open
- paused
- closed
title: TaskLabelingStage
TaskClassification:
properties:
task_type:
$ref: '#/components/schemas/TaskTypeClassification'
title:
type: string
minLength: 1
title: Title
prompt:
type: string
maxLength: 52
minLength: 1
title: Prompt
answers:
items:
type: string
type: array
minItems: 1
title: Answers
unique_items: true
is_variable_answer_choice:
type: boolean
title: Is Variable Answer Choice
default: false
description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Description
n_contexts_per_problem:
anyOf:
- type: number
- type: integer
multipleOf: 2
minimum: 0
title: N Contexts Per Problem
default: 0
n_targets_per_problem:
anyOf:
- type: number
- type: integer
exclusiveMinimum: 0
title: N Targets Per Problem
default: 1
view_mapping:
anyOf:
- items:
$ref: '#/components/schemas/ViewMapping'
type: array
maxLength: 10
minLength: 1
unique_items: true
- type: 'null'
title: View Mapping
organization_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Organization Id
project_id:
type: integer
exclusiveMinimum: 0
title: Project Id
platforms:
items:
$ref: '#/components/schemas/TaskPlatform'
type: array
title: Platforms
audiences:
items:
$ref: '#/components/schemas/TaskAudience'
type: array
title: Audiences
is_multi_answer:
type: boolean
title: Is Multi Answer
default: false
additionalProperties: false
type: object
required:
- task_type
- title
- prompt
- answers
- project_id
title: TaskClassification
ResponseSummary:
properties:
message:
type: string
title: Message
details:
anyOf:
- items:
$ref: '#/components/schemas/ResponseDetails'
type: array
- type: 'null'
title: Details
additionalProperties: false
type: object
required:
- message
title: ResponseSummary
TaskListResponse:
properties:
payload:
items:
anyOf:
- $ref: '#/components/schemas/ExistingTaskClassification'
- $ref: '#/components/schemas/ExistingTaskSegmentation'
- $ref: '#/components/schemas/ExistingTaskRange'
type: array
title: Payload
description: The list of tasks
has_next:
type: boolean
title: Has Next
description: Whether or not the list of tasks has reached the end
last_sequence_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Last Sequence Id
description: If has_next is true, the last_sequence_id is the token that should accompany the next request to get the following page of results
limit:
anyOf:
- type: integer
maximum: 1000
minimum: 1
exclusiveMinimum: 0
- type: 'null'
title: Limit
description: The maximum number of tasks to retrieve per page
default: 100
type: object
required:
- payload
- has_next
title: TaskListResponse
TaskTypeRange:
type: string
enum:
- range
- named_entity_recognition
- range_selection_time
title: TaskTypeRange
UpdateTaskClassification:
properties:
task_name:
anyOf:
- type: string
minLength: 1
- type: 'null'
title: Task Name
task_prompt:
anyOf:
- type: string
maxLength: 52
minLength: 1
- type: 'null'
title: Task Prompt
force:
type: boolean
title: Force
default: false
platforms:
anyOf:
- items:
$ref: '#/components/schemas/TaskPlatform'
type: array
- type: 'null'
title: Platforms
audiences:
anyOf:
- items:
$ref: '#/components/schemas/TaskAudience'
type: array
- type: 'null'
title: Audiences
task_description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Task Description
task_labeling_stage:
anyOf:
- $ref: '#/components/schemas/TaskLabelingStage'
- type: string
- type: 'null'
title: Task Labeling Stage
task_labeling_stage_note:
anyOf:
- type: string
- type: 'null'
title: Task Labeling Stage Note
is_multi_answer:
anyOf:
- type: boolean
- type: 'null'
title: Is Multi Answer
additionalProperties: false
type: object
title: UpdateTaskClassification
ExistingTaskRange:
properties:
task_type:
$ref: '#/components/schemas/TaskTypeRange'
title:
type: string
minLength: 1
title: Title
prompt:
type: string
maxLength: 52
minLength: 1
title: Prompt
answers:
items:
type: string
type: array
minItems: 1
title: Answers
unique_items: true
is_variable_answer_choice:
type: boolean
const: false
title: Is Variable Answer Choice
default: false
description:
anyOf:
- type: string
maxLength: 1024
minLength: 1
- type: 'null'
title: Description
n_contexts_per_problem:
anyOf:
- type: string
- type: number
title: N Contexts Per Problem
n_targets_per_problem:
anyOf:
- type: string
- type: number
title: N Targets Per Problem
view_mapping:
anyOf:
- items:
$ref: '#/components/schemas/ViewMapping'
type: array
maxLength: 10
minLength: 1
unique_items: true
- type: 'null'
title: View Mapping
organization_id:
anyOf:
- type: integer
exclusiveMinimum: 0
- type: 'null'
title: Organization Id
project_id:
type: integer
exclusiveMinimum: 0
title: Project Id
platforms:
items:
$ref: '#/components/schemas/TaskPlatform'
type: array
title: Platforms
audiences:
items:
$ref: '#/components/schemas/TaskAudience'
type: array
title: Audiences
id:
type: integer
title: Id
created_at:
type: string
title: Created At
updated_at:
type: string
title: Updated At
is_multi_answer:
type: boolean
const: true
title: Is Multi Answer
default: true
n_levels_per_problem:
type: integer
title: N Levels Per Problem
readOnly: true
is_multiple_assets:
type: boolean
title: Is Multiple Assets
readOnly: true
type: object
required:
- task_type
- title
- prompt
- answers
- project_id
- id
- created_at
- updated_at
- n_levels_per_problem
- is_multiple_assets
title: ExistingTaskRange
securitySchemes:
APIKeyHeader:
type: apiKey
description: Your Centaur API key
in: header
name: X-API-KEY
BearerToken:
type: http
description: Bearer token obtained from authentication endpoint
scheme: bearer
x-provenance:
method: searched
source: https://docs.centaurlabs.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.centaurlabs.com/reference/add_asset_and_case_from_file_cases_public_v1_addimagefromfile_post.md
- https://docs.centaurlabs.com/reference/add_asset_to_task_tasks_assets_public_v1_add_post.md
- https://docs.centaurlabs.com/reference/add_assets_from_urls_imports_public_v1_addassetsfromurls_post.md
- https://docs.centaurlabs.com/reference/add_files_manifest_manifests_public_v1_add_post.md
- https://docs.centaurlabs.com/reference/add_import_imports_public_v1_add_post.md
- https://docs.centaurlabs.com/reference/add_imports_to_task_public_tasks_imports_public_v1_add_post.md
- https://docs.centaurlabs.com/reference/create_project_public_projects_public_v1_add_post.md
- https://docs.centaurlabs.com/reference/delete_case_cases_public_v1_delete_delete.md
- https://docs.centaurlabs.com/reference/delete_project_projects_public_v1_delete_delete.md
- https://docs.centaurlabs.com/reference/get_import_policy_imports_public_v1_policy_get_get.md
- https://docs.centaurlabs.com/reference/get_import_public_imports_public_v1_get_get.md
- https://docs.centaurlabs.com/reference/get_manifest_manifests_public_v1_get_get.md
- https://docs.centaurlabs.com/reference/get_project_projects_public_v1_get_get.md
- https://docs.centaurlabs.com/reference/get_version_imports_public_api_v1_version_get.md
- https://docs.centaurlabs.com/reference/handler_add_answer_labelclasses_public_v1_add_post.md
- https://docs.centaurlabs.com/reference/handler_add_answer_legacy_answers_public_v1_add_post.md
- https://docs.centaurlabs.com/reference/handler_add_existing_answers_to_label_class_group_labelclasses_public_v1_groups__label_class_group_id__answers_post.md
- https://docs.centaurlabs.com/reference/handler_add_label_class_group_labelclasses_public_v1_groups_post.md
- https://docs.centaurlabs.com/reference/handler_delete_answer_labelclasses_public_v1_delete_delete.md
- https://docs.centaurlabs.com/reference/handler_delete_answer_legacy_answers_public_v1_delete_delete.md
- https://docs.centaurlabs.com/reference/handler_delete_answers_from_label_class_group_labelclasses_public_v1_groups__label_class_group_id__answers_delete.md
- https://docs.centaurlabs.com/reference/handler_delete_label_class_group_labelclasses_public_v1_groups__label_class_group_id__delete.md
- https://docs.centaurlabs.com/reference/handler_duplicate_case_cases_public_v1_duplicate_post.md
- https://docs.centaurlabs.com/reference/handler_get_label_class_group_labelclasses_public_v1_groups__label_class_group_id__get.md
- https://docs.centaurlabs.com/reference/handler_list_label_class_groups_labelclasses_public_v1_groups_get.md
- https://docs.centaurlabs.com/reference/handler_reorder_answers_labelclasses_public_v1_reorder_put.md
- https://docs.centaurlabs.com/reference/handler_reorder_label_class_groups_labelclasses_public_v1_groups_reorder_put.md
- https://docs.centaurlabs.com/reference/handler_set_prelabels_override_cases_prelabels_public_v1_set_put.md
- https://docs.centaurlabs.com/reference/handler_unset_prelabels_from_problems_cases_prelabels_public_v1_unset_delete.md
- https://docs.centaurlabs.com/reference/handler_unset_prelabels_from_task_tasks_prelabels_public_v1_unset_delete.md
- https://docs.centaurlabs.com/reference/handler_update_label_class_group_labelclasses_public_v1_groups__label_class_group_id__patch.md
- https://docs.centaurlabs.com/reference/import_delete_imports_public_v1_delete_delete.md
- https://docs.centaurlabs.com/reference/list_import_imports_public_v1_list_get.md
- https://docs.centaurlabs.com/reference/list_projects_projects_public_v1_list_get.md
- https://docs.centaurlabs.com/reference/public_add_asset_tag_tags_public_v1_asset_add_post.md
- https://docs.centaurlabs.com/reference/public_add_tag_tags_public_v1_add_post.md
- https://docs.centaurlabs.com/reference/public_list_asset_tags_tags_public_v1_asset_list_get.md
- https://docs.centaurlabs.com/reference/public_list_assets_assets_public_v1_list_get.md
- https://docs.centaurlabs.com/reference/public_list_tags_tags_public_v1_list_get.md
- https://docs.centaurlabs.com/reference/public_remove_asset_tag_tags_public_v1_asset_delete_delete.md
- https://docs.centaurlabs.com/reference/public_remove_tag_tags_public_v1_delete_delete.md
- https://docs.centaurlabs.com/reference/set_gold_standards_override_cases_goldstandards_public_v1_set_patch.md
- https://docs.centaurlabs.com/reference/shared_add_asset_override_assets_public_v1_add_post.md
- https://docs.centaurlabs.com/reference/shared_get_asset_assets_public_v1_get_get.md
- https://docs.centaurlabs.com/reference/shared_list_assets_v2_assets_public_v2_list_post.md
- https://docs.centaurlabs.com/reference/shared_list_series_assets_public_v1_listseries_post.md
- https://docs.centaurlabs.com/reference/task_add_public_tasks_public_v1_add_post.md
- https://docs.centaurlabs.com/reference/task_add_public_tasks_public_v2_add_post.md
- https://docs.centaurlabs.com/reference/task_duplicate_tasks_public_v1_duplicate_post.md
- https://docs.centaurlabs.com/reference/task_get_tasks_public_v1_get_get.md
- https://docs.centaurlabs.com/reference/task_list_tasks_public_v1_list_get.md
- https://docs.centaurlabs.com/reference/task_set_instructions_tasks_public_v1_instructions_post.md
- https://docs.centaurlabs.com/reference/task_update_public_tasks_public_v1_set_patch.md
- https://docs.centaurlabs.com/reference/unset_gs_from_problems_cases_goldstandards_public_v1_unset_delete.md
- https://docs.centaurlabs.com/reference/unset_gs_from_task_tasks_goldstandards_public_v1_unset_delete.md
- https://docs.centaurlabs.com/reference/update_label_classes_answers_public_v1_update_patch.md
- https://docs.centaurlabs.com/reference/update_label_classes_labelclasses_public_v1_update_patch.md
- https://docs.centaurlabs.com/reference/update_problem_cases_custom_v1_update_patch.md
- https://docs.centaurlabs.com/reference/update_project_public_projects_public_v1_set_patch.md
- https://docs.centaurlabs.com/reference/validate_access_imports_public_v1_validateaccess_get.md
merge:
pages: 60
deduped: 323
conflicts_kept_first: 0