}`\n 2. Use that `import_id` with this GET endpoint to check the import status\n 3. Poll this endpoint to see if the import has completed, is still processing, or has failed\n 4. **Import errors and failures will only be visible in this GET response**, not in the original POST request\n \n This endpoint returns detailed information about the import including task counts, status, and any error messages.\n "
operationId: api_projects_imports_retrieve
parameters:
- description: A unique integer value identifying this project import.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: import_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectImport'
description: ''
security:
- Token: []
summary: 'Get project import status '
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name: tasks
x-fern-sdk-method-name: create_many_status
/api/projects/{id}/members/:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Remove a member from a specific project.
operationId: api_projects_members_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: Member removed
security:
- Token: []
summary: ✨ Remove member from project
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- members
x-fern-sdk-method-name: remove
get:
deprecated: true
description: |-
Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated).
Does NOT include annotators. Deprecated; use paginated endpoint.
operationId: api_projects_members_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: 'Comma-separated list of user IDs to include. Example: user_ids=1,2,3'
in: query
name: user_ids
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/LseUser'
type: array
description: List of users with membership information
security:
- Token: []
summary: Get project members
tags:
- Projects
x-fern-audiences:
- internal
x-fern-sdk-group-name:
- projects
- members
x-fern-sdk-method-name: get
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Add a member to a specific project.
operationId: api_projects_members_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectMemberRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ProjectMemberRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ProjectMemberRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectMember'
description: ''
security:
- Token: []
summary: ✨ Add project member
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- members
x-fern-sdk-method-name: add
/api/projects/{id}/members/bulk/:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Unassign project members in bulk. Allows the same request body as bulk assign.
operationId: api_projects_members_bulk_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Filter by last activity (ISO 8601 formatted date). Only when all=True.
in: query
name: last_activity__gte
schema:
type: string
- description: Filter by last activity upper bound (ISO 8601 formatted date). Only when all=True.
in: query
name: last_activity__lte
schema:
type: string
- description: Filter by role, project roles take precedence over organization roles. Only when all=True. (comma-separated values)
in: query
name: role
schema:
type: string
- description: Search term for filtering members by name, email, or username. Only when all=True.
in: query
name: search
schema:
type: string
- description: Multiple values may be separated by commas. (comma-separated values)
in: query
name: tags
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
unassignments:
type: integer
type: object
description: ''
security:
- Token: []
summary: ✨ Bulk unassign project members
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- members
- bulk
x-fern-sdk-method-name: delete
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Assign project members in bulk.
operationId: api_projects_members_bulk_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Filter by last activity (ISO 8601 formatted date). Only when all=True.
in: query
name: last_activity__gte
schema:
type: string
- description: Filter by last activity upper bound (ISO 8601 formatted date). Only when all=True.
in: query
name: last_activity__lte
schema:
type: string
- description: Filter by role, project roles take precedence over organization roles. Only when all=True. (comma-separated values)
in: query
name: role
schema:
type: string
- description: Search term for filtering members by name, email, or username. Only when all=True.
in: query
name: search
schema:
type: string
- description: Multiple values may be separated by commas. (comma-separated values)
in: query
name: tags
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectMemberBulkAssignRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ProjectMemberBulkAssignRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ProjectMemberBulkAssignRequest'
required: true
responses:
'200':
content:
application/json:
schema:
properties:
assignments:
type: integer
type: object
description: ''
security:
- Token: []
summary: ✨ Bulk assign project members
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- members
- bulk
x-fern-sdk-method-name: post
/api/projects/{id}/members/paginated/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve the members for a specific project.
**Response Fields:**
- `implicit_member` (boolean): Indicates if the user is an implicit member.
- `true`: User has access via workspace membership or organization role (Administrator/Owner)
- `false`: User is an explicit project member (added directly to the project)
- `project_role` (string|null): Project-specific role override if assigned, null otherwise
**Note:** Users can have both explicit membership AND implicit access. The `implicit_member` field is `false` if the user has an explicit ProjectMember entry, regardless of whether they also have implicit access via workspace or org role.
operationId: api_projects_members_paginated_list
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Comma-separated list of user IDs to filter by
in: query
name: ids
schema:
type: string
- description: Include/Exclude implicit project members in the results. If not provided, explicit + implicit members are returned.
in: query
name: implicit
schema:
type: boolean
- description: Filter by last activity time (ISO 8601 datetime). Returns users with last activity greater than or equal to this time.
in: query
name: last_activity__gte
schema:
format: date-time
type: string
- description: Filter by last activity time (ISO 8601 datetime). Returns users with last activity less than or equal to this time.
in: query
name: last_activity__lte
schema:
format: date-time
type: string
- description: Exclude annotators from the results
in: query
name: no_annotators
schema:
type: boolean
- description: |-
Ordering field. Prefix with "-" for descending order. Allowed fields: id, email, first_name, last_name, username, last_activity, role, date_joined
**Note on role ordering:**
When ordering by "role", the system uses the effective role:
- Project-specific role if assigned (takes precedence)
- Organization role if no project role is assigned
Roles are sorted alphabetically by their code: AD (Administrator), AN (Annotator), DI (Disabled), MA (Manager), NO (Not Activated), OW (Owner), RE (Reviewer)
in: query
name: ordering
schema:
type: string
- description: A page number within the paginated result set.
in: query
name: page
required: false
schema:
type: integer
- description: Number of results to return per page.
in: query
name: page_size
required: false
schema:
type: integer
- description: |-
Filter members by role. Accepts single role or comma-separated list of roles.
**Format:**
- Single role: `?role=RE`
- Multiple roles: `?role=AN,RE` (users with ANY of these roles)
**Role Codes:**
- `OW` = Owner
- `AD` = Administrator
- `MA` = Manager
- `RE` = Reviewer
- `AN` = Annotator
**Matching Logic:**
Returns users who have any of the specified roles either:
1. As their **project-specific role** (from project role assignments), OR
2. As their **organization role** (if they have no project-specific role override)
**Note:** Project-specific roles take precedence. If a user has a project role assigned, their organization role is ignored for filtering purposes.
in: query
name: role
schema:
type: string
- description: Search term for filtering members by name, email, or username
in: query
name: search
schema:
type: string
- description: Filter members by tags. Use a comma-separated list of tag IDs.
in: query
name: tags
schema:
type: string
- description: Include deleted members in the results
in: query
name: with_deleted
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPaginatedProjectMemberList'
description: ''
security:
- Token: []
summary: ✨ Get project members paginated
tags:
- Projects
x-fern-audiences:
- public
x-fern-pagination:
offset: $request.page
results: $response.results
x-fern-sdk-group-name:
- projects
- members
- paginated
x-fern-sdk-method-name: list
/api/projects/{id}/metricparam/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get the current metrics configuration for a project.
operationId: api_projects_metricparam_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MetricParam'
description: Current metrics configuration
security:
- Token: []
summary: ✨ Get project metrics configuration
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- metrics
x-fern-sdk-method-name: get
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update metrics strategy and parameters for a project.
operationId: api_projects_metricparam_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MetricParamUpdateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MetricParamUpdateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/MetricParamUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MetricParam'
description: Updated metrics configuration
'204':
description: No params provided to update
security:
- Token: []
summary: ✨ Update project metrics configuration
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- metrics
x-fern-sdk-method-name: update
/api/projects/{id}/model-stats/{model_version}/agreement:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement between a given model version and all annotators in the project for overlapping tasks.
operationId: api_projects_model_stats_agreement_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- in: path
name: model_version
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
agreement:
nullable: true
type: number
type: object
description: Model-version overall agreement vs annotators
security:
- Token: []
summary: ✨ Get model-version overall agreement vs annotators
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: model_version_annotator_agreement
/api/projects/{id}/model-stats/{model_version}/agreement-groundtruth:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement between a given model version and ground truth annotations in the project for overlapping tasks.
operationId: api_projects_model_stats_agreement_groundtruth_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- in: path
name: model_version
required: true
schema:
type: string
- description: Calculate agreement per label
in: query
name: per_label
schema:
default: false
type: boolean
responses:
'200':
content:
application/json:
schema:
properties:
agreement:
nullable: true
type: number
type: object
description: Model-version ground truth agreement
security:
- Token: []
summary: ✨ Get model-version ground truth agreement
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: model_version_ground_truth_agreement
/api/projects/{id}/model-stats/{model_version}/prediction:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement between a given model version and all other model versions in the project for overlapping tasks.
operationId: api_projects_model_stats_prediction_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- in: path
name: model_version
required: true
schema:
type: string
- description: Calculate agreement per label
in: query
name: per_label
schema:
default: false
type: boolean
responses:
'200':
content:
application/json:
schema:
properties:
average_prediction_agreement_per_model:
nullable: true
type: number
type: object
description: Model-version prediction agreement
security:
- Token: []
summary: ✨ Get model-version prediction agreement
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: model_version_prediction_agreement
/api/projects/{id}/project-extra-params/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve the annotator weights for statistics and Cohen's Kappa for a specific project. Affects dashboard-members stats, but old and unused.
operationId: api_projects_project_extra_params_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LseProjectParams'
description: Annotator weights retrieved
'204':
description: No annotator weights found
security:
- Token: []
summary: ✨ Get annotator weights
tags:
- Projects
x-fern-audiences:
- internal
x-fern-sdk-group-name:
- projects
- annotator_weights
x-fern-sdk-method-name: get
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create annotator weights to be used in the annotation statistics for a project, such as when calculating kappa metrics for inter-annotator agreement. Affects dashboard-members stats, but old and unused.
operationId: api_projects_project_extra_params_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
examples:
AnnotatorWeightsMapping:
description: annotator_params must be a mapping of user_id to weight (0..1).
summary: payload format for annotator_params
value:
annotator_params:
123: 1.0
456: 0.75
use_kappa: true
schema:
$ref: '#/components/schemas/LseProjectParamsRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LseProjectParamsRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LseProjectParamsRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LseProjectParams'
description: Annotator weights created/updated
security:
- Token: []
summary: ✨ Create annotator weights for statistics
tags:
- Projects
x-fern-audiences:
- internal
x-fern-sdk-group-name:
- projects
- annotator_weights
x-fern-sdk-method-name: create
/api/projects/{id}/reimports/{reimport_pk}/:
get:
description: "\n Poll the status of an asynchronous project reimport operation.\n \n **Usage:**\n 1. When you POST to reimport tasks, you'll receive a response with a reimport ID\n 2. Use that `reimport_id` with this GET endpoint to check the reimport status\n 3. Poll this endpoint to see if the reimport has completed, is still processing, or has failed\n 4. **Reimport errors and failures will only be visible in this GET response**, not in the original POST request\n \n This endpoint returns detailed information about the reimport including task counts, status, and any error messages.\n "
operationId: api_projects_reimports_retrieve
parameters:
- description: A unique integer value identifying this project reimport.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: reimport_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectReimport'
description: ''
security:
- Token: []
summary: Get project reimport status
tags:
- Projects
x-fern-audiences:
- internal
/api/projects/{id}/roles:
get:
description: "\n ![\"Label](\"https://docs.humansignal.com/images/badge.svg\")
\n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \n\n List users and their project level roles for a given project.\n If user is not listed here and is a member of the project then they would behave as assigned role in organization.\n "
operationId: api_projects_roles_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ProjectRole'
type: array
description: ''
security:
- Token: []
summary: ✨ List project roles
tags:
- Project Roles
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- roles
x-fern-sdk-method-name: get
/api/projects/{id}/stats/IAA:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get Inter-Annotator Agreement (IAA) matrix for a project, showing agreement between all annotators.
operationId: api_projects_stats_IAA_retrieve
parameters:
- description: Comma-separated list of fields to expand
in: query
name: expand
schema:
type: string
- in: path
name: id
required: true
schema:
type: integer
- description: Calculate IAA per label
in: query
name: per_label
schema:
default: false
type: boolean
- description: Include standard deviation in results
in: query
name: std
schema:
default: false
type: boolean
- description: Comma-separated list of task IDs to filter by
in: query
name: task
schema:
type: string
responses:
'200':
content:
application/json:
examples:
Inter-AnnotatorAgreementMatrix(perLabel=false):
description: Example of Inter-Annotator Agreement matrix when per_label=false
summary: Inter-Annotator Agreement Matrix (per_label=false)
value:
IAA:
- - 1.0
- 0.5
- - 0.5
- 1.0
common_tasks:
- - 0.0
- 1.0
- - 1.0
- 0.0
users:
- email: user1@example.com
id: 1
- email: user2@example.com
id: 2
Inter-AnnotatorAgreementMatrix(perLabel=true):
description: Example of Inter-Annotator Agreement matrix when per_label=true
summary: Inter-Annotator Agreement Matrix (per_label=true)
value:
IAA:
neg:
- - null
- 0.0
- - 0.0
- null
pos:
- - null
- 0.5
- - 0.5
- null
common_tasks:
neg:
- - 0.0
- 2.0
- - 2.0
- 0.0
pos:
- - 0.0
- 4.0
- - 4.0
- 0.0
std:
neg: 0.1
pos: 0.2
users:
- email: user1@example.com
id: 1
- email: user2@example.com
id: 2
schema:
properties:
IAA:
description: Inter-Annotator Agreement matrix - 2D array when per_label=false, object with label keys when per_label=true
oneOf:
- description: Inter-Annotator Agreement matrix (2D array) when per_label=false
items:
items:
type: number
type: array
type: array
- additionalProperties:
items:
items:
type: number
type: array
type: array
description: Inter-Annotator Agreement matrix per label when per_label=true
type: object
common_tasks:
description: Common tasks matrix - 2D array when per_label=false, object with label keys when per_label=true
oneOf:
- description: Number of common tasks between annotators (2D array) when per_label=false
items:
items:
type: number
type: array
type: array
- additionalProperties:
items:
items:
type: number
type: array
type: array
description: Number of common tasks per label when per_label=true
type: object
std:
description: Standard deviation - number when per_label=false, object with label keys when per_label=true
oneOf:
- type: number
- additionalProperties:
type: number
description: Standard deviation per label when per_label=true
type: object
users:
description: List of users in the matrix
items:
type: object
type: array
type: object
description: Inter-Annotator Agreement matrix
security:
- Token: []
summary: ✨ Get Inter-Annotator Agreement matrix
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: iaa
/api/projects/{id}/stats/agreement-groundtruth:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get ground truth agreement statistics for multiple users within a project.
operationId: api_projects_stats_agreement_groundtruth_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Comma separated list of user IDs to get ground truth agreement for
in: query
name: ids
required: true
schema:
type: string
- description: Per label
in: query
name: per_label
schema:
default: false
type: boolean
responses:
'200':
content:
application/json:
schema:
properties:
agreement:
additionalProperties:
oneOf:
- description: Ground truth agreement score for the user (0-1) when per_label=False
type: number
- additionalProperties:
description: Agreement score for specific label (0-1)
type: number
description: Ground truth agreement scores per label when per_label=True
type: object
description: Dictionary mapping user IDs to their ground truth agreement scores
type: object
type: object
description: Ground truth agreement statistics for multiple users
security:
- Token: []
summary: ✨ Get ground truth agreement for multiple users
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: users_ground_truth_agreement
/api/projects/{id}/stats/agreement_annotator/{user_id}:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement statistics for a specific annotator within a project.
operationId: api_projects_stats_agreement_annotator_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- in: path
name: user_id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
properties:
Agreement_per_annotator:
description: Agreement score for the annotator (0-1)
type: number
type: object
description: Individual annotator agreement statistics
security:
- Token: []
summary: ✨ Get individual annotator agreement stats
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: agreement_annotator
/api/projects/{id}/stats/agreement_annotators:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement statistics for multiple annotators within a project.
operationId: api_projects_stats_agreement_annotators_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Comma separated list of annotator user IDs to get agreement scores for
in: query
name: ids
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
agreement:
additionalProperties:
type: number
description: Mapping of annotator ID to their agreement score (0-1) or null if no data
type: object
required:
- agreement
type: object
description: Multiple annotator agreement statistics
security:
- Token: []
summary: ✨ Get agreement statistics for multiple annotators
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: agreement_annotators
/api/projects/{id}/stats/data_filter:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get statistics about user data filters and their usage within a project.
operationId: api_projects_stats_data_filter_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
properties:
user_filters:
description: Data filter statistics by user and model
properties:
stats:
description: List of filter configurations for users and models
items:
additionalProperties:
description: Filter configurations (finished, skipped, accepted, rejected, gt, predictions, review_score)
type: object
properties:
id:
description: User ID or model version identifier (e.g., "model:1.0")
type: string
type: object
type: array
tasks_with_annotations:
description: Default filter tab for tasks with annotations
type: object
type: object
type: object
description: User data filter statistics
security:
- Token: []
summary: ✨ Get user data filter statistics
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: data_filters
/api/projects/{id}/stats/finished:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get statistics about finished tasks for a project.
operationId: api_projects_stats_finished_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: User ID to filter statistics by (optional)
in: query
name: user_pk
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
properties:
finished:
description: Number of finished tasks
type: integer
id:
description: User ID
type: integer
progress:
description: Progress percentage (0-100)
type: integer
type: object
description: Finished tasks statistics
security:
- Token: []
summary: ✨ Get finished tasks statistics
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: finished_tasks
/api/projects/{id}/stats/label-distribution/counts:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Returns counts and percentages for requested label choices, from both annotations and predictions. Supports either pagination (`limit`, `offset`) or targeted fetches via explicit `choice_keys`.
operationId: api_projects_stats_label_distribution_counts_retrieve
parameters:
- description: 'Explicit choice keys to fetch, joined by "___PIPE___" (for example: "label___SEP___pos___PIPE___quality___SEP___4"). When provided, pagination params are ignored.'
in: query
name: choice_keys
schema:
type: string
- in: path
name: id
required: true
schema:
type: integer
- description: Maximum number of choice keys to return for pagination. Ignored when `choice_keys` is provided.
in: query
name: limit
schema:
type: integer
- description: Zero-based offset into the structure `choice_keys` list. Used only when `choice_keys` is not provided.
in: query
name: offset
schema:
default: 0
type: integer
responses:
'200':
content:
application/json:
examples:
LabelDistributionCounts(explicitChoiceKeys):
description: Example response for `choice_keys=label___SEP___pos___PIPE___label___SEP___neg`.
summary: Label Distribution Counts (explicit choice_keys)
value:
next_offset: null
results:
- choice: pos
choice_key: label___SEP___pos
dimension_name: label
from_annotations_count: 12
from_annotations_percent: 60.0
from_predictions_count: 9
from_predictions_percent: 45.0
- choice: neg
choice_key: label___SEP___neg
dimension_name: label
from_annotations_count: 8
from_annotations_percent: 40.0
from_predictions_count: 11
from_predictions_percent: 55.0
totals:
annotation_totals_by_dimension:
label: 20
prediction_totals_by_dimension:
label: 20
schema:
$ref: '#/components/schemas/LabelDistributionCountsResponse'
description: Label distribution counts
security:
- Token: []
summary: ✨ Get label distribution counts
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: label_distribution_counts
/api/projects/{id}/stats/label-distribution/structure:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Returns dimensions and flattened `choice_keys` for a project. Use this response to drive paginated or targeted calls to the label distribution counts endpoint.
operationId: api_projects_stats_label_distribution_structure_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
LabelDistributionStructure:
description: Example response used by Analytics Label Distribution before loading counts.
summary: Label Distribution Structure
value:
choice_keys:
- label___SEP___neg
- label___SEP___pos
- quality___SEP___1
- quality___SEP___2
- quality___SEP___3
- quality___SEP___4
- quality___SEP___5
dimensions:
- choice_keys:
- label___SEP___neg
- label___SEP___pos
choices:
- neg
- pos
name: label
type: choices
- choice_keys:
- quality___SEP___1
- quality___SEP___2
- quality___SEP___3
- quality___SEP___4
- quality___SEP___5
choices:
- '1'
- '2'
- '3'
- '4'
- '5'
name: quality
type: rating
schema:
$ref: '#/components/schemas/LabelDistributionStructureResponse'
description: Label distribution structure
security:
- Token: []
summary: ✨ Get label distribution structure
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: label_distribution_structure
/api/projects/{id}/stats/lead_time:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get lead time statistics across the project, including average annotation time.
operationId: api_projects_stats_lead_time_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
properties:
lead_time_stats:
description: Lead time statistics including mean, median, and distribution
items:
properties:
mean_time:
description: Average lead time for the user
type: number
median_time:
description: Median lead time for the user
type: number
sum_lead_time:
description: Total lead time for the user
type: number
user_id:
description: User ID
type: integer
type: object
type: array
type: object
description: Lead time statistics
security:
- Token: []
summary: ✨ Get lead time statistics
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: lead_time
/api/projects/{id}/stats/total_agreement:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Overall or per-label total agreement across the project.
NOTE: due to an open issue in Fern, SDK clients will raise ApiError upon handling a 204 response. As a workaround, wrap call to this function in a try-except block.
operationId: api_projects_stats_total_agreement_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Return agreement per label
in: query
name: per_label
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
oneOf:
- properties:
total_agreement:
type: number
type: object
- properties:
total_agreement:
additionalProperties:
type: number
type: object
type: object
description: Total agreement
'204':
description: No data to compute agreement
security:
- Token: []
summary: ✨ Get total agreement for project
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: total_agreement
/api/projects/{id}/tasks/:
delete:
description: Delete all tasks from a specific project.
operationId: api_projects_tasks_destroy
parameters:
- description: A unique integer value identifying this project.
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete all tasks
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name: tasks
x-fern-sdk-method-name: delete_all_tasks
get:
description: "\n Retrieve a paginated list of tasks for a specific project. For example, use the following cURL command:\n ```bash\n curl -X GET http://localhost:8000/api/projects/{id}/tasks/?page=1&page_size=10 -H 'Authorization: Token abc123'\n ```\n "
operationId: api_projects_tasks_list
parameters:
- description: A unique integer value identifying this project.
in: path
name: id
required: true
schema:
type: integer
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: '[or "start"] current page'
in: query
name: page
schema:
type: integer
- description: '[or "length"] tasks per page, use -1 to obtain all tasks (in this case "page" has no effect and this operation might be slow)'
in: query
name: page_size
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TaskSimple'
type: array
description: ''
security:
- Token: []
summary: List project tasks
tags:
- Projects
x-fern-audiences:
- internal
/api/projects/{id}/tasks/assignees:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Assign multiple users to a collection of tasks within a specific project.
operationId: api_projects_tasks_assignees_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
filters:
description: 'Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.
Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`'
properties:
conjunction:
description: Logical conjunction for the filters. This conjunction (either "or" or "and") will be applied to all items in the filters list. It is not possible to combine "or" and "and" within one list of filters. All filters will be either combined with "or" or with "and", but not a mix of both.
enum:
- or
- and
type: string
items:
description: List of filter items
items:
example:
filter: filter:tasks:id
operator: greater
type: Number
value: 123
properties:
filter:
description: 'Filter identifier, it should start with `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. For `task.data` fields it may look like `filter:tasks:data.field_name`. If you need more info about columns, check the [Get data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) API endpoint. Possible values:
`filter:tasks:agreement`
(Number) Agreement for annotation results for a specific task (Enterprise only)
`filter:tasks:annotations_results`
(String) Annotation results for the tasks
`filter:tasks:annotators`
(List) Annotators that completed the task (Community). Can include assigned annotators (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer
`filter:tasks:cancelled_annotations`
(Number) Number of cancelled or skipped annotations for the task
`filter:tasks:comments`
(Number) Number of comments in a task
`filter:tasks:completed_at`
(Datetime) Time when a task was fully annotated
`filter:tasks:created_at`
(Datetime) Time the task was created at
`filter:tasks:file_upload`
(String) Name of the file uploaded to create the tasks
`filter:tasks:ground_truth`
(Boolean) Ground truth status of the tasks
`filter:tasks:id`
(Number) Task ID
`filter:tasks:inner_id`
(Number) Task Inner ID, it starts from 1 for all projects
`filter:tasks:predictions_model_versions`
(String) Model version used for the predictions
`filter:tasks:predictions_results`
(String) Prediction results for the tasks
`filter:tasks:predictions_score`
(Number) Prediction score for the task
`filter:tasks:reviewed`
(Boolean) Whether the tasks have been reviewed (Enterprise only)
`filter:tasks:reviewers`
(String) Reviewers that reviewed the task, or assigned reviewers (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer
`filter:tasks:reviews_accepted`
(Number) Number of annotations accepted for a task in review (Enterprise only)
`filter:tasks:reviews_rejected`
(Number) Number of annotations rejected for a task in review (Enterprise only)
`filter:tasks:total_annotations`
(Number) Total number of annotations on a task
`filter:tasks:total_predictions`
(Number) Total number of predictions for the task
`filter:tasks:unresolved_comment_count`
(Number) Number of unresolved comments in a task
`filter:tasks:updated_at`
(Datetime) Time the task was updated at (e.g. new annotation was created, review added, etc)'
enum:
- filter:tasks:agreement
- filter:tasks:annotations_results
- filter:tasks:annotators
- filter:tasks:cancelled_annotations
- filter:tasks:comments
- filter:tasks:completed_at
- filter:tasks:created_at
- filter:tasks:file_upload
- filter:tasks:ground_truth
- filter:tasks:id
- filter:tasks:inner_id
- filter:tasks:predictions_model_versions
- filter:tasks:predictions_results
- filter:tasks:predictions_score
- filter:tasks:reviewed
- filter:tasks:reviewers
- filter:tasks:reviews_accepted
- filter:tasks:reviews_rejected
- filter:tasks:total_annotations
- filter:tasks:total_predictions
- filter:tasks:unresolved_comment_count
- filter:tasks:updated_at
type: string
operator:
description: 'Filter operator. Possible values:
`contains`
Contains
`ends_with`
Ends with
`equal`
Equal to
`exists`
Exists
`greater`
Greater than
`greater_or_equal`
Greater than or equal to
`in`
Is between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`
`less`
Less than
`less_or_equal`
Less than or equal to
`not_contains`
Does not contain
`not_equal`
Not equal to
`not_exists`
Does not exist
`not_in`
Is not between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`
`starts_with`
Starts with'
enum:
- contains
- ends_with
- equal
- exists
- greater
- greater_or_equal
- in
- less
- less_or_equal
- not_contains
- not_equal
- not_exists
- not_in
- starts_with
type: string
type:
description: Type of the filter value. Possible values:
`Boolean`
Boolean
`Datetime`
Datetime string in `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format
`List`
List of items
`Number`
Float or Integer
`String`
String
`Unknown`
Unknown is explicitly converted to string format
type: string
value:
description: Value to filter by
oneOf:
- description: String
title: String
type: string
- description: Integer
title: Integer
type: integer
- description: Float
format: float
title: Float
type: number
- description: Boolean
title: Boolean
type: boolean
- description: Dictionary is used for some operator types, e.g. `in` and `not_in`
title: Dictionary
type: object
- description: List of strings or integers
title: List
type: object
type: object
required:
- filter
- operator
- type
- value
type: object
type: array
required:
- conjunction
- items
type: object
selectedItems:
description: 'Task selection by IDs. If filters are applied, the selection will be applied to the filtered tasks.If "all" is `false`, `"included"` must be used. If "all" is `true`, `"excluded"` must be used.
Examples: `{"all": false, "included": [1, 2, 3]}` or `{"all": true, "excluded": [4, 5]}`'
oneOf:
- properties:
all:
description: No tasks are selected
enum:
- false
type: boolean
included:
description: List of included task IDs
items:
type: integer
type: array
required:
- all
title: 'all: false'
type: object
- properties:
all:
description: All tasks are selected
enum:
- true
type: boolean
excluded:
description: List of excluded task IDs
items:
type: integer
type: array
required:
- all
title: 'all: true'
type: object
required:
- all
type: object
type:
description: Assignment type. Use AN for annotate or RE for review.
enum:
- AN
- RE
type: string
users:
description: List of user IDs to assign
items:
type: integer
type: array
required:
- type
- users
- selectedItems
type: object
responses:
'201':
content:
application/json:
schema:
properties:
assignments:
type: integer
async:
type: boolean
type: object
description: Success
'400':
description: Can't assign tasks
security:
- Token: []
summary: ✨ Bulk assign users to tasks
tags:
- Tasks
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- assignments
x-fern-sdk-method-name: bulk_assign
/api/projects/{id}/tasks/{task_pk}/assignees:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Remove assignees for a task within a specific project.
operationId: api_projects_tasks_assignees_destroy
parameters:
- description: A unique integer value identifying this project.
in: path
name: id
required: true
schema:
type: integer
- description: A unique integer value identifying this task.
in: path
name: task_pk
required: true
schema:
type: integer
- description: Assignment type to delete (optional). If omitted, deletes all assignments for the task.
in: query
name: type
schema:
enum:
- AN
- RE
type: string
- description: Comma separated list of user IDs to delete, as a string. If omitted, deletes all assignees for the given type.
in: query
name: users
schema:
type: string
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete task assignments
tags:
- Tasks
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- assignments
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a list of tasks and assignees for those tasks for a specific project.
operationId: api_projects_tasks_assignees_retrieve
parameters:
- description: A unique integer value identifying this project.
in: path
name: id
required: true
schema:
type: integer
- description: A unique integer value identifying this task.
in: path
name: task_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TaskAssignment'
type: array
description: List of assignments for the task
security:
- Token: []
summary: ✨ Get assigned tasks and assignees
tags:
- Tasks
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- assignments
x-fern-sdk-method-name: list
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update the assignee for a task in a specific project.
operationId: api_projects_tasks_assignees_partial_update
parameters:
- description: A unique integer value identifying this project.
in: path
name: id
required: true
schema:
type: integer
- description: A unique integer value identifying this task.
in: path
name: task_pk
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
type:
description: Assignment type. Use AN for annotate or RE for review.
enum:
- AN
- RE
type: string
users:
description: List of user IDs to assign
items:
type: integer
type: array
required:
- type
- users
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskAssignment'
description: ''
security:
- Token: []
summary: ✨ Update task assignee
tags:
- Tasks
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- assignments
x-fern-sdk-method-name: update
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Assign a user to a task in a specific project.
operationId: api_projects_tasks_assignees_create_2
parameters:
- description: A unique integer value identifying this project.
in: path
name: id
required: true
schema:
type: integer
- description: A unique integer value identifying this task.
in: path
name: task_pk
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
type:
description: Assignment type. Use AN for annotate or RE for review.
enum:
- AN
- RE
type: string
users:
description: List of user IDs to assign
items:
type: integer
type: array
required:
- type
- users
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskAssignment'
description: ''
security:
- Token: []
summary: ✨ Create task assignee
tags:
- Tasks
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- assignments
x-fern-sdk-method-name: assign
/api/projects/{id}/update-stats:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Start stats recalculation for given project
operationId: api_projects_update_stats_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: 'Stat type to recalculate. Possible values: label, stats'
in: query
name: stat_type
schema:
type: string
responses:
'200':
content:
application/json:
schema:
description: Stat recalculation job
title: Stat recalculation job
type: object
description: Successful response returns job id
security:
- Token: []
summary: ✨ Start stats recalculation
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: update_stats
/api/projects/{id}/user-stats/prediction:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get prediction agreement statistics for multiple annotators within a project.
operationId: api_projects_user_stats_prediction_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Comma separated list of annotator user IDs to get agreement scores for
in: query
name: ids
required: true
schema:
type: string
- description: Per label
in: query
name: per_label
schema:
default: false
type: boolean
responses:
'200':
content:
application/json:
schema:
properties:
agreement:
additionalProperties:
oneOf:
- description: Average prediction agreement score for the user (0-1) when per_label=False
type: number
- additionalProperties:
type: number
description: Average prediction agreement score per label for the user (0-1) when per_label=True
type: object
description: Dictionary mapping user IDs to their prediction agreement scores
type: object
type: object
description: Prediction agreement statistics for multiple annotators
security:
- Token: []
summary: ✨ Get prediction agreement statistics for multiple annotators
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: users_prediction_agreement
/api/projects/{id}/user-stats/review_score:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get review score and performance score statistics for multiple annotators within a project. Only allowed for accounts with reviewing features enabled.
operationId: api_projects_user_stats_review_score_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Comma separated list of annotator user IDs to get review scores for
in: query
name: ids
required: true
schema:
type: string
- description: Per label
in: query
name: per_label
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
properties:
performance_score:
additionalProperties:
oneOf:
- description: Performance score for the annotator when per_label=False
type: number
- additionalProperties:
type: number
description: Performance score per label for the annotator when per_label=True
type: object
description: Performance scores mapped by annotator ID
type: object
review_score:
additionalProperties:
oneOf:
- description: Average review score for the annotator when per_label=False
type: number
- additionalProperties:
type: number
description: Review score per label for the annotator when per_label=True
type: object
description: Review scores mapped by annotator ID
type: object
type: object
description: Review scores and performance scores for multiple annotators
security:
- Token: []
summary: ✨ Get review scores for multiple annotators
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: users_review_score
/api/projects/{id}/user-stats/{user_pk}/prediction:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get prediction agreement statistics for a specific user within a project.
operationId: api_projects_user_stats_prediction_retrieve_2
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Calculate agreement per label
in: query
name: per_label
schema:
type: boolean
- in: path
name: user_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
properties:
average_prediction_agreement_per_user:
oneOf:
- description: Average prediction agreement score for the user (0-1) when per_label=False
type: number
- additionalProperties:
type: number
description: Average prediction agreement score per label for the user (0-1) when per_label=True
type: object
type: object
description: Individual user prediction agreement statistics
security:
- Token: []
summary: ✨ Get individual user prediction agreement
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: user_prediction_agreement
/api/projects/{id}/user-stats/{user_pk}/review_score:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get review score statistics for a specific user within a project. Only allowed for accounts with reviewing features enabled.
operationId: api_projects_user_stats_review_score_retrieve_2
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Calculate agreement per label
in: query
name: per_label
schema:
type: boolean
- in: path
name: user_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
properties:
performance_score:
oneOf:
- description: Performance score for the user when per_label=False
type: number
- additionalProperties:
type: number
description: Performance score per label for the user when per_label=True
type: object
review_score:
oneOf:
- description: Average review score for the user when per_label=False
type: number
- additionalProperties:
type: number
description: Average review score per label for the user when per_label=True
type: object
type: object
description: Individual user review score statistics
security:
- Token: []
summary: ✨ Get individual user review scores
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: user_review_score
/api/projects/{id}/users/{user_pk}/stats/agreement-groundtruth:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get ground truth agreement statistics for a specific user within a project.
operationId: api_projects_users_stats_agreement_groundtruth_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Calculate agreement per label
in: query
name: per_label
schema:
type: boolean
- in: path
name: user_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
properties:
agreement:
oneOf:
- description: Ground truth agreement score for the user (0-1) when per_label=False
type: number
- additionalProperties:
description: Agreement score for specific label (0-1)
type: number
description: Ground truth agreement scores per label when per_label=True
type: object
type: object
description: Individual user ground truth agreement statistics
security:
- Token: []
summary: ✨ Get individual user ground truth agreement
tags:
- Stats
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- stats
x-fern-sdk-method-name: user_ground_truth_agreement
/api/projects/{id}/validate/:
post:
description: Determine whether the label configuration for a specific project is valid.
operationId: api_projects_validate_label_config
parameters:
- description: A unique integer value identifying this project.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectLabelConfigRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ProjectLabelConfigRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ProjectLabelConfigRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectLabelConfig'
description: ''
security:
- Token: []
summary: Validate project label config
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name: projects
x-fern-sdk-method-name: validate_label_config
/api/projects/{project_pk}/dimensions/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all dimensions for a specific project.
operationId: api_projects_dimensions_list
parameters:
- description: 'Agreement methodology to use for computing allowed_metrics_with_params. If not provided, uses the methodology stored in the project settings. Valid values: "pairwise", "consensus". '
in: query
name: agreement_methodology
schema:
type: string
- description: Filter by active status
in: query
name: is_active
schema:
type: boolean
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: path
name: project_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DimensionList'
type: array
description: List of dimensions
security:
- Token: []
summary: ✨ List dimensions
tags:
- Dimensions
x-fern-audiences:
- public
x-fern-sdk-group-name: dimensions
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new dimension for a specific project.
operationId: api_projects_dimensions_create
parameters:
- description: Project ID
in: path
name: project_pk
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DimensionCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DimensionCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DimensionCreateRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Dimension'
description: Created dimension
security:
- Token: []
summary: ✨ Create dimension
tags:
- Dimensions
x-fern-audiences:
- internal
x-fern-sdk-group-name: dimensions
x-fern-sdk-method-name: create
/api/projects/{project_pk}/dimensions/{id}/:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a dimension by ID.
operationId: api_projects_dimensions_destroy
parameters:
- description: Dimension ID
in: path
name: id
required: true
schema:
type: integer
- description: Project ID
in: path
name: project_pk
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete dimension
tags:
- Dimensions
x-fern-audiences:
- internal
x-fern-sdk-group-name: dimensions
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a specific dimension by ID.
operationId: api_projects_dimensions_retrieve
parameters:
- description: Dimension ID
in: path
name: id
required: true
schema:
type: integer
- description: Project ID
in: path
name: project_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Dimension'
description: Dimension details
security:
- Token: []
summary: ✨ Get dimension
tags:
- Dimensions
x-fern-audiences:
- public
x-fern-sdk-group-name: dimensions
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific dimension by ID.
operationId: api_projects_dimensions_partial_update
parameters:
- description: Dimension ID
in: path
name: id
required: true
schema:
type: integer
- description: Project ID
in: path
name: project_pk
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDimensionRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedDimensionRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDimensionRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Dimension'
description: Updated dimension
security:
- Token: []
summary: ✨ Update dimension
tags:
- Dimensions
x-fern-audiences:
- internal
x-fern-sdk-group-name: dimensions
x-fern-sdk-method-name: update
put:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Overwrite a specific dimension by ID.
operationId: api_projects_dimensions_update
parameters:
- description: Dimension ID
in: path
name: id
required: true
schema:
type: integer
- description: Project ID
in: path
name: project_pk
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DimensionRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DimensionRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DimensionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Dimension'
description: ''
security:
- Token: []
summary: ✨ Put dimension
tags:
- Dimensions
x-fern-audiences:
- internal
/api/projects/{project_pk}/members/{user_pk}/pauses/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a list of all pauses.
operationId: api_projects_members_pauses_list
parameters:
- description: Include deleted pauses.
in: query
name: include_deleted
schema:
type: boolean
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- in: path
name: project_pk
required: true
schema:
type: integer
- in: path
name: user_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Pause'
type: array
description: ''
security:
- Token: []
summary: ✨ List pauses
tags:
- Pauses
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- pauses
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new pause entry.
operationId: api_projects_members_pauses_create
parameters:
- in: path
name: project_pk
required: true
schema:
type: integer
- in: path
name: user_pk
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PauseRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PauseRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PauseRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Pause'
description: ''
security:
- Token: []
summary: ✨ Create pause
tags:
- Pauses
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- pauses
x-fern-sdk-method-name: create
/api/projects/{project_pk}/members/{user_pk}/pauses/{id}/:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific pause by ID.
operationId: api_projects_members_pauses_destroy
parameters:
- in: path
name: id
required: true
schema:
type: string
- in: path
name: project_pk
required: true
schema:
type: integer
- in: path
name: user_pk
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete pause
tags:
- Pauses
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- pauses
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a specific pause by ID.
operationId: api_projects_members_pauses_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: string
- in: path
name: project_pk
required: true
schema:
type: integer
- in: path
name: user_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Pause'
description: ''
security:
- Token: []
summary: ✨ Get pause
tags:
- Pauses
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- pauses
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Partially update a pause entry by ID.
operationId: api_projects_members_pauses_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: string
- in: path
name: project_pk
required: true
schema:
type: integer
- in: path
name: user_pk
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedPauseRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedPauseRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedPauseRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Pause'
description: ''
security:
- Token: []
summary: ✨ Update pause
tags:
- Pauses
x-fern-audiences:
- public
x-fern-sdk-group-name:
- projects
- pauses
x-fern-sdk-method-name: update
put:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Overwrite a pause entry by ID.
operationId: api_projects_members_pauses_update
parameters:
- in: path
name: id
required: true
schema:
type: string
- in: path
name: project_pk
required: true
schema:
type: integer
- in: path
name: user_pk
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PauseRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PauseRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PauseRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Pause'
description: ''
security:
- Token: []
summary: ✨ Put pause
tags:
- Pauses
x-fern-audiences:
- internal
/api/projects/{project_pk}/subset-tasks:
get:
description: "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \n\n Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided.\n "
operationId: api_projects_subset_tasks_list
parameters:
- description: If true (default), includes task_count in response; if false, omits it.
in: query
name: include_total
schema:
type: boolean
- description: A unique ID of a ModelRun
in: query
name: model_run
schema:
type: integer
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: A page number within the paginated result set.
in: query
name: page
required: false
schema:
type: integer
- description: Number of results to return per page.
in: query
name: page_size
required: false
schema:
type: integer
- description: The ID of the parent model (ModelInterface) for this Inference Run
in: query
name: parent_model
schema:
type: integer
- in: path
name: project_pk
required: true
schema:
type: integer
- description: The project subset to retrieve tasks for
in: query
name: project_subset
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedProjectSubsetTasksResponseList'
description: ''
'400':
description: Bad request - missing parent_model
security:
- Token: []
summary: ✨ Get Project Subset Task List with Predictions and Accuracy details
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name: prompts
x-fern-sdk-method-name: subset_tasks
/api/projects/{project_pk}/subsets:
get:
description: "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \n\n Provides list of available subsets for a project along with count of tasks in each subset\n "
operationId: api_projects_subsets_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- in: path
name: project_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ProjectSubsetItem'
type: array
description: ''
security:
- Token: []
summary: ✨ Get available subsets of a project (for prompts usage)
tags:
- Projects
x-fern-audiences:
- public
x-fern-sdk-group-name: prompts
x-fern-sdk-method-name: subsets
/api/projects/{project_pk}/tasks/{task_pk}/agreement-matrix:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Returns a pairwise agreement matrix between selected participants for a single task, averaged across all active dimensions or a single specified dimension.
operationId: api_projects_tasks_agreement_matrix_retrieve
parameters:
- description: Dimension ID to compute agreement for. If not provided, averages across all active dimensions.
in: query
name: dimension
schema:
type: integer
- description: Project ID
in: path
name: project_pk
required: true
schema:
type: integer
- description: JSON object specifying which participants to include in the agreement matrix
in: query
name: selection
required: true
schema:
$ref: '#/components/schemas/AgreementSelectionRequest'
- description: Task ID
in: path
name: task_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
TaskAgreementMatrixResponse:
summary: Task agreement matrix response
value:
matrix:
- - 1.0
- 0.75
- 0.5
- - 0.75
- 1.0
- 0.6
- - 0.5
- 0.6
- 1.0
users:
- avatar: null
email: annotator1@example.com
first_name: John
id: 1
initials: JD
last_name: Doe
username: annotator1
- avatar: null
email: annotator2@example.com
first_name: Jane
id: 2
initials: JS
last_name: Smith
username: annotator2
- id: model:v1
username: Model v1
schema:
$ref: '#/components/schemas/TaskAgreementMatrixResponse'
description: ''
security:
- Token: []
summary: ✨ Get task agreement matrix
tags:
- Dimensions
x-fern-audiences:
- public
x-fern-sdk-group-name:
- tasks
- agreement_matrix
x-fern-sdk-method-name: get
/api/prompts/:
get:
description: List all prompts.
operationId: api_prompts_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ModelInterfaceSerializerGET'
type: array
description: ''
security:
- Token: []
summary: ✨ List prompts
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name: prompts
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new prompt.
operationId: api_prompts_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelInterfaceRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ModelInterfaceRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ModelInterfaceRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ModelInterface'
description: ''
security:
- Token: []
summary: ✨ Create prompt
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name: prompts
x-fern-sdk-method-name: create
/api/prompts/compatible-projects:
get:
description: Retrieve a list of compatible project for prompt.
operationId: api_prompts_compatible_projects_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: A page number within the paginated result set.
in: query
name: page
required: false
schema:
type: integer
- description: Number of results to return per page.
in: query
name: page_size
required: false
schema:
type: integer
- description: Skill to filter by
in: query
name: project_type
schema:
default: TextClassification
enum:
- NamedEntityRecognition
- TextClassification
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAllRolesProjectListList'
description: ''
security:
- Token: []
summary: ✨ List projects compatible with prompt
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name: prompts
x-fern-sdk-method-name: compatible_projects
/api/prompts/{id}/:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a prompt by ID
operationId: api_prompts_destroy
parameters:
- in: path
name: id
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete prompt
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name: prompts
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a specific prompt.
operationId: api_prompts_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ModelInterfaceSerializerGET'
description: ''
security:
- Token: []
summary: ✨ Get prompt
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name: prompts
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific prompt by ID.
operationId: api_prompts_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedModelInterfaceRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedModelInterfaceRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedModelInterfaceRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ModelInterface'
description: ''
security:
- Token: []
summary: ✨ Update prompt
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name: prompts
x-fern-sdk-method-name: update
put:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Overwrite a specific prompt by ID.
operationId: api_prompts_update
parameters:
- in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelInterfaceRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ModelInterfaceRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ModelInterfaceRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ModelInterface'
description: ''
security:
- Token: []
summary: ✨ Put prompt
tags:
- Prompts
x-fern-audiences:
- internal
/api/prompts/{id}/get-default-version-name:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get default prompt version name
operationId: api_prompts_get_default_version_name_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
description: No response body
security:
- Token: []
summary: ✨ Get default prompt version name
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- versions
x-fern-sdk-method-name: get_default_version_name
/api/prompts/{prompt_id}/versions:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all versions of a prompt.
operationId: api_prompts_versions_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- in: path
name: prompt_id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ThirdPartyModelVersion'
type: array
description: ''
security:
- Token: []
summary: ✨ List prompt versions
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- versions
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new version of a prompt.
operationId: api_prompts_versions_create
parameters:
- in: path
name: prompt_id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyModelVersionRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ThirdPartyModelVersionRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ThirdPartyModelVersionRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyModelVersion'
description: ''
security:
- Token: []
summary: ✨ Create prompt version
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- versions
x-fern-sdk-method-name: create
/api/prompts/{prompt_id}/versions/{version_id}:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a prompt version by ID
operationId: api_prompts_versions_destroy
parameters:
- in: path
name: prompt_id
required: true
schema:
type: integer
- in: path
name: version_id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete prompt version
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- versions
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a specific prompt of a model.
operationId: api_prompts_versions_retrieve
parameters:
- in: path
name: prompt_id
required: true
schema:
type: integer
- in: path
name: version_id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyModelVersion'
description: ''
security:
- Token: []
summary: ✨ Get prompt version
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- versions
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific prompt version by ID.
operationId: api_prompts_versions_partial_update
parameters:
- in: path
name: prompt_id
required: true
schema:
type: integer
- in: path
name: version_id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedThirdPartyModelVersionRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedThirdPartyModelVersionRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedThirdPartyModelVersionRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyModelVersion'
description: ''
security:
- Token: []
summary: ✨ Update prompt version
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- versions
x-fern-sdk-method-name: update
put:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Overwrite a specific prompt version by ID.
operationId: api_prompts_versions_update
parameters:
- in: path
name: prompt_id
required: true
schema:
type: integer
- in: path
name: version_id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyModelVersionRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ThirdPartyModelVersionRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ThirdPartyModelVersionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyModelVersion'
description: ''
security:
- Token: []
summary: ✨ Put prompt version
tags:
- Prompts
x-fern-audiences:
- internal
/api/prompts/{prompt_id}/versions/{version_id}/cost-estimate:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset
operationId: api_prompts_versions_cost_estimate_retrieve
parameters:
- in: path
name: prompt_id
required: true
schema:
type: integer
- in: path
name: version_id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InferenceRunCostEstimate'
description: Cost estimate response
security:
- Token: []
summary: ✨ Get cost estimate for running a prompt version on a particular project/subset
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- versions
x-fern-sdk-method-name: cost_estimate
/api/prompts/{prompt_id}/versions/{version_id}/inference-runs:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get information (status, metadata, etc) about an existing inference run
operationId: api_prompts_versions_inference_runs_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: The ID of the parent model for this Inference Run
in: query
name: parent_model
schema:
type: integer
- description: The ID of the project this Inference Run makes predictions on
in: query
name: project
schema:
type: integer
- description: Defines which tasks are operated on (e.g. HasGT will only operate on tasks with a ground truth annotation, but All will operate on all records)
in: query
name: project_subset
schema:
enum:
- All
- HasGT
- Sample
type: string
- in: path
name: prompt_id
required: true
schema:
type: integer
- in: path
name: version_id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ModelRun'
type: array
description: ''
security:
- Token: []
summary: ✨ Get inference run info
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- runs
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Run a prompt inference.
operationId: api_prompts_versions_inference_runs_create
parameters:
- in: path
name: prompt_id
required: true
schema:
type: integer
- in: path
name: version_id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelRunRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ModelRunRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ModelRunRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ModelRun'
description: ''
security:
- Token: []
summary: ✨ Run prompt inference
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- runs
x-fern-sdk-method-name: create
/api/prompts/{prompt_id}/versions/{version_id}/inference-runs/{inference_run_id}/cancel:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Cancel the inference run for the given api
operationId: api_prompts_versions_inference_runs_cancel_create
parameters:
- in: path
name: inference_run_id
required: true
schema:
type: integer
- in: path
name: prompt_id
required: true
schema:
type: integer
- in: path
name: version_id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CancelModelRunResponse'
description: ''
security:
- Token: []
summary: ✨ Cancel Inference Run API
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- runs
x-fern-sdk-method-name: cancel
/api/prompts/{prompt_id}/versions/{version_id}/refine:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get the refined prompt based on the `refinement_job_id`.
operationId: api_prompts_versions_refine_retrieve
parameters:
- in: path
name: prompt_id
required: true
schema:
type: integer
- description: Refinement Job ID acquired from the `POST /api/prompts/{prompt_id}/versions/{version_id}/refine` endpoint
in: query
name: refinement_job_id
schema:
type: string
- in: path
name: version_id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RefinedPromptResponse'
description: Refined prompt response
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/RefinedPromptResponse'
description: Refinement job status
security:
- Token: []
summary: ✨ Get refined prompt
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- versions
x-fern-sdk-method-name: get_refined_prompt
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Refine a prompt version using a teacher model and save the refined prompt as a new version.
operationId: api_prompts_versions_refine_create
parameters:
- description: Whether to run the refinement asynchronously
in: query
name: async
schema:
type: boolean
- in: path
name: prompt_id
required: true
schema:
type: integer
- in: path
name: version_id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RefinePromptRequestRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/RefinePromptRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/RefinePromptRequestRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/RefinedPromptResponse'
description: Refined prompt response
security:
- Token: []
summary: ✨ Refine a prompt version
tags:
- Prompts
x-fern-audiences:
- public
x-fern-sdk-group-name:
- prompts
- versions
x-fern-sdk-method-name: refine_prompt
/api/saml/settings:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Reset SAML2 settings for the currently active organization. This clears all configured fields (domain, metadata, attribute mappings, group mappings) back to their defaults without deleting the underlying settings record.
operationId: api_saml_settings_destroy
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Reset SAML2 Settings
tags:
- SSO
x-fern-audiences:
- public
x-fern-sdk-group-name:
- sso
- saml
x-fern-sdk-method-name: reset
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve SAML2 settings for the currently active organization.
operationId: api_saml_settings_retrieve
responses:
'200':
content:
application/json:
examples:
Response:
summary: response
value:
projects_groups:
- group: groups_test
project_id: 42
role: Inherit
roles_groups:
- - Administrator
- groups_test
workspaces_groups:
- - Default workspace
- groups_test
schema:
$ref: '#/components/schemas/SamlSettings'
description: ''
security:
- Token: []
summary: ✨ Retrieve SAML2 Settings
tags:
- SSO
x-fern-audiences:
- public
x-fern-sdk-group-name:
- sso
- saml
x-fern-sdk-method-name: get
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update SAML2 settings for the currently active organization.
operationId: api_saml_settings_create
requestBody:
content:
application/json:
examples:
Response:
summary: response
value:
projects_groups:
- group: groups_test
project_id: 42
role: Inherit
roles_groups:
- - Administrator
- groups_test
workspaces_groups:
- - Default workspace
- groups_test
schema:
$ref: '#/components/schemas/SamlSettingsUpdateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SamlSettingsUpdateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/SamlSettingsUpdateRequest'
responses:
'201':
content:
application/json:
examples:
Response:
summary: response
value:
projects_groups:
- group: groups_test
project_id: 42
role: Inherit
roles_groups:
- - Administrator
- groups_test
workspaces_groups:
- - Default workspace
- groups_test
schema:
$ref: '#/components/schemas/SamlSettingsUpdate'
description: ''
security:
- Token: []
summary: ✨ Update SAML2 Settings
tags:
- SSO
x-fern-audiences:
- public
x-fern-sdk-group-name:
- sso
- saml
x-fern-sdk-method-name: update
/api/saml/settings/validate-metadata-url:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a SAML metadata URL by fetching it and checking whether it returns valid XML, without saving any settings.
operationId: api_saml_settings_validate_metadata_url_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateSamlMetadataUrlRequestRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ValidateSamlMetadataUrlRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ValidateSamlMetadataUrlRequestRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateSamlMetadataUrlResponse'
description: ''
security:
- Token: []
summary: ✨ Validate SAML Metadata URL
tags:
- SSO
x-fern-audiences:
- public
x-fern-sdk-group-name:
- sso
- saml
x-fern-sdk-method-name: validate_metadata_url
/api/scim/settings:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve SCIM settings for the currently active organization.
operationId: api_scim_settings_retrieve
responses:
'200':
content:
application/json:
examples:
Response:
summary: response
value:
projects_groups:
- group: groups_test
project_id: 42
role: Inherit
roles_groups:
- - Administrator
- groups_test
workspaces_groups:
- - Default workspace
- groups_test
schema:
$ref: '#/components/schemas/ScimSettings'
description: ''
security:
- Token: []
summary: ✨ Retrieve SCIM Settings
tags:
- SSO
x-fern-audiences:
- public
x-fern-sdk-group-name:
- sso
- scim
x-fern-sdk-method-name: get
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update SCIM settings for the currently active organization.
operationId: api_scim_settings_create
requestBody:
content:
application/json:
examples:
Response:
summary: response
value:
projects_groups:
- group: groups_test
project_id: 42
role: Inherit
roles_groups:
- - Administrator
- groups_test
workspaces_groups:
- - Default workspace
- groups_test
schema:
$ref: '#/components/schemas/ScimSettingsUpdateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ScimSettingsUpdateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/ScimSettingsUpdateRequest'
responses:
'201':
content:
application/json:
examples:
Response:
summary: response
value:
projects_groups:
- group: groups_test
project_id: 42
role: Inherit
roles_groups:
- - Administrator
- groups_test
workspaces_groups:
- - Default workspace
- groups_test
schema:
$ref: '#/components/schemas/ScimSettingsUpdate'
description: ''
security:
- Token: []
summary: ✨ Update SCIM Settings
tags:
- SSO
x-fern-audiences:
- public
x-fern-sdk-group-name:
- sso
- scim
x-fern-sdk-method-name: update
/api/session-policy/:
get:
description: Retrieve session timeout policy for the currently active organization.
operationId: api_session_policy_retrieve
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SessionTimeoutPolicy'
description: ''
security:
- Token: []
summary: Retrieve Session Policy
tags:
- Session Policy
x-fern-audiences:
- public
x-fern-sdk-group-name: session_policy
x-fern-sdk-method-name: get
patch:
description: Update session timeout policy for the currently active organization.
operationId: api_session_policy_partial_update
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSessionTimeoutPolicyRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedSessionTimeoutPolicyRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSessionTimeoutPolicyRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SessionTimeoutPolicy'
description: ''
security:
- Token: []
summary: Update Session Policy
tags:
- Session Policy
x-fern-audiences:
- public
x-fern-sdk-group-name: session_policy
x-fern-sdk-method-name: update
/api/storages/:
get:
description: Retrieve a list of the import storages of all types with their IDs.
operationId: api_storages_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
additionalProperties: {}
description: Unspecified response body
type: object
type: array
description: ''
security:
- Token: []
summary: List all import storages from the project
tags:
- Storage
x-fern-audiences:
- internal
x-fern-sdk-group-name:
- import_storage
x-fern-sdk-method-name: list
/api/storages/azure/:
get:
description: Get list of all Azure import storage connections.
operationId: api_storages_azure_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AzureBlobImportStorage'
type: array
description: ''
security:
- Token: []
summary: Get all import storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure
x-fern-sdk-method-name: list
post:
description: Create new Azure import storage
operationId: api_storages_azure_create
requestBody:
content:
application/json:
schema:
properties:
account_key:
description: Azure Blob account key
type: string
account_name:
description: Azure Blob account name
type: string
container:
description: Azure blob container
type: string
description:
description: Storage description
type: string
prefix:
description: Azure blob prefix name
type: string
presign:
default: true
description: Presign URLs for direct download
type: boolean
presign_ttl:
default: 1
description: Presign TTL in minutes
type: integer
project:
description: Project ID
type: integer
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureBlobImportStorage'
description: ''
security:
- Token: []
summary: Create new storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure
x-fern-sdk-method-name: create
/api/storages/azure/validate:
post:
description: Validate a specific Azure import storage connection.
operationId: api_storages_azure_validate_create
requestBody:
content:
application/json:
schema:
properties:
account_key:
description: Azure Blob account key
type: string
account_name:
description: Azure Blob account name
type: string
container:
description: Azure blob container
type: string
description:
description: Storage description
type: string
id:
description: Storage ID. If set, storage with specified ID will be updated
type: integer
prefix:
description: Azure blob prefix name
type: string
presign:
default: true
description: Presign URLs for direct download
type: boolean
presign_ttl:
default: 1
description: Presign TTL in minutes
type: integer
project:
description: Project ID
type: integer
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
description: Validation successful
security:
- Token: []
summary: Validate import storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure
x-fern-sdk-method-name: validate
/api/storages/azure/{id}:
delete:
description: Delete a specific Azure import storage connection.
operationId: api_storages_azure_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete import storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure
x-fern-sdk-method-name: delete
get:
description: Get a specific Azure import storage connection.
operationId: api_storages_azure_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureBlobImportStorage'
description: ''
security:
- Token: []
summary: Get import storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure
x-fern-sdk-method-name: get
patch:
description: Update a specific Azure import storage connection.
operationId: api_storages_azure_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
account_key:
description: Azure Blob account key
type: string
account_name:
description: Azure Blob account name
type: string
container:
description: Azure blob container
type: string
description:
description: Storage description
type: string
prefix:
description: Azure blob prefix name
type: string
presign:
default: true
description: Presign URLs for direct download
type: boolean
presign_ttl:
default: 1
description: Presign TTL in minutes
type: integer
project:
description: Project ID
type: integer
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureBlobImportStorage'
description: ''
security:
- Token: []
summary: Update import storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure
x-fern-sdk-method-name: update
/api/storages/azure/{id}/sync:
post:
description: Sync tasks from an Azure import storage connection.
operationId: api_storages_azure_sync_create
parameters:
- description: Storage ID
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureBlobImportStorage'
description: ''
security:
- Token: []
summary: Sync import storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure
x-fern-sdk-method-name: sync
/api/storages/azure_spi/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get list of all Azure import storage connections set up with Service Principal authentication.
operationId: api_storages_azure_spi_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AzureServicePrincipalImportStorage'
type: array
description: ''
security:
- Token: []
summary: ✨ Get Azure SPI import storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure_spi
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create Azure import storage with Service Principal authentication.
operationId: api_storages_azure_spi_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalImportStorage'
description: ''
security:
- Token: []
summary: ✨ Create Azure import storage with SPI
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure_spi
x-fern-sdk-method-name: create
/api/storages/azure_spi/validate:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific Azure import storage connection that was set up with Service Principal authentication.
operationId: api_storages_azure_spi_validate_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest'
required: true
responses:
'200':
description: Validation successful
security:
- Token: []
summary: ✨ Validate Azure SPI import storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure_spi
x-fern-sdk-method-name: validate
/api/storages/azure_spi/{id}:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific Azure import storage connection that was set up with Service Principal authentication.
operationId: api_storages_azure_spi_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete Azure SPI import storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure_spi
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific Azure import storage connection that was set up with Service Principal authentication.
operationId: api_storages_azure_spi_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalImportStorage'
description: ''
security:
- Token: []
summary: ✨ Get Azure SPI import storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure_spi
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific Azure import storage connection that was set up with Service Principal authentication.
operationId: api_storages_azure_spi_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAzureServicePrincipalImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedAzureServicePrincipalImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedAzureServicePrincipalImportStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalImportStorage'
description: ''
security:
- Token: []
summary: ✨ Update Azure SPI import storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure_spi
x-fern-sdk-method-name: update
/api/storages/azure_spi/{id}/sync:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Sync tasks from an Azure import storage connection that was set up with Service Principal authentication.
operationId: api_storages_azure_spi_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalImportStorage'
description: ''
security:
- Token: []
summary: ✨ Sync Azure SPI import storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- azure_spi
x-fern-sdk-method-name: sync
/api/storages/databricks/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get list of all Databricks Files import storage connections.
operationId: api_storages_databricks_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DatabricksImportStorage'
type: array
description: ''
security:
- Token: []
summary: ✨ List Databricks import storages
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- databricks
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a Databricks Files import storage connection.
operationId: api_storages_databricks_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DatabricksImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DatabricksImportStorageRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorage'
description: ''
security:
- Token: []
summary: ✨ Create Databricks import storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- databricks
x-fern-sdk-method-name: create
/api/storages/databricks/validate:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific Databricks Files import storage connection.
operationId: api_storages_databricks_validate_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DatabricksImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DatabricksImportStorageRequest'
required: true
responses:
'200':
description: Validation successful
security:
- Token: []
summary: ✨ Validate Databricks import storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- databricks
x-fern-sdk-method-name: validate
/api/storages/databricks/{id}:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific Databricks Files import storage connection.
operationId: api_storages_databricks_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete Databricks import storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- databricks
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific Databricks Files import storage connection.
operationId: api_storages_databricks_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorage'
description: ''
security:
- Token: []
summary: ✨ Get Databricks import storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- databricks
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific Databricks Files import storage connection.
operationId: api_storages_databricks_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDatabricksImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedDatabricksImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDatabricksImportStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorage'
description: ''
security:
- Token: []
summary: ✨ Update Databricks import storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- databricks
x-fern-sdk-method-name: update
/api/storages/databricks/{id}/sync:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Sync tasks from a Databricks Files import storage.
operationId: api_storages_databricks_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksImportStorage'
description: ''
security:
- Token: []
summary: ✨ Sync Databricks import storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- databricks
x-fern-sdk-method-name: sync
/api/storages/export:
get:
description: Retrieve a list of the export storages of all types with their IDs.
operationId: api_storages_export_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
additionalProperties: {}
description: Unspecified response body
type: object
type: array
description: ''
security:
- Token: []
summary: List all export storages from the project
tags:
- Storage
x-fern-audiences:
- internal
x-fern-sdk-group-name:
- export_storage
x-fern-sdk-method-name: list
/api/storages/export/azure:
get:
description: Get a list of all Azure export storage connections.
operationId: api_storages_export_azure_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AzureBlobExportStorage'
type: array
description: ''
security:
- Token: []
summary: Get all export storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure
x-fern-sdk-method-name: list
post:
description: Create a new Azure export storage connection to store annotations.
operationId: api_storages_export_azure_create
requestBody:
content:
application/json:
schema:
properties:
account_key:
description: Azure Blob account key
type: string
account_name:
description: Azure Blob account name
type: string
can_delete_objects:
default: false
description: Deletion from storage enabled
type: boolean
container:
description: Azure blob container
type: string
description:
description: Storage description
type: string
prefix:
description: Azure blob prefix name
type: string
project:
description: Project ID
type: integer
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureBlobExportStorage'
description: ''
security:
- Token: []
summary: Create export storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure
x-fern-sdk-method-name: create
/api/storages/export/azure/validate:
post:
description: Validate a specific Azure export storage connection.
operationId: api_storages_export_azure_validate_create
requestBody:
content:
application/json:
schema:
properties:
account_key:
description: Azure Blob account key
type: string
account_name:
description: Azure Blob account name
type: string
can_delete_objects:
default: false
description: Deletion from storage enabled
type: boolean
container:
description: Azure blob container
type: string
description:
description: Storage description
type: string
id:
description: Storage ID. If set, storage with specified ID will be updated
type: integer
prefix:
description: Azure blob prefix name
type: string
project:
description: Project ID
type: integer
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'200':
description: Validation successful
security:
- Token: []
summary: Validate export storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure
x-fern-sdk-method-name: validate
/api/storages/export/azure/{id}:
delete:
description: Delete a specific Azure export storage connection.
operationId: api_storages_export_azure_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete export storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure
x-fern-sdk-method-name: delete
get:
description: Get a specific Azure export storage connection.
operationId: api_storages_export_azure_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureBlobExportStorage'
description: ''
security:
- Token: []
summary: Get export storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure
x-fern-sdk-method-name: get
patch:
description: Update a specific Azure export storage connection.
operationId: api_storages_export_azure_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
account_key:
description: Azure Blob account key
type: string
account_name:
description: Azure Blob account name
type: string
can_delete_objects:
default: false
description: Deletion from storage enabled
type: boolean
container:
description: Azure blob container
type: string
description:
description: Storage description
type: string
prefix:
description: Azure blob prefix name
type: string
project:
description: Project ID
type: integer
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureBlobExportStorage'
description: ''
security:
- Token: []
summary: Update export storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure
x-fern-sdk-method-name: update
/api/storages/export/azure/{id}/sync:
post:
description: Sync tasks from an Azure export storage connection.
operationId: api_storages_export_azure_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureBlobExportStorage'
description: ''
security:
- Token: []
summary: Sync export storage
tags:
- 'Storage: Azure'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure
x-fern-sdk-method-name: sync
/api/storages/export/azure_spi:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a list of all Azure export storage connections that were set up with Service Principal authentication.
operationId: api_storages_export_azure_spi_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AzureServicePrincipalExportStorage'
type: array
description: ''
security:
- Token: []
summary: ✨ Get all Azure SPI export storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure_spi
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create an Azure export storage connection with Service Principal authentication to store annotations.
operationId: api_storages_export_azure_spi_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalExportStorage'
description: ''
security:
- Token: []
summary: ✨ Create Azure export storage with SPI authentication
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure_spi
x-fern-sdk-method-name: create
/api/storages/export/azure_spi/validate:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific Azure export storage connection that was set up with Service Principal authentication.
operationId: api_storages_export_azure_spi_validate_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest'
required: true
responses:
'200':
description: Validation successful
security:
- Token: []
summary: ✨ Validate Azure SPI export storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure_spi
x-fern-sdk-method-name: validate
/api/storages/export/azure_spi/{id}:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific Azure export storage connection that was set up with Service Principal authentication.
operationId: api_storages_export_azure_spi_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete Azure SPI export storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure_spi
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific Azure export storage connection that was set up with Service Principal authentication.
operationId: api_storages_export_azure_spi_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalExportStorage'
description: ''
security:
- Token: []
summary: ✨ Get Azure SPI export storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure_spi
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific Azure export storage connection that was set up with Service Principal authentication.
operationId: api_storages_export_azure_spi_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAzureServicePrincipalExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedAzureServicePrincipalExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedAzureServicePrincipalExportStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalExportStorage'
description: ''
security:
- Token: []
summary: ✨ Update Azure SPI export storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure_spi
x-fern-sdk-method-name: update
/api/storages/export/azure_spi/{id}/sync:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Sync tasks from an Azure SPI export storage.
operationId: api_storages_export_azure_spi_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AzureServicePrincipalExportStorage'
description: ''
security:
- Token: []
summary: ✨ Sync Azure SPI export storage
tags:
- 'Storage: Azure SPI'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- azure_spi
x-fern-sdk-method-name: sync
/api/storages/export/databricks:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a list of all Databricks Files export storage connections.
operationId: api_storages_export_databricks_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DatabricksExportStorage'
type: array
description: ''
security:
- Token: []
summary: ✨ List Databricks export storages
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- databricks
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a Databricks Files export storage connection.
operationId: api_storages_export_databricks_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DatabricksExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DatabricksExportStorageRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksExportStorage'
description: ''
security:
- Token: []
summary: ✨ Create Databricks export storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- databricks
x-fern-sdk-method-name: create
/api/storages/export/databricks/validate:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific Databricks Files export storage connection.
operationId: api_storages_export_databricks_validate_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DatabricksExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DatabricksExportStorageRequest'
required: true
responses:
'200':
description: Validation successful
security:
- Token: []
summary: ✨ Validate Databricks export storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- databricks
x-fern-sdk-method-name: validate
/api/storages/export/databricks/{id}:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific Databricks Files export storage connection.
operationId: api_storages_export_databricks_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete Databricks export storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- databricks
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific Databricks Files export storage connection.
operationId: api_storages_export_databricks_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksExportStorage'
description: ''
security:
- Token: []
summary: ✨ Get Databricks export storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- databricks
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific Databricks Files export storage connection.
operationId: api_storages_export_databricks_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDatabricksExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedDatabricksExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDatabricksExportStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksExportStorage'
description: ''
security:
- Token: []
summary: ✨ Update Databricks export storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- databricks
x-fern-sdk-method-name: update
/api/storages/export/databricks/{id}/sync:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Export annotations to a Databricks Files storage.
operationId: api_storages_export_databricks_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DatabricksExportStorage'
description: ''
security:
- Token: []
summary: ✨ Sync Databricks export storage
tags:
- 'Storage: Databricks Files'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- databricks
x-fern-sdk-method-name: sync
/api/storages/export/gcs:
get:
description: Get a list of all GCS export storage connections.
operationId: api_storages_export_gcs_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/GCSExportStorage'
type: array
description: ''
security:
- Token: []
summary: Get all export storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcs
x-fern-sdk-method-name: list
post:
description: Create a new GCS export storage connection to store annotations.
operationId: api_storages_export_gcs_create
requestBody:
content:
application/json:
schema:
properties:
bucket:
description: GCS bucket name
type: string
can_delete_objects:
default: false
description: Deletion from storage enabled.
type: boolean
description:
description: Storage description
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
type: string
google_project_id:
description: Google project ID
type: string
prefix:
description: GCS bucket prefix
type: string
project:
description: Project ID
type: integer
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSExportStorage'
description: ''
security:
- Token: []
summary: Create export storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcs
x-fern-sdk-method-name: create
/api/storages/export/gcs/validate:
post:
description: Validate a specific GCS export storage connection.
operationId: api_storages_export_gcs_validate_create
requestBody:
content:
application/json:
schema:
properties:
bucket:
description: GCS bucket name
type: string
can_delete_objects:
default: false
description: Deletion from storage enabled.
type: boolean
description:
description: Storage description
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
type: string
google_project_id:
description: Google project ID
type: string
id:
description: Storage ID. If set, storage with specified ID will be updated
type: integer
prefix:
description: GCS bucket prefix
type: string
project:
description: Project ID
type: integer
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'200':
description: Validation successful
security:
- Token: []
summary: Validate export storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcs
x-fern-sdk-method-name: validate
/api/storages/export/gcs/{id}:
delete:
description: Delete a specific GCS export storage connection.
operationId: api_storages_export_gcs_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete export storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcs
x-fern-sdk-method-name: delete
get:
description: Get a specific GCS export storage connection.
operationId: api_storages_export_gcs_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSExportStorage'
description: ''
security:
- Token: []
summary: Get export storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcs
x-fern-sdk-method-name: get
patch:
description: Update a specific GCS export storage connection.
operationId: api_storages_export_gcs_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
bucket:
description: GCS bucket name
type: string
can_delete_objects:
default: false
description: Deletion from storage enabled.
type: boolean
description:
description: Storage description
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
type: string
google_project_id:
description: Google project ID
type: string
prefix:
description: GCS bucket prefix
type: string
project:
description: Project ID
type: integer
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSExportStorage'
description: ''
security:
- Token: []
summary: Update export storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcs
x-fern-sdk-method-name: update
/api/storages/export/gcs/{id}/sync:
post:
description: Sync tasks from an GCS export storage connection.
operationId: api_storages_export_gcs_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSExportStorage'
description: ''
security:
- Token: []
summary: Sync export storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcs
x-fern-sdk-method-name: sync
/api/storages/export/gcswif:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a list of all GCS export storage connections that were set up with WIF authentication.
operationId: api_storages_export_gcswif_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/GCSWIFExportStorage'
type: array
description: ''
security:
- Token: []
summary: ✨ Get all GCS WIF export storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcswif
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create an GCS export storage connection with WIF authentication to store annotations.
operationId: api_storages_export_gcswif_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/GCSWIFExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/GCSWIFExportStorageRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFExportStorage'
description: ''
security:
- Token: []
summary: ✨ Create GCS export storage with WIF authentication
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcswif
x-fern-sdk-method-name: create
/api/storages/export/gcswif/validate:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific GCS export storage connection that was set up with WIF authentication.
operationId: api_storages_export_gcswif_validate_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/GCSWIFExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/GCSWIFExportStorageRequest'
required: true
responses:
'200':
description: Validation successful
security:
- Token: []
summary: ✨ Validate GCS WIF export storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcswif
x-fern-sdk-method-name: validate
/api/storages/export/gcswif/{id}:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific GCS export storage connection that was set up with WIF authentication.
operationId: api_storages_export_gcswif_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete GCS WIF export storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcswif
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific GCS export storage connection that was set up with WIF authentication.
operationId: api_storages_export_gcswif_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFExportStorage'
description: ''
security:
- Token: []
summary: ✨ Get GCS WIF export storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcswif
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific GCS export storage connection that was set up with WIF authentication.
operationId: api_storages_export_gcswif_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedGCSWIFExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedGCSWIFExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedGCSWIFExportStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFExportStorage'
description: ''
security:
- Token: []
summary: ✨ Update GCS WIF export storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcswif
x-fern-sdk-method-name: update
/api/storages/export/gcswif/{id}/sync:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Sync tasks from an GCS WIF export storage.
operationId: api_storages_export_gcswif_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFExportStorage'
description: ''
security:
- Token: []
summary: ✨ Sync GCS WIF export storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- gcswif
x-fern-sdk-method-name: sync
/api/storages/export/localfiles:
get:
description: Get a list of all local file export storage connections.
operationId: api_storages_export_localfiles_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/LocalFilesExportStorage'
type: array
description: ''
security:
- Token: []
summary: Get all export storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- local
x-fern-sdk-method-name: list
post:
description: Create a new local file export storage connection to store annotations.
operationId: api_storages_export_localfiles_create
requestBody:
content:
application/json:
schema:
properties:
description:
description: Storage description
type: string
path:
description: Path to local directory
type: string
project:
description: Project ID
type: integer
regex_filter:
description: Regex for filtering objects
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalFilesExportStorage'
description: ''
security:
- Token: []
summary: Create export storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- local
x-fern-sdk-method-name: create
/api/storages/export/localfiles/validate:
post:
description: Validate a specific local file export storage connection.
operationId: api_storages_export_localfiles_validate_create
requestBody:
content:
application/json:
schema:
properties:
description:
description: Storage description
type: string
id:
description: Storage ID. If set, storage with specified ID will be updated
type: integer
path:
description: Path to local directory
type: string
project:
description: Project ID
type: integer
regex_filter:
description: Regex for filtering objects
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
description: Validation successful
security:
- Token: []
summary: Validate export storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- local
x-fern-sdk-method-name: validate
/api/storages/export/localfiles/{id}:
delete:
description: Delete a specific local file export storage connection.
operationId: api_storages_export_localfiles_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete export storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- local
x-fern-sdk-method-name: delete
get:
description: Get a specific local file export storage connection.
operationId: api_storages_export_localfiles_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalFilesExportStorage'
description: ''
security:
- Token: []
summary: Get export storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- local
x-fern-sdk-method-name: get
patch:
description: Update a specific local file export storage connection.
operationId: api_storages_export_localfiles_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
description:
description: Storage description
type: string
path:
description: Path to local directory
type: string
project:
description: Project ID
type: integer
regex_filter:
description: Regex for filtering objects
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalFilesExportStorage'
description: ''
security:
- Token: []
summary: Update export storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- local
x-fern-sdk-method-name: update
/api/storages/export/localfiles/{id}/sync:
post:
description: Sync tasks from a local file export storage connection.
operationId: api_storages_export_localfiles_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalFilesExportStorage'
description: ''
security:
- Token: []
summary: Sync export storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- local
x-fern-sdk-method-name: sync
/api/storages/export/redis:
get:
description: Get a list of all Redis export storage connections.
operationId: api_storages_export_redis_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/RedisExportStorage'
type: array
description: ''
security:
- Token: []
summary: Get all export storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- redis
x-fern-sdk-method-name: list
post:
description: Create a new Redis export storage connection to store annotations.
operationId: api_storages_export_redis_create
requestBody:
content:
application/json:
schema:
properties:
can_delete_objects:
default: false
description: Deletion from storage enabled.
type: boolean
db:
description: Database ID of database to use
type: integer
description:
description: Storage description
type: string
host:
description: Server Host IP (optional)
type: string
password:
description: Server Password (optional)
type: string
path:
description: Storage prefix (optional)
type: string
port:
description: Server Port (optional)
type: string
project:
description: Project ID
type: integer
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/RedisExportStorage'
description: ''
security:
- Token: []
summary: Create export storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- redis
x-fern-sdk-method-name: create
/api/storages/export/redis/validate:
post:
description: Validate a specific Redis export storage connection.
operationId: api_storages_export_redis_validate_create
requestBody:
content:
application/json:
schema:
properties:
can_delete_objects:
default: false
description: Deletion from storage enabled.
type: boolean
db:
description: Database ID of database to use
type: integer
description:
description: Storage description
type: string
host:
description: Server Host IP (optional)
type: string
id:
description: Storage ID. If set, storage with specified ID will be updated
type: integer
password:
description: Server Password (optional)
type: string
path:
description: Storage prefix (optional)
type: string
port:
description: Server Port (optional)
type: string
project:
description: Project ID
type: integer
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'200':
description: Validation successful
security:
- Token: []
summary: Validate export storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- redis
x-fern-sdk-method-name: validate
/api/storages/export/redis/{id}:
delete:
description: Delete a specific Redis export storage connection.
operationId: api_storages_export_redis_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete export storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- redis
x-fern-sdk-method-name: delete
get:
description: Get a specific Redis export storage connection.
operationId: api_storages_export_redis_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RedisExportStorage'
description: ''
security:
- Token: []
summary: Get export storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- redis
x-fern-sdk-method-name: get
patch:
description: Update a specific Redis export storage connection.
operationId: api_storages_export_redis_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
can_delete_objects:
default: false
description: Deletion from storage enabled.
type: boolean
db:
description: Database ID of database to use
type: integer
description:
description: Storage description
type: string
host:
description: Server Host IP (optional)
type: string
password:
description: Server Password (optional)
type: string
path:
description: Storage prefix (optional)
type: string
port:
description: Server Port (optional)
type: string
project:
description: Project ID
type: integer
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RedisExportStorage'
description: ''
security:
- Token: []
summary: Update export storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- redis
x-fern-sdk-method-name: update
/api/storages/export/redis/{id}/sync:
post:
description: Sync tasks from a Redis export storage connection.
operationId: api_storages_export_redis_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RedisExportStorage'
description: ''
security:
- Token: []
summary: Sync export storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- redis
x-fern-sdk-method-name: sync
/api/storages/export/s3:
get:
description: Get a list of all S3 export storage connections.
operationId: api_storages_export_s3_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/S3ExportStorage'
type: array
description: ''
security:
- Token: []
summary: Get all export storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3
x-fern-sdk-method-name: list
post:
description: Create a new S3 export storage connection to store annotations.
operationId: api_storages_export_s3_create
requestBody:
content:
application/json:
schema:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
type: string
bucket:
description: S3 bucket name
type: string
can_delete_objects:
default: false
description: Deletion from storage enabled.
type: boolean
description:
description: Storage description
type: string
prefix:
description: S3 bucket prefix
type: string
project:
description: Project ID
type: integer
region_name:
description: AWS Region
type: string
s3_endpoint:
description: S3 Endpoint
type: string
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/S3ExportStorage'
description: ''
security:
- Token: []
summary: Create export storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3
x-fern-sdk-method-name: create
/api/storages/export/s3/validate:
post:
description: Validate a specific S3 export storage connection.
operationId: api_storages_export_s3_validate_create
requestBody:
content:
application/json:
schema:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
type: string
bucket:
description: S3 bucket name
type: string
can_delete_objects:
default: false
description: Deletion from storage enabled.
type: boolean
description:
description: Storage description
type: string
id:
description: Storage ID. If set, storage with specified ID will be updated
type: integer
prefix:
description: S3 bucket prefix
type: string
project:
description: Project ID
type: integer
region_name:
description: AWS Region
type: string
s3_endpoint:
description: S3 Endpoint
type: string
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'200':
description: Validation successful
security:
- Token: []
summary: Validate export storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3
x-fern-sdk-method-name: validate
/api/storages/export/s3/{id}:
delete:
description: Delete a specific S3 export storage connection.
operationId: api_storages_export_s3_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete export storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3
x-fern-sdk-method-name: delete
get:
description: Get a specific S3 export storage connection.
operationId: api_storages_export_s3_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/S3ExportStorage'
description: ''
security:
- Token: []
summary: Get export storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3
x-fern-sdk-method-name: get
patch:
description: Update a specific S3 export storage connection.
operationId: api_storages_export_s3_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
type: string
bucket:
description: S3 bucket name
type: string
can_delete_objects:
default: false
description: Deletion from storage enabled.
type: boolean
description:
description: Storage description
type: string
prefix:
description: S3 bucket prefix
type: string
project:
description: Project ID
type: integer
region_name:
description: AWS Region
type: string
s3_endpoint:
description: S3 Endpoint
type: string
title:
description: Storage title
maxLength: 2048
type: string
required: []
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/S3ExportStorage'
description: ''
security:
- Token: []
summary: Update export storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3
x-fern-sdk-method-name: update
/api/storages/export/s3/{id}/sync:
post:
description: Sync tasks from an S3 export storage connection.
operationId: api_storages_export_s3_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/S3ExportStorage'
description: ''
security:
- Token: []
summary: Sync export storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3
x-fern-sdk-method-name: sync
/api/storages/export/s3s:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a list of all S3 export storage connections that were set up with IAM role access.
operationId: api_storages_export_s3s_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/LseS3ExportStorage'
type: array
description: ''
security:
- Token: []
summary: ✨ List S3s export storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3s
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create an S3 export storage connection with IAM role access to store annotations.
operationId: api_storages_export_s3s_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LseS3ExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LseS3ExportStorageRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ExportStorage'
description: ''
security:
- Token: []
summary: ✨ Create export storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3s
x-fern-sdk-method-name: create
/api/storages/export/s3s/validate:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific S3 export storage connection that was set up with IAM role access.
operationId: api_storages_export_s3s_validate_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LseS3ExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LseS3ExportStorageRequest'
required: true
responses:
'200':
description: Validation successful
security:
- Token: []
summary: ✨ Validate export storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3s
x-fern-sdk-method-name: validate
/api/storages/export/s3s/{id}:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific S3 export storage connection that was set up with IAM role access.
operationId: api_storages_export_s3s_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete export storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3s
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific S3 export storage connection that was set up with IAM role access.
operationId: api_storages_export_s3s_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ExportStorage'
description: ''
security:
- Token: []
summary: ✨ Get export storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3s
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific S3 export storage connection that was set up with IAM role access.
operationId: api_storages_export_s3s_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLseS3ExportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedLseS3ExportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedLseS3ExportStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ExportStorage'
description: ''
security:
- Token: []
summary: ✨ Update export storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3s
x-fern-sdk-method-name: update
/api/storages/export/s3s/{id}/sync:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Sync tasks from an S3 export storage.
operationId: api_storages_export_s3s_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ExportStorage'
description: ''
security:
- Token: []
summary: ✨ Sync export storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
- s3s
x-fern-sdk-method-name: sync
/api/storages/export/types:
get:
description: Retrieve a list of the export storages types.
operationId: api_storages_export_types_retrieve
responses:
'200':
content:
application/json:
schema:
items:
properties:
name:
type: string
title:
type: string
type: object
type: array
description: List of export storage types
security:
- Token: []
summary: List all export storages types
tags:
- Storage
x-fern-audiences:
- public
x-fern-sdk-group-name:
- export_storage
x-fern-sdk-method-name: list_types
/api/storages/gcs/:
get:
description: Get a list of all GCS import storage connections.
operationId: api_storages_gcs_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/GCSImportStorage'
type: array
description: ''
security:
- Token: []
summary: Get all import storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcs
x-fern-sdk-method-name: list
post:
description: Create a new GCS import storage connection.
operationId: api_storages_gcs_create
requestBody:
content:
application/json:
schema:
properties:
bucket:
description: GCS bucket name
type: string
description:
description: Storage description
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
type: string
google_project_id:
description: Google project ID
type: string
prefix:
description: GCS bucket prefix
type: string
presign:
default: true
description: Presign URLs for direct download
type: boolean
presign_ttl:
default: 1
description: Presign TTL in minutes
type: integer
project:
description: Project ID
type: integer
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSImportStorage'
description: ''
security:
- Token: []
summary: Create import storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcs
x-fern-sdk-method-name: create
/api/storages/gcs/validate:
post:
description: Validate a specific GCS import storage connection.
operationId: api_storages_gcs_validate_create
requestBody:
content:
application/json:
schema:
properties:
bucket:
description: GCS bucket name
type: string
description:
description: Storage description
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
type: string
google_project_id:
description: Google project ID
type: string
id:
description: Storage ID. If set, storage with specified ID will be updated
type: integer
prefix:
description: GCS bucket prefix
type: string
presign:
default: true
description: Presign URLs for direct download
type: boolean
presign_ttl:
default: 1
description: Presign TTL in minutes
type: integer
project:
description: Project ID
type: integer
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
description: Validation successful
security:
- Token: []
summary: Validate import storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcs
x-fern-sdk-method-name: validate
/api/storages/gcs/{id}:
delete:
description: Delete a specific GCS import storage connection.
operationId: api_storages_gcs_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete import storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcs
x-fern-sdk-method-name: delete
get:
description: Get a specific GCS import storage connection.
operationId: api_storages_gcs_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSImportStorage'
description: ''
security:
- Token: []
summary: Get import storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcs
x-fern-sdk-method-name: get
patch:
description: Update a specific GCS import storage connection.
operationId: api_storages_gcs_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
bucket:
description: GCS bucket name
type: string
description:
description: Storage description
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
type: string
google_project_id:
description: Google project ID
type: string
prefix:
description: GCS bucket prefix
type: string
presign:
default: true
description: Presign URLs for direct download
type: boolean
presign_ttl:
default: 1
description: Presign TTL in minutes
type: integer
project:
description: Project ID
type: integer
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSImportStorage'
description: ''
security:
- Token: []
summary: Update import storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcs
x-fern-sdk-method-name: update
/api/storages/gcs/{id}/sync:
post:
description: Sync tasks from a GCS import storage connection.
operationId: api_storages_gcs_sync_create
parameters:
- description: Storage ID
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSImportStorage'
description: ''
security:
- Token: []
summary: Sync import storage
tags:
- 'Storage: GCS'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcs
x-fern-sdk-method-name: sync
/api/storages/gcswif/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get list of all GCS import storage connections set up with WIF authentication.
operationId: api_storages_gcswif_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/GCSWIFImportStorage'
type: array
description: ''
security:
- Token: []
summary: ✨ Get GCS WIF import storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcswif
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create GCS import storage with WIF.
operationId: api_storages_gcswif_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/GCSWIFImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/GCSWIFImportStorageRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFImportStorage'
description: ''
security:
- Token: []
summary: ✨ Create GCS import storage with WIF
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcswif
x-fern-sdk-method-name: create
/api/storages/gcswif/validate:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific GCS import storage connection that was set up with WIF authentication.
operationId: api_storages_gcswif_validate_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/GCSWIFImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/GCSWIFImportStorageRequest'
required: true
responses:
'200':
description: Validation successful
security:
- Token: []
summary: ✨ Validate GCS WIF import storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcswif
x-fern-sdk-method-name: validate
/api/storages/gcswif/{id}:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific GCS import storage connection that was set up with WIF authentication.
operationId: api_storages_gcswif_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete GCS WIF import storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcswif
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific GCS import storage connection that was set up with WIF.
operationId: api_storages_gcswif_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFImportStorage'
description: ''
security:
- Token: []
summary: ✨ Get GCS WIF import storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcswif
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific GCS import storage connection that was set up with WIF authentication.
operationId: api_storages_gcswif_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedGCSWIFImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedGCSWIFImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedGCSWIFImportStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFImportStorage'
description: ''
security:
- Token: []
summary: ✨ Update GCS WIF import storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcswif
x-fern-sdk-method-name: update
/api/storages/gcswif/{id}/sync:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Sync tasks from an GCS import storage connection that was set up with WIF authentication.
operationId: api_storages_gcswif_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GCSWIFImportStorage'
description: ''
security:
- Token: []
summary: ✨ Sync GCS WIF import storage
tags:
- 'Storage: GCS WIF'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- gcswif
x-fern-sdk-method-name: sync
/api/storages/localfiles/:
get:
description: Get a list of all local file import storage connections.
operationId: api_storages_localfiles_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/LocalFilesImportStorage'
type: array
description: ''
security:
- Token: []
summary: Get all import storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- local
x-fern-sdk-method-name: list
post:
description: Create a new local file import storage connection.
operationId: api_storages_localfiles_create
requestBody:
content:
application/json:
schema:
properties:
description:
description: Storage description
type: string
path:
description: Path to local directory
type: string
project:
description: Project ID
type: integer
regex_filter:
description: Regex for filtering objects
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalFilesImportStorage'
description: ''
security:
- Token: []
summary: Create import storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- local
x-fern-sdk-method-name: create
/api/storages/localfiles/validate:
post:
description: Validate a specific local file import storage connection.
operationId: api_storages_localfiles_validate_create
requestBody:
content:
application/json:
schema:
properties:
description:
description: Storage description
type: string
id:
description: Storage ID. If set, storage with specified ID will be updated
type: integer
path:
description: Path to local directory
type: string
project:
description: Project ID
type: integer
regex_filter:
description: Regex for filtering objects
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
description: Validation successful
security:
- Token: []
summary: Validate import storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- local
x-fern-sdk-method-name: validate
/api/storages/localfiles/{id}:
delete:
description: Delete a specific local file import storage connection.
operationId: api_storages_localfiles_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete import storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- local
x-fern-sdk-method-name: delete
get:
description: Get a specific local file import storage connection.
operationId: api_storages_localfiles_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalFilesImportStorage'
description: ''
security:
- Token: []
summary: Get import storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- local
x-fern-sdk-method-name: get
patch:
description: Update a specific local file import storage connection.
operationId: api_storages_localfiles_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
description:
description: Storage description
type: string
path:
description: Path to local directory
type: string
project:
description: Project ID
type: integer
regex_filter:
description: Regex for filtering objects
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalFilesImportStorage'
description: ''
security:
- Token: []
summary: Update import storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- local
x-fern-sdk-method-name: update
/api/storages/localfiles/{id}/sync:
post:
description: Sync tasks from a local file import storage connection.
operationId: api_storages_localfiles_sync_create
parameters:
- description: Storage ID
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalFilesImportStorage'
description: ''
security:
- Token: []
summary: Sync import storage
tags:
- 'Storage: Local'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- local
x-fern-sdk-method-name: sync
/api/storages/redis/:
get:
description: Get a list of all Redis import storage connections.
operationId: api_storages_redis_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/RedisImportStorage'
type: array
description: ''
security:
- Token: []
summary: Get all import storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- redis
x-fern-sdk-method-name: list
post:
description: Create a new Redis import storage connection.
operationId: api_storages_redis_create
requestBody:
content:
application/json:
schema:
properties:
description:
description: Storage description
type: string
host:
description: Server Host IP (optional)
type: string
password:
description: Server Password (optional)
type: string
path:
description: Storage prefix (optional)
type: string
port:
description: Server Port (optional)
type: string
project:
description: Project ID
type: integer
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/RedisImportStorage'
description: ''
security:
- Token: []
summary: Create import storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- redis
x-fern-sdk-method-name: create
/api/storages/redis/validate:
post:
description: Validate a specific Redis import storage connection.
operationId: api_storages_redis_validate_create
requestBody:
content:
application/json:
schema:
properties:
description:
description: Storage description
type: string
host:
description: Server Host IP (optional)
type: string
id:
description: Storage ID. If set, storage with specified ID will be updated
type: integer
password:
description: Server Password (optional)
type: string
path:
description: Storage prefix (optional)
type: string
port:
description: Server Port (optional)
type: string
project:
description: Project ID
type: integer
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
description: Validation successful
security:
- Token: []
summary: Validate import storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- redis
x-fern-sdk-method-name: validate
/api/storages/redis/{id}:
delete:
description: Delete a specific Redis import storage connection.
operationId: api_storages_redis_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete import storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- redis
x-fern-sdk-method-name: delete
get:
description: Get a specific Redis import storage connection.
operationId: api_storages_redis_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RedisImportStorage'
description: ''
security:
- Token: []
summary: Get import storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- redis
x-fern-sdk-method-name: get
patch:
description: Update a specific Redis import storage connection.
operationId: api_storages_redis_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
description:
description: Storage description
type: string
host:
description: Server Host IP (optional)
type: string
password:
description: Server Password (optional)
type: string
path:
description: Storage prefix (optional)
type: string
port:
description: Server Port (optional)
type: string
project:
description: Project ID
type: integer
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RedisImportStorage'
description: ''
security:
- Token: []
summary: Update import storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- redis
x-fern-sdk-method-name: update
/api/storages/redis/{id}/sync:
post:
description: Sync tasks from a Redis import storage connection.
operationId: api_storages_redis_sync_create
parameters:
- description: Storage ID
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RedisImportStorage'
description: ''
security:
- Token: []
summary: Sync import storage
tags:
- 'Storage: Redis'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- redis
x-fern-sdk-method-name: sync
/api/storages/s3/:
get:
description: Get a list of all S3 import storage connections.
operationId: api_storages_s3_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/S3ImportStorage'
type: array
description: ''
security:
- Token: []
summary: List S3 import storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3
x-fern-sdk-method-name: list
post:
description: Create new S3 import storage
operationId: api_storages_s3_create
requestBody:
content:
application/json:
schema:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
type: string
bucket:
description: S3 bucket name
type: string
description:
description: Storage description
type: string
prefix:
description: S3 bucket prefix
type: string
presign:
default: true
description: Presign URLs for download
type: boolean
presign_ttl:
default: 1
description: Presign TTL in minutes
type: integer
project:
description: Project ID
type: integer
recursive_scan:
description: Scan recursively
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
region_name:
description: AWS Region
type: string
s3_endpoint:
description: S3 Endpoint
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/S3ImportStorage'
description: ''
security:
- Token: []
summary: Create new S3 storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3
x-fern-sdk-method-name: create
/api/storages/s3/validate:
post:
description: Validate a specific S3 import storage connection.
operationId: api_storages_s3_validate_create
requestBody:
content:
application/json:
schema:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
type: string
bucket:
description: S3 bucket name
type: string
description:
description: Storage description
type: string
id:
description: Storage ID. If set, storage with specified ID will be updated
type: integer
prefix:
description: S3 bucket prefix
type: string
presign:
default: true
description: Presign URLs for download
type: boolean
presign_ttl:
default: 1
description: Presign TTL in minutes
type: integer
project:
description: Project ID
type: integer
recursive_scan:
description: Scan recursively
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
region_name:
description: AWS Region
type: string
s3_endpoint:
description: S3 Endpoint
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
description: Validation successful
security:
- Token: []
summary: Validate import storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3
x-fern-sdk-method-name: validate
/api/storages/s3/{id}:
delete:
description: Delete a specific S3 import storage connection.
operationId: api_storages_s3_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete import storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3
x-fern-sdk-method-name: delete
get:
description: Get a specific S3 import storage connection.
operationId: api_storages_s3_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/S3ImportStorage'
description: ''
security:
- Token: []
summary: Get import storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3
x-fern-sdk-method-name: get
patch:
description: Update a specific S3 import storage connection.
operationId: api_storages_s3_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
type: string
bucket:
description: S3 bucket name
type: string
description:
description: Storage description
type: string
prefix:
description: S3 bucket prefix
type: string
presign:
default: true
description: Presign URLs for download
type: boolean
presign_ttl:
default: 1
description: Presign TTL in minutes
type: integer
project:
description: Project ID
type: integer
recursive_scan:
description: Scan recursively
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
type: string
region_name:
description: AWS Region
type: string
s3_endpoint:
description: S3 Endpoint
type: string
title:
description: Storage title
maxLength: 2048
type: string
use_blob_urls:
default: false
description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
type: boolean
required: []
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/S3ImportStorage'
description: ''
security:
- Token: []
summary: Update import storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3
x-fern-sdk-method-name: update
/api/storages/s3/{id}/sync:
post:
description: Sync tasks from an S3 import storage connection.
operationId: api_storages_s3_sync_create
parameters:
- description: Storage ID
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/S3ImportStorage'
description: ''
security:
- Token: []
summary: Sync import storage
tags:
- 'Storage: S3'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3
x-fern-sdk-method-name: sync
/api/storages/s3s/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get list of all S3 import storage connections set up with IAM role access.
operationId: api_storages_s3s_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: Project ID
in: query
name: project
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/LseS3ImportStorage'
type: array
description: ''
security:
- Token: []
summary: ✨ List S3s import storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3s
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create S3 import storage with IAM role access.
operationId: api_storages_s3s_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LseS3ImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LseS3ImportStorageRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ImportStorage'
description: ''
security:
- Token: []
summary: ✨ Create import storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3s
x-fern-sdk-method-name: create
/api/storages/s3s/validate:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Validate a specific S3 import storage connection that was set up with IAM role access.
operationId: api_storages_s3s_validate_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LseS3ImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LseS3ImportStorageRequest'
required: true
responses:
'200':
description: Validation successful
security:
- Token: []
summary: ✨ Validate import storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3s
x-fern-sdk-method-name: validate
/api/storages/s3s/{id}:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific S3 import storage connection that was set up with IAM role access.
operationId: api_storages_s3s_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete import storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3s
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a specific S3 import storage connection that was set up with IAM role access.
operationId: api_storages_s3s_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ImportStorage'
description: ''
security:
- Token: []
summary: ✨ Get import storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3s
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update a specific S3 import storage connection that was set up with IAM role access.
operationId: api_storages_s3s_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLseS3ImportStorageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedLseS3ImportStorageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedLseS3ImportStorageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ImportStorage'
description: ''
security:
- Token: []
summary: ✨ Update import storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3s
x-fern-sdk-method-name: update
/api/storages/s3s/{id}/sync:
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Sync tasks from an S3 import storage connection that was set up with IAM role access.
operationId: api_storages_s3s_sync_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LseS3ImportStorage'
description: ''
security:
- Token: []
summary: ✨ Sync import storage
tags:
- 'Storage: S3 Roles'
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
- s3s
x-fern-sdk-method-name: sync
/api/storages/types:
get:
description: Retrieve a list of the import storages types.
operationId: api_storages_types_retrieve
responses:
'200':
content:
application/json:
schema:
items:
properties:
name:
type: string
title:
type: string
type: object
type: array
description: List of import storage types
security:
- Token: []
summary: List all import storages types
tags:
- Storage
x-fern-audiences:
- public
x-fern-sdk-group-name:
- import_storage
x-fern-sdk-method-name: list_types
/api/tasks/:
get:
description: |-
Retrieve a paginated list of tasks. The response format varies based on the user's role in the organization:
- **Admin/Owner**: Full task details with all annotations, reviews, and metadata
- **Reviewer**: Task details optimized for review workflow
- **Annotator**: Task details filtered to show only user's own annotations and assignments
operationId: api_tasks_list
parameters:
- description: Set to "all" if you want to include annotations and predictions in the response. Defaults to task_only
in: query
name: fields
schema:
enum:
- all
- task_only
type: string
- description: Specify which fields to include in the response
in: query
name: include
schema:
type: string
- description: Filter to show only tasks that have annotations
in: query
name: only_annotated
schema:
type: boolean
- description: A page number within the paginated result set.
in: query
name: page
required: false
schema:
type: integer
- description: Number of results to return per page.
in: query
name: page_size
required: false
schema:
type: integer
- description: Project ID
in: query
name: project
schema:
type: integer
- description: |-
Additional query to filter tasks. It must be JSON encoded string of dict containing one of the following parameters: {"filters": ..., "selectedItems": ..., "ordering": ...}. Check Data Manager > Create View > see data field for more details about filters, selectedItems and ordering.
filters: dict with "conjunction" string ("or" or "and") and list of filters in "items" array. Each filter is a dictionary with keys: "filter", "operator", "type", "value". Read more about available filters
Example: {"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}
selectedItems: dictionary with keys: "all", "included", "excluded". If "all" is false, "included" must be used. If "all" is true, "excluded" must be used.
Examples: {"all": false, "included": [1, 2, 3]} or {"all": true, "excluded": [4, 5]}
ordering: list of fields to order by. Currently, ordering is supported by only one parameter.
Example: ["completed_at"]
in: query
name: query
schema:
type: string
- description: Resolve task data URIs using Cloud Storage
in: query
name: resolve_uri
schema:
type: boolean
- description: Get tasks for review
in: query
name: review
schema:
type: boolean
- description: JSON string of selected task IDs for review workflow
in: query
name: selectedItems
schema:
type: string
- description: View ID
in: query
name: view
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedRoleBasedTaskList'
description: ''
'400':
description: Bad request - invalid parameters
'401':
description: Unauthorized - authentication required
'403':
description: Forbidden - insufficient permissions
security:
- Token: []
summary: List tasks
tags:
- Tasks
x-fern-audiences:
- public
x-fern-pagination:
offset: $request.page
results: $response.tasks
x-fern-sdk-group-name: tasks
x-fern-sdk-method-name: list
post:
description: Create a new task
operationId: api_tasks_create
requestBody:
content:
application/json:
examples:
CreateTask:
description: Example of Create Task
summary: Create Task
value:
data:
image: https://example.com/image.jpg
text: Hello, world!
project: 1
schema:
$ref: '#/components/schemas/LseTaskRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LseTaskRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LseTaskRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LseTask'
description: ''
security:
- Token: []
summary: Create a new task
tags:
- Tasks
x-fern-audiences:
- public
x-fern-sdk-group-name: tasks
x-fern-sdk-method-name: create
/api/tasks/{id}/:
delete:
description: Delete a task in Label Studio. This action cannot be undone!
operationId: api_tasks_destroy
parameters:
- description: Task ID
in: path
name: id
required: true
schema:
type: string
responses:
'204':
description: Task deleted successfully
security:
- Token: []
summary: Delete task
tags:
- Tasks
x-fern-audiences:
- public
x-fern-sdk-group-name: tasks
x-fern-sdk-method-name: delete
get:
description: Get task data, metadata, annotations and other attributes for a specific labeling task by task ID.
operationId: api_tasks_retrieve
parameters:
- description: Task ID
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoleBasedTask'
description: ''
security:
- Token: []
summary: Get task
tags:
- Tasks
x-fern-audiences:
- public
x-fern-sdk-group-name: tasks
x-fern-sdk-method-name: get
patch:
description: Update the attributes of an existing labeling task.
operationId: api_tasks_partial_update
parameters:
- description: Task ID
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLseTaskRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedLseTaskRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedLseTaskRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoleBasedTask'
description: ''
security:
- Token: []
summary: Update task
tags:
- Tasks
x-fern-audiences:
- public
x-fern-sdk-group-name: tasks
x-fern-sdk-method-name: update
/api/tasks/{id}/agreement/:
get:
description: Get aggregated label distribution across all annotations for a task. Returns counts of each label value grouped by control tag. This is an efficient endpoint that avoids N+1 queries.
operationId: api_tasks_agreement_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
description: Label distribution data
security:
- Token: []
summary: Get task label distribution
tags:
- Tasks
x-fern-audiences:
- internal
/api/tasks/{id}/annotations/:
get:
description: List all annotations for a task.
operationId: api_tasks_annotations_list
parameters:
- description: Task ID
in: path
name: id
required: true
schema:
type: integer
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
responses:
'200':
content:
application/json:
examples:
Response:
summary: response
value:
- - completed_by: 1
ground_truth: false
id: 1
lead_time: 10
project: 1
result:
- from_name: bboxes
image_rotation: 0
original_height: 1080
original_width: 1920
to_name: image
type: rectanglelabels
value:
height: 60
rotation: 0
values:
rectanglelabels:
- Person
width: 50
x: 20
y: 30
task: 1
updated_by: 1
was_cancelled: false
schema:
items:
$ref: '#/components/schemas/Annotation'
type: array
description: Annotation
security:
- Token: []
summary: Get all task annotations
tags:
- Annotations
x-fern-audiences:
- public
x-fern-sdk-group-name: annotations
x-fern-sdk-method-name: list
post:
description: "\n Add annotations to a task like an annotator does. The content of the result field depends on your\n labeling configuration. For example, send the following data as part of your POST\n request to send an empty annotation with the ID of the user who completed the task:\n\n ```json\n {\n \"result\": {},\n \"was_cancelled\": true,\n \"ground_truth\": true,\n \"lead_time\": 0,\n \"task\": 0\n \"completed_by\": 123\n }\n ```\n "
operationId: api_tasks_annotations_create
parameters:
- description: Task ID
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
example:
ground_truth: true
result:
- from_name: bboxes
image_rotation: 0
original_height: 1080
original_width: 1920
to_name: image
type: rectanglelabels
value:
height: 60
rotation: 0
values:
rectanglelabels:
- Person
width: 50
x: 20
y: 30
was_cancelled: false
properties:
completed_by:
description: User ID of the person who created this annotation
type: integer
ground_truth:
description: This annotation is a Ground Truth
type: boolean
lead_time:
description: How much time it took to annotate the task (in seconds)
example: 100.5
type: number
project:
description: Project ID for this annotation
type: integer
result:
description: Labeling result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/task_format)
example:
- from_name: bboxes
image_rotation: 0
original_height: 1080
original_width: 1920
to_name: image
type: rectanglelabels
value:
height: 60
rotation: 0
values:
rectanglelabels:
- Person
width: 50
x: 20
y: 30
items:
type: object
type: array
task:
description: Corresponding task for this annotation
type: integer
updated_by:
description: Last user who updated this annotation
type: integer
was_cancelled:
description: User skipped the task
type: boolean
required: []
type: object
responses:
'201':
content:
application/json:
examples:
Response:
summary: response
value:
completed_by: 1
ground_truth: false
id: 1
lead_time: 10
project: 1
result:
- from_name: bboxes
image_rotation: 0
original_height: 1080
original_width: 1920
to_name: image
type: rectanglelabels
value:
height: 60
rotation: 0
values:
rectanglelabels:
- Person
width: 50
x: 20
y: 30
task: 1
updated_by: 1
was_cancelled: false
schema:
$ref: '#/components/schemas/Annotation'
description: Created annotation
security:
- Token: []
summary: Create annotation
tags:
- Annotations
x-fern-audiences:
- public
x-fern-sdk-group-name: annotations
x-fern-sdk-method-name: create
/api/tasks/{id}/events/:
post:
description: "\n Create a new task event to track user interactions and system events during annotation.\n\n This endpoint is designed to receive events from the frontend labeling interface to enable\n accurate lead time calculation and detailed annotation analytics.\n\n ## Event Types\n\n **Core Annotation Events:**\n - `annotation_loaded` - When annotation interface is loaded\n - `annotation_created` - When annotation is submitted\n - `annotation_updated` - When annotation is modified\n - `annotation_reviewed` - When annotation is reviewed\n\n **User Activity Events:**\n - `visibility_change` - When page visibility changes (tab switch, minimize)\n - `idle_detected` - When user goes idle\n - `idle_resumed` - When user returns from idle\n\n **Interaction Events:**\n - `region_finished_drawing` - When annotation region is completed\n - `region_deleted` - When annotation regions are removed\n - `hotkey_pressed` - When keyboard shortcuts are used\n\n **Media Events:**\n - `video_playback_start/end` - Video playback control\n - `audio_playback_start/end` - Audio playback control\n - `video_scrub` - Video timeline scrubbing\n\n ## Usage\n\n Events are automatically associated with the task specified in the URL path.\n The current user is automatically set as the actor. Project and organization\n are derived from the task context.\n\n ## Example Request\n\n ```json\n {\n \"event_key\": \"annotation_loaded\",\n \"event_time\": \"2024-01-15T10:30:00Z\",\n \"annotation\": 123,\n \"meta\": {\n \"annotation_count\": 5,\n \"estimated_time\": 300\n }\n }\n ```\n "
operationId: api_tasks_events_create
parameters:
- description: Task ID to associate the event with
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskEventRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TaskEventRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TaskEventRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskEvent'
description: ''
'400':
description: Bad request - validation errors
'401':
description: Unauthorized - authentication required
'403':
description: Forbidden - insufficient permissions
'404':
description: Not found - task does not exist
security:
- Token: []
summary: Create task event
tags:
- Task Events
x-fern-audiences:
- public
x-fern-sdk-group-name: tasks
x-fern-sdk-method-name: create_event
/api/token/:
get:
description: List all API tokens for the current user.
operationId: api_token_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/LSEAPITokenList'
type: array
description: ''
security:
- Token: []
summary: List API tokens
tags:
- JWT
x-fern-audiences:
- public
x-fern-sdk-group-name: tokens
x-fern-sdk-method-name: list
post:
description: Create a new API token for the current user.
operationId: api_token_create
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LSEAPITokenCreate'
description: ''
security:
- Token: []
summary: Create API token
tags:
- JWT
x-fern-audiences:
- public
x-fern-sdk-group-name: tokens
x-fern-sdk-method-name: create
/api/token/blacklist/:
post:
description: Adds a JWT refresh token to the blacklist, preventing it from being used to obtain new access tokens.
operationId: api_token_blacklist_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LSAPITokenBlacklistRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LSAPITokenBlacklistRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LSAPITokenBlacklistRequest'
required: true
responses:
'204':
content:
application/json:
schema:
additionalProperties: {}
description: Unspecified response body
type: object
description: ''
'404':
content:
application/json:
schema:
additionalProperties: {}
description: Unspecified response body
type: object
description: ''
summary: Blacklist a JWT refresh token
tags:
- JWT
x-fern-audiences:
- public
x-fern-sdk-group-name: tokens
x-fern-sdk-method-name: blacklist
/api/token/refresh/:
post:
description: Get a new access token, using a refresh token.
operationId: api_token_refresh_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefreshRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenRefreshRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenRefreshRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefreshResponse'
description: ''
summary: Refresh JWT token
tags:
- JWT
x-fern-audiences:
- public
x-fern-sdk-group-name: tokens
x-fern-sdk-method-name: refresh
/api/token/rotate/:
post:
description: Creates a new JWT refresh token and blacklists the current one.
operationId: api_token_rotate_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LSAPITokenRotateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LSAPITokenRotateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LSAPITokenRotateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRotateResponse'
description: ''
'400':
content:
application/json:
schema:
additionalProperties: {}
description: Unspecified response body
type: object
description: ''
security:
- Token: []
summary: Rotate JWT refresh token
tags:
- JWT
x-fern-audiences:
- public
x-fern-sdk-group-name: tokens
x-fern-sdk-method-name: rotate
/api/users/:
get:
description: List the users that exist on the Label Studio server.
operationId: api_users_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/LseUserAPI'
type: array
description: ''
security:
- Token: []
summary: List users
tags:
- Users
x-fern-audiences:
- public
x-fern-sdk-group-name: users
x-fern-sdk-method-name: list
post:
description: Create a user in Label Studio.
operationId: api_users_create
requestBody:
content:
application/json:
schema:
properties:
allow_newsletters:
description: Whether the user allows newsletters
type: boolean
avatar:
description: Avatar URL of the user
type: string
email:
description: Email of the user
type: string
first_name:
description: First name of the user
type: string
id:
description: User ID
type: integer
initials:
description: Initials of the user
type: string
last_name:
description: Last name of the user
type: string
phone:
description: Phone number of the user
type: string
username:
description: Username of the user
type: string
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LseUser'
description: ''
security:
- Token: []
summary: Create new user
tags:
- Users
x-fern-audiences:
- public
x-fern-sdk-group-name: users
x-fern-sdk-method-name: create
/api/users/{id}/:
delete:
description: |-
Delete a specific Label Studio user. Only available in community edition.
Use caution when deleting a user, as this can cause issues such as breaking the "Annotated by" filter or leaving orphaned records.
operationId: api_users_destroy
parameters:
- description: User ID
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete user
tags:
- Users
x-fern-audiences:
- public
x-fern-sdk-group-name: users
x-fern-sdk-method-name: delete
get:
description: Get info about a specific Label Studio user, based on the user ID.
operationId: api_users_retrieve
parameters:
- description: User ID
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LseUser'
description: ''
security:
- Token: []
summary: Get user info
tags:
- Users
x-fern-audiences:
- public
x-fern-sdk-group-name: users
x-fern-sdk-method-name: get
patch:
description: "\n Update details for a specific user, such as their name or contact information, in Label Studio.\n "
operationId: api_users_partial_update
parameters:
- description: User ID
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
properties:
allow_newsletters:
description: Whether the user allows newsletters
type: boolean
avatar:
description: Avatar URL of the user
type: string
email:
description: Email of the user
type: string
first_name:
description: First name of the user
type: string
id:
description: User ID
type: integer
initials:
description: Initials of the user
type: string
last_name:
description: Last name of the user
type: string
phone:
description: Phone number of the user
type: string
username:
description: Username of the user
type: string
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LseUser'
description: ''
security:
- Token: []
summary: Update user details
tags:
- Users
x-fern-audiences:
- public
x-fern-sdk-group-name: users
x-fern-sdk-method-name: update
/api/version/:
get:
description: Get version information about the Label Studio instance.
operationId: api_version_retrieve
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VersionResponse'
description: ''
security:
- Token: []
- {}
summary: Get version information
tags:
- Versions
x-fern-audiences:
- public
x-fern-sdk-group-name: versions
x-fern-sdk-method-name: get
/api/webhooks/:
get:
description: List all webhooks set up for your organization.
operationId: api_webhooks_list
parameters:
- description: Project ID
in: query
name: project
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Webhook'
type: array
description: ''
security:
- Token: []
summary: List all webhooks
tags:
- Webhooks
x-fern-audiences:
- public
x-fern-sdk-group-name: webhooks
x-fern-sdk-method-name: list
post:
description: Create a webhook for your organization.
operationId: api_webhooks_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WebhookRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WebhookRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
description: ''
security:
- Token: []
summary: Create a webhook
tags:
- Webhooks
x-fern-audiences:
- public
x-fern-sdk-group-name: webhooks
x-fern-sdk-method-name: create
/api/webhooks/info/:
get:
description: Get descriptions of all available webhook actions to set up webhooks.
operationId: api_webhooks_info_retrieve
parameters:
- description: organization-only or not
in: query
name: organization-only
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
properties:
ANNOTATIONS_CREATED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
ANNOTATIONS_DELETED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
ANNOTATION_CREATED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
ANNOTATION_UPDATED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
LABEL_LINK_CREATED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
LABEL_LINK_DELETED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
LABEL_LINK_UPDATED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
PROJECT_CREATED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
PROJECT_DELETED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
PROJECT_UPDATED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
REVIEWS_DELETED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
REVIEW_CREATED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
REVIEW_UPDATED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
TASKS_CREATED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
TASKS_DELETED:
properties:
description:
type: string
key:
type: string
name:
type: string
organization-only:
type: boolean
required:
- name
- description
- key
- organization-only
type: object
type: object
description: Object with webhook action descriptions.
security:
- Token: []
- {}
summary: Get all webhook actions
tags:
- Webhooks
x-fern-audiences:
- public
x-fern-sdk-group-name: webhooks
x-fern-sdk-method-name: info
/api/webhooks/{id}/:
delete:
operationId: api_webhooks_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: Delete webhook info
tags:
- Webhooks
x-fern-audiences:
- public
x-fern-sdk-group-name: webhooks
x-fern-sdk-method-name: delete
get:
operationId: api_webhooks_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
description: ''
security:
- Token: []
summary: Get webhook info
tags:
- Webhooks
x-fern-audiences:
- public
x-fern-sdk-group-name: webhooks
x-fern-sdk-method-name: get
patch:
operationId: api_webhooks_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWebhookSerializerForUpdateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedWebhookSerializerForUpdateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWebhookSerializerForUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookSerializerForUpdate'
description: ''
security:
- Token: []
summary: Update webhook info
tags:
- Webhooks
x-fern-audiences:
- public
x-fern-sdk-group-name: webhooks
x-fern-sdk-method-name: update
put:
operationId: api_webhooks_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookSerializerForUpdateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WebhookSerializerForUpdateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WebhookSerializerForUpdateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookSerializerForUpdate'
description: ''
security:
- Token: []
summary: Save webhook info
tags:
- Webhooks
x-fern-audiences:
- internal
/api/workspaces/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all workspaces for your organization. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
operationId: api_workspaces_list
parameters:
- description: Include all workspaces in the organization, including other users' personal workspaces. Only effective for users with Administrator or Owner role. When enabled, the response includes created_by_user info for personal workspaces.
in: query
name: include_all_workspaces
schema:
type: boolean
- description: Filter by archived status. Set to false to exclude archived workspaces.
in: query
name: is_archived
schema:
type: boolean
- description: Workspace is a personal user workspace.
in: query
name: is_personal
schema:
type: boolean
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Workspace'
type: array
description: ''
security:
- Token: []
summary: ✨ List workspaces
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name: workspaces
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new workspace. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
operationId: api_workspaces_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkspaceRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WorkspaceRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WorkspaceRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Workspace'
description: ''
security:
- Token: []
summary: ✨ Create workspace
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name: workspaces
x-fern-sdk-method-name: create
/api/workspaces/{id}/:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific workspace by ID.
operationId: api_workspaces_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete workspace
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name: workspaces
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve details for a specific workspace by ID.
operationId: api_workspaces_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Workspace'
description: ''
security:
- Token: []
summary: ✨ Get workspace
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name: workspaces
x-fern-sdk-method-name: get
patch:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update settings for a specific workspace by ID.
operationId: api_workspaces_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWorkspaceRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedWorkspaceRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWorkspaceRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Workspace'
description: ''
security:
- Token: []
summary: ✨ Update workspace
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name: workspaces
x-fern-sdk-method-name: update
/api/workspaces/{id}/memberships/:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Remove a specific member by ID from a workspace. This endpoint expects an object like `{"user_id": 123}`.
operationId: api_workspaces_memberships_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- Token: []
summary: ✨ Delete workspace membership
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name:
- workspaces
- members
x-fern-sdk-method-name: delete
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get a list of all members in a specific workspace.
operationId: api_workspaces_memberships_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/WorkspaceMemberList'
type: array
description: A list of workspace memberships
security:
- Token: []
summary: ✨ List workspace memberships
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name:
- workspaces
- members
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Add a new workspace member by user ID.
operationId: api_workspaces_memberships_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkspaceMemberCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WorkspaceMemberCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WorkspaceMemberCreateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WorkspaceMemberCreate'
description: ''
security:
- Token: []
summary: ✨ Create workspace membership
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name:
- workspaces
- members
x-fern-sdk-method-name: create
/api/workspaces/{id}/memberships/bulk/:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Unassign workspace members in bulk. Allows the same request body as bulk assign.
operationId: api_workspaces_memberships_bulk_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
properties:
unassignments:
type: integer
type: object
description: ''
security:
- Token: []
summary: ✨ Bulk unassign workspace members
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name:
- workspaces
- members
- bulk
x-fern-sdk-method-name: delete
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Assign workspace members in bulk.
operationId: api_workspaces_memberships_bulk_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkspaceMemberBulkAssignRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WorkspaceMemberBulkAssignRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WorkspaceMemberBulkAssignRequest'
required: true
responses:
'200':
content:
application/json:
schema:
properties:
assignments:
type: integer
type: object
description: ''
security:
- Token: []
summary: ✨ Bulk assign workspace members
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name:
- workspaces
- members
- bulk
x-fern-sdk-method-name: post
/api/workspaces/{id}/memberships/paginated/:
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve the members for a specific workspace.
operationId: api_workspaces_memberships_paginated_list
parameters:
- in: path
name: id
required: true
schema:
type: integer
- description: Comma-separated list of user IDs to filter by
in: query
name: ids
schema:
type: string
- description: A page number within the paginated result set.
in: query
name: page
required: false
schema:
type: integer
- description: Number of results to return per page.
in: query
name: page_size
required: false
schema:
type: integer
- description: A search term.
in: query
name: search
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedLseUserList'
description: ''
security:
- Token: []
summary: ✨ Get workspace members paginated
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-pagination:
offset: $request.page
results: $response.results
x-fern-sdk-group-name:
- workspaces
- members
- paginated
x-fern-sdk-method-name: list
/api/workspaces/{id}/projects/:
delete:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Remove a project from a specific workspace.
operationId: api_workspaces_projects_destroy
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: Project removed
security:
- Token: []
summary: ✨ Remove workspace project
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name:
- workspaces
- projects
x-fern-sdk-method-name: remove
get:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a list of all projects in a specific workspace.
operationId: api_workspaces_projects_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Project'
type: array
description: Projects list
security:
- Token: []
summary: ✨ List workspace projects
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name:
- workspaces
- projects
x-fern-sdk-method-name: list
post:
description: |-
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Add a project to a specific workspace.
operationId: api_workspaces_projects_create
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkspaceProjectsRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WorkspaceProjectsRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WorkspaceProjectsRequest'
required: true
responses:
'201':
description: Project added
security:
- Token: []
summary: ✨ Add workspace project
tags:
- Workspaces
x-fern-audiences:
- public
x-fern-sdk-group-name:
- workspaces
- projects
x-fern-sdk-method-name: add
/data/upload/{filename}:
get:
description: Download a specific uploaded file.
operationId: data_upload_retrieve
parameters:
- in: path
name: filename
required: true
schema:
type: string
responses:
'200':
description: File downloaded successfully
security:
- Token: []
summary: Download file
tags:
- Import
x-fern-audiences:
- public
x-fern-sdk-group-name:
- files
x-fern-sdk-method-name: download
components:
schemas:
AWSCustomFunctionUpdateRequest:
description: Serializer for updating AWS Lambda custom metric function.
properties:
code:
description: The Python code for the custom metric function.
minLength: 1
type: string
region:
description: The AWS region for the Lambda function. Uses default if not provided.
nullable: true
type: string
role:
description: The AWS IAM role ARN for the Lambda function. Uses default if not provided.
nullable: true
type: string
required:
- code
type: object
ActionEnum:
description: |-
* `prediction` - Created from prediction
* `propagated_annotation` - Created from another annotation
* `imported` - Imported
* `submitted` - Submitted
* `updated` - Updated
* `skipped` - Skipped
* `accepted` - Accepted
* `rejected` - Rejected
* `fixed_and_accepted` - Fixed and accepted
* `deleted_review` - Deleted review
enum:
- prediction
- propagated_annotation
- imported
- submitted
- updated
- skipped
- accepted
- rejected
- fixed_and_accepted
- deleted_review
type: string
ActionsEnum:
description: |-
* `PROJECT_CREATED` - PROJECT_CREATED
* `PROJECT_UPDATED` - PROJECT_UPDATED
* `PROJECT_DELETED` - PROJECT_DELETED
* `TASKS_CREATED` - TASKS_CREATED
* `TASKS_DELETED` - TASKS_DELETED
* `ANNOTATION_CREATED` - ANNOTATION_CREATED
* `ANNOTATIONS_CREATED` - ANNOTATIONS_CREATED
* `ANNOTATION_UPDATED` - ANNOTATION_UPDATED
* `ANNOTATIONS_DELETED` - ANNOTATIONS_DELETED
* `LABEL_LINK_CREATED` - LABEL_LINK_CREATED
* `LABEL_LINK_UPDATED` - LABEL_LINK_UPDATED
* `LABEL_LINK_DELETED` - LABEL_LINK_DELETED
* `REVIEW_CREATED` - REVIEW_CREATED
* `REVIEW_UPDATED` - REVIEW_UPDATED
* `REVIEWS_DELETED` - REVIEWS_DELETED
enum:
- PROJECT_CREATED
- PROJECT_UPDATED
- PROJECT_DELETED
- TASKS_CREATED
- TASKS_DELETED
- ANNOTATION_CREATED
- ANNOTATIONS_CREATED
- ANNOTATION_UPDATED
- ANNOTATIONS_DELETED
- LABEL_LINK_CREATED
- LABEL_LINK_UPDATED
- LABEL_LINK_DELETED
- REVIEW_CREATED
- REVIEW_UPDATED
- REVIEWS_DELETED
type: string
ActivityLog:
properties:
datetime:
format: date-time
readOnly: true
type: string
duration:
description: Duration of response generation in ms
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
email:
maxLength: 256
type: string
extra_data:
nullable: true
http_referer:
maxLength: 1024
type: string
id:
readOnly: true
type: integer
ip_address:
nullable: true
title: IP
type: string
organization_id:
description: Organization id
maximum: 2147483647
minimum: -2147483648
nullable: true
title: Active organization id
type: integer
project_id:
description: Project id if request has it
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
request_method:
maxLength: 10
title: Http method
type: string
request_url:
maxLength: 256
title: Url
type: string
response_code:
maxLength: 3
type: string
user_agent:
maxLength: 1024
type: string
user_id:
maximum: 2147483647
minimum: -2147483648
type: integer
user_session:
maxLength: 8
nullable: true
type: string
workspace_owner_id:
description: Owner id of workspace where action performed
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
required:
- datetime
- email
- id
- request_method
- request_url
- response_code
- user_id
type: object
ActivityLogResponse:
description: Serializer for ActivityLogAPI response.
properties:
data:
items:
$ref: '#/components/schemas/ActivityLog'
type: array
recordsFiltered:
type: integer
recordsTotal:
type: integer
required:
- data
- recordsFiltered
- recordsTotal
type: object
AgreementMethodologyEnum:
description: |-
* `consensus` - Consensus
* `pairwise` - Pairwise Averaging
enum:
- consensus
- pairwise
type: string
AgreementSelectionGroupRequest:
properties:
all:
default: false
type: boolean
ids:
default: []
items:
minLength: 1
type: string
type: array
type: object
AgreementSelectionRequest:
properties:
annotators:
$ref: '#/components/schemas/AgreementSelectionGroupRequest'
ground_truth:
default: false
type: boolean
models:
$ref: '#/components/schemas/AgreementSelectionGroupRequest'
type: object
AgreementV2BackfillCancelResponse:
description: Response from DELETE /api/dimensions/backfill/
properties:
cancelled_count:
description: Number of jobs successfully cancelled
type: integer
message:
type: string
required:
- cancelled_count
- message
type: object
AgreementV2BackfillJob:
description: |-
Serializes a DimensionsBackfillJob model instance.
Used by the list endpoint and as the base for the status endpoint.
properties:
completed_at:
format: date-time
nullable: true
type: string
created_at:
format: date-time
readOnly: true
type: string
error_message:
description: Error message if job failed
type: string
job_id:
description: Database ID of the backfill job
readOnly: true
type: integer
progress_data:
description: JSON data tracking job progress (matrices_created, errors, etc.)
project_id:
description: Optional specific project to backfill (if null, backfills entire organization)
nullable: true
readOnly: true
type: integer
rq_job_id:
description: Redis queue job ID
nullable: true
readOnly: true
type: string
started_at:
format: date-time
nullable: true
type: string
status:
allOf:
- $ref: '#/components/schemas/AgreementV2BackfillJobStatusEnum'
description: |-
Current status of the backfill job
* `PENDING` - Pending
* `QUEUED` - Queued
* `RUNNING` - Running
* `COMPLETED` - Completed
* `FAILED` - Failed
triggered_by:
description: User who triggered the backfill
readOnly: true
type: string
required:
- created_at
- job_id
- project_id
- rq_job_id
- triggered_by
type: object
AgreementV2BackfillJobStatusEnum:
description: |-
* `PENDING` - Pending
* `QUEUED` - Queued
* `RUNNING` - Running
* `COMPLETED` - Completed
* `FAILED` - Failed
enum:
- PENDING
- QUEUED
- RUNNING
- COMPLETED
- FAILED
type: string
AgreementV2BackfillTriggerRequestRequest:
description: |-
Request body for POST /api/dimensions/backfill/
Exactly one of the three mode fields must be provided:
- project_id: backfill a single specific project.
- num_projects: batched org backfill — queue the next N not-yet-started projects
(ascending project ID order), leaving in-flight jobs untouched.
Check `projects_remaining` in the response and repeat until it reaches 0.
- all_projects: full org backfill — cancel all in-flight jobs and queue every
remaining non-completed project at once.
properties:
all_projects:
description: Set to true to trigger a full org backfill (cancels in-flight jobs and queues all remaining projects).
nullable: true
type: boolean
num_projects:
description: Queue at most this many projects per call (batched mode).
minimum: 1
nullable: true
type: integer
project_id:
description: Backfill a single specific project.
nullable: true
type: integer
type: object
AgreementV2BackfillTriggerResponse:
description: Response from POST /api/dimensions/backfill/
properties:
jobs:
description: 'Queued jobs: [{job_id, rq_job_id, project_id}]'
items:
additionalProperties: {}
type: object
type: array
jobs_queued:
description: Number of jobs queued in this request
type: integer
message:
type: string
organization_id:
type: integer
projects_remaining:
description: Projects not yet started and not currently in-flight. Relevant when num_projects is used — call POST again until this reaches 0.
type: integer
projects_skipped:
description: Projects skipped because they already have a completed backfill
type: integer
required:
- jobs
- jobs_queued
- message
- organization_id
- projects_remaining
- projects_skipped
type: object
AllRolesProjectList:
description: |-
Serializer get numbers from project queryset annotation,
make sure, that you use correct one(Project.objects.with_counts())
properties:
agreement_methodology:
allOf:
- $ref: '#/components/schemas/AgreementMethodologyEnum'
default: pairwise
description: |-
Methodology (Consensus / Pairwise Averaging)
* `consensus` - Consensus
* `pairwise` - Pairwise Averaging
agreement_threshold:
description: Agreement threshold
format: decimal
nullable: true
pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
type: string
allow_stream:
readOnly: true
type: boolean
annotation_limit_count:
description: Limit by number of tasks
minimum: 1
nullable: true
type: integer
annotation_limit_percent:
description: Limit by percentage of tasks
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
annotator_evaluation_continuous_tasks:
default: 0
description: 'Continuous Evaluation: Required tasks'
minimum: 0
type: integer
annotator_evaluation_enabled:
description: Evaluate all annotators against ground truth
type: boolean
annotator_evaluation_minimum_score:
default: '95.00'
description: Score required to pass evaluation
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
annotator_evaluation_minimum_tasks:
default: 10
description: Number of tasks for evaluation
minimum: 0
nullable: true
type: integer
annotator_evaluation_onboarding_tasks:
default: 0
description: 'Onboarding Evaluation: Required tasks'
minimum: 0
type: integer
assignment_settings:
$ref: '#/components/schemas/AssignmentSettings'
blueprints:
items:
$ref: '#/components/schemas/BlueprintList'
readOnly: true
type: array
color:
description: Color
maxLength: 16
nullable: true
type: string
comment_classification_config:
type: string
config_has_control_tags:
description: Flag to detect is project ready for labeling
readOnly: true
type: boolean
config_suitable_for_bulk_annotation:
description: Flag to detect is project ready for bulk annotation
readOnly: true
type: boolean
control_weights:
additionalProperties:
$ref: '#/components/schemas/ControlTagWeight'
description: 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.
nullable: true
type: object
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
description: Project owner
custom_script:
description: Plugins
type: string
custom_task_lock_ttl:
description: Task reservation time. TTL in seconds (UI displays and edits this value in minutes).
maximum: 86400
minimum: 1
nullable: true
type: integer
data_types:
additionalProperties: true
nullable: true
readOnly: true
type: object
description:
description: Description
nullable: true
type: string
description_short:
readOnly: true
type: string
duplication_done:
default: false
type: boolean
duplication_status:
type: string
enable_empty_annotation:
description: Allow empty annotations
type: boolean
evaluate_predictions_automatically:
description: Retrieve and display predictions when loading a task
type: boolean
expert_instruction:
description: Instructions
nullable: true
type: string
finished_task_number:
readOnly: true
type: integer
ground_truth_number:
description: Honeypot annotation number in project
readOnly: true
type: integer
id:
readOnly: true
type: integer
is_dimensions_enabled:
readOnly: true
type: string
is_draft:
description: Whether or not the project is in the middle of being created
type: boolean
is_published:
description: Whether or not the project is published to annotators
title: Published
type: boolean
label_config:
description: Labeling Configuration
nullable: true
type: string
max_additional_annotators_assignable:
description: Maximum additional annotators
nullable: true
type: integer
maximum_annotations:
description: Annotations per task
maximum: 2147483647
minimum: -2147483648
title: Maximum annotation number
type: integer
members:
readOnly: true
type: string
members_count:
readOnly: true
type: integer
min_annotations_to_start_training:
description: Minimum number of completed tasks after which model training is started
maximum: 2147483647
minimum: -2147483648
type: integer
model_version:
description: Machine learning model version
nullable: true
type: string
num_tasks_with_annotations:
nullable: true
readOnly: true
type: integer
organization:
nullable: true
type: integer
overlap_cohort_percentage:
description: Annotations per task coverage
maximum: 2147483647
minimum: -2147483648
type: integer
parsed_label_config:
additionalProperties: true
description: JSON-formatted labeling configuration
readOnly: true
type: object
pause_on_failed_annotator_evaluation:
default: false
description: Pause annotator on failed evaluation
nullable: true
type: boolean
pinned_at:
description: Pinned date and time
format: date-time
nullable: true
type: string
prompts:
readOnly: true
type: string
queue_done:
readOnly: true
type: integer
queue_left:
readOnly: true
type: integer
queue_total:
readOnly: true
type: string
ready:
readOnly: true
type: boolean
rejected:
readOnly: true
type: integer
require_comment_on_skip:
default: false
description: Require comment to skip
type: boolean
reveal_preannotations_interactively:
description: Reveal pre-annotations interactively
type: boolean
review_settings:
$ref: '#/components/schemas/ReviewSettings'
review_total_tasks:
readOnly: true
type: integer
reviewed_number:
readOnly: true
type: integer
reviewer_queue_total:
readOnly: true
type: integer
sampling:
allOf:
- $ref: '#/components/schemas/SamplingDe5Enum'
nullable: true
show_annotation_history:
description: Show Data Manager to Annotators
type: boolean
show_collab_predictions:
description: Use predictions to pre-label Tasks
title: Show predictions to annotator
type: boolean
show_ground_truth_first:
deprecated: true
description: 'Onboarding mode (true): show ground truth tasks first in the labeling stream'
type: boolean
show_instruction:
description: Show instructions before labeling
type: boolean
show_overlap_first:
description: Show tasks with overlap first
type: boolean
show_skip_button:
description: Allow skipping tasks
type: boolean
show_unused_data_columns_to_annotators:
description: '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.'
nullable: true
type: boolean
skip_queue:
allOf:
- $ref: '#/components/schemas/SkipQueueEnum'
nullable: true
skipped_annotations_number:
readOnly: true
type: string
start_training_on_annotation_update:
description: Start model training after any annotations are submitted or updated
readOnly: true
type: boolean
state:
readOnly: true
type: string
strict_task_overlap:
default: true
description: Enforce strict overlap limit
type: boolean
task_number:
description: Total task number in project
readOnly: true
type: integer
title:
description: Project Name
maxLength: 50
minLength: 3
nullable: true
type: string
total_annotations_number:
readOnly: true
type: string
total_predictions_number:
readOnly: true
type: integer
useful_annotation_number:
nullable: true
readOnly: true
type: integer
workspace:
readOnly: true
type: string
workspace_title:
readOnly: true
type: string
required:
- allow_stream
- assignment_settings
- blueprints
- config_has_control_tags
- config_suitable_for_bulk_annotation
- created_at
- data_types
- description_short
- finished_task_number
- ground_truth_number
- id
- is_dimensions_enabled
- members
- members_count
- num_tasks_with_annotations
- parsed_label_config
- prompts
- queue_done
- queue_left
- queue_total
- ready
- rejected
- review_settings
- review_total_tasks
- reviewed_number
- reviewer_queue_total
- skipped_annotations_number
- start_training_on_annotation_update
- state
- task_number
- total_annotations_number
- total_predictions_number
- useful_annotation_number
- workspace
- workspace_title
type: object
AnalyticsView:
description: |-
Serializer for user-scoped analytics saved views.
The primary key is intentionally excluded; the ``uuid`` field is the only
stable public identifier exposed to callers.
``dashboard_type`` scopes views per dashboard: "overview" vs "member_performance".
properties:
created_at:
format: date-time
readOnly: true
type: string
dashboard_type:
$ref: '#/components/schemas/DashboardTypeEnum'
filters: {}
name:
maxLength: 255
type: string
owner_id:
readOnly: true
type: integer
updated_at:
format: date-time
readOnly: true
type: string
uuid:
format: uuid
readOnly: true
type: string
required:
- created_at
- name
- owner_id
- updated_at
- uuid
type: object
AnalyticsViewRequest:
description: |-
Serializer for user-scoped analytics saved views.
The primary key is intentionally excluded; the ``uuid`` field is the only
stable public identifier exposed to callers.
``dashboard_type`` scopes views per dashboard: "overview" vs "member_performance".
properties:
dashboard_type:
$ref: '#/components/schemas/DashboardTypeEnum'
filters: {}
name:
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
AnnotatedEnum:
description: |-
* `only` - only
* `exclude` - exclude
* `None` - None
enum:
- only
- exclude
Annotation:
description: |-
Annotation Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
properties:
bulk_created:
description: Annotation was created in bulk mode
nullable: true
type: boolean
completed_by:
type: integer
created_ago:
default: ''
description: Time delta from creation time
readOnly: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
created_username:
default: ''
description: Username string
readOnly: true
type: string
draft_created_at:
description: Draft creation time
format: date-time
nullable: true
type: string
ground_truth:
description: This annotation is a Ground Truth (ground_truth)
type: boolean
id:
readOnly: true
type: integer
import_id:
description: Original annotation ID that was at the import step or NULL if this annotation wasn't imported
format: int64
maximum: 9223372036854775807
minimum: -9223372036854775808
nullable: true
type: integer
last_action:
allOf:
- $ref: '#/components/schemas/LastActionEnum'
description: |-
Action which was performed in the last annotation history item
* `prediction` - Created from prediction
* `propagated_annotation` - Created from another annotation
* `imported` - Imported
* `submitted` - Submitted
* `updated` - Updated
* `skipped` - Skipped
* `accepted` - Accepted
* `rejected` - Rejected
* `fixed_and_accepted` - Fixed and accepted
* `deleted_review` - Deleted review
nullable: true
last_created_by:
description: User who created the last annotation history item
nullable: true
type: integer
lead_time:
description: How much time it took to annotate the task
format: double
nullable: true
type: number
parent_annotation:
description: Points to the parent annotation from which this annotation was created
nullable: true
type: integer
parent_prediction:
description: Points to the prediction from which this annotation was created
nullable: true
type: integer
project:
description: Project ID for this annotation
nullable: true
type: integer
result:
description: List of annotation results for the task
items:
description: List of annotated regions for the task
title: Annotation result items (regions)
type: object
title: Annotation result list
type: array
state:
readOnly: true
type: string
task:
description: Corresponding task for this annotation
nullable: true
type: integer
updated_at:
description: Last updated time
format: date-time
readOnly: true
type: string
updated_by:
description: Last user who updated this annotation
nullable: true
type: integer
was_cancelled:
description: User skipped the task
type: boolean
required:
- created_ago
- created_at
- created_username
- id
- state
- updated_at
type: object
AnnotationBulkDeleteRequest:
description: Serializer for bulk annotation deletion by IDs.
properties:
ids:
description: List of annotation IDs to delete
items:
minimum: 1
type: integer
maxItems: 100
minItems: 1
type: array
project:
type: integer
required:
- ids
- project
type: object
AnnotationBulkSerializerWithSelectedItemsRequest:
description: |-
Annotation Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
properties:
bulk_created:
description: Annotation was created in bulk mode
nullable: true
type: boolean
completed_by:
type: integer
draft_created_at:
description: Draft creation time
format: date-time
nullable: true
type: string
ground_truth:
description: This annotation is a Ground Truth (ground_truth)
type: boolean
import_id:
description: Original annotation ID that was at the import step or NULL if this annotation wasn't imported
format: int64
maximum: 9223372036854775807
minimum: -9223372036854775808
nullable: true
type: integer
last_action:
allOf:
- $ref: '#/components/schemas/LastActionEnum'
description: |-
Action which was performed in the last annotation history item
* `prediction` - Created from prediction
* `propagated_annotation` - Created from another annotation
* `imported` - Imported
* `submitted` - Submitted
* `updated` - Updated
* `skipped` - Skipped
* `accepted` - Accepted
* `rejected` - Rejected
* `fixed_and_accepted` - Fixed and accepted
* `deleted_review` - Deleted review
nullable: true
last_created_by:
description: User who created the last annotation history item
nullable: true
type: integer
lead_time:
description: How much time it took to annotate the task
format: double
nullable: true
type: number
parent_annotation:
description: Points to the parent annotation from which this annotation was created
nullable: true
type: integer
parent_prediction:
description: Points to the prediction from which this annotation was created
nullable: true
type: integer
project:
description: Project ID for this annotation
nullable: true
type: integer
result:
description: List of annotation results for the task
items:
description: List of annotated regions for the task
title: Annotation result items (regions)
type: object
title: Annotation result list
type: array
selected_items:
allOf:
- $ref: '#/components/schemas/SelectedItemsRequest'
nullable: true
task:
description: Corresponding task for this annotation
nullable: true
type: integer
tasks:
items:
type: integer
type: array
unique_id:
minLength: 1
type: string
writeOnly: true
updated_by:
description: Last user who updated this annotation
nullable: true
type: integer
was_cancelled:
description: User skipped the task
type: boolean
type: object
AnnotationHistory:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
action:
allOf:
- $ref: '#/components/schemas/ActionEnum'
nullable: true
annotation_id:
description: Corresponding annotation for this historical annotation
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
comment:
nullable: true
readOnly: true
type: string
comment_id:
description: Comment id sent with result
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
created_at:
format: date-time
readOnly: true
type: string
created_by:
description: Created by user id
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
draft_id:
description: Corresponding draft for this historical annotation
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
id:
readOnly: true
type: integer
lead_time:
description: How much time it took to annotate the task
format: double
nullable: true
type: number
organization_id:
description: Organization for this annotation history
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
project_id:
description: Project for this annotation history
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
result:
description: Labeling result
nullable: true
review_id:
description: AnnotationReview ID, using with review field
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
started_at:
description: The time that a user started working on this revision of the annotation
format: date-time
nullable: true
type: string
task_id:
description: Task id
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
required:
- comment
- created_at
- id
type: object
AnnotationRequest:
description: |-
Annotation Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
properties:
bulk_created:
description: Annotation was created in bulk mode
nullable: true
type: boolean
completed_by:
type: integer
draft_created_at:
description: Draft creation time
format: date-time
nullable: true
type: string
ground_truth:
description: This annotation is a Ground Truth (ground_truth)
type: boolean
import_id:
description: Original annotation ID that was at the import step or NULL if this annotation wasn't imported
format: int64
maximum: 9223372036854775807
minimum: -9223372036854775808
nullable: true
type: integer
last_action:
allOf:
- $ref: '#/components/schemas/LastActionEnum'
description: |-
Action which was performed in the last annotation history item
* `prediction` - Created from prediction
* `propagated_annotation` - Created from another annotation
* `imported` - Imported
* `submitted` - Submitted
* `updated` - Updated
* `skipped` - Skipped
* `accepted` - Accepted
* `rejected` - Rejected
* `fixed_and_accepted` - Fixed and accepted
* `deleted_review` - Deleted review
nullable: true
last_created_by:
description: User who created the last annotation history item
nullable: true
type: integer
lead_time:
description: How much time it took to annotate the task
format: double
nullable: true
type: number
parent_annotation:
description: Points to the parent annotation from which this annotation was created
nullable: true
type: integer
parent_prediction:
description: Points to the prediction from which this annotation was created
nullable: true
type: integer
project:
description: Project ID for this annotation
nullable: true
type: integer
result:
description: List of annotation results for the task
items:
description: List of annotated regions for the task
title: Annotation result items (regions)
type: object
title: Annotation result list
type: array
task:
description: Corresponding task for this annotation
nullable: true
type: integer
unique_id:
minLength: 1
type: string
writeOnly: true
updated_by:
description: Last user who updated this annotation
nullable: true
type: integer
was_cancelled:
description: User skipped the task
type: boolean
type: object
AnnotationReview:
description: |-
AnnotationReview Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
The state field display is controlled by both:
- fflag_feat_fit_568_finite_state_management (FSM background calculations)
- fflag_feat_fit_710_fsm_state_fields (state field display in APIs)
properties:
accepted:
description: Accepted or rejected (if false) flag
type: boolean
annotation:
description: Corresponding annotation
type: integer
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
created_by:
description: User who made this review
readOnly: true
type: integer
fixed_annotation_history:
description: Fixed annotation history item by the reviewer
nullable: true
readOnly: true
type: integer
id:
readOnly: true
type: integer
last_annotation_history:
nullable: true
type: integer
previous_annotation_history:
description: Previous annotation history item by the annotator
nullable: true
readOnly: true
type: integer
remove_from_queue:
nullable: true
type: boolean
result:
nullable: true
started_at:
format: date-time
nullable: true
type: string
state:
readOnly: true
type: string
required:
- annotation
- created_at
- created_by
- fixed_annotation_history
- id
- previous_annotation_history
- state
type: object
AnnotationReviewRequest:
description: |-
AnnotationReview Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
The state field display is controlled by both:
- fflag_feat_fit_568_finite_state_management (FSM background calculations)
- fflag_feat_fit_710_fsm_state_fields (state field display in APIs)
properties:
accepted:
description: Accepted or rejected (if false) flag
type: boolean
annotation:
description: Corresponding annotation
type: integer
comment:
minLength: 1
nullable: true
type: string
writeOnly: true
last_annotation_history:
nullable: true
type: integer
remove_from_queue:
nullable: true
type: boolean
result:
nullable: true
started_at:
format: date-time
nullable: true
type: string
required:
- annotation
type: object
AssignmentSettings:
properties:
id:
readOnly: true
type: integer
label_stream_task_distribution:
allOf:
- $ref: '#/components/schemas/LabelStreamTaskDistributionEnum'
description: |-
Automatic / Manual
* `auto_distribution` - Label Stream distributes tasks automatically to annotators
* `assigned_only` - Label Stream shows tasks only to assigned users
nullable: true
project:
nullable: true
type: integer
required:
- id
type: object
AssignmentSettingsRequest:
properties:
label_stream_task_distribution:
allOf:
- $ref: '#/components/schemas/LabelStreamTaskDistributionEnum'
description: |-
Automatic / Manual
* `auto_distribution` - Label Stream distributes tasks automatically to annotators
* `assigned_only` - Label Stream shows tasks only to assigned users
nullable: true
project:
nullable: true
type: integer
type: object
AssociatedProject:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
id:
readOnly: true
type: integer
title:
description: Project name. Must be between 3 and 50 characters long.
maxLength: 50
minLength: 3
nullable: true
type: string
required:
- id
type: object
AuthMethodEnum:
description: |-
* `NONE` - None
* `BASIC_AUTH` - Basic Auth
enum:
- NONE
- BASIC_AUTH
type: string
AuthTypeEnum:
description: |-
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
enum:
- pat
- dbx_sp
- azure_ad_sp
type: string
AzureBlobExportStorage:
properties:
account_key:
description: Azure Blob account key
nullable: true
type: string
account_name:
description: Azure Blob account name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
container:
description: Azure blob container
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: azure
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
AzureBlobImportStorage:
properties:
account_key:
description: Azure Blob account key
nullable: true
type: string
account_name:
description: Azure Blob account name
nullable: true
type: string
container:
description: Azure blob container
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan over the container content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: azure
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
AzureDatasetStorage:
properties:
account_key:
description: Azure Blob account key
nullable: true
type: string
account_name:
description: Azure Blob account name
nullable: true
type: string
container:
description: Azure blob container
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
dataset:
description: A unique integer value identifying this dataset.
type: integer
description:
description: Cloud storage description
nullable: true
type: string
glob_pattern:
description: Glob pattern for syncing from bucket
nullable: true
type: string
id:
readOnly: true
type: integer
job_id:
nullable: true
readOnly: true
title: The Job ID for the GCP Dataproc job that will import the records of this dataset into the vector db
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
recursive_scan:
description: Perform recursive scan over the container content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synced:
description: Flag if dataset has been previously synced or not
type: boolean
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: azure
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- dataset
- id
- job_id
- type
type: object
AzureDatasetStorageRequest:
properties:
account_key:
description: Azure Blob account key
nullable: true
type: string
account_name:
description: Azure Blob account name
nullable: true
type: string
container:
description: Azure blob container
nullable: true
type: string
dataset:
description: A unique integer value identifying this dataset.
type: integer
description:
description: Cloud storage description
nullable: true
type: string
glob_pattern:
description: Glob pattern for syncing from bucket
nullable: true
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
recursive_scan:
description: Perform recursive scan over the container content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synced:
description: Flag if dataset has been previously synced or not
type: boolean
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- dataset
type: object
AzureServicePrincipalExportStorage:
properties:
account_name:
description: Azure Blob account name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
client_id:
description: Azure Blob Service Principal Client ID
nullable: true
type: string
client_secret:
description: Azure Blob Service Principal Client Secret
nullable: true
type: string
container:
description: Azure blob container
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure Tenant ID
nullable: true
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: azure_spi
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
user_delegation_key:
description: User Delegation Key (Backend)
nullable: true
type: string
required:
- created_at
- id
- project
- type
type: object
AzureServicePrincipalExportStorageRequest:
properties:
account_name:
description: Azure Blob account name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
client_id:
description: Azure Blob Service Principal Client ID
nullable: true
type: string
client_secret:
description: Azure Blob Service Principal Client Secret
nullable: true
type: string
container:
description: Azure blob container
nullable: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure Tenant ID
nullable: true
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
user_delegation_key:
description: User Delegation Key (Backend)
nullable: true
type: string
required:
- project
type: object
AzureServicePrincipalImportStorage:
properties:
account_name:
description: Azure Blob account name
nullable: true
type: string
client_id:
description: Azure Blob Service Principal Client ID
nullable: true
type: string
client_secret:
description: Azure Blob Service Principal Client Secret
nullable: true
type: string
container:
description: Azure blob container
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure Tenant ID
nullable: true
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: azure_spi
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
user_delegation_key:
description: User Delegation Key (Backend)
nullable: true
type: string
required:
- created_at
- id
- project
- type
type: object
AzureServicePrincipalImportStorageRequest:
properties:
account_name:
description: Azure Blob account name
nullable: true
type: string
client_id:
description: Azure Blob Service Principal Client ID
nullable: true
type: string
client_secret:
description: Azure Blob Service Principal Client Secret
nullable: true
type: string
container:
description: Azure blob container
nullable: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure Tenant ID
nullable: true
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
user_delegation_key:
description: User Delegation Key (Backend)
nullable: true
type: string
required:
- project
type: object
BatchFailedPredictions:
properties:
failed_predictions:
items: {}
type: array
job_id:
maxLength: 255
type: string
required:
- failed_predictions
- job_id
type: object
BatchFailedPredictionsRequestRequest:
properties:
failed_predictions:
items: {}
type: array
job_id:
maxLength: 255
minLength: 1
type: string
modelrun_id:
type: integer
required:
- failed_predictions
- modelrun_id
type: object
BatchPredictions:
properties:
job_id:
maxLength: 255
type: string
results:
items: {}
type: array
required:
- job_id
- results
type: object
BatchPredictionsRequestRequest:
properties:
job_id:
maxLength: 255
minLength: 1
type: string
modelrun_id:
type: integer
results:
items: {}
type: array
required:
- modelrun_id
- results
type: object
BillingChecks:
properties:
export_storages:
$ref: '#/components/schemas/CountLimit'
import_storages:
$ref: '#/components/schemas/CountLimit'
is_license_expired:
type: boolean
is_license_warning:
type: boolean
is_prompts_expire:
type: boolean
is_prompts_warning:
type: boolean
license_expires:
format: date
nullable: true
type: string
license_issued:
format: date
nullable: true
type: string
license_warning:
format: date
nullable: true
type: string
organization_is_active:
type: boolean
projects:
$ref: '#/components/schemas/CountLimit'
prompts_api_keys_enabled:
type: boolean
prompts_enabled:
type: boolean
prompts_expire:
nullable: true
type: string
prompts_status:
$ref: '#/components/schemas/PromptsStatusEnum'
prompts_warning:
nullable: true
type: string
results:
$ref: '#/components/schemas/CountLimit'
trial_days:
type: integer
users:
$ref: '#/components/schemas/CountLimit'
required:
- export_storages
- import_storages
- is_license_expired
- is_license_warning
- is_prompts_expire
- is_prompts_warning
- license_expires
- license_issued
- license_warning
- organization_is_active
- projects
- prompts_api_keys_enabled
- prompts_enabled
- prompts_expire
- prompts_status
- prompts_warning
- results
- trial_days
- users
type: object
BillingFlags:
properties:
activated_at:
format: date-time
nullable: true
type: string
allow_activity_log:
type: boolean
allow_ai:
type: boolean
allow_ask_ai:
type: boolean
allow_data_credentials:
type: boolean
allow_invite_people:
type: boolean
allow_invite_project_experts:
type: boolean
allow_nda:
type: boolean
allow_organization_webhooks:
type: boolean
allow_reviewing:
type: boolean
allow_sso:
type: boolean
allow_storage_proxy:
type: boolean
automax_enabled:
type: boolean
automax_token_exists:
type: boolean
cloud_instance:
type: boolean
disable_members_page:
type: boolean
disable_project_imports:
type: boolean
early_adopter:
type: boolean
email_configured:
type: boolean
embed_domains:
items:
additionalProperties: {}
type: object
type: array
embed_enabled:
type: boolean
embed_settings:
additionalProperties: {}
type: object
manual_role_management:
type: boolean
manual_workspace_management:
type: boolean
secure_mode:
type: boolean
storage_persistence:
type: boolean
white_label_id:
nullable: true
type: string
required:
- activated_at
- allow_activity_log
- allow_ai
- allow_ask_ai
- allow_data_credentials
- allow_invite_people
- allow_invite_project_experts
- allow_nda
- allow_organization_webhooks
- allow_reviewing
- allow_sso
- allow_storage_proxy
- automax_enabled
- automax_token_exists
- cloud_instance
- disable_members_page
- disable_project_imports
- early_adopter
- email_configured
- embed_enabled
- manual_role_management
- manual_workspace_management
- secure_mode
- storage_persistence
- white_label_id
type: object
BillingInfoResponse:
properties:
billing_checks:
$ref: '#/components/schemas/BillingChecks'
billing_flags:
$ref: '#/components/schemas/BillingFlags'
required:
- billing_checks
- billing_flags
type: object
Blueprint:
properties:
created_at:
format: date-time
readOnly: true
type: string
created_by:
nullable: true
type: integer
description:
description: Project description
nullable: true
type: string
id:
readOnly: true
type: integer
label_config:
description: Labeling configuration in XML format
nullable: true
type: string
project:
type: integer
share_id:
readOnly: true
type: string
short_url:
readOnly: true
type: string
task_count:
readOnly: true
type: string
title:
description: Blueprint name. Must be between 3 and 50 characters long.
maxLength: 50
nullable: true
type: string
updated_at:
format: date-time
readOnly: true
type: string
required:
- created_at
- id
- project
- share_id
- short_url
- task_count
- updated_at
type: object
BlueprintList:
properties:
created_at:
format: date-time
readOnly: true
type: string
description:
description: Project description
nullable: true
type: string
id:
readOnly: true
type: integer
share_id:
readOnly: true
type: string
short_url:
readOnly: true
type: string
task_count:
readOnly: true
type: string
title:
description: Blueprint name. Must be between 3 and 50 characters long.
maxLength: 50
nullable: true
type: string
required:
- created_at
- id
- share_id
- short_url
- task_count
type: object
BlueprintRequest:
properties:
created_by:
nullable: true
type: integer
description:
description: Project description
nullable: true
type: string
label_config:
description: Labeling configuration in XML format
nullable: true
type: string
project:
type: integer
task_ids:
items:
type: integer
maxItems: 100
type: array
writeOnly: true
title:
description: Blueprint name. Must be between 3 and 50 characters long.
maxLength: 50
nullable: true
type: string
required:
- project
type: object
BudgetResetPeriodEnum:
description: |-
* `Monthly` - Monthly
* `Yearly` - Yearly
enum:
- Monthly
- Yearly
type: string
BulkOrganizationMemberTagAssignmentRequest:
properties:
all:
description: If true, assign tags to all organization members. If false, assign tags to the provided users.
type: boolean
excluded:
description: List of user IDs to exclude from the assignment.
items:
minimum: 1
type: integer
type: array
included:
description: List of user IDs to include in the assignment.
items:
minimum: 1
type: integer
type: array
overwrite:
default: false
description: If true, replace all existing tag assignments for each user with the provided ones. If false, only add new assignments.
type: boolean
tags:
description: List of tag IDs to assign.
items:
minimum: 1
type: integer
type: array
required:
- all
type: object
CancelModelRunResponse:
properties:
detail:
type: string
required:
- detail
type: object
CheckMatchingFunctionRequestRequest:
properties:
code:
minLength: 1
type: string
required:
- code
type: object
ChildFilter:
properties:
column:
description: Field name
maxLength: 1024
type: string
id:
readOnly: true
type: integer
index:
description: Display order among root filters only
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
operator:
description: Filter operator
maxLength: 1024
type: string
parent:
description: Optional parent filter to create one-level hierarchy (child filters are AND-merged with parent)
nullable: true
type: integer
type:
description: Field type
maxLength: 1024
type: string
value:
description: Filter value
nullable: true
required:
- column
- id
- operator
- type
type: object
ChildFilterRequest:
properties:
column:
description: Field name
maxLength: 1024
minLength: 1
type: string
index:
description: Display order among root filters only
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
operator:
description: Filter operator
maxLength: 1024
minLength: 1
type: string
parent:
description: Optional parent filter to create one-level hierarchy (child filters are AND-merged with parent)
nullable: true
type: integer
type:
description: Field type
maxLength: 1024
minLength: 1
type: string
value:
description: Filter value
nullable: true
required:
- column
- operator
- type
type: object
Comment:
description: |-
Comment Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
The state field display is controlled by both:
- fflag_feat_fit_568_finite_state_management (FSM background calculations)
- fflag_feat_fit_710_fsm_state_fields (state field display in APIs)
properties:
annotation:
nullable: true
type: integer
classifications:
description: Classifications applied by a reviewer or annotator
nullable: true
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
created_by:
description: User who made this comment
readOnly: true
type: integer
draft:
nullable: true
type: integer
id:
readOnly: true
type: integer
is_resolved:
description: True if the comment is resolved
type: boolean
project:
nullable: true
readOnly: true
type: integer
region_ref:
description: Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.
nullable: true
resolved_at:
description: Resolving time
format: date-time
nullable: true
readOnly: true
type: string
state:
readOnly: true
type: string
task:
nullable: true
readOnly: true
type: integer
text:
description: Reviewer or annotator comment
nullable: true
type: string
updated_at:
description: Last updated time
format: date-time
readOnly: true
type: string
required:
- created_at
- created_by
- id
- project
- resolved_at
- state
- task
- updated_at
type: object
CommentRequest:
description: |-
Comment Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
The state field display is controlled by both:
- fflag_feat_fit_568_finite_state_management (FSM background calculations)
- fflag_feat_fit_710_fsm_state_fields (state field display in APIs)
properties:
annotation:
nullable: true
type: integer
classifications:
description: Classifications applied by a reviewer or annotator
nullable: true
draft:
nullable: true
type: integer
is_resolved:
description: True if the comment is resolved
type: boolean
region_ref:
description: Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.
nullable: true
text:
description: Reviewer or annotator comment
nullable: true
type: string
type: object
CommentSerializerWithExpandedUser:
description: |-
Comment Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
The state field display is controlled by both:
- fflag_feat_fit_568_finite_state_management (FSM background calculations)
- fflag_feat_fit_710_fsm_state_fields (state field display in APIs)
properties:
annotation:
nullable: true
type: integer
classifications:
description: Classifications applied by a reviewer or annotator
nullable: true
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
created_by:
$ref: '#/components/schemas/LseUser'
draft:
nullable: true
type: integer
id:
readOnly: true
type: integer
is_resolved:
description: True if the comment is resolved
type: boolean
project:
nullable: true
readOnly: true
type: integer
region_ref:
description: Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.
nullable: true
resolved_at:
description: Resolving time
format: date-time
nullable: true
readOnly: true
type: string
state:
readOnly: true
type: string
task:
nullable: true
readOnly: true
type: integer
text:
description: Reviewer or annotator comment
nullable: true
type: string
updated_at:
description: Last updated time
format: date-time
readOnly: true
type: string
required:
- created_at
- created_by
- id
- project
- resolved_at
- state
- task
- updated_at
type: object
ConfigurablePermissionOption:
properties:
default:
items:
$ref: '#/components/schemas/Role9e7Enum'
type: array
group:
type: string
label:
type: string
options:
items:
$ref: '#/components/schemas/Role9e7Enum'
type: array
permission:
type: string
tooltip:
type: string
required:
- default
- options
- permission
type: object
ControlTagWeight:
description: |-
Weights configuration for a single control tag.
Structure: {"overall": 0.5, "type": "Choices", "labels": {"cat": 1.0, "dog": 0.0}}
properties:
labels:
additionalProperties:
format: double
maximum: 1.0
minimum: 0.0
type: number
description: Per-label weights (0.0 to 1.0). Zero excludes the label from agreement.
type: object
overall:
description: Overall weight for this control tag (0.0 to 1.0). Zero excludes the tag from agreement.
format: double
maximum: 1.0
minimum: 0.0
type: number
type:
description: Control tag type from the labeling config (e.g. Choices, Labels, TextArea).
type: string
required:
- overall
- type
type: object
ControlTagWeightRequest:
description: |-
Weights configuration for a single control tag.
Structure: {"overall": 0.5, "type": "Choices", "labels": {"cat": 1.0, "dog": 0.0}}
properties:
labels:
additionalProperties:
format: double
maximum: 1.0
minimum: 0.0
type: number
description: Per-label weights (0.0 to 1.0). Zero excludes the label from agreement.
type: object
overall:
description: Overall weight for this control tag (0.0 to 1.0). Zero excludes the tag from agreement.
format: double
maximum: 1.0
minimum: 0.0
type: number
type:
description: Control tag type from the labeling config (e.g. Choices, Labels, TextArea).
minLength: 1
type: string
required:
- overall
- type
type: object
ConvertedFormat:
properties:
export_type:
maxLength: 64
type: string
id:
readOnly: true
type: integer
status:
$ref: '#/components/schemas/Status7bfEnum'
traceback:
description: Traceback report in case of errors
nullable: true
type: string
required:
- export_type
- id
type: object
ConvertedFormatRequest:
properties:
export_type:
maxLength: 64
minLength: 1
type: string
status:
$ref: '#/components/schemas/Status7bfEnum'
traceback:
description: Traceback report in case of errors
nullable: true
type: string
required:
- export_type
type: object
CountLimit:
properties:
count:
type: integer
limit:
type: integer
reached:
type: boolean
total:
type: integer
required:
- count
- limit
- reached
type: object
DashboardTypeEnum:
description: |-
* `overview` - Overview
* `member_performance` - Member Performance
enum:
- overview
- member_performance
type: string
DatabricksExportStorage:
description: Serializer for Databricks export storage with multi-auth support.
properties:
auth_type:
allOf:
- $ref: '#/components/schemas/AuthTypeEnum'
default: pat
description: |-
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
catalog:
description: UC catalog name
type: string
client_id:
description: Service principal client/application ID (required for SP modes)
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
host:
description: Databricks workspace base URL (https://...)
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Export path prefix under the volume
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Regex for filtering objects
nullable: true
type: string
request_timeout_s:
maximum: 2147483647
minimum: 0
type: integer
schema:
description: UC schema name
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
stream_chunk_bytes:
maximum: 2147483647
minimum: 0
type: integer
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure AD tenant ID (required for Azure AD SP mode)
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: databricks
readOnly: true
type: string
use_blob_urls:
description: Generate blob URLs in tasks
type: boolean
verify_tls:
description: Verify TLS certificates
type: boolean
volume:
description: UC volume name
type: string
required:
- catalog
- created_at
- host
- id
- project
- schema
- type
- volume
type: object
DatabricksExportStorageRequest:
description: Serializer for Databricks export storage with multi-auth support.
properties:
auth_type:
allOf:
- $ref: '#/components/schemas/AuthTypeEnum'
default: pat
description: |-
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
catalog:
description: UC catalog name
minLength: 1
type: string
client_id:
description: Service principal client/application ID (required for SP modes)
type: string
client_secret:
description: Service principal client secret (required for SP modes)
type: string
writeOnly: true
description:
description: Cloud storage description
nullable: true
type: string
host:
description: Databricks workspace base URL (https://...)
minLength: 1
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Export path prefix under the volume
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Regex for filtering objects
nullable: true
type: string
request_timeout_s:
maximum: 2147483647
minimum: 0
type: integer
schema:
description: UC schema name
minLength: 1
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
stream_chunk_bytes:
maximum: 2147483647
minimum: 0
type: integer
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure AD tenant ID (required for Azure AD SP mode)
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
token:
description: Databricks personal access token (required for PAT mode)
type: string
writeOnly: true
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Generate blob URLs in tasks
type: boolean
verify_tls:
description: Verify TLS certificates
type: boolean
volume:
description: UC volume name
minLength: 1
type: string
required:
- catalog
- host
- project
- schema
- volume
type: object
DatabricksImportStorage:
description: Serializer for Databricks import storage with multi-auth support.
properties:
auth_type:
allOf:
- $ref: '#/components/schemas/AuthTypeEnum'
default: pat
description: |-
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
catalog:
description: UC catalog name
type: string
client_id:
description: Service principal client/application ID (required for SP modes)
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
host:
description: Databricks workspace base URL (https://...)
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Path under the volume
nullable: true
type: string
presign:
description: Presign not supported; always proxied
type: boolean
presign_ttl:
description: Unused for Databricks; kept for compatibility
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan
type: boolean
regex_filter:
description: Regex for filtering objects
nullable: true
type: string
request_timeout_s:
maximum: 2147483647
minimum: 0
type: integer
schema:
description: UC schema name
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
stream_chunk_bytes:
maximum: 2147483647
minimum: 0
type: integer
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure AD tenant ID (required for Azure AD SP mode)
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: databricks
readOnly: true
type: string
use_blob_urls:
description: Generate blob URLs in tasks
type: boolean
verify_tls:
description: Verify TLS certificates
type: boolean
volume:
description: UC volume name
type: string
required:
- catalog
- created_at
- host
- id
- project
- schema
- type
- volume
type: object
DatabricksImportStorageRequest:
description: Serializer for Databricks import storage with multi-auth support.
properties:
auth_type:
allOf:
- $ref: '#/components/schemas/AuthTypeEnum'
default: pat
description: |-
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
catalog:
description: UC catalog name
minLength: 1
type: string
client_id:
description: Service principal client/application ID (required for SP modes)
type: string
client_secret:
description: Service principal client secret (required for SP modes)
type: string
writeOnly: true
description:
description: Cloud storage description
nullable: true
type: string
host:
description: Databricks workspace base URL (https://...)
minLength: 1
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Path under the volume
nullable: true
type: string
presign:
description: Presign not supported; always proxied
type: boolean
presign_ttl:
description: Unused for Databricks; kept for compatibility
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan
type: boolean
regex_filter:
description: Regex for filtering objects
nullable: true
type: string
request_timeout_s:
maximum: 2147483647
minimum: 0
type: integer
schema:
description: UC schema name
minLength: 1
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
stream_chunk_bytes:
maximum: 2147483647
minimum: 0
type: integer
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure AD tenant ID (required for Azure AD SP mode)
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
token:
description: Databricks personal access token (required for PAT mode)
type: string
writeOnly: true
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Generate blob URLs in tasks
type: boolean
verify_tls:
description: Verify TLS certificates
type: boolean
volume:
description: UC volume name
minLength: 1
type: string
required:
- catalog
- host
- project
- schema
- volume
type: object
Dataset:
properties:
columns:
description: All data columns found in Dataset tasks
nullable: true
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
description: User who created Dataset
description:
description: Dataset description
nullable: true
type: string
id:
readOnly: true
type: integer
organization:
nullable: true
type: integer
title:
description: Dataset title
maxLength: 1000
type: string
total_entities:
maximum: 2147483647
minimum: -2147483648
nullable: true
title: The number of entities in the dataset
type: integer
updated_at:
description: Last updated time
format: date-time
readOnly: true
type: string
vector_db_dataset_name:
description: Dataset name for weaviate schema
maxLength: 37
type: string
required:
- created_at
- id
- title
- updated_at
type: object
DatasetMember:
properties:
user:
type: integer
required:
- user
type: object
DatasetMemberRequest:
properties:
user:
type: integer
required:
- user
type: object
DatasetRequest:
properties:
columns:
description: All data columns found in Dataset tasks
nullable: true
created_by:
allOf:
- $ref: '#/components/schemas/UserSimpleRequest'
description: User who created Dataset
description:
description: Dataset description
nullable: true
type: string
organization:
nullable: true
type: integer
title:
description: Dataset title
maxLength: 1000
minLength: 1
type: string
total_entities:
maximum: 2147483647
minimum: -2147483648
nullable: true
title: The number of entities in the dataset
type: integer
vector_db_dataset_name:
description: Dataset name for weaviate schema
maxLength: 37
minLength: 1
type: string
required:
- title
type: object
DatasetView:
properties:
data:
description: Custom view data
nullable: true
dataset:
description: Dataset ID
type: integer
filter_group:
$ref: '#/components/schemas/FilterGroup'
id:
readOnly: true
type: integer
order:
description: Position of the tab, starting at the left in data manager and increasing as the tabs go left to right
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
ordering:
description: Ordering parameters
nullable: true
selected_items:
description: Selected items
nullable: true
user:
description: User who made this view
nullable: true
type: integer
required:
- dataset
- id
type: object
DatasetViewRequest:
properties:
data:
description: Custom view data
nullable: true
dataset:
description: Dataset ID
type: integer
filter_group:
$ref: '#/components/schemas/FilterGroupRequest'
order:
description: Position of the tab, starting at the left in data manager and increasing as the tabs go left to right
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
ordering:
description: Ordering parameters
nullable: true
selected_items:
description: Selected items
nullable: true
user:
description: User who made this view
nullable: true
type: integer
required:
- dataset
type: object
Default165Enum:
enum:
- OW
- AD
- MA
- RE
- AN
- DI
- 'NO'
type: string
DefaultRole:
properties:
annotator_reviewer_firewall_enabled_at:
description: Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
format: date-time
nullable: true
type: string
custom_scripts_enabled_at:
description: Set to current time to enable custom scripts (Plugins) for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts (Plugins).
format: date-time
nullable: true
type: string
default_role:
allOf:
- $ref: '#/components/schemas/Role9e7Enum'
description: |-
Default membership role for invited users
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
email_notification_settings:
description: 'Email notification settings for this organization. Controls which email notifications users can receive. Structure: {"notifications_allowed": {"notification_type": bool}}'
nullable: true
embed_domains:
description: 'List of objects: {"domain": "example.com"}. Used for CSP header on /embed routes.'
nullable: true
embed_settings:
description: Embed settings for this organization
nullable: true
external_id:
description: External ID to uniquely identify this organization
nullable: true
type: string
extra_data_on_activity_logs:
type: boolean
label_stream_navigation_disabled_at:
description: Set to current time to disable the label stream navigation for this organization. This will prevent users from going back in the label stream to view previous labels.
format: date-time
nullable: true
type: string
organization:
description: A unique integer value identifying this organization.
type: integer
read_only_quick_view_enabled_at:
description: Set to current time to prevent creating or editing annotations in quick view.
format: date-time
nullable: true
type: string
required:
- organization
type: object
Dimension:
description: |-
Serializer for Dimension model.
Handles serialization and validation for CRUD operations on dimensions.
The project and created_by fields are set automatically from the request context.
properties:
allowed_metrics_with_params:
description: Dictionary mapping metric type names to their parameter schemas.
readOnly: true
type: string
control_tag:
description: Name of the control tag this dimension is extracted from. Set automatically for system dimensions.
nullable: true
readOnly: true
type: string
created_at:
format: date-time
readOnly: true
type: string
created_by:
description: User who created this dimension
nullable: true
readOnly: true
type: integer
description:
description: Human-readable description of what this dimension represents
type: string
extraction_method:
description: Method used to extract values from annotation JSON
maxLength: 32
type: string
extraction_method_params:
description: Parameters specific to the extraction method. See metrics.py for available extraction methods and their parameters.
title: Extraction method parameters
id:
readOnly: true
type: integer
is_active:
description: Whether this dimension is used in agreement calculations.
type: boolean
is_user_defined:
description: Whether this dimension was manually created by a user. System-generated dimensions have this set to False.
type: boolean
metric_params:
description: Parameters for the metric. See metrics.py for available metrics and their parameters.
title: Metric parameters
metric_type:
description: Strategy for comparing dimension values across annotators
maxLength: 32
type: string
name:
description: Unique identifier for this dimension within the project
maxLength: 255
minLength: 1
type: string
order:
description: Display order within the project
maximum: 2147483647
minimum: 0
type: integer
project:
description: Project this dimension belongs to
readOnly: true
type: integer
updated_at:
format: date-time
readOnly: true
type: string
required:
- allowed_metrics_with_params
- control_tag
- created_at
- created_by
- id
- name
- project
- updated_at
type: object
DimensionCreateRequest:
description: |-
Serializer for creating new dimensions.
Excludes is_user_defined from user input - new dimensions are always user-defined.
properties:
description:
description: Human-readable description of what this dimension represents
type: string
extraction_method:
description: Method used to extract values from annotation JSON
maxLength: 32
minLength: 1
type: string
extraction_method_params:
description: Parameters specific to the extraction method. See metrics.py for available extraction methods and their parameters.
title: Extraction method parameters
is_active:
description: Whether this dimension is used in agreement calculations.
type: boolean
metric_params:
description: Parameters for the metric. See metrics.py for available metrics and their parameters.
title: Metric parameters
metric_type:
description: Strategy for comparing dimension values across annotators
maxLength: 32
minLength: 1
type: string
name:
description: Unique identifier for this dimension within the project
maxLength: 255
minLength: 1
type: string
order:
description: Display order within the project
maximum: 2147483647
minimum: 0
type: integer
required:
- name
type: object
DimensionList:
description: |-
Lightweight serializer for listing dimensions.
Excludes detailed parameters for performance in list views.
properties:
allowed_metrics_with_params:
description: Dictionary mapping metric type names to their parameter schemas.
readOnly: true
type: string
control_tag:
description: Name of the control tag this dimension is extracted from. Set automatically for system dimensions.
nullable: true
readOnly: true
type: string
created_at:
format: date-time
readOnly: true
type: string
description:
description: Human-readable description of what this dimension represents
readOnly: true
type: string
extraction_method:
description: Method used to extract values from annotation JSON
readOnly: true
type: string
extraction_method_params:
description: Parameters specific to the extraction method. See metrics.py for available extraction methods and their parameters.
readOnly: true
title: Extraction method parameters
id:
readOnly: true
type: integer
is_active:
description: Whether this dimension is used in agreement calculations.
readOnly: true
type: boolean
is_user_defined:
description: Whether this dimension was manually created by a user. System-generated dimensions have this set to False.
readOnly: true
type: boolean
metric_params:
description: Parameters for the metric. See metrics.py for available metrics and their parameters.
readOnly: true
title: Metric parameters
metric_type:
description: Strategy for comparing dimension values across annotators
readOnly: true
type: string
name:
description: Unique identifier for this dimension within the project
readOnly: true
type: string
order:
description: Display order within the project
readOnly: true
type: integer
project:
description: Project this dimension belongs to
readOnly: true
type: integer
updated_at:
format: date-time
readOnly: true
type: string
required:
- allowed_metrics_with_params
- control_tag
- created_at
- description
- extraction_method
- extraction_method_params
- id
- is_active
- is_user_defined
- metric_params
- metric_type
- name
- order
- project
- updated_at
type: object
DimensionRequest:
description: |-
Serializer for Dimension model.
Handles serialization and validation for CRUD operations on dimensions.
The project and created_by fields are set automatically from the request context.
properties:
description:
description: Human-readable description of what this dimension represents
type: string
extraction_method:
description: Method used to extract values from annotation JSON
maxLength: 32
minLength: 1
type: string
extraction_method_params:
description: Parameters specific to the extraction method. See metrics.py for available extraction methods and their parameters.
title: Extraction method parameters
is_active:
description: Whether this dimension is used in agreement calculations.
type: boolean
is_user_defined:
description: Whether this dimension was manually created by a user. System-generated dimensions have this set to False.
type: boolean
metric_params:
description: Parameters for the metric. See metrics.py for available metrics and their parameters.
title: Metric parameters
metric_type:
description: Strategy for comparing dimension values across annotators
maxLength: 32
minLength: 1
type: string
name:
description: Unique identifier for this dimension within the project
maxLength: 255
minLength: 1
type: string
order:
description: Display order within the project
maximum: 2147483647
minimum: 0
type: integer
required:
- name
type: object
EditionEnum:
description: |-
* `Community` - Community
* `Enterprise` - Enterprise
enum:
- Community
- Enterprise
type: string
Export:
properties:
converted_formats:
items:
$ref: '#/components/schemas/ConvertedFormat'
type: array
counters:
title: Exporting meta data
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
created_by:
$ref: '#/components/schemas/UserSimple'
finished_at:
description: Complete or fail time
format: date-time
nullable: true
type: string
id:
readOnly: true
type: integer
md5:
maxLength: 128
title: Md5 of file
type: string
status:
allOf:
- $ref: '#/components/schemas/Status7bfEnum'
title: Export status
title:
maxLength: 2048
type: string
required:
- created_at
- id
type: object
ExportConvertRequest:
properties:
download_resources:
description: Download resources in converter.
type: boolean
export_type:
description: Export file format.
minLength: 1
type: string
required:
- export_type
type: object
FSMTransitionExecuteRequestRequest:
description: Request body serializer for executing a manual FSM transition.
properties:
transition_data:
additionalProperties: {}
nullable: true
type: object
transition_name:
minLength: 1
type: string
required:
- transition_name
type: object
FSMTransitionExecuteResponse:
description: Response serializer for manual FSM transition execution.
properties:
new_state:
nullable: true
readOnly: true
type: string
state_record:
allOf:
- $ref: '#/components/schemas/StateModel'
nullable: true
readOnly: true
success:
readOnly: true
type: boolean
required:
- new_state
- state_record
- success
type: object
FileUpload:
properties:
file:
type: string
id:
readOnly: true
type: integer
size:
nullable: true
readOnly: true
type: integer
required:
- file
- id
- size
type: object
Filter:
properties:
child_filter:
$ref: '#/components/schemas/ChildFilter'
column:
description: Field name
maxLength: 1024
type: string
id:
readOnly: true
type: integer
index:
description: Display order among root filters only
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
operator:
description: Filter operator
maxLength: 1024
type: string
parent:
description: Optional parent filter to create one-level hierarchy (child filters are AND-merged with parent)
nullable: true
type: integer
type:
description: Field type
maxLength: 1024
type: string
value:
description: Filter value
nullable: true
required:
- column
- id
- operator
- type
type: object
FilterGroup:
properties:
conjunction:
description: Type of conjunction
maxLength: 1024
type: string
filters:
items:
$ref: '#/components/schemas/Filter'
type: array
id:
readOnly: true
type: integer
required:
- conjunction
- filters
- id
type: object
FilterGroupRequest:
properties:
conjunction:
description: Type of conjunction
maxLength: 1024
minLength: 1
type: string
filters:
items:
$ref: '#/components/schemas/FilterRequest'
type: array
required:
- conjunction
- filters
type: object
FilterRequest:
properties:
child_filter:
$ref: '#/components/schemas/ChildFilterRequest'
column:
description: Field name
maxLength: 1024
minLength: 1
type: string
index:
description: Display order among root filters only
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
operator:
description: Filter operator
maxLength: 1024
minLength: 1
type: string
parent:
description: Optional parent filter to create one-level hierarchy (child filters are AND-merged with parent)
nullable: true
type: integer
type:
description: Field type
maxLength: 1024
minLength: 1
type: string
value:
description: Filter value
nullable: true
required:
- column
- operator
- type
type: object
FinishedEnum:
description: |-
* `only` - only
* `exclude` - exclude
* `None` - None
enum:
- only
- exclude
GCSDatasetStorage:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
dataset:
description: A unique integer value identifying this dataset.
type: integer
description:
description: Cloud storage description
nullable: true
type: string
glob_pattern:
description: Glob pattern for syncing from bucket
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
id:
readOnly: true
type: integer
job_id:
nullable: true
readOnly: true
title: The Job ID for the GCP Dataproc job that will import the records of this dataset into the vector db
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synced:
description: Flag if dataset has been previously synced or not
type: boolean
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: gcs
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- dataset
- id
- job_id
- type
type: object
GCSDatasetStorageRequest:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
dataset:
description: A unique integer value identifying this dataset.
type: integer
description:
description: Cloud storage description
nullable: true
type: string
glob_pattern:
description: Glob pattern for syncing from bucket
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synced:
description: Flag if dataset has been previously synced or not
type: boolean
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- dataset
type: object
GCSExportStorage:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: gcs
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
GCSImportStorage:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: gcs
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
GCSWIFExportStorage:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
google_project_number:
description: Google project number
nullable: true
type: string
google_service_account_email:
description: Google service account email
nullable: true
type: string
google_wif_pool_id:
description: Google WIF pool ID
nullable: true
type: string
google_wif_provider_id:
description: Google WIF provider ID
nullable: true
title: Google wif provider
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: gcswif
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
GCSWIFExportStorageRequest:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
description:
description: Cloud storage description
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
google_project_number:
description: Google project number
nullable: true
type: string
google_service_account_email:
description: Google service account email
nullable: true
type: string
google_wif_pool_id:
description: Google WIF pool ID
nullable: true
type: string
google_wif_provider_id:
description: Google WIF provider ID
nullable: true
title: Google wif provider
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- project
type: object
GCSWIFImportStorage:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
google_project_number:
description: Google project number
nullable: true
type: string
google_service_account_email:
description: Google service account email
nullable: true
type: string
google_wif_pool_id:
description: Google WIF pool ID
nullable: true
type: string
google_wif_provider_id:
description: Google WIF provider ID
nullable: true
title: Google wif provider
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: gcswif
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
GCSWIFImportStorageRequest:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
google_project_number:
description: Google project number
nullable: true
type: string
google_service_account_email:
description: Google service account email
nullable: true
type: string
google_wif_pool_id:
description: Google WIF pool ID
nullable: true
type: string
google_wif_provider_id:
description: Google WIF provider ID
nullable: true
title: Google wif provider
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- project
type: object
Hotkeys:
properties:
custom_hotkeys:
additionalProperties: {}
type: object
required:
- custom_hotkeys
type: object
ImportApiRequest:
description: Tasks serializer for Import API (TaskBulkCreateAPI)
properties:
allow_skip:
description: Whether this task can be skipped. Set to False to make task unskippable.
nullable: true
type: boolean
annotations:
default: []
items:
$ref: '#/components/schemas/AnnotationRequest'
type: array
cancelled_annotations:
description: Number of total cancelled annotations for the current task
maximum: 2147483647
minimum: -2147483648
type: integer
comment_authors:
description: Users who wrote comments
items:
type: integer
type: array
comment_count:
description: Number of comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
data:
description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
file_upload:
description: Uploaded file used as data source for this task
nullable: true
type: integer
inner_id:
description: Internal task ID in the project, starts with 1
format: int64
maximum: 9223372036854775807
minimum: -9223372036854775808
nullable: true
type: integer
last_comment_updated_at:
description: When the last comment was updated
format: date-time
nullable: true
type: string
meta:
description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
nullable: true
overlap:
description: Number of distinct annotators that processed the current task
maximum: 2147483647
minimum: -2147483648
type: integer
precomputed_agreement:
description: Average agreement score for the task
format: double
nullable: true
type: number
predictions:
default: []
items:
$ref: '#/components/schemas/PredictionRequest'
type: array
total_annotations:
description: Number of total annotations for the current task except cancelled annotations
maximum: 2147483647
minimum: -2147483648
type: integer
total_predictions:
description: Number of total predictions for the current task
maximum: 2147483647
minimum: -2147483648
type: integer
unresolved_comment_count:
description: Number of unresolved comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
updated_by:
description: Last annotator or reviewer who updated this task
nullable: true
type: integer
required:
- data
type: object
InferenceRunCostEstimate:
properties:
completion_cost_usd:
description: Cost of the completion (in USD)
nullable: true
type: string
error_message:
description: Error message details
nullable: true
type: string
error_type:
description: Type of error (e.g. "Timeout", "Rate Limit", etc)
nullable: true
type: string
is_error:
description: Whether an error occurred or not
nullable: true
type: boolean
prompt_cost_usd:
description: Cost of the prompt (in USD)
nullable: true
type: string
total_cost_usd:
description: Total cost of the inference (in USD)
nullable: true
type: string
type: object
KPIDetailResponse:
description: |-
Response serializer for KPI detail endpoint.
Structure varies based on segmentation parameters.
properties:
by_project:
allOf:
- $ref: '#/components/schemas/KPIProjectSegment'
description: Project-segmented data (compact format with parallel arrays)
nullable: true
by_user:
allOf:
- $ref: '#/components/schemas/KPIUserSegment'
description: User-segmented data (compact format with parallel arrays)
nullable: true
kpi_key:
description: KPI identifier
type: string
kpi_label:
description: Human-readable KPI label
nullable: true
type: string
matrix:
allOf:
- $ref: '#/components/schemas/KPIMatrixSegment'
description: 2D matrix (time × user) in compact format
nullable: true
project_matrix:
allOf:
- $ref: '#/components/schemas/KPIProjectMatrixSegment'
description: 2D matrix (time × project) in compact format
nullable: true
segmentation:
allOf:
- $ref: '#/components/schemas/SegmentationEnum'
description: |-
Type of segmentation applied
* `none` - none
* `time` - time
* `user` - user
* `project` - project
* `matrix` - matrix
* `project_matrix` - project_matrix
time_series:
allOf:
- $ref: '#/components/schemas/KPITimeSegment'
description: Time-segmented data (compact format with parallel arrays)
nullable: true
total:
allOf:
- $ref: '#/components/schemas/KPIValue'
description: Total value (no segmentation)
nullable: true
unit:
description: 'Unit of measurement: seconds, minutes, hours, count, or ratio'
type: string
required:
- kpi_key
- kpi_label
- segmentation
- unit
type: object
KPIMatrixSegment:
description: |-
Serializer for 2D matrix segmentation (time × user) in compact format.
Returns a 2D array where values[user_index][time_index] corresponds to
users[user_index] at interval_start[time_index].
properties:
interval_start:
description: Array of time period start timestamps
items:
format: date-time
type: string
type: array
users:
description: Array of user information
items:
$ref: '#/components/schemas/KPIUserInfo'
type: array
values:
description: '2D array of values: values[user_index][time_index]'
items:
items:
format: double
nullable: true
type: number
type: array
type: array
required:
- interval_start
- users
- values
type: object
KPIMetadata:
description: |-
Serializer for KPI metadata information.
Provides information about available KPIs including their keys, labels,
dependencies, and configuration.
properties:
aggregation_method:
description: 'Aggregation method for the KPI: count, sum, avg, max, min, or snapshot. Snapshot KPIs show point-in-time counts rather than event totals.'
nullable: true
type: string
base_class:
description: Base class name that the KPI inherits from
type: string
calculation_formula:
additionalProperties: {}
description: 'Formula for calculated KPIs defining how to derive the value from component KPIs. Structure: {"type": "ratio|sum|difference|product", "numerator": "kpi_key", "denominator": "kpi_key"}'
nullable: true
type: object
date_column:
description: Database column used for date filtering and aggregation
nullable: true
type: string
depends_on_kpis:
description: List of other KPI keys that this KPI depends on
items:
type: string
type: array
is_calculated:
description: Whether this KPI is calculated from other KPIs (has dependencies)
type: boolean
is_label_type:
description: Whether this KPI is a label/filter type that does not show a value per se
type: boolean
key:
description: Unique identifier for the KPI
type: string
label:
description: Human-readable label for the KPI
nullable: true
type: string
percentage:
description: 'Whether the KPI value is a percentage (DEPRECATED: use unit)'
type: boolean
unit:
description: 'Unit of measurement: seconds, minutes, hours, count, or ratio'
type: string
required:
- base_class
- date_column
- depends_on_kpis
- is_calculated
- is_label_type
- key
- label
- percentage
- unit
type: object
KPIProjectInfo:
description: Serializer for project information (compact format).
properties:
project_id:
description: Project ID
type: integer
project_name:
description: Project name
type: string
workspace_id:
description: Workspace ID
type: integer
workspace_name:
description: Workspace name
type: string
required:
- project_id
- project_name
- workspace_id
- workspace_name
type: object
KPIProjectMatrixSegment:
description: |-
Serializer for 2D matrix segmentation (time × project) in compact format.
Returns a 2D array where values[project_index][time_index] corresponds to
projects[project_index] at interval_start[time_index].
properties:
interval_start:
description: Array of time period start timestamps
items:
format: date-time
type: string
type: array
projects:
description: Array of project information
items:
$ref: '#/components/schemas/KPIProjectInfo'
type: array
values:
description: '2D array of values: values[project_index][time_index]'
items:
items:
format: double
nullable: true
type: number
type: array
type: array
required:
- interval_start
- projects
- values
type: object
KPIProjectSegment:
description: |-
Serializer for project-segmented KPI data (compact format).
Returns parallel arrays: projects and values.
Note: Values can be numbers (for count/time/ratio KPIs) or strings
(for category KPIs like project_state).
properties:
projects:
description: Array of project information
items:
$ref: '#/components/schemas/KPIProjectInfo'
type: array
values:
description: Array of KPI values, one per project (parallel to projects array). Can be numbers or strings depending on KPI type.
items:
nullable: true
type: string
type: array
required:
- projects
- values
type: object
KPITimeSegment:
description: |-
Serializer for time-segmented KPI data (compact format).
Returns parallel arrays: interval_start and values.
properties:
interval_start:
description: Array of time period start timestamps
items:
format: date-time
type: string
type: array
values:
description: Array of KPI values, one per time period (parallel to interval_start)
items:
format: double
nullable: true
type: number
type: array
required:
- interval_start
- values
type: object
KPIUserInfo:
description: Serializer for user information (compact format).
properties:
user_email:
description: User email
format: email
type: string
user_id:
description: User ID
type: integer
username:
description: Username
type: string
required:
- user_email
- user_id
- username
type: object
KPIUserSegment:
description: |-
Serializer for user-segmented KPI data (compact format).
Returns parallel arrays: users and values.
properties:
users:
description: Array of user information
items:
$ref: '#/components/schemas/KPIUserInfo'
type: array
values:
description: Array of KPI values, one per user (parallel to users array)
items:
format: double
nullable: true
type: number
type: array
required:
- users
- values
type: object
KPIValue:
description: Serializer for a single KPI value (no segmentation).
properties:
unit:
description: 'Unit of measurement: seconds, minutes, hours, count, or ratio'
type: string
value:
description: The KPI value in its native unit
format: double
nullable: true
type: number
required:
- unit
- value
type: object
LSAPITokenBlacklistRequest:
properties:
refresh:
minLength: 1
type: string
writeOnly: true
required:
- refresh
type: object
LSAPITokenRotateRequest:
properties:
refresh:
minLength: 1
type: string
required:
- refresh
type: object
LSEAPITokenCreate:
properties:
created_at:
readOnly: true
type: string
expires_at:
readOnly: true
type: string
token:
readOnly: true
type: string
required:
- created_at
- expires_at
- token
type: object
LSEAPITokenList:
properties:
created_at:
readOnly: true
type: string
expires_at:
readOnly: true
type: string
token:
readOnly: true
type: string
required:
- created_at
- expires_at
- token
type: object
LSEJWTSettings:
properties:
api_token_ttl_days:
maximum: 365
minimum: 1
type: integer
api_tokens_enabled:
description: Enable JWT API token authentication for this organization
title: JWT API tokens enabled
type: boolean
legacy_api_tokens_enabled:
description: Enable legacy API token authentication for this organization
type: boolean
required:
- api_token_ttl_days
type: object
LSEJWTSettingsRequest:
properties:
api_token_ttl_days:
maximum: 365
minimum: 1
type: integer
api_tokens_enabled:
description: Enable JWT API token authentication for this organization
title: JWT API tokens enabled
type: boolean
legacy_api_tokens_enabled:
description: Enable legacy API token authentication for this organization
type: boolean
required:
- api_token_ttl_days
type: object
LSEKeyIndicatorValue:
description: |-
Key indicator value for Label Studio Enterprise.
Attributes:
title: The title for this metric, to be displayed to the user
values: Dictionary of key-value pairs for the indicator values
properties:
title:
description: The title for this metric, to be displayed to the user
title: Title
type: string
values:
additionalProperties: true
description: Dictionary of key-value pairs for the indicator values
title: Values
type: object
required:
- title
- values
title: LSEKeyIndicatorValue
type: object
Label:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
approved:
description: Status of label
type: boolean
approved_by:
description: User who approved this label
nullable: true
type: integer
created_at:
description: Time of label creation
format: date-time
readOnly: true
type: string
created_by:
description: User who made this label
type: integer
description:
description: Label description
nullable: true
type: string
id:
readOnly: true
type: integer
links:
items:
type: integer
readOnly: true
type: array
organization:
type: integer
projects:
items:
type: integer
readOnly: true
type: array
title:
description: Label title
maxLength: 2048
type: string
updated_at:
description: Time of label modification
format: date-time
readOnly: true
type: string
value:
description: Label value
required:
- created_at
- created_by
- id
- links
- organization
- projects
- title
- updated_at
- value
type: object
LabelCreate:
properties:
approved:
description: Status of label
type: boolean
approved_by:
description: User who approved this label
nullable: true
type: integer
created_at:
description: Time of label creation
format: date-time
readOnly: true
type: string
created_by:
readOnly: true
type: integer
description:
description: Label description
nullable: true
type: string
from_name:
type: string
id:
readOnly: true
type: integer
organization:
readOnly: true
type: integer
project:
type: integer
projects:
items:
type: integer
readOnly: true
type: array
title:
description: Label title
maxLength: 2048
type: string
updated_at:
description: Time of label modification
format: date-time
readOnly: true
type: string
value:
description: Label value
required:
- created_at
- created_by
- from_name
- id
- organization
- project
- projects
- title
- updated_at
- value
type: object
LabelCreateRequest:
properties:
approved:
description: Status of label
type: boolean
approved_by:
description: User who approved this label
nullable: true
type: integer
description:
description: Label description
nullable: true
type: string
from_name:
minLength: 1
type: string
project:
type: integer
title:
description: Label title
maxLength: 2048
minLength: 1
type: string
value:
description: Label value
required:
- from_name
- project
- title
- value
type: object
LabelDistributionCountsResponse:
properties:
next_offset:
description: Next offset for pagination when using limit/offset mode; null when there are no more results or when filtering by explicit `choice_keys`.
nullable: true
type: integer
results:
items:
$ref: '#/components/schemas/LabelDistributionCountsRow'
type: array
totals:
$ref: '#/components/schemas/LabelDistributionCountsTotals'
required:
- next_offset
- results
- totals
type: object
LabelDistributionCountsRow:
properties:
choice:
type: string
choice_key:
readOnly: true
type: string
dimension_name:
type: string
from_annotations_count:
type: integer
from_annotations_percent:
format: double
type: number
from_predictions_count:
type: integer
from_predictions_percent:
format: double
type: number
required:
- choice
- choice_key
- dimension_name
- from_annotations_count
- from_annotations_percent
- from_predictions_count
- from_predictions_percent
type: object
LabelDistributionCountsTotals:
properties:
annotation_totals_by_dimension:
additionalProperties:
type: integer
description: Total annotation counts keyed by dimension name.
type: object
prediction_totals_by_dimension:
additionalProperties:
type: integer
description: Total prediction counts keyed by dimension name.
type: object
type: object
LabelDistributionStructureDimension:
properties:
choice_keys:
description: Flat keys in "___SEP___" format for this dimension.
readOnly: true
type: string
choices:
description: Sorted list of choices observed from config and/or created labels.
items:
type: string
type: array
name:
description: Original from_name from labeling config or observed annotation results.
type: string
type:
description: Result item type for this dimension when available.
type: string
required:
- choice_keys
- choices
- name
type: object
LabelDistributionStructureResponse:
properties:
choice_keys:
description: All project choice keys in stable order, joined with "___PIPE___" when passed as query param.
readOnly: true
type: string
dimensions:
items:
$ref: '#/components/schemas/LabelDistributionStructureDimension'
type: array
required:
- choice_keys
- dimensions
type: object
LabelLink:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
annotations_count:
readOnly: true
type: integer
from_name:
description: Tag name
maxLength: 2048
title: Tag name
type: string
id:
readOnly: true
type: integer
label:
type: integer
project:
type: integer
required:
- annotations_count
- from_name
- id
- label
- project
type: object
LabelLinkRequest:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
from_name:
description: Tag name
maxLength: 2048
minLength: 1
title: Tag name
type: string
label:
type: integer
project:
type: integer
required:
- from_name
- label
- project
type: object
LabelStreamTaskDistributionEnum:
description: |-
* `auto_distribution` - Label Stream distributes tasks automatically to annotators
* `assigned_only` - Label Stream shows tasks only to assigned users
enum:
- auto_distribution
- assigned_only
type: string
LastActionEnum:
description: |-
* `prediction` - Created from prediction
* `propagated_annotation` - Created from another annotation
* `imported` - Imported
* `submitted` - Submitted
* `updated` - Updated
* `skipped` - Skipped
* `accepted` - Accepted
* `rejected` - Rejected
* `fixed_and_accepted` - Fixed and accepted
* `deleted_review` - Deleted review
enum:
- prediction
- propagated_annotation
- imported
- submitted
- updated
- skipped
- accepted
- rejected
- fixed_and_accepted
- deleted_review
type: string
LocalFilesExportStorage:
properties:
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
path:
description: Local path
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: localfiles
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
LocalFilesImportStorage:
properties:
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
path:
description: Local path
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan over the directory content
nullable: true
type: boolean
regex_filter:
description: Regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: localfiles
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
LseAnnotationFilterOptions:
properties:
ground_truth:
description: Include ground truth annotations
nullable: true
type: boolean
reviewed:
allOf:
- $ref: '#/components/schemas/ReviewedEnum'
description: |-
`only` - include all tasks with at least one not reviewed annotation
`exclude` - exclude with at least one not reviewed annotation
* `only` - only
* `exclude` - exclude
* `None` - None
nullable: true
skipped:
description: Include skipped annotations
nullable: true
type: boolean
usual:
default: true
description: Include not skipped and not ground truth annotations
nullable: true
type: boolean
type: object
LseAnnotationFilterOptionsRequest:
properties:
ground_truth:
description: Include ground truth annotations
nullable: true
type: boolean
reviewed:
allOf:
- $ref: '#/components/schemas/ReviewedEnum'
description: |-
`only` - include all tasks with at least one not reviewed annotation
`exclude` - exclude with at least one not reviewed annotation
* `only` - only
* `exclude` - exclude
* `None` - None
nullable: true
skipped:
description: Include skipped annotations
nullable: true
type: boolean
usual:
default: true
description: Include not skipped and not ground truth annotations
nullable: true
type: boolean
type: object
LseExportCreate:
properties:
annotation_filter_options:
$ref: '#/components/schemas/LseAnnotationFilterOptions'
converted_formats:
items:
$ref: '#/components/schemas/ConvertedFormat'
type: array
counters:
title: Exporting meta data
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
created_by:
$ref: '#/components/schemas/UserSimple'
finished_at:
description: Complete or fail time
format: date-time
nullable: true
type: string
id:
readOnly: true
type: integer
md5:
maxLength: 128
title: Md5 of file
type: string
serialization_options:
$ref: '#/components/schemas/SerializationOptions'
status:
allOf:
- $ref: '#/components/schemas/Status7bfEnum'
title: Export status
task_filter_options:
$ref: '#/components/schemas/LseTaskFilterOptions'
title:
maxLength: 2048
type: string
required:
- created_at
- id
type: object
LseExportCreateRequest:
properties:
annotation_filter_options:
$ref: '#/components/schemas/LseAnnotationFilterOptionsRequest'
converted_formats:
items:
$ref: '#/components/schemas/ConvertedFormatRequest'
type: array
counters:
title: Exporting meta data
created_by:
$ref: '#/components/schemas/UserSimpleRequest'
finished_at:
description: Complete or fail time
format: date-time
nullable: true
type: string
md5:
maxLength: 128
minLength: 1
title: Md5 of file
type: string
serialization_options:
$ref: '#/components/schemas/SerializationOptionsRequest'
status:
allOf:
- $ref: '#/components/schemas/Status7bfEnum'
title: Export status
task_filter_options:
$ref: '#/components/schemas/LseTaskFilterOptionsRequest'
title:
maxLength: 2048
type: string
type: object
LseFields:
properties:
email_notification_settings:
readOnly: true
type: string
invite_activated:
nullable: true
type: boolean
invite_expired:
readOnly: true
type: string
invite_expired_at:
readOnly: true
type: string
invited_at:
format: date-time
nullable: true
type: string
invited_by:
nullable: true
type: integer
onboarding_state:
allOf:
- $ref: '#/components/schemas/OnboardingStateEnum'
description: |-
The current stage of user onboarding
* `not_started` - Not Started
* `signup` - Signup
* `trial_signup` - Trial Signup
* `first_tutorial` - First Tutorial
* `in_app_guidance` - In App Guidance
* `complete` - Complete
nullable: true
social_auth_finished:
description: Is user finished social authentication
nullable: true
type: boolean
trial_company:
maxLength: 1000
nullable: true
type: string
trial_experience_labeling:
maxLength: 1000
nullable: true
type: string
trial_license_enterprise:
nullable: true
type: boolean
trial_models_in_production:
maxLength: 1000
nullable: true
type: string
trial_role:
allOf:
- $ref: '#/components/schemas/TrialRoleEnum'
nullable: true
required:
- email_notification_settings
- invite_expired
- invite_expired_at
type: object
LseFieldsRequest:
properties:
invite_activated:
nullable: true
type: boolean
invited_at:
format: date-time
nullable: true
type: string
invited_by:
nullable: true
type: integer
onboarding_state:
allOf:
- $ref: '#/components/schemas/OnboardingStateEnum'
description: |-
The current stage of user onboarding
* `not_started` - Not Started
* `signup` - Signup
* `trial_signup` - Trial Signup
* `first_tutorial` - First Tutorial
* `in_app_guidance` - In App Guidance
* `complete` - Complete
nullable: true
social_auth_finished:
description: Is user finished social authentication
nullable: true
type: boolean
trial_company:
maxLength: 1000
nullable: true
type: string
trial_experience_labeling:
maxLength: 1000
nullable: true
type: string
trial_license_enterprise:
nullable: true
type: boolean
trial_models_in_production:
maxLength: 1000
nullable: true
type: string
trial_role:
allOf:
- $ref: '#/components/schemas/TrialRoleEnum'
nullable: true
type: object
LseOrganization:
properties:
billing:
$ref: '#/components/schemas/OrganizationBilling'
created_at:
format: date-time
readOnly: true
type: string
custom_scripts_enabled:
readOnly: true
type: string
default_role:
allOf:
- $ref: '#/components/schemas/Role9e7Enum'
description: |-
Default membership role for invited users
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
email_notification_settings:
readOnly: true
type: string
embed_domains:
description: 'List of objects: {"domain": "example.com"}. Used for CSP header on /embed routes.'
nullable: true
embed_settings:
description: Embed settings for this organization
nullable: true
external_id:
description: External ID to uniquely identify this organization
nullable: true
type: string
id:
readOnly: true
type: integer
title:
readOnly: true
type: string
token:
readOnly: true
type: string
required:
- billing
- created_at
- custom_scripts_enabled
- email_notification_settings
- id
- title
- token
type: object
LseOrganizationMemberList:
description: |-
A serializer mixin that takes an additional `fields` argument that controls
which fields should be displayed.
properties:
concurrency:
readOnly: true
type: string
contributed_to_projects:
items:
properties:
id:
type: integer
title:
type: string
required:
- id
- title
type: object
nullable: true
readOnly: true
type: array
created_projects:
items:
properties:
id:
type: integer
title:
type: string
required:
- id
- title
type: object
nullable: true
readOnly: true
type: array
id:
readOnly: true
type: integer
organization:
description: Organization ID
type: integer
role:
readOnly: true
type: string
tags:
items:
$ref: '#/components/schemas/SimpleOrganizationMemberTag'
readOnly: true
type: array
user:
$ref: '#/components/schemas/LseUserOrganizationMemberList'
required:
- concurrency
- contributed_to_projects
- created_projects
- id
- organization
- role
- tags
- user
type: object
LseProject:
description: |-
Serializer get numbers from project queryset annotation,
make sure, that you use correct one(Project.objects.with_counts())
properties:
agreement_methodology:
allOf:
- $ref: '#/components/schemas/AgreementMethodologyEnum'
default: pairwise
description: |-
Methodology (Consensus / Pairwise Averaging)
* `consensus` - Consensus
* `pairwise` - Pairwise Averaging
agreement_threshold:
description: Agreement threshold
format: decimal
nullable: true
pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
type: string
annotation_limit_count:
description: Limit by number of tasks
minimum: 1
nullable: true
type: integer
annotation_limit_percent:
description: Limit by percentage of tasks
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
annotator_evaluation_continuous_tasks:
default: 0
description: 'Continuous Evaluation: Required tasks'
minimum: 0
type: integer
annotator_evaluation_enabled:
description: Evaluate all annotators against ground truth
type: boolean
annotator_evaluation_minimum_score:
default: '95.00'
description: Score required to pass evaluation
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
annotator_evaluation_minimum_tasks:
default: 10
description: Number of tasks for evaluation
minimum: 0
nullable: true
type: integer
annotator_evaluation_onboarding_tasks:
default: 0
description: 'Onboarding Evaluation: Required tasks'
minimum: 0
type: integer
assignment_settings:
$ref: '#/components/schemas/AssignmentSettings'
color:
description: Color
maxLength: 16
nullable: true
type: string
comment_classification_config:
type: string
config_has_control_tags:
description: Flag to detect is project ready for labeling
readOnly: true
type: boolean
config_suitable_for_bulk_annotation:
description: Flag to detect is project ready for bulk annotation
readOnly: true
type: boolean
control_weights:
additionalProperties:
$ref: '#/components/schemas/ControlTagWeight'
description: 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.
nullable: true
type: object
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
description: Project owner
custom_script:
description: Plugins
type: string
custom_task_lock_ttl:
description: Task reservation time. TTL in seconds (UI displays and edits this value in minutes).
maximum: 86400
minimum: 1
nullable: true
type: integer
data_types:
additionalProperties: true
nullable: true
readOnly: true
type: object
description:
description: Description
nullable: true
type: string
duplication_done:
default: false
type: boolean
duplication_status:
type: string
enable_empty_annotation:
description: Allow empty annotations
type: boolean
evaluate_predictions_automatically:
description: Retrieve and display predictions when loading a task
type: boolean
expert_instruction:
description: Instructions
nullable: true
type: string
finished_task_number:
description: Finished tasks
readOnly: true
type: integer
ground_truth_number:
description: Honeypot annotation number in project
readOnly: true
type: integer
id:
readOnly: true
type: integer
is_dimensions_enabled:
readOnly: true
type: string
is_draft:
description: Whether or not the project is in the middle of being created
type: boolean
is_published:
description: Whether or not the project is published to annotators
title: Published
type: boolean
label_config:
description: Labeling Configuration
nullable: true
type: string
max_additional_annotators_assignable:
description: Maximum additional annotators
nullable: true
type: integer
maximum_annotations:
description: Annotations per task
maximum: 2147483647
minimum: -2147483648
title: Maximum annotation number
type: integer
members:
readOnly: true
type: string
members_count:
readOnly: true
type: integer
min_annotations_to_start_training:
description: Minimum number of completed tasks after which model training is started
maximum: 2147483647
minimum: -2147483648
type: integer
model_version:
description: Machine learning model version
nullable: true
type: string
num_tasks_with_annotations:
nullable: true
readOnly: true
type: integer
organization:
nullable: true
type: integer
overlap_cohort_percentage:
description: Annotations per task coverage
maximum: 2147483647
minimum: -2147483648
type: integer
parsed_label_config:
additionalProperties: true
description: JSON-formatted labeling configuration
readOnly: true
type: object
pause_on_failed_annotator_evaluation:
default: false
description: Pause annotator on failed evaluation
nullable: true
type: boolean
pinned_at:
description: Pinned date and time
format: date-time
nullable: true
type: string
prompts:
readOnly: true
type: string
queue_done:
readOnly: true
type: string
queue_left:
readOnly: true
type: string
queue_total:
readOnly: true
type: string
require_comment_on_skip:
default: false
description: Require comment to skip
type: boolean
reveal_preannotations_interactively:
description: Reveal pre-annotations interactively
type: boolean
review_settings:
$ref: '#/components/schemas/ReviewSettings'
reviewer_queue_total:
readOnly: true
type: string
sampling:
allOf:
- $ref: '#/components/schemas/SamplingDe5Enum'
nullable: true
show_annotation_history:
description: Show Data Manager to Annotators
type: boolean
show_collab_predictions:
description: Use predictions to pre-label Tasks
title: Show predictions to annotator
type: boolean
show_ground_truth_first:
deprecated: true
description: 'Onboarding mode (true): show ground truth tasks first in the labeling stream'
type: boolean
show_instruction:
description: Show instructions before labeling
type: boolean
show_overlap_first:
description: Show tasks with overlap first
type: boolean
show_skip_button:
description: Allow skipping tasks
type: boolean
show_unused_data_columns_to_annotators:
description: '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.'
nullable: true
type: boolean
skip_queue:
allOf:
- $ref: '#/components/schemas/SkipQueueEnum'
nullable: true
skipped_annotations_number:
description: Skipped by collaborators annotation number in project
readOnly: true
type: integer
start_training_on_annotation_update:
description: Start model training after any annotations are submitted or updated
readOnly: true
type: boolean
state:
readOnly: true
type: string
strict_task_overlap:
default: true
description: Enforce strict overlap limit
type: boolean
task_data_login:
description: Login
maxLength: 256
nullable: true
type: string
task_data_password:
description: Password
maxLength: 256
nullable: true
type: string
task_number:
description: Total task number in project
readOnly: true
type: integer
title:
description: Project Name
maxLength: 50
minLength: 3
nullable: true
type: string
total_annotations_number:
description: Total annotations number in project including skipped_annotations_number and ground_truth_number.
readOnly: true
type: integer
total_predictions_number:
description: Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
readOnly: true
type: integer
useful_annotation_number:
description: Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
readOnly: true
type: integer
workspace:
readOnly: true
type: string
workspace_title:
readOnly: true
type: string
required:
- assignment_settings
- config_has_control_tags
- config_suitable_for_bulk_annotation
- created_at
- data_types
- finished_task_number
- ground_truth_number
- id
- is_dimensions_enabled
- members
- members_count
- num_tasks_with_annotations
- parsed_label_config
- prompts
- queue_done
- queue_left
- queue_total
- review_settings
- reviewer_queue_total
- skipped_annotations_number
- start_training_on_annotation_update
- state
- task_number
- total_annotations_number
- total_predictions_number
- useful_annotation_number
- workspace
- workspace_title
type: object
LseProjectCounts:
description: |-
Serializer get numbers from project queryset annotation,
make sure, that you use correct one(Project.objects.with_counts())
properties:
finished_task_number:
readOnly: true
type: integer
ground_truth_number:
description: Honeypot annotation number in project
readOnly: true
type: integer
id:
readOnly: true
type: integer
num_tasks_with_annotations:
nullable: true
readOnly: true
type: integer
queue_done:
readOnly: true
type: integer
queue_left:
readOnly: true
type: integer
queue_total:
readOnly: true
type: string
rejected:
readOnly: true
type: integer
review_total_tasks:
readOnly: true
type: integer
reviewed_number:
readOnly: true
type: integer
skipped_annotations_number:
readOnly: true
type: string
task_number:
description: Total task number in project
readOnly: true
type: integer
total_annotations_number:
readOnly: true
type: string
total_predictions_number:
readOnly: true
type: integer
useful_annotation_number:
nullable: true
readOnly: true
type: integer
required:
- finished_task_number
- ground_truth_number
- id
- num_tasks_with_annotations
- queue_done
- queue_left
- queue_total
- rejected
- review_total_tasks
- reviewed_number
- skipped_annotations_number
- task_number
- total_annotations_number
- total_predictions_number
- useful_annotation_number
type: object
LseProjectCreate:
description: |-
Serializer get numbers from project queryset annotation,
make sure, that you use correct one(Project.objects.with_counts())
properties:
annotator_evaluation_enabled:
description: Enable annotator evaluation for the project
type: boolean
color:
maxLength: 16
nullable: true
type: string
config_has_control_tags:
description: Flag to detect is project ready for labeling
readOnly: true
type: boolean
config_suitable_for_bulk_annotation:
description: Flag to detect is project ready for bulk annotation
readOnly: true
type: boolean
control_weights:
additionalProperties:
$ref: '#/components/schemas/ControlTagWeight'
description: 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.
nullable: true
type: object
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
description: Project owner
description:
description: Project Description
nullable: true
type: string
enable_empty_annotation:
description: Allow annotators to submit empty annotations
type: boolean
evaluate_predictions_automatically:
description: Retrieve and display predictions when loading a task
type: boolean
expert_instruction:
description: Labeling instructions in HTML format
nullable: true
type: string
finished_task_number:
description: Finished tasks
readOnly: true
type: integer
ground_truth_number:
description: Honeypot annotation number in project
readOnly: true
type: integer
id:
readOnly: true
type: integer
is_draft:
description: Whether or not the project is in the middle of being created
type: boolean
is_published:
description: Whether or not the project is published to annotators
title: Published
type: boolean
label_config:
description: Label config in XML format. See more about it in documentation
nullable: true
type: string
maximum_annotations:
description: 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)
maximum: 2147483647
minimum: -2147483648
title: Maximum annotation number
type: integer
min_annotations_to_start_training:
description: Minimum number of completed tasks after which model training is started
maximum: 2147483647
minimum: -2147483648
type: integer
model_version:
description: Machine learning model version
nullable: true
type: string
num_tasks_with_annotations:
description: Tasks with annotations count
readOnly: true
type: integer
organization:
nullable: true
type: integer
overlap_cohort_percentage:
maximum: 2147483647
minimum: -2147483648
type: integer
parsed_label_config:
additionalProperties: true
description: JSON-formatted labeling configuration
readOnly: true
type: object
pinned_at:
description: Pinned date and time
format: date-time
nullable: true
type: string
queue_done:
readOnly: true
type: integer
queue_total:
readOnly: true
type: integer
reveal_preannotations_interactively:
description: Reveal pre-annotations interactively
type: boolean
sampling:
allOf:
- $ref: '#/components/schemas/SamplingDe5Enum'
nullable: true
show_annotation_history:
description: Show annotation history to annotator
type: boolean
show_collab_predictions:
description: If set, the annotator can view model predictions
title: Show predictions to annotator
type: boolean
show_ground_truth_first:
deprecated: true
description: 'Onboarding mode (true): show ground truth tasks first in the labeling stream'
type: boolean
show_instruction:
description: Show instructions to the annotator before they start
type: boolean
show_overlap_first:
type: boolean
show_skip_button:
description: Show a skip button in interface and allow annotators to skip the task
type: boolean
skip_queue:
allOf:
- $ref: '#/components/schemas/SkipQueueEnum'
nullable: true
skipped_annotations_number:
description: Skipped by collaborators annotation number in project
readOnly: true
type: integer
start_training_on_annotation_update:
description: Start model training after any annotations are submitted or updated
readOnly: true
type: boolean
state:
readOnly: true
type: string
task_data_login:
description: 'Task data credentials: login'
maxLength: 256
nullable: true
type: string
task_data_password:
description: 'Task data credentials: password'
maxLength: 256
nullable: true
type: string
task_number:
description: Total task number in project
readOnly: true
type: integer
title:
description: Project Title
maxLength: 50
minLength: 3
nullable: true
type: string
total_annotations_number:
description: Total annotations number in project including skipped_annotations_number and ground_truth_number.
readOnly: true
type: integer
total_predictions_number:
description: Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
readOnly: true
type: integer
useful_annotation_number:
description: Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
readOnly: true
type: integer
workspace:
description: In Workspace
type: integer
required:
- config_has_control_tags
- config_suitable_for_bulk_annotation
- created_at
- finished_task_number
- ground_truth_number
- id
- num_tasks_with_annotations
- parsed_label_config
- queue_done
- queue_total
- skipped_annotations_number
- start_training_on_annotation_update
- state
- task_number
- total_annotations_number
- total_predictions_number
- useful_annotation_number
type: object
LseProjectCreateRequest:
description: |-
Serializer get numbers from project queryset annotation,
make sure, that you use correct one(Project.objects.with_counts())
properties:
annotator_evaluation_enabled:
description: Enable annotator evaluation for the project
type: boolean
color:
maxLength: 16
nullable: true
type: string
control_weights:
additionalProperties:
$ref: '#/components/schemas/ControlTagWeightRequest'
description: 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.
nullable: true
type: object
created_by:
allOf:
- $ref: '#/components/schemas/UserSimpleRequest'
description: Project owner
description:
description: Project Description
nullable: true
type: string
enable_empty_annotation:
description: Allow annotators to submit empty annotations
type: boolean
evaluate_predictions_automatically:
description: Retrieve and display predictions when loading a task
type: boolean
expert_instruction:
description: Labeling instructions in HTML format
nullable: true
type: string
is_draft:
description: Whether or not the project is in the middle of being created
type: boolean
is_published:
description: Whether or not the project is published to annotators
title: Published
type: boolean
label_config:
description: Label config in XML format. See more about it in documentation
nullable: true
type: string
maximum_annotations:
description: 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)
maximum: 2147483647
minimum: -2147483648
title: Maximum annotation number
type: integer
min_annotations_to_start_training:
description: Minimum number of completed tasks after which model training is started
maximum: 2147483647
minimum: -2147483648
type: integer
model_version:
description: Machine learning model version
nullable: true
type: string
organization:
nullable: true
type: integer
overlap_cohort_percentage:
maximum: 2147483647
minimum: -2147483648
type: integer
pinned_at:
description: Pinned date and time
format: date-time
nullable: true
type: string
reveal_preannotations_interactively:
description: Reveal pre-annotations interactively
type: boolean
sampling:
allOf:
- $ref: '#/components/schemas/SamplingDe5Enum'
nullable: true
show_annotation_history:
description: Show annotation history to annotator
type: boolean
show_collab_predictions:
description: If set, the annotator can view model predictions
title: Show predictions to annotator
type: boolean
show_ground_truth_first:
deprecated: true
description: 'Onboarding mode (true): show ground truth tasks first in the labeling stream'
type: boolean
show_instruction:
description: Show instructions to the annotator before they start
type: boolean
show_overlap_first:
type: boolean
show_skip_button:
description: Show a skip button in interface and allow annotators to skip the task
type: boolean
skip_queue:
allOf:
- $ref: '#/components/schemas/SkipQueueEnum'
nullable: true
task_data_login:
description: 'Task data credentials: login'
maxLength: 256
nullable: true
type: string
task_data_password:
description: 'Task data credentials: password'
maxLength: 256
nullable: true
type: string
title:
description: Project Title
maxLength: 50
minLength: 3
nullable: true
type: string
workspace:
description: In Workspace
type: integer
type: object
LseProjectParams:
properties:
annotator_params:
description: 'user ID and user weight in score calculation. Format {user_id[int]: weight[Float[0..1]]}'
nullable: true
use_kappa:
description: If categorical variables are used in labeling (e.g. choices), Cohen's Kappa statistic is computed to measure inter-rater reliability instead of basic agreement
type: boolean
type: object
LseProjectParamsRequest:
properties:
annotator_params:
description: 'user ID and user weight in score calculation. Format {user_id[int]: weight[Float[0..1]]}'
nullable: true
use_kappa:
description: If categorical variables are used in labeling (e.g. choices), Cohen's Kappa statistic is computed to measure inter-rater reliability instead of basic agreement
type: boolean
type: object
LseProjectResponse:
description: Serializer for project response, combining all the serializers for different roles. Don't use it except for Spectacular/Fern definitions.
properties:
agreement_methodology:
allOf:
- $ref: '#/components/schemas/AgreementMethodologyEnum'
default: pairwise
description: |-
Methodology (Consensus / Pairwise Averaging)
* `consensus` - Consensus
* `pairwise` - Pairwise Averaging
agreement_threshold:
description: Agreement threshold
format: decimal
nullable: true
pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
type: string
allow_stream:
readOnly: true
type: boolean
annotation_limit_count:
description: Limit by number of tasks
minimum: 1
nullable: true
type: integer
annotation_limit_percent:
description: Limit by percentage of tasks
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
annotator_evaluation_continuous_tasks:
default: 0
description: 'Continuous Evaluation: Required tasks'
minimum: 0
type: integer
annotator_evaluation_enabled:
description: Evaluate all annotators against ground truth
type: boolean
annotator_evaluation_minimum_score:
default: '95.00'
description: Score required to pass evaluation
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
annotator_evaluation_minimum_tasks:
default: 10
description: Number of tasks for evaluation
minimum: 0
nullable: true
type: integer
annotator_evaluation_onboarding_tasks:
default: 0
description: 'Onboarding Evaluation: Required tasks'
minimum: 0
type: integer
assignment_settings:
$ref: '#/components/schemas/AssignmentSettings'
color:
description: Color
maxLength: 16
nullable: true
type: string
comment_classification_config:
type: string
config_has_control_tags:
description: Flag to detect is project ready for labeling
readOnly: true
type: boolean
config_suitable_for_bulk_annotation:
description: Flag to detect is project ready for bulk annotation
readOnly: true
type: boolean
control_weights:
additionalProperties:
$ref: '#/components/schemas/ControlTagWeight'
description: 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.
nullable: true
type: object
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
description: Project owner
custom_script:
description: Plugins
type: string
custom_task_lock_ttl:
description: Task reservation time. TTL in seconds (UI displays and edits this value in minutes).
maximum: 86400
minimum: 1
nullable: true
type: integer
data_types:
additionalProperties: true
nullable: true
readOnly: true
type: object
description:
description: Description
nullable: true
type: string
duplication_done:
default: false
type: boolean
duplication_status:
type: string
enable_empty_annotation:
description: Allow empty annotations
type: boolean
evaluate_predictions_automatically:
description: Retrieve and display predictions when loading a task
type: boolean
expert_instruction:
description: Instructions
nullable: true
type: string
finished_task_number:
description: Finished tasks
readOnly: true
type: integer
ground_truth_number:
description: Honeypot annotation number in project
readOnly: true
type: integer
id:
readOnly: true
type: integer
is_dimensions_enabled:
readOnly: true
type: string
is_draft:
description: Whether or not the project is in the middle of being created
type: boolean
is_published:
description: Whether or not the project is published to annotators
title: Published
type: boolean
label_config:
description: Labeling Configuration
nullable: true
type: string
max_additional_annotators_assignable:
description: Maximum additional annotators
nullable: true
type: integer
maximum_annotations:
description: Annotations per task
maximum: 2147483647
minimum: -2147483648
title: Maximum annotation number
type: integer
members:
readOnly: true
type: string
members_count:
readOnly: true
type: integer
min_annotations_to_start_training:
description: Minimum number of completed tasks after which model training is started
maximum: 2147483647
minimum: -2147483648
type: integer
model_version:
description: Machine learning model version
nullable: true
type: string
num_tasks_with_annotations:
readOnly: true
type: integer
organization:
nullable: true
type: integer
overlap_cohort_percentage:
description: Annotations per task coverage
maximum: 2147483647
minimum: -2147483648
type: integer
parsed_label_config:
additionalProperties: true
description: JSON-formatted labeling configuration
readOnly: true
type: object
pause_on_failed_annotator_evaluation:
default: false
description: Pause annotator on failed evaluation
nullable: true
type: boolean
pinned_at:
description: Pinned date and time
format: date-time
nullable: true
type: string
prompts:
readOnly: true
type: string
queue_done:
readOnly: true
type: integer
queue_left:
readOnly: true
type: integer
queue_total:
readOnly: true
type: integer
ready:
readOnly: true
type: boolean
rejected:
readOnly: true
type: integer
require_comment_on_skip:
default: false
description: Require comment to skip
type: boolean
reveal_preannotations_interactively:
description: Reveal pre-annotations interactively
type: boolean
review_settings:
$ref: '#/components/schemas/ReviewSettings'
review_total_tasks:
readOnly: true
type: integer
reviewed_number:
readOnly: true
type: integer
reviewer_queue_total:
readOnly: true
type: integer
sampling:
allOf:
- $ref: '#/components/schemas/SamplingDe5Enum'
nullable: true
show_annotation_history:
description: Show Data Manager to Annotators
type: boolean
show_collab_predictions:
description: Use predictions to pre-label Tasks
title: Show predictions to annotator
type: boolean
show_ground_truth_first:
deprecated: true
description: 'Onboarding mode (true): show ground truth tasks first in the labeling stream'
type: boolean
show_instruction:
description: Show instructions before labeling
type: boolean
show_overlap_first:
description: Show tasks with overlap first
type: boolean
show_skip_button:
description: Allow skipping tasks
type: boolean
show_unused_data_columns_to_annotators:
description: '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.'
nullable: true
type: boolean
skip_queue:
allOf:
- $ref: '#/components/schemas/SkipQueueEnum'
nullable: true
skipped_annotations_number:
readOnly: true
type: integer
start_training_on_annotation_update:
description: Start model training after any annotations are submitted or updated
readOnly: true
type: boolean
state:
readOnly: true
type: string
strict_task_overlap:
default: true
description: Enforce strict overlap limit
type: boolean
task_data_login:
description: Login
maxLength: 256
nullable: true
type: string
task_data_password:
description: Password
maxLength: 256
nullable: true
type: string
task_number:
description: Total task number in project
readOnly: true
type: integer
title:
description: Project Name
maxLength: 50
minLength: 3
nullable: true
type: string
total_annotations_number:
readOnly: true
type: integer
total_predictions_number:
nullable: true
readOnly: true
type: integer
useful_annotation_number:
nullable: true
readOnly: true
type: integer
workspace:
readOnly: true
type: string
workspace_title:
readOnly: true
type: string
required:
- allow_stream
- assignment_settings
- config_has_control_tags
- config_suitable_for_bulk_annotation
- created_at
- data_types
- finished_task_number
- ground_truth_number
- id
- is_dimensions_enabled
- members
- members_count
- num_tasks_with_annotations
- parsed_label_config
- prompts
- queue_done
- queue_left
- queue_total
- ready
- rejected
- review_settings
- review_total_tasks
- reviewed_number
- reviewer_queue_total
- skipped_annotations_number
- start_training_on_annotation_update
- state
- task_number
- total_annotations_number
- total_predictions_number
- useful_annotation_number
- workspace
- workspace_title
type: object
LseProjectUpdate:
description: |-
Serializer get numbers from project queryset annotation,
make sure, that you use correct one(Project.objects.with_counts())
properties:
agreement_methodology:
allOf:
- $ref: '#/components/schemas/AgreementMethodologyEnum'
default: pairwise
description: |-
Methodology (Consensus / Pairwise Averaging)
* `consensus` - Consensus
* `pairwise` - Pairwise Averaging
agreement_threshold:
description: Agreement threshold
format: decimal
nullable: true
pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
type: string
annotation_limit_count:
description: Limit by number of tasks
minimum: 1
nullable: true
type: integer
annotation_limit_percent:
description: Limit by percentage of tasks
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
annotator_evaluation_continuous_tasks:
default: 0
description: 'Continuous Evaluation: Required tasks'
minimum: 0
type: integer
annotator_evaluation_enabled:
description: Evaluate all annotators against ground truth
type: boolean
annotator_evaluation_minimum_score:
default: '95.00'
description: Score required to pass evaluation
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
annotator_evaluation_minimum_tasks:
default: 10
description: Number of tasks for evaluation
minimum: 0
nullable: true
type: integer
annotator_evaluation_onboarding_tasks:
default: 0
description: 'Onboarding Evaluation: Required tasks'
minimum: 0
type: integer
assignment_settings:
$ref: '#/components/schemas/AssignmentSettings'
color:
description: Color
maxLength: 16
nullable: true
type: string
comment_classification_config:
type: string
config_has_control_tags:
description: Flag to detect is project ready for labeling
readOnly: true
type: boolean
config_suitable_for_bulk_annotation:
description: Flag to detect is project ready for bulk annotation
readOnly: true
type: boolean
control_weights:
additionalProperties:
$ref: '#/components/schemas/ControlTagWeight'
description: 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.
nullable: true
type: object
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
description: Project owner
custom_script:
description: Plugins
type: string
custom_task_lock_ttl:
description: Task reservation time. TTL in seconds (UI displays and edits this value in minutes).
maximum: 86400
minimum: 1
nullable: true
type: integer
description:
description: Description
nullable: true
type: string
enable_empty_annotation:
description: Allow empty annotations
type: boolean
evaluate_predictions_automatically:
description: Retrieve and display predictions when loading a task
type: boolean
expert_instruction:
description: Instructions
nullable: true
type: string
finished_task_number:
description: Finished tasks
readOnly: true
type: integer
ground_truth_number:
description: Honeypot annotation number in project
readOnly: true
type: integer
id:
readOnly: true
type: integer
is_draft:
description: Whether or not the project is in the middle of being created
type: boolean
is_published:
description: Whether or not the project is published to annotators
title: Published
type: boolean
label_config:
description: Labeling Configuration
nullable: true
type: string
max_additional_annotators_assignable:
description: Maximum additional annotators
nullable: true
type: integer
maximum_annotations:
description: Annotations per task
maximum: 2147483647
minimum: -2147483648
title: Maximum annotation number
type: integer
min_annotations_to_start_training:
description: Minimum number of completed tasks after which model training is started
maximum: 2147483647
minimum: -2147483648
type: integer
model_version:
description: Machine learning model version
nullable: true
type: string
num_tasks_with_annotations:
description: Tasks with annotations count
readOnly: true
type: integer
organization:
nullable: true
type: integer
overlap_cohort_percentage:
description: Annotations per task coverage
maximum: 2147483647
minimum: -2147483648
type: integer
parsed_label_config:
additionalProperties: true
description: JSON-formatted labeling configuration
readOnly: true
type: object
pause_on_failed_annotator_evaluation:
default: false
description: Pause annotator on failed evaluation
nullable: true
type: boolean
pinned_at:
description: Pinned date and time
format: date-time
nullable: true
type: string
prompts:
readOnly: true
type: string
queue_done:
readOnly: true
type: integer
queue_total:
readOnly: true
type: integer
require_comment_on_skip:
default: false
description: Require comment to skip
type: boolean
reveal_preannotations_interactively:
description: Reveal pre-annotations interactively
type: boolean
review_settings:
$ref: '#/components/schemas/ReviewSettings'
sampling:
allOf:
- $ref: '#/components/schemas/SamplingDe5Enum'
nullable: true
show_annotation_history:
description: Show Data Manager to Annotators
type: boolean
show_collab_predictions:
description: Use predictions to pre-label Tasks
title: Show predictions to annotator
type: boolean
show_ground_truth_first:
deprecated: true
description: 'Onboarding mode (true): show ground truth tasks first in the labeling stream'
type: boolean
show_instruction:
description: Show instructions before labeling
type: boolean
show_overlap_first:
description: Show tasks with overlap first
type: boolean
show_skip_button:
description: Allow skipping tasks
type: boolean
show_unused_data_columns_to_annotators:
description: '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.'
nullable: true
type: boolean
skip_queue:
allOf:
- $ref: '#/components/schemas/SkipQueueEnum'
nullable: true
skipped_annotations_number:
description: Skipped by collaborators annotation number in project
readOnly: true
type: integer
start_training_on_annotation_update:
description: Start model training after any annotations are submitted or updated
readOnly: true
type: boolean
state:
readOnly: true
type: string
strict_task_overlap:
default: true
description: Enforce strict overlap limit
type: boolean
task_data_login:
description: Login
maxLength: 256
nullable: true
type: string
task_data_password:
description: Password
maxLength: 256
nullable: true
type: string
task_number:
description: Total task number in project
readOnly: true
type: integer
title:
description: Project Name
maxLength: 50
minLength: 3
nullable: true
type: string
total_annotations_number:
description: Total annotations number in project including skipped_annotations_number and ground_truth_number.
readOnly: true
type: integer
total_predictions_number:
description: Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
readOnly: true
type: integer
useful_annotation_number:
description: Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
readOnly: true
type: integer
workspace:
description: Workspace
type: integer
workspace_title:
readOnly: true
type: string
required:
- assignment_settings
- config_has_control_tags
- config_suitable_for_bulk_annotation
- created_at
- finished_task_number
- ground_truth_number
- id
- num_tasks_with_annotations
- parsed_label_config
- prompts
- queue_done
- queue_total
- review_settings
- skipped_annotations_number
- start_training_on_annotation_update
- state
- task_number
- total_annotations_number
- total_predictions_number
- useful_annotation_number
- workspace
- workspace_title
type: object
LseS3ExportStorage:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
external_id:
description: AWS ExternalId
nullable: true
title: ExternalID
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
legacy_auth:
nullable: true
type: boolean
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
role_arn:
description: AWS RoleArn
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: s3s
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- role_arn
- type
type: object
LseS3ExportStorageRequest:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
description:
description: Cloud storage description
nullable: true
type: string
external_id:
description: AWS ExternalId
nullable: true
title: ExternalID
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
legacy_auth:
nullable: true
type: boolean
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
role_arn:
description: AWS RoleArn
minLength: 1
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- project
- role_arn
type: object
LseS3ImportStorage:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
external_id:
description: AWS ExternalId
nullable: true
title: ExternalID
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
legacy_auth:
nullable: true
type: boolean
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
role_arn:
description: AWS RoleArn
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: s3s
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- role_arn
- type
type: object
LseS3ImportStorageRequest:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
external_id:
description: AWS ExternalId
nullable: true
title: ExternalID
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
legacy_auth:
nullable: true
type: boolean
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
role_arn:
description: AWS RoleArn
minLength: 1
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- project
- role_arn
type: object
LseTask:
description: Data Manager Task Serializer with FSM state support.
properties:
agreement:
readOnly: true
type: string
agreement_selected:
readOnly: true
type: string
allow_skip:
description: Whether this task can be skipped. Set to False to make task unskippable.
nullable: true
type: boolean
annotation_time:
description: |-
Calculate total annotation time for this task from MetricInTimeBucket records.
Returns time in seconds.
readOnly: true
type: integer
annotations:
readOnly: true
type: string
annotations_ids:
readOnly: true
type: string
annotations_results:
readOnly: true
type: string
annotators:
description: Annotators IDs who annotated this task
items:
title: User IDs
type: integer
readOnly: true
title: Annotators IDs
type: array
annotators_count:
description: The annotators_count is calculated as the number of users with annotations (can be repeated, so same as the number of annotations) + the number of assignees without annotations.
readOnly: true
type: integer
avg_lead_time:
format: double
type: number
cancelled_annotations:
type: integer
comment_authors:
items:
additionalProperties: {}
type: object
readOnly: true
type: array
comment_authors_count:
readOnly: true
type: integer
comment_count:
description: Number of comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
comments:
readOnly: true
type: string
completed_at:
format: date-time
type: string
created_at:
description: Time a task was created
format: date-time
readOnly: true
type: string
data:
description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
draft_exists:
type: boolean
drafts:
description: Drafts for this task
items:
properties:
created_at:
format: date-time
title: Creation time
type: string
result:
items:
title: Draft result item
type: object
title: Draft result
type: array
updated_at:
format: date-time
title: Last update time
type: string
title: Draft object
type: object
readOnly: true
title: Annotation drafts
type: array
file_upload:
readOnly: true
type: string
ground_truth:
type: boolean
id:
readOnly: true
type: integer
inner_id:
type: integer
is_labeled:
description: True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
type: boolean
last_comment_updated_at:
description: When the last comment was updated
format: date-time
nullable: true
type: string
meta:
description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
nullable: true
overlap:
description: Number of distinct annotators that processed the current task
maximum: 2147483647
minimum: -2147483648
type: integer
precomputed_agreement:
description: Average agreement score for the task
format: double
nullable: true
type: number
predictions:
description: Predictions for this task
items:
properties:
created_at:
format: date-time
title: Creation time
type: string
model:
title: ML Backend instance
type: object
model_run:
title: Model Run instance
type: object
model_version:
title: Model version
type: string
project:
title: Project ID related to the prediction
type: integer
result:
items:
title: Prediction result item
type: object
title: Prediction result
type: array
score:
title: Prediction score
type: number
task:
title: Task ID related to the prediction
type: integer
updated_at:
format: date-time
title: Last update time
type: string
title: Prediction object
type: object
readOnly: true
title: Predictions
type: array
predictions_model_versions:
readOnly: true
type: string
predictions_results:
readOnly: true
type: string
predictions_score:
format: double
type: number
project:
description: Project ID for this task
nullable: true
type: integer
review_time:
description: |-
Calculate total review time for this task from MetricInTimeBucket records.
Returns time in seconds.
readOnly: true
type: integer
reviewed:
type: boolean
reviewers:
items:
additionalProperties: {}
type: object
readOnly: true
type: array
reviewers_count:
readOnly: true
type: integer
reviews_accepted:
type: integer
reviews_rejected:
type: integer
state:
readOnly: true
type: string
storage_filename:
readOnly: true
type: string
total_annotations:
type: integer
total_predictions:
type: integer
unresolved_comment_count:
description: Number of unresolved comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
updated_at:
description: Last time a task was updated
format: date-time
readOnly: true
type: string
updated_by:
description: User IDs who updated this task
items:
title: User IDs
type: object
readOnly: true
title: User IDs
type: array
required:
- agreement
- agreement_selected
- annotation_time
- annotations
- annotations_ids
- annotations_results
- annotators
- annotators_count
- comment_authors
- comment_authors_count
- comments
- created_at
- data
- drafts
- file_upload
- id
- predictions
- predictions_model_versions
- predictions_results
- review_time
- reviewers
- reviewers_count
- state
- storage_filename
- updated_at
- updated_by
type: object
LseTaskFilterOptions:
properties:
annotated:
allOf:
- $ref: '#/components/schemas/AnnotatedEnum'
description: |-
`only` - include all tasks with at least one not skipped annotation
`exclude` - exclude all tasks with at least one not skipped annotation
* `only` - only
* `exclude` - exclude
* `None` - None
nullable: true
finished:
allOf:
- $ref: '#/components/schemas/FinishedEnum'
description: |-
`only` - include all finished tasks (is_labeled = true)
`exclude` - exclude all finished tasks
* `only` - only
* `exclude` - exclude
* `None` - None
nullable: true
only_with_annotations:
default: false
type: boolean
reviewed:
allOf:
- $ref: '#/components/schemas/ReviewedEnum'
description: |-
`only` - include all reviewed tasks
`exclude` - exclude all reviewed tasks
* `only` - only
* `exclude` - exclude
* `None` - None
nullable: true
skipped:
allOf:
- $ref: '#/components/schemas/SkippedEnum'
description: |-
`only` - include all tasks with skipped annotations
`exclude` - exclude all tasks with skipped annotations
* `only` - only
* `exclude` - exclude
* `None` - None
nullable: true
view:
description: Apply filters from the view ID (a tab from the Data Manager)
type: integer
type: object
LseTaskFilterOptionsRequest:
properties:
annotated:
allOf:
- $ref: '#/components/schemas/AnnotatedEnum'
description: |-
`only` - include all tasks with at least one not skipped annotation
`exclude` - exclude all tasks with at least one not skipped annotation
* `only` - only
* `exclude` - exclude
* `None` - None
nullable: true
finished:
allOf:
- $ref: '#/components/schemas/FinishedEnum'
description: |-
`only` - include all finished tasks (is_labeled = true)
`exclude` - exclude all finished tasks
* `only` - only
* `exclude` - exclude
* `None` - None
nullable: true
only_with_annotations:
default: false
type: boolean
reviewed:
allOf:
- $ref: '#/components/schemas/ReviewedEnum'
description: |-
`only` - include all reviewed tasks
`exclude` - exclude all reviewed tasks
* `only` - only
* `exclude` - exclude
* `None` - None
nullable: true
skipped:
allOf:
- $ref: '#/components/schemas/SkippedEnum'
description: |-
`only` - include all tasks with skipped annotations
`exclude` - exclude all tasks with skipped annotations
* `only` - only
* `exclude` - exclude
* `None` - None
nullable: true
view:
description: Apply filters from the view ID (a tab from the Data Manager)
type: integer
type: object
LseTaskRequest:
description: Task Serializer with project scheme configs validation
properties:
allow_skip:
description: Whether this task can be skipped. Set to False to make task unskippable.
nullable: true
type: boolean
cancelled_annotations:
description: Number of total cancelled annotations for the current task
maximum: 2147483647
minimum: -2147483648
type: integer
comment_authors:
description: Users who wrote comments
items:
type: integer
type: array
comment_count:
description: Number of comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
data:
description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
file_upload:
description: Uploaded file used as data source for this task
nullable: true
type: integer
inner_id:
description: Internal task ID in the project, starts with 1
format: int64
maximum: 9223372036854775807
minimum: -9223372036854775808
nullable: true
type: integer
is_labeled:
description: True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
type: boolean
last_comment_updated_at:
description: When the last comment was updated
format: date-time
nullable: true
type: string
meta:
description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
nullable: true
overlap:
description: Number of distinct annotators that processed the current task
maximum: 2147483647
minimum: -2147483648
type: integer
project:
description: Project ID for this task
nullable: true
type: integer
total_annotations:
description: Number of total annotations for the current task except cancelled annotations
maximum: 2147483647
minimum: -2147483648
type: integer
total_predictions:
description: Number of total predictions for the current task
maximum: 2147483647
minimum: -2147483648
type: integer
unresolved_comment_count:
description: Number of unresolved comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
updated_by:
description: Last annotator or reviewer who updated this task
nullable: true
type: integer
required:
- data
type: object
LseTaskSerializerForAnnotators:
description: Data Manager Task Serializer with FSM state support.
properties:
annotations:
default: []
readOnly: true
type: string
annotations_results:
readOnly: true
type: string
cancelled_annotations:
type: integer
comment_count:
readOnly: true
type: string
comments:
readOnly: true
type: string
created_at:
description: Time a task was created
format: date-time
readOnly: true
type: string
data:
description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
draft_exists:
type: boolean
drafts:
description: Drafts for this task
items:
properties:
created_at:
format: date-time
title: Creation time
type: string
result:
items:
title: Draft result item
type: object
title: Draft result
type: array
updated_at:
format: date-time
title: Last update time
type: string
title: Draft object
type: object
readOnly: true
title: Annotation drafts
type: array
id:
readOnly: true
type: integer
predictions:
description: Predictions for this task
items:
properties:
created_at:
format: date-time
title: Creation time
type: string
model:
title: ML Backend instance
type: object
model_run:
title: Model Run instance
type: object
model_version:
title: Model version
type: string
project:
title: Project ID related to the prediction
type: integer
result:
items:
title: Prediction result item
type: object
title: Prediction result
type: array
score:
title: Prediction score
type: number
task:
title: Task ID related to the prediction
type: integer
updated_at:
format: date-time
title: Last update time
type: string
title: Prediction object
type: object
readOnly: true
title: Predictions
type: array
predictions_results:
readOnly: true
type: string
predictions_score:
format: double
type: number
reviews_rejected:
type: integer
state:
readOnly: true
type: string
total_annotations:
type: integer
total_predictions:
type: integer
unresolved_comment_count:
readOnly: true
type: string
required:
- annotations
- annotations_results
- comment_count
- comments
- created_at
- data
- drafts
- id
- predictions
- predictions_results
- state
- unresolved_comment_count
type: object
LseTaskSerializerForReviewers:
description: Data Manager Task Serializer with FSM state support.
properties:
agreement:
readOnly: true
type: string
agreement_selected:
readOnly: true
type: string
allow_skip:
description: Whether this task can be skipped. Set to False to make task unskippable.
nullable: true
type: boolean
annotation_time:
description: |-
Calculate total annotation time for this task from MetricInTimeBucket records.
Returns time in seconds.
readOnly: true
type: integer
annotations:
readOnly: true
type: string
annotations_ids:
readOnly: true
type: string
annotations_results:
readOnly: true
type: string
annotators:
description: Annotators IDs who annotated this task
items:
title: User IDs
type: integer
readOnly: true
title: Annotators IDs
type: array
annotators_count:
description: The annotators_count is calculated as the number of users with annotations (can be repeated, so same as the number of annotations) + the number of assignees without annotations.
readOnly: true
type: integer
avg_lead_time:
format: double
type: number
cancelled_annotations:
type: integer
comment_authors:
items:
additionalProperties: {}
type: object
readOnly: true
type: array
comment_authors_count:
readOnly: true
type: integer
comment_count:
description: Number of comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
comments:
readOnly: true
type: string
completed_at:
format: date-time
type: string
created_at:
description: Time a task was created
format: date-time
readOnly: true
type: string
data:
description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
draft_exists:
type: boolean
drafts:
description: Drafts for this task
items:
properties:
created_at:
format: date-time
title: Creation time
type: string
result:
items:
title: Draft result item
type: object
title: Draft result
type: array
updated_at:
format: date-time
title: Last update time
type: string
title: Draft object
type: object
readOnly: true
title: Annotation drafts
type: array
file_upload:
readOnly: true
type: string
ground_truth:
type: boolean
id:
readOnly: true
type: integer
inner_id:
type: integer
is_labeled:
description: True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
type: boolean
last_comment_updated_at:
description: When the last comment was updated
format: date-time
nullable: true
type: string
meta:
description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
nullable: true
overlap:
description: Number of distinct annotators that processed the current task
maximum: 2147483647
minimum: -2147483648
type: integer
precomputed_agreement:
description: Average agreement score for the task
format: double
nullable: true
type: number
predictions:
description: Predictions for this task
items:
properties:
created_at:
format: date-time
title: Creation time
type: string
model:
title: ML Backend instance
type: object
model_run:
title: Model Run instance
type: object
model_version:
title: Model version
type: string
project:
title: Project ID related to the prediction
type: integer
result:
items:
title: Prediction result item
type: object
title: Prediction result
type: array
score:
title: Prediction score
type: number
task:
title: Task ID related to the prediction
type: integer
updated_at:
format: date-time
title: Last update time
type: string
title: Prediction object
type: object
readOnly: true
title: Predictions
type: array
predictions_model_versions:
readOnly: true
type: string
predictions_results:
readOnly: true
type: string
predictions_score:
format: double
type: number
project:
description: Project ID for this task
nullable: true
type: integer
review_time:
description: |-
Calculate total review time for this task from MetricInTimeBucket records.
Returns time in seconds.
readOnly: true
type: integer
reviewed:
type: boolean
reviewers:
items:
additionalProperties: {}
type: object
readOnly: true
type: array
reviewers_count:
readOnly: true
type: integer
reviews_accepted:
type: integer
reviews_rejected:
type: integer
state:
readOnly: true
type: string
storage_filename:
readOnly: true
type: string
total_annotations:
type: integer
total_predictions:
type: integer
unresolved_comment_count:
description: Number of unresolved comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
updated_at:
description: Last time a task was updated
format: date-time
readOnly: true
type: string
updated_by:
description: User IDs who updated this task
items:
title: User IDs
type: object
readOnly: true
title: User IDs
type: array
required:
- agreement
- agreement_selected
- annotation_time
- annotations
- annotations_ids
- annotations_results
- annotators
- annotators_count
- comment_authors
- comment_authors_count
- comments
- created_at
- data
- drafts
- file_upload
- id
- predictions
- predictions_model_versions
- predictions_results
- review_time
- reviewers
- reviewers_count
- state
- storage_filename
- updated_at
- updated_by
type: object
LseUser:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
active_organization:
nullable: true
type: integer
active_organization_meta:
readOnly: true
type: string
allow_newsletters:
description: Allow sending newsletters to user
nullable: true
type: boolean
avatar:
readOnly: true
type: string
custom_hotkeys:
description: Custom keyboard shortcuts configuration for the user interface
nullable: true
date_joined:
format: date-time
type: string
email:
format: email
maxLength: 254
title: Email address
type: string
first_name:
maxLength: 256
type: string
id:
readOnly: true
type: integer
initials:
default: '?'
readOnly: true
type: string
last_activity:
format: date-time
readOnly: true
type: string
last_name:
maxLength: 256
type: string
lse_fields:
allOf:
- $ref: '#/components/schemas/LseFields'
readOnly: true
org_membership:
deprecated: true
items:
$ref: '#/components/schemas/OrganizationMembership'
readOnly: true
type: array
organization_membership:
allOf:
- $ref: '#/components/schemas/OrganizationMembership'
readOnly: true
pause:
readOnly: true
type: string
phone:
maxLength: 256
type: string
username:
maxLength: 256
type: string
required:
- active_organization_meta
- avatar
- id
- initials
- last_activity
- lse_fields
- org_membership
- organization_membership
- pause
- username
type: object
LseUserAPI:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
active_organization:
nullable: true
type: integer
active_organization_meta:
readOnly: true
type: string
allow_newsletters:
description: Allow sending newsletters to user
nullable: true
type: boolean
avatar:
readOnly: true
type: string
custom_hotkeys:
description: Custom keyboard shortcuts configuration for the user interface
nullable: true
date_joined:
format: date-time
type: string
email:
format: email
maxLength: 254
title: Email address
type: string
first_name:
maxLength: 256
type: string
id:
readOnly: true
type: integer
initials:
default: '?'
readOnly: true
type: string
last_activity:
format: date-time
readOnly: true
type: string
last_name:
maxLength: 256
type: string
org_membership:
deprecated: true
items:
$ref: '#/components/schemas/OrganizationMembership'
readOnly: true
type: array
organization_membership:
allOf:
- $ref: '#/components/schemas/OrganizationMembership'
readOnly: true
phone:
maxLength: 256
type: string
username:
maxLength: 256
type: string
required:
- active_organization_meta
- avatar
- id
- initials
- last_activity
- org_membership
- organization_membership
- username
type: object
LseUserOrganizationMemberList:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
active_organization:
nullable: true
type: integer
allow_newsletters:
description: Allow sending newsletters to user
nullable: true
type: boolean
avatar:
readOnly: true
type: string
contributed_to_projects:
deprecated: true
items:
properties:
id:
type: integer
title:
type: string
required:
- id
- title
type: object
nullable: true
readOnly: true
type: array
created_projects:
deprecated: true
items:
properties:
id:
type: integer
title:
type: string
required:
- id
- title
type: object
nullable: true
readOnly: true
type: array
custom_hotkeys:
description: Custom keyboard shortcuts configuration for the user interface
nullable: true
date_joined:
format: date-time
type: string
email:
format: email
maxLength: 254
title: Email address
type: string
first_name:
maxLength: 256
type: string
id:
readOnly: true
type: integer
initials:
default: '?'
readOnly: true
type: string
last_activity:
format: date-time
readOnly: true
type: string
last_name:
maxLength: 256
type: string
lse_fields:
allOf:
- $ref: '#/components/schemas/LseFields'
readOnly: true
pause:
readOnly: true
type: string
phone:
maxLength: 256
type: string
username:
maxLength: 256
type: string
required:
- avatar
- contributed_to_projects
- created_projects
- id
- initials
- last_activity
- lse_fields
- pause
- username
type: object
MLBackend:
description: Serializer for MLBackend model.
properties:
auth_method:
$ref: '#/components/schemas/AuthMethodEnum'
auto_update:
description: If false, model version is set by the user, if true - getting latest version from backend.
type: boolean
basic_auth_pass_is_set:
readOnly: true
type: boolean
basic_auth_user:
description: HTTP Basic Auth user
nullable: true
type: string
created_at:
format: date-time
readOnly: true
type: string
description:
description: Description for the machine learning backend
nullable: true
type: string
error_message:
description: Error message in error state
nullable: true
type: string
extra_params:
description: Any extra parameters passed to the ML Backend during the setup
nullable: true
id:
readOnly: true
type: integer
is_interactive:
description: Used to interactively annotate tasks. If true, model returns one list with results
type: boolean
model_version:
description: Current model version associated with this machine learning backend
nullable: true
type: string
project:
type: integer
readable_state:
readOnly: true
type: string
state:
$ref: '#/components/schemas/StateEnum'
timeout:
description: Response model timeout
format: double
type: number
title:
description: Name of the machine learning backend
nullable: true
type: string
updated_at:
format: date-time
readOnly: true
type: string
url:
description: URL for the machine learning model server
type: string
required:
- basic_auth_pass_is_set
- created_at
- id
- project
- readable_state
- updated_at
- url
type: object
MLBackendRequest:
description: Serializer for MLBackend model.
properties:
auth_method:
$ref: '#/components/schemas/AuthMethodEnum'
auto_update:
description: If false, model version is set by the user, if true - getting latest version from backend.
type: boolean
basic_auth_pass:
nullable: true
type: string
writeOnly: true
basic_auth_user:
description: HTTP Basic Auth user
nullable: true
type: string
description:
description: Description for the machine learning backend
nullable: true
type: string
error_message:
description: Error message in error state
nullable: true
type: string
extra_params:
description: Any extra parameters passed to the ML Backend during the setup
nullable: true
is_interactive:
description: Used to interactively annotate tasks. If true, model returns one list with results
type: boolean
model_version:
description: Current model version associated with this machine learning backend
nullable: true
type: string
project:
type: integer
state:
$ref: '#/components/schemas/StateEnum'
timeout:
description: Response model timeout
format: double
type: number
title:
description: Name of the machine learning backend
nullable: true
type: string
url:
description: URL for the machine learning model server
minLength: 1
type: string
required:
- project
- url
type: object
MLInteractiveAnnotatingRequestRequest:
description: Serializer for ML interactive annotating request.
properties:
context:
description: Context for ML model
nullable: true
task:
description: ID of task to annotate
type: integer
required:
- task
type: object
MaybeExpandedComment:
oneOf:
- $ref: '#/components/schemas/Comment'
- $ref: '#/components/schemas/CommentSerializerWithExpandedUser'
MetricParam:
properties:
agreement_threshold:
deprecated: true
readOnly: true
type: string
allowed:
readOnly: true
type: string
max_additional_annotators_assignable:
deprecated: true
description: Maximum number of additional annotators that can be assigned to a low agreement task
maximum: 2147483647
minimum: -2147483648
nullable: true
title: Maximum new annotators added
type: integer
metric_name:
description: Evaluation metric chosen for this project
nullable: true
type: string
metric_params:
nullable: true
required:
- agreement_threshold
- allowed
type: object
MetricParamUpdateRequest:
properties:
additional_params:
additionalProperties: {}
description: Agreement metric parameters
nullable: true
type: object
agreement_threshold:
deprecated: true
maximum: 100
minimum: 0
type: integer
max_additional_annotators_assignable:
deprecated: true
minimum: 0
type: integer
metric_name:
description: Agreement metric
minLength: 1
type: string
type: object
ModeEnum:
description: |-
* `settings` - Only settings
* `settings,data` - Settings and tasks
enum:
- settings
- settings,data
type: string
ModelInterface:
properties:
associated_projects:
items:
type: integer
type: array
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
description: User who created Dataset
description:
description: Model description
nullable: true
type: string
id:
readOnly: true
type: integer
input_fields: {}
organization:
nullable: true
type: integer
output_classes: {}
skill_name:
allOf:
- $ref: '#/components/schemas/SkillNameEnum'
default: TextClassification
title:
description: Model name
maxLength: 500
type: string
updated_at:
format: date-time
readOnly: true
type: string
required:
- created_at
- id
- title
- updated_at
type: object
ModelInterfaceRequest:
properties:
associated_projects:
items:
type: integer
type: array
created_by:
allOf:
- $ref: '#/components/schemas/UserSimpleRequest'
description: User who created Dataset
description:
description: Model description
nullable: true
type: string
input_fields: {}
organization:
nullable: true
type: integer
output_classes: {}
skill_name:
allOf:
- $ref: '#/components/schemas/SkillNameEnum'
default: TextClassification
title:
description: Model name
maxLength: 500
minLength: 1
type: string
required:
- title
type: object
ModelInterfaceSerializerGET:
properties:
associated_projects:
default: []
items:
$ref: '#/components/schemas/AssociatedProject'
type: array
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
description: User who created Dataset
description:
description: Model description
nullable: true
type: string
id:
readOnly: true
type: integer
input_fields: {}
organization:
nullable: true
type: integer
output_classes: {}
skill_name:
allOf:
- $ref: '#/components/schemas/SkillNameEnum'
default: TextClassification
title:
description: Model name
maxLength: 500
type: string
updated_at:
format: date-time
readOnly: true
type: string
required:
- created_at
- id
- title
- updated_at
type: object
ModelProviderConnection:
properties:
budget_alert_threshold:
description: Budget alert threshold for the given provider connection
format: double
nullable: true
type: number
budget_last_reset_date:
description: Date and time the budget was last reset
format: date-time
nullable: true
readOnly: true
type: string
budget_limit:
description: Budget limit for the model provider connection (null if unlimited)
format: double
nullable: true
readOnly: true
type: number
budget_reset_period:
allOf:
- $ref: '#/components/schemas/BudgetResetPeriodEnum'
description: |-
Budget reset period for the model provider connection (null if not reset)
* `Monthly` - Monthly
* `Yearly` - Yearly
nullable: true
readOnly: true
budget_total_spent:
description: Tracked total budget spent for the given provider connection within the current budget period
format: double
nullable: true
readOnly: true
type: number
cached_available_models:
description: List of available models from the provider
maxLength: 4096
nullable: true
type: string
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
readOnly: true
deployment_name:
description: Azure OpenAI deployment name
maxLength: 512
nullable: true
type: string
endpoint:
description: Azure OpenAI endpoint
maxLength: 512
nullable: true
type: string
google_location:
description: Google project location
maxLength: 255
nullable: true
type: string
google_project_id:
description: Google project ID
maxLength: 255
nullable: true
type: string
id:
readOnly: true
type: integer
is_internal:
description: Whether the model provider connection is internal, not visible to the user
nullable: true
type: boolean
model_params:
description: JSON schema for the model parameters available for the provider
readOnly: true
type: string
organization:
nullable: true
readOnly: true
type: integer
provider:
$ref: '#/components/schemas/ProviderEnum'
scope:
$ref: '#/components/schemas/ScopeEnum'
updated_at:
format: date-time
readOnly: true
type: string
required:
- budget_last_reset_date
- budget_limit
- budget_reset_period
- budget_total_spent
- created_at
- created_by
- id
- model_params
- organization
- updated_at
type: object
ModelProviderConnectionRequest:
properties:
api_key:
description: Model provider API key
nullable: true
type: string
writeOnly: true
auth_token:
description: Model provider Auth token
nullable: true
type: string
writeOnly: true
budget_alert_threshold:
description: Budget alert threshold for the given provider connection
format: double
nullable: true
type: number
cached_available_models:
description: List of available models from the provider
maxLength: 4096
nullable: true
type: string
deployment_name:
description: Azure OpenAI deployment name
maxLength: 512
nullable: true
type: string
endpoint:
description: Azure OpenAI endpoint
maxLength: 512
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
writeOnly: true
google_location:
description: Google project location
maxLength: 255
nullable: true
type: string
google_project_id:
description: Google project ID
maxLength: 255
nullable: true
type: string
is_internal:
description: Whether the model provider connection is internal, not visible to the user
nullable: true
type: boolean
provider:
$ref: '#/components/schemas/ProviderEnum'
scope:
$ref: '#/components/schemas/ScopeEnum'
type: object
ModelRun:
properties:
completed_at:
format: date-time
nullable: true
readOnly: true
type: string
created_at:
format: date-time
readOnly: true
type: string
created_by:
nullable: true
readOnly: true
type: integer
id:
readOnly: true
type: integer
job_id:
description: Job ID for inference job for a ModelRun e.g. Adala job ID
maxLength: 255
nullable: true
type: string
organization:
nullable: true
type: integer
parent_model:
readOnly: true
type: integer
predictions_updated_at:
format: date-time
nullable: true
type: string
project:
type: integer
project_subset:
$ref: '#/components/schemas/ProjectSubsetEnum'
status:
allOf:
- $ref: '#/components/schemas/ModelRunStatusEnum'
readOnly: true
total_correct_predictions:
maximum: 2147483647
minimum: -2147483648
type: integer
total_predictions:
maximum: 2147483647
minimum: -2147483648
type: integer
total_tasks:
maximum: 2147483647
minimum: -2147483648
type: integer
triggered_at:
format: date-time
nullable: true
readOnly: true
type: string
required:
- completed_at
- created_at
- created_by
- id
- parent_model
- project
- status
- triggered_at
type: object
ModelRunRequest:
properties:
job_id:
description: Job ID for inference job for a ModelRun e.g. Adala job ID
maxLength: 255
nullable: true
type: string
only_missing_predictions:
default: false
description: When true, only tasks without successful predictions for this prompt version are submitted for inference.
type: boolean
writeOnly: true
organization:
nullable: true
type: integer
predictions_updated_at:
format: date-time
nullable: true
type: string
project:
type: integer
project_subset:
$ref: '#/components/schemas/ProjectSubsetEnum'
total_correct_predictions:
maximum: 2147483647
minimum: -2147483648
type: integer
total_predictions:
maximum: 2147483647
minimum: -2147483648
type: integer
total_tasks:
maximum: 2147483647
minimum: -2147483648
type: integer
required:
- project
type: object
ModelRunStatusEnum:
description: |-
* `Pending` - Pending
* `InProgress` - InProgress
* `Completed` - Completed
* `Failed` - Failed
* `Canceled` - Canceled
enum:
- Pending
- InProgress
- Completed
- Failed
- Canceled
type: string
OnboardingStateEnum:
description: |-
* `not_started` - Not Started
* `signup` - Signup
* `trial_signup` - Trial Signup
* `first_tutorial` - First Tutorial
* `in_app_guidance` - In App Guidance
* `complete` - Complete
enum:
- not_started
- signup
- trial_signup
- first_tutorial
- in_app_guidance
- complete
type: string
Options165Enum:
enum:
- OW
- AD
- MA
- RE
- AN
- DI
- 'NO'
type: string
OrganizationBilling:
properties:
enforce_session_concurrency:
readOnly: true
type: string
manual_role_management:
readOnly: true
type: string
manual_workspace_management:
readOnly: true
type: string
max_parallel_sessions:
readOnly: true
type: string
session_concurrency_window_seconds:
readOnly: true
type: string
required:
- enforce_session_concurrency
- manual_role_management
- manual_workspace_management
- max_parallel_sessions
- session_concurrency_window_seconds
type: object
OrganizationId:
description: |-
A serializer mixin that takes an additional `fields` argument that controls
which fields should be displayed.
properties:
contact_info:
format: email
maxLength: 254
nullable: true
type: string
created_at:
format: date-time
readOnly: true
type: string
id:
readOnly: true
type: integer
title:
maxLength: 1000
title: Organization title
type: string
required:
- created_at
- id
- title
type: object
OrganizationInvite:
properties:
invite_url:
type: string
token:
type: string
type: object
OrganizationMember:
description: |-
A serializer mixin that takes an additional `fields` argument that controls
which fields should be displayed.
properties:
annotations_count:
readOnly: true
type: integer
contributed_projects_count:
readOnly: true
type: integer
contributed_to_projects:
items:
properties:
id:
type: integer
title:
type: string
required:
- id
- title
type: object
nullable: true
readOnly: true
type: array
created_at:
format: date-time
readOnly: true
type: string
created_projects:
items:
properties:
id:
type: integer
title:
type: string
required:
- id
- title
type: object
nullable: true
readOnly: true
type: array
organization:
description: Organization ID
type: integer
user:
description: User ID
type: integer
required:
- annotations_count
- contributed_projects_count
- contributed_to_projects
- created_at
- created_projects
- organization
- user
type: object
OrganizationMemberTag:
properties:
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
readOnly: true
id:
readOnly: true
type: integer
label:
description: Label
maxLength: 255
type: string
member_count:
readOnly: true
type: integer
organization:
readOnly: true
type: integer
updated_at:
format: date-time
readOnly: true
type: string
required:
- created_at
- created_by
- id
- label
- member_count
- organization
- updated_at
type: object
OrganizationMemberTagBulkCreateRequest:
description: Serializer for bulk create of organization member tags.
properties:
labels:
description: List of tag labels to create.
items:
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
required:
- labels
type: object
OrganizationMemberTagImportCreateRequest:
properties:
bulk_tags:
type: string
file:
format: binary
type: string
required:
- bulk_tags
- file
type: object
OrganizationMemberTagImportStatus:
description: Serializer for the status of a member tag import job.
properties:
assignments_created:
maximum: 2147483647
minimum: -2147483648
type: integer
created_at:
format: date-time
readOnly: true
type: string
finished_at:
format: date-time
nullable: true
type: string
id:
readOnly: true
type: integer
status:
$ref: '#/components/schemas/OrganizationMemberTagImportStatusStatusEnum'
tags_created:
maximum: 2147483647
minimum: -2147483648
type: integer
users_skipped: {}
required:
- created_at
- id
type: object
OrganizationMemberTagImportStatusStatusEnum:
description: |-
* `created` - Created
* `in_progress` - In Progress
* `completed` - Completed
* `failed` - Failed
enum:
- created
- in_progress
- completed
- failed
type: string
OrganizationMemberTagRequest:
properties:
label:
description: Label
maxLength: 255
minLength: 1
type: string
required:
- label
type: object
OrganizationMembership:
properties:
active:
readOnly: true
type: string
organization_id:
description: Organization ID
readOnly: true
type: integer
role:
type: string
required:
- active
- organization_id
- role
type: object
OrganizationMembershipRequest:
properties:
role:
minLength: 1
type: string
required:
- role
type: object
OrganizationPermission:
properties:
default:
items:
$ref: '#/components/schemas/Default165Enum'
readOnly: true
type: array
group:
nullable: true
readOnly: true
type: string
id:
readOnly: true
type: integer
label:
nullable: true
readOnly: true
type: string
options:
items:
$ref: '#/components/schemas/Options165Enum'
readOnly: true
type: array
organization:
readOnly: true
type: integer
permission:
maxLength: 255
type: string
roles:
description: Organization roles
items:
$ref: '#/components/schemas/Role9e7Enum'
type: array
tooltip:
nullable: true
readOnly: true
type: string
required:
- default
- group
- id
- label
- options
- organization
- permission
- tooltip
type: object
OrganizationPermissionRequest:
properties:
permission:
maxLength: 255
minLength: 1
type: string
roles:
description: Organization roles
items:
$ref: '#/components/schemas/Role9e7Enum'
type: array
required:
- permission
type: object
PaginatedAllRolesProjectListList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/AllRolesProjectList'
type: array
required:
- count
- results
type: object
PaginatedAnnotationHistoryList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/AnnotationHistory'
type: array
required:
- count
- results
type: object
PaginatedLabelCreateList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/LabelCreate'
type: array
required:
- count
- results
type: object
PaginatedLabelLinkList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/LabelLink'
type: array
required:
- count
- results
type: object
PaginatedLabelList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/Label'
type: array
required:
- count
- results
type: object
PaginatedLseOrganizationMemberListList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/LseOrganizationMemberList'
type: array
required:
- count
- results
type: object
PaginatedLseProjectCountsList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/LseProjectCounts'
type: array
required:
- count
- results
type: object
PaginatedLseUserList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/LseUser'
type: array
required:
- count
- results
type: object
PaginatedOrganizationMemberTagList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/OrganizationMemberTag'
type: array
required:
- count
- results
type: object
PaginatedPaginatedProjectMemberList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/PaginatedProjectMember'
type: array
required:
- count
- results
type: object
PaginatedProjectMember:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
active_organization:
nullable: true
type: integer
active_organization_meta:
readOnly: true
type: string
allow_newsletters:
description: Allow sending newsletters to user
nullable: true
type: boolean
avatar:
readOnly: true
type: string
custom_hotkeys:
description: Custom keyboard shortcuts configuration for the user interface
nullable: true
date_joined:
format: date-time
type: string
email:
format: email
maxLength: 254
title: Email address
type: string
first_name:
maxLength: 256
type: string
id:
readOnly: true
type: integer
implicit_member:
readOnly: true
type: boolean
initials:
default: '?'
readOnly: true
type: string
last_activity:
format: date-time
readOnly: true
type: string
last_name:
maxLength: 256
type: string
lse_fields:
allOf:
- $ref: '#/components/schemas/LseFields'
readOnly: true
org_membership:
deprecated: true
items:
$ref: '#/components/schemas/OrganizationMembership'
readOnly: true
type: array
organization_membership:
allOf:
- $ref: '#/components/schemas/OrganizationMembership'
readOnly: true
pause:
readOnly: true
type: string
phone:
maxLength: 256
type: string
project_role:
readOnly: true
type: string
tags:
items:
$ref: '#/components/schemas/SimpleOrganizationMemberTag'
readOnly: true
type: array
username:
maxLength: 256
type: string
required:
- active_organization_meta
- avatar
- id
- implicit_member
- initials
- last_activity
- lse_fields
- org_membership
- organization_membership
- pause
- project_role
- tags
- username
type: object
PaginatedProjectSubsetTasksResponseList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/ProjectSubsetTasksResponse'
type: array
required:
- count
- results
type: object
PaginatedRoleBasedTaskList:
properties:
tasks:
items:
$ref: '#/components/schemas/RoleBasedTask'
type: array
total:
description: Total number of tasks
example: 123
type: integer
total_annotations:
description: Total number of annotations
example: 456
type: integer
total_predictions:
description: Total number of predictions
example: 78
type: integer
required:
- tasks
- total
- total_annotations
- total_predictions
type: object
PaginatedStateModelList:
properties:
count:
example: 123
type: integer
next:
example: http://api.example.org/accounts/?page=4
format: uri
nullable: true
type: string
previous:
example: http://api.example.org/accounts/?page=2
format: uri
nullable: true
type: string
results:
items:
$ref: '#/components/schemas/StateModel'
type: array
required:
- count
- results
type: object
PatchedAnalyticsViewRequest:
description: |-
Serializer for user-scoped analytics saved views.
The primary key is intentionally excluded; the ``uuid`` field is the only
stable public identifier exposed to callers.
``dashboard_type`` scopes views per dashboard: "overview" vs "member_performance".
properties:
dashboard_type:
$ref: '#/components/schemas/DashboardTypeEnum'
filters: {}
name:
maxLength: 255
minLength: 1
type: string
type: object
PatchedAnnotationReviewRequest:
description: |-
AnnotationReview Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
The state field display is controlled by both:
- fflag_feat_fit_568_finite_state_management (FSM background calculations)
- fflag_feat_fit_710_fsm_state_fields (state field display in APIs)
properties:
accepted:
description: Accepted or rejected (if false) flag
type: boolean
annotation:
description: Corresponding annotation
type: integer
comment:
minLength: 1
nullable: true
type: string
writeOnly: true
last_annotation_history:
nullable: true
type: integer
remove_from_queue:
nullable: true
type: boolean
result:
nullable: true
started_at:
format: date-time
nullable: true
type: string
type: object
PatchedAzureDatasetStorageRequest:
properties:
account_key:
description: Azure Blob account key
nullable: true
type: string
account_name:
description: Azure Blob account name
nullable: true
type: string
container:
description: Azure blob container
nullable: true
type: string
dataset:
description: A unique integer value identifying this dataset.
type: integer
description:
description: Cloud storage description
nullable: true
type: string
glob_pattern:
description: Glob pattern for syncing from bucket
nullable: true
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
recursive_scan:
description: Perform recursive scan over the container content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synced:
description: Flag if dataset has been previously synced or not
type: boolean
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
type: object
PatchedAzureServicePrincipalExportStorageRequest:
properties:
account_name:
description: Azure Blob account name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
client_id:
description: Azure Blob Service Principal Client ID
nullable: true
type: string
client_secret:
description: Azure Blob Service Principal Client Secret
nullable: true
type: string
container:
description: Azure blob container
nullable: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure Tenant ID
nullable: true
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
user_delegation_key:
description: User Delegation Key (Backend)
nullable: true
type: string
type: object
PatchedAzureServicePrincipalImportStorageRequest:
properties:
account_name:
description: Azure Blob account name
nullable: true
type: string
client_id:
description: Azure Blob Service Principal Client ID
nullable: true
type: string
client_secret:
description: Azure Blob Service Principal Client Secret
nullable: true
type: string
container:
description: Azure blob container
nullable: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Azure blob prefix name
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure Tenant ID
nullable: true
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
user_delegation_key:
description: User Delegation Key (Backend)
nullable: true
type: string
type: object
PatchedBlueprintUpdateRequest:
description: Serializer for updating a blueprint. Only title, description, and task_ids can be changed.
properties:
description:
description: Project description
nullable: true
type: string
task_ids:
items:
type: integer
maxItems: 100
type: array
writeOnly: true
title:
description: Blueprint name. Must be between 3 and 50 characters long.
maxLength: 50
nullable: true
type: string
type: object
PatchedCommentRequest:
description: |-
Comment Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
The state field display is controlled by both:
- fflag_feat_fit_568_finite_state_management (FSM background calculations)
- fflag_feat_fit_710_fsm_state_fields (state field display in APIs)
properties:
annotation:
nullable: true
type: integer
classifications:
description: Classifications applied by a reviewer or annotator
nullable: true
draft:
nullable: true
type: integer
is_resolved:
description: True if the comment is resolved
type: boolean
region_ref:
description: Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.
nullable: true
text:
description: Reviewer or annotator comment
nullable: true
type: string
type: object
PatchedDatabricksExportStorageRequest:
description: Serializer for Databricks export storage with multi-auth support.
properties:
auth_type:
allOf:
- $ref: '#/components/schemas/AuthTypeEnum'
default: pat
description: |-
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
catalog:
description: UC catalog name
minLength: 1
type: string
client_id:
description: Service principal client/application ID (required for SP modes)
type: string
client_secret:
description: Service principal client secret (required for SP modes)
type: string
writeOnly: true
description:
description: Cloud storage description
nullable: true
type: string
host:
description: Databricks workspace base URL (https://...)
minLength: 1
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Export path prefix under the volume
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Regex for filtering objects
nullable: true
type: string
request_timeout_s:
maximum: 2147483647
minimum: 0
type: integer
schema:
description: UC schema name
minLength: 1
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
stream_chunk_bytes:
maximum: 2147483647
minimum: 0
type: integer
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure AD tenant ID (required for Azure AD SP mode)
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
token:
description: Databricks personal access token (required for PAT mode)
type: string
writeOnly: true
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Generate blob URLs in tasks
type: boolean
verify_tls:
description: Verify TLS certificates
type: boolean
volume:
description: UC volume name
minLength: 1
type: string
type: object
PatchedDatabricksImportStorageRequest:
description: Serializer for Databricks import storage with multi-auth support.
properties:
auth_type:
allOf:
- $ref: '#/components/schemas/AuthTypeEnum'
default: pat
description: |-
Authentication method: PAT, Databricks SP, or Azure AD SP
* `pat` - Personal Access Token
* `dbx_sp` - Databricks Service Principal
* `azure_ad_sp` - Azure AD Service Principal
catalog:
description: UC catalog name
minLength: 1
type: string
client_id:
description: Service principal client/application ID (required for SP modes)
type: string
client_secret:
description: Service principal client secret (required for SP modes)
type: string
writeOnly: true
description:
description: Cloud storage description
nullable: true
type: string
host:
description: Databricks workspace base URL (https://...)
minLength: 1
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: Path under the volume
nullable: true
type: string
presign:
description: Presign not supported; always proxied
type: boolean
presign_ttl:
description: Unused for Databricks; kept for compatibility
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan
type: boolean
regex_filter:
description: Regex for filtering objects
nullable: true
type: string
request_timeout_s:
maximum: 2147483647
minimum: 0
type: integer
schema:
description: UC schema name
minLength: 1
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
stream_chunk_bytes:
maximum: 2147483647
minimum: 0
type: integer
synchronizable:
default: true
type: boolean
tenant_id:
description: Azure AD tenant ID (required for Azure AD SP mode)
type: string
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
token:
description: Databricks personal access token (required for PAT mode)
type: string
writeOnly: true
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Generate blob URLs in tasks
type: boolean
verify_tls:
description: Verify TLS certificates
type: boolean
volume:
description: UC volume name
minLength: 1
type: string
type: object
PatchedDatasetRequest:
properties:
columns:
description: All data columns found in Dataset tasks
nullable: true
created_by:
allOf:
- $ref: '#/components/schemas/UserSimpleRequest'
description: User who created Dataset
description:
description: Dataset description
nullable: true
type: string
organization:
nullable: true
type: integer
title:
description: Dataset title
maxLength: 1000
minLength: 1
type: string
total_entities:
maximum: 2147483647
minimum: -2147483648
nullable: true
title: The number of entities in the dataset
type: integer
vector_db_dataset_name:
description: Dataset name for weaviate schema
maxLength: 37
minLength: 1
type: string
type: object
PatchedDatasetViewRequest:
properties:
data:
description: Custom view data
nullable: true
dataset:
description: Dataset ID
type: integer
filter_group:
$ref: '#/components/schemas/FilterGroupRequest'
order:
description: Position of the tab, starting at the left in data manager and increasing as the tabs go left to right
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
ordering:
description: Ordering parameters
nullable: true
selected_items:
description: Selected items
nullable: true
user:
description: User who made this view
nullable: true
type: integer
type: object
PatchedDefaultRoleRequest:
properties:
annotator_reviewer_firewall_enabled_at:
description: Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
format: date-time
nullable: true
type: string
custom_scripts_enabled_at:
description: Set to current time to enable custom scripts (Plugins) for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts (Plugins).
format: date-time
nullable: true
type: string
default_role:
allOf:
- $ref: '#/components/schemas/Role9e7Enum'
description: |-
Default membership role for invited users
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
email_notification_settings:
description: 'Email notification settings for this organization. Controls which email notifications users can receive. Structure: {"notifications_allowed": {"notification_type": bool}}'
nullable: true
embed_domains:
description: 'List of objects: {"domain": "example.com"}. Used for CSP header on /embed routes.'
nullable: true
embed_settings:
description: Embed settings for this organization
nullable: true
external_id:
description: External ID to uniquely identify this organization
nullable: true
type: string
extra_data_on_activity_logs:
type: boolean
label_stream_navigation_disabled_at:
description: Set to current time to disable the label stream navigation for this organization. This will prevent users from going back in the label stream to view previous labels.
format: date-time
nullable: true
type: string
organization:
description: A unique integer value identifying this organization.
type: integer
read_only_quick_view_enabled_at:
description: Set to current time to prevent creating or editing annotations in quick view.
format: date-time
nullable: true
type: string
type: object
PatchedDimensionRequest:
description: |-
Serializer for Dimension model.
Handles serialization and validation for CRUD operations on dimensions.
The project and created_by fields are set automatically from the request context.
properties:
description:
description: Human-readable description of what this dimension represents
type: string
extraction_method:
description: Method used to extract values from annotation JSON
maxLength: 32
minLength: 1
type: string
extraction_method_params:
description: Parameters specific to the extraction method. See metrics.py for available extraction methods and their parameters.
title: Extraction method parameters
is_active:
description: Whether this dimension is used in agreement calculations.
type: boolean
is_user_defined:
description: Whether this dimension was manually created by a user. System-generated dimensions have this set to False.
type: boolean
metric_params:
description: Parameters for the metric. See metrics.py for available metrics and their parameters.
title: Metric parameters
metric_type:
description: Strategy for comparing dimension values across annotators
maxLength: 32
minLength: 1
type: string
name:
description: Unique identifier for this dimension within the project
maxLength: 255
minLength: 1
type: string
order:
description: Display order within the project
maximum: 2147483647
minimum: 0
type: integer
type: object
PatchedFileUploadRequest:
properties:
file:
format: binary
type: string
type: object
PatchedGCSDatasetStorageRequest:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
dataset:
description: A unique integer value identifying this dataset.
type: integer
description:
description: Cloud storage description
nullable: true
type: string
glob_pattern:
description: Glob pattern for syncing from bucket
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synced:
description: Flag if dataset has been previously synced or not
type: boolean
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
type: object
PatchedGCSWIFExportStorageRequest:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
description:
description: Cloud storage description
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
google_project_number:
description: Google project number
nullable: true
type: string
google_service_account_email:
description: Google service account email
nullable: true
type: string
google_wif_pool_id:
description: Google WIF pool ID
nullable: true
type: string
google_wif_provider_id:
description: Google WIF provider ID
nullable: true
title: Google wif provider
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
type: object
PatchedGCSWIFImportStorageRequest:
properties:
bucket:
description: GCS bucket name
nullable: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
google_project_id:
description: Google project ID
nullable: true
type: string
google_project_number:
description: Google project number
nullable: true
type: string
google_service_account_email:
description: Google service account email
nullable: true
type: string
google_wif_pool_id:
description: Google WIF pool ID
nullable: true
type: string
google_wif_provider_id:
description: Google WIF provider ID
nullable: true
title: Google wif provider
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: GCS bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
nullable: true
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
type: object
PatchedHotkeysRequest:
properties:
custom_hotkeys:
additionalProperties: {}
type: object
type: object
PatchedLabelLinkRequest:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
from_name:
description: Tag name
maxLength: 2048
minLength: 1
title: Tag name
type: string
label:
type: integer
project:
type: integer
type: object
PatchedLabelRequest:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
approved:
description: Status of label
type: boolean
approved_by:
description: User who approved this label
nullable: true
type: integer
created_by:
description: User who made this label
type: integer
description:
description: Label description
nullable: true
type: string
organization:
type: integer
title:
description: Label title
maxLength: 2048
minLength: 1
type: string
value:
description: Label value
type: object
PatchedLseOrganizationSerializerUpdateRequest:
description: |-
A serializer mixin that takes an additional `fields` argument that controls
which fields should be displayed.
properties:
contact_info:
format: email
maxLength: 254
nullable: true
type: string
created_by:
nullable: true
type: integer
custom_scripts_enabled:
description: Plugins
nullable: true
type: boolean
writeOnly: true
email_notification_settings:
description: Email Notification Settings
nullable: true
writeOnly: true
embed_domains:
description: Supported domains
items:
additionalProperties:
minLength: 1
type: string
type: object
nullable: true
type: array
writeOnly: true
embed_settings:
description: Public Verification Key and Public Verification Algorithms configuration
nullable: true
writeOnly: true
title:
description: Organization name
minLength: 1
nullable: true
type: string
writeOnly: true
token:
maxLength: 256
nullable: true
type: string
type: object
PatchedLseProjectUpdateRequest:
description: |-
Serializer get numbers from project queryset annotation,
make sure, that you use correct one(Project.objects.with_counts())
properties:
agreement_methodology:
allOf:
- $ref: '#/components/schemas/AgreementMethodologyEnum'
default: pairwise
description: |-
Methodology (Consensus / Pairwise Averaging)
* `consensus` - Consensus
* `pairwise` - Pairwise Averaging
agreement_threshold:
description: Agreement threshold
format: decimal
nullable: true
pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
type: string
annotation_limit_count:
description: Limit by number of tasks
minimum: 1
nullable: true
type: integer
annotation_limit_percent:
description: Limit by percentage of tasks
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
annotator_evaluation_continuous_tasks:
default: 0
description: 'Continuous Evaluation: Required tasks'
minimum: 0
type: integer
annotator_evaluation_enabled:
description: Evaluate all annotators against ground truth
type: boolean
annotator_evaluation_minimum_score:
default: '95.00'
description: Score required to pass evaluation
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
annotator_evaluation_minimum_tasks:
default: 10
description: Number of tasks for evaluation
minimum: 0
nullable: true
type: integer
annotator_evaluation_onboarding_tasks:
default: 0
description: 'Onboarding Evaluation: Required tasks'
minimum: 0
type: integer
assignment_settings:
$ref: '#/components/schemas/AssignmentSettingsRequest'
color:
description: Color
maxLength: 16
nullable: true
type: string
comment_classification_config:
type: string
control_weights:
additionalProperties:
$ref: '#/components/schemas/ControlTagWeightRequest'
description: 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.
nullable: true
type: object
created_by:
allOf:
- $ref: '#/components/schemas/UserSimpleRequest'
description: Project owner
custom_script:
description: Plugins
type: string
custom_task_lock_ttl:
description: Task reservation time. TTL in seconds (UI displays and edits this value in minutes).
maximum: 86400
minimum: 1
nullable: true
type: integer
description:
description: Description
nullable: true
type: string
enable_empty_annotation:
description: Allow empty annotations
type: boolean
evaluate_predictions_automatically:
description: Retrieve and display predictions when loading a task
type: boolean
expert_instruction:
description: Instructions
nullable: true
type: string
is_draft:
description: Whether or not the project is in the middle of being created
type: boolean
is_published:
description: Whether or not the project is published to annotators
title: Published
type: boolean
label_config:
description: Labeling Configuration
nullable: true
type: string
max_additional_annotators_assignable:
description: Maximum additional annotators
nullable: true
type: integer
maximum_annotations:
description: Annotations per task
maximum: 2147483647
minimum: -2147483648
title: Maximum annotation number
type: integer
min_annotations_to_start_training:
description: Minimum number of completed tasks after which model training is started
maximum: 2147483647
minimum: -2147483648
type: integer
model_version:
description: Machine learning model version
nullable: true
type: string
organization:
nullable: true
type: integer
overlap_cohort_percentage:
description: Annotations per task coverage
maximum: 2147483647
minimum: -2147483648
type: integer
pause_on_failed_annotator_evaluation:
default: false
description: Pause annotator on failed evaluation
nullable: true
type: boolean
pinned_at:
description: Pinned date and time
format: date-time
nullable: true
type: string
require_comment_on_skip:
default: false
description: Require comment to skip
type: boolean
reveal_preannotations_interactively:
description: Reveal pre-annotations interactively
type: boolean
review_settings:
$ref: '#/components/schemas/ReviewSettingsRequest'
sampling:
allOf:
- $ref: '#/components/schemas/SamplingDe5Enum'
nullable: true
show_annotation_history:
description: Show Data Manager to Annotators
type: boolean
show_collab_predictions:
description: Use predictions to pre-label Tasks
title: Show predictions to annotator
type: boolean
show_ground_truth_first:
deprecated: true
description: 'Onboarding mode (true): show ground truth tasks first in the labeling stream'
type: boolean
show_instruction:
description: Show instructions before labeling
type: boolean
show_overlap_first:
description: Show tasks with overlap first
type: boolean
show_skip_button:
description: Allow skipping tasks
type: boolean
show_unused_data_columns_to_annotators:
description: '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.'
nullable: true
type: boolean
skip_queue:
allOf:
- $ref: '#/components/schemas/SkipQueueEnum'
nullable: true
strict_task_overlap:
default: true
description: Enforce strict overlap limit
type: boolean
task_data_login:
description: Login
maxLength: 256
nullable: true
type: string
task_data_password:
description: Password
maxLength: 256
nullable: true
type: string
title:
description: Project Name
maxLength: 50
minLength: 3
nullable: true
type: string
workspace:
description: Workspace
type: integer
type: object
PatchedLseS3ExportStorageRequest:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
description:
description: Cloud storage description
nullable: true
type: string
external_id:
description: AWS ExternalId
nullable: true
title: ExternalID
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
legacy_auth:
nullable: true
type: boolean
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
role_arn:
description: AWS RoleArn
minLength: 1
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
type: object
PatchedLseS3ImportStorageRequest:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
external_id:
description: AWS ExternalId
nullable: true
title: ExternalID
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
legacy_auth:
nullable: true
type: boolean
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
role_arn:
description: AWS RoleArn
minLength: 1
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
type: object
PatchedLseTaskRequest:
description: Data Manager Task Serializer with FSM state support.
properties:
allow_skip:
description: Whether this task can be skipped. Set to False to make task unskippable.
nullable: true
type: boolean
avg_lead_time:
format: double
type: number
cancelled_annotations:
type: integer
comment_count:
description: Number of comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
completed_at:
format: date-time
type: string
data:
description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
draft_exists:
type: boolean
ground_truth:
type: boolean
inner_id:
type: integer
is_labeled:
description: True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
type: boolean
last_comment_updated_at:
description: When the last comment was updated
format: date-time
nullable: true
type: string
meta:
description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
nullable: true
overlap:
description: Number of distinct annotators that processed the current task
maximum: 2147483647
minimum: -2147483648
type: integer
precomputed_agreement:
description: Average agreement score for the task
format: double
nullable: true
type: number
predictions_score:
format: double
type: number
project:
description: Project ID for this task
nullable: true
type: integer
reviewed:
type: boolean
reviews_accepted:
type: integer
reviews_rejected:
type: integer
total_annotations:
type: integer
total_predictions:
type: integer
unresolved_comment_count:
description: Number of unresolved comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
type: object
PatchedLseUserSerializerUpdateRequest:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
active_organization:
nullable: true
type: integer
allow_newsletters:
description: Allow sending newsletters to user
nullable: true
type: boolean
custom_hotkeys:
description: Custom keyboard shortcuts configuration for the user interface
nullable: true
date_joined:
format: date-time
type: string
email_notification_settings:
writeOnly: true
first_name:
maxLength: 256
type: string
is_email_verified:
nullable: true
type: boolean
writeOnly: true
last_name:
maxLength: 256
type: string
onboarding_state:
minLength: 1
nullable: true
type: string
writeOnly: true
password:
minLength: 1
type: string
writeOnly: true
phone:
maxLength: 256
type: string
username:
maxLength: 256
minLength: 1
type: string
type: object
PatchedModelInterfaceRequest:
properties:
associated_projects:
items:
type: integer
type: array
created_by:
allOf:
- $ref: '#/components/schemas/UserSimpleRequest'
description: User who created Dataset
description:
description: Model description
nullable: true
type: string
input_fields: {}
organization:
nullable: true
type: integer
output_classes: {}
skill_name:
allOf:
- $ref: '#/components/schemas/SkillNameEnum'
default: TextClassification
title:
description: Model name
maxLength: 500
minLength: 1
type: string
type: object
PatchedModelProviderConnectionRequest:
properties:
api_key:
description: Model provider API key
nullable: true
type: string
writeOnly: true
auth_token:
description: Model provider Auth token
nullable: true
type: string
writeOnly: true
budget_alert_threshold:
description: Budget alert threshold for the given provider connection
format: double
nullable: true
type: number
cached_available_models:
description: List of available models from the provider
maxLength: 4096
nullable: true
type: string
deployment_name:
description: Azure OpenAI deployment name
maxLength: 512
nullable: true
type: string
endpoint:
description: Azure OpenAI endpoint
maxLength: 512
nullable: true
type: string
google_application_credentials:
description: The content of GOOGLE_APPLICATION_CREDENTIALS json file
nullable: true
type: string
writeOnly: true
google_location:
description: Google project location
maxLength: 255
nullable: true
type: string
google_project_id:
description: Google project ID
maxLength: 255
nullable: true
type: string
is_internal:
description: Whether the model provider connection is internal, not visible to the user
nullable: true
type: boolean
provider:
$ref: '#/components/schemas/ProviderEnum'
scope:
$ref: '#/components/schemas/ScopeEnum'
type: object
PatchedOrganizationMemberCreateUpdateRequest:
properties:
role:
allOf:
- $ref: '#/components/schemas/Role9e7Enum'
description: |-
Organization role
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
user_id:
description: Member
type: integer
type: object
PatchedOrganizationMemberTagRequest:
properties:
label:
description: Label
maxLength: 255
minLength: 1
type: string
type: object
PatchedOrganizationPermissionRequest:
properties:
permission:
maxLength: 255
minLength: 1
type: string
roles:
description: Organization roles
items:
$ref: '#/components/schemas/Role9e7Enum'
type: array
type: object
PatchedPauseRequest:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
reason:
allOf:
- $ref: '#/components/schemas/ReasonEnum'
description: |-
Reason for pausing
* `MANUAL` - Manual
* `BEHAVIOR_BASED` - Behavior-based
* `ANNOTATOR_EVALUATION` - Annotator evaluation
* `ANNOTATION_LIMIT` - Annotation limit
* `CUSTOM_SCRIPT` - Custom script
verbose_reason:
description: Detailed description of why the project is paused, will be readable by paused annotators
nullable: true
type: string
type: object
PatchedProjectTemplateRequest:
properties:
assignment_settings:
description: general dict serialized assignment settings
created_by:
nullable: true
type: integer
custom_script:
description: custom script (Plugin) for projects created from this template
minLength: 1
nullable: true
type: string
description:
minLength: 1
nullable: true
type: string
name:
maxLength: 1000
minLength: 1
type: string
organization:
nullable: true
type: integer
project_id:
type: integer
writeOnly: true
project_settings:
description: general dict serialized project settings
require_comment_on_skip:
description: flag to require comment on skip
type: boolean
review_settings:
description: general dict serialized review settings
show_unused_data_columns_to_annotators:
nullable: true
type: boolean
tags: {}
type: object
PatchedS3DatasetStorageRequest:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
dataset:
description: A unique integer value identifying this dataset.
type: integer
description:
description: Cloud storage description
nullable: true
type: string
glob_pattern:
description: Glob pattern for syncing from bucket
nullable: true
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synced:
description: Flag if dataset has been previously synced or not
type: boolean
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
type: object
PatchedSessionTimeoutPolicyRequest:
properties:
max_session_age:
description: Number of minutes that a session can be active before needing to re-login
maximum: 2147483647
minimum: 1
title: Max session age (minutes)
type: integer
max_time_between_activity:
description: Number of minutes that a session stays active without any activity
maximum: 2147483647
minimum: 1
title: Max time (minutes) between activity
type: integer
type: object
PatchedThirdPartyModelVersionRequest:
properties:
model_provider_connection:
nullable: true
type: integer
organization:
nullable: true
type: integer
parent_model:
description: Parent model interface ID
type: integer
prompt:
description: Prompt to execute
minLength: 1
type: string
provider:
allOf:
- $ref: '#/components/schemas/ProviderEnum'
description: |-
The model provider to use e.g. OpenAI
* `OpenAI` - OpenAI
* `AzureOpenAI` - AzureOpenAI
* `AzureAIFoundry` - AzureAIFoundry
* `VertexAI` - VertexAI
* `Gemini` - Gemini
* `Anthropic` - Anthropic
* `Custom` - Custom
provider_model_id:
description: The model ID to use within the given provider, e.g. gpt-3.5
maxLength: 255
minLength: 1
type: string
title:
description: Model name
maxLength: 500
minLength: 1
type: string
type: object
PatchedWebhookSerializerForUpdateRequest:
description: |-
Serializer class for updating webhooks
Used to forbid updating project field.
properties:
actions:
default: []
items:
$ref: '#/components/schemas/ActionsEnum'
type: array
headers:
description: Key Value Json of headers
title: Request extra headers of webhook
is_active:
description: If value is False the webhook is disabled
title: Is webhook active
type: boolean
send_for_all_actions:
description: If value is False - used only for actions from WebhookAction
title: Use webhook for all actions
type: boolean
send_payload:
description: If value is False send only action
title: Does webhook send the payload
type: boolean
url:
description: URL of webhook
format: uri
maxLength: 2048
minLength: 1
title: URL of webhook
type: string
type: object
PatchedWorkspaceRequest:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
color:
description: Color
maxLength: 16
nullable: true
type: string
description:
description: Workspace description
nullable: true
type: string
is_archived:
description: Workspace is archived
title: Archived
type: boolean
is_personal:
description: Workspace is a personal user workspace
title: Personal
type: boolean
title:
description: Workspace Name
maxLength: 1000
minLength: 1
type: string
type: object
Pause:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
created_at:
description: Timestamp when this pause record was created
format: date-time
readOnly: true
type: string
deleted_at:
description: Timestamp when this pause record was soft-deleted
format: date-time
nullable: true
readOnly: true
type: string
deleted_by:
description: User who soft-deleted this pause record
nullable: true
readOnly: true
type: integer
id:
readOnly: true
type: integer
paused_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
readOnly: true
project:
description: Related project for which the pause is set
nullable: true
readOnly: true
type: integer
reason:
allOf:
- $ref: '#/components/schemas/ReasonEnum'
description: |-
Reason for pausing
* `MANUAL` - Manual
* `BEHAVIOR_BASED` - Behavior-based
* `ANNOTATOR_EVALUATION` - Annotator evaluation
* `ANNOTATION_LIMIT` - Annotation limit
* `CUSTOM_SCRIPT` - Custom script
updated_at:
description: Timestamp when this pause record was last updated
format: date-time
readOnly: true
type: string
user:
description: User who is paused
nullable: true
readOnly: true
type: integer
verbose_reason:
description: Detailed description of why the project is paused, will be readable by paused annotators
nullable: true
type: string
required:
- created_at
- deleted_at
- deleted_by
- id
- paused_by
- project
- reason
- updated_at
- user
type: object
PauseRequest:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
reason:
allOf:
- $ref: '#/components/schemas/ReasonEnum'
description: |-
Reason for pausing
* `MANUAL` - Manual
* `BEHAVIOR_BASED` - Behavior-based
* `ANNOTATOR_EVALUATION` - Annotator evaluation
* `ANNOTATION_LIMIT` - Annotation limit
* `CUSTOM_SCRIPT` - Custom script
verbose_reason:
description: Detailed description of why the project is paused, will be readable by paused annotators
nullable: true
type: string
required:
- reason
type: object
Prediction:
properties:
cluster:
description: Cluster for the current prediction
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
created_ago:
default: ''
description: Delta time from creation time
readOnly: true
type: string
created_at:
format: date-time
readOnly: true
type: string
id:
readOnly: true
type: integer
mislabeling:
description: Related task mislabeling score
format: double
type: number
model:
description: An ML Backend instance that created the prediction.
nullable: true
type: integer
model_run:
description: A run of a ModelVersion that created the prediction.
nullable: true
type: integer
model_version:
description: Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
type: string
neighbors:
description: Array of task IDs of the closest neighbors
nullable: true
project:
nullable: true
type: integer
result:
description: List of prediction results for the task
items:
description: List of predicted regions for the task
title: Prediction result items (regions)
type: object
title: Prediction result list
type: array
score:
description: Prediction score
format: double
nullable: true
type: number
task:
type: integer
updated_at:
format: date-time
readOnly: true
type: string
required:
- created_ago
- created_at
- id
- result
- task
- updated_at
type: object
PredictionRequest:
properties:
cluster:
description: Cluster for the current prediction
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
mislabeling:
description: Related task mislabeling score
format: double
type: number
model:
description: An ML Backend instance that created the prediction.
nullable: true
type: integer
model_run:
description: A run of a ModelVersion that created the prediction.
nullable: true
type: integer
model_version:
description: Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
type: string
neighbors:
description: Array of task IDs of the closest neighbors
nullable: true
project:
nullable: true
type: integer
result:
description: List of prediction results for the task
items:
description: List of predicted regions for the task
title: Prediction result items (regions)
type: object
title: Prediction result list
type: array
score:
description: Prediction score
format: double
nullable: true
type: number
task:
type: integer
required:
- result
- task
type: object
Project:
description: |-
Serializer get numbers from project queryset annotation,
make sure, that you use correct one(Project.objects.with_counts())
properties:
annotator_evaluation_enabled:
description: Enable annotator evaluation for the project
type: boolean
color:
maxLength: 16
nullable: true
type: string
config_has_control_tags:
description: Flag to detect is project ready for labeling
readOnly: true
type: boolean
config_suitable_for_bulk_annotation:
description: Flag to detect is project ready for bulk annotation
readOnly: true
type: boolean
control_weights:
additionalProperties:
$ref: '#/components/schemas/ControlTagWeight'
description: 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.
nullable: true
type: object
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
description: Project owner
description:
description: Project description
nullable: true
type: string
enable_empty_annotation:
description: Allow annotators to submit empty annotations
type: boolean
evaluate_predictions_automatically:
description: Retrieve and display predictions when loading a task
type: boolean
expert_instruction:
description: Labeling instructions in HTML format
nullable: true
type: string
finished_task_number:
description: Finished tasks
readOnly: true
type: integer
ground_truth_number:
description: Honeypot annotation number in project
readOnly: true
type: integer
id:
readOnly: true
type: integer
is_draft:
description: Whether or not the project is in the middle of being created
type: boolean
is_published:
description: Whether or not the project is published to annotators
title: Published
type: boolean
label_config:
description: Label config in XML format. See more about it in documentation
nullable: true
type: string
maximum_annotations:
description: 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)
maximum: 2147483647
minimum: -2147483648
title: Maximum annotation number
type: integer
min_annotations_to_start_training:
description: Minimum number of completed tasks after which model training is started
maximum: 2147483647
minimum: -2147483648
type: integer
model_version:
description: Machine learning model version
nullable: true
type: string
num_tasks_with_annotations:
description: Tasks with annotations count
readOnly: true
type: integer
organization:
nullable: true
type: integer
overlap_cohort_percentage:
maximum: 2147483647
minimum: -2147483648
type: integer
parsed_label_config:
additionalProperties: true
description: JSON-formatted labeling configuration
readOnly: true
type: object
pinned_at:
description: Pinned date and time
format: date-time
nullable: true
type: string
queue_done:
readOnly: true
type: integer
queue_total:
readOnly: true
type: integer
reveal_preannotations_interactively:
description: Reveal pre-annotations interactively
type: boolean
sampling:
allOf:
- $ref: '#/components/schemas/SamplingDe5Enum'
nullable: true
show_annotation_history:
description: Show annotation history to annotator
type: boolean
show_collab_predictions:
description: If set, the annotator can view model predictions
title: Show predictions to annotator
type: boolean
show_ground_truth_first:
deprecated: true
description: 'Onboarding mode (true): show ground truth tasks first in the labeling stream'
type: boolean
show_instruction:
description: Show instructions to the annotator before they start
type: boolean
show_overlap_first:
type: boolean
show_skip_button:
description: Show a skip button in interface and allow annotators to skip the task
type: boolean
skip_queue:
allOf:
- $ref: '#/components/schemas/SkipQueueEnum'
nullable: true
skipped_annotations_number:
description: Skipped by collaborators annotation number in project
readOnly: true
type: integer
start_training_on_annotation_update:
description: Start model training after any annotations are submitted or updated
readOnly: true
type: boolean
state:
readOnly: true
type: string
task_data_login:
description: 'Task data credentials: login'
maxLength: 256
nullable: true
type: string
task_data_password:
description: 'Task data credentials: password'
maxLength: 256
nullable: true
type: string
task_number:
description: Total task number in project
readOnly: true
type: integer
title:
description: Project name. Must be between 3 and 50 characters long.
maxLength: 50
minLength: 3
nullable: true
type: string
total_annotations_number:
description: Total annotations number in project including skipped_annotations_number and ground_truth_number.
readOnly: true
type: integer
total_predictions_number:
description: Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
readOnly: true
type: integer
useful_annotation_number:
description: Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
readOnly: true
type: integer
required:
- config_has_control_tags
- config_suitable_for_bulk_annotation
- created_at
- finished_task_number
- ground_truth_number
- id
- num_tasks_with_annotations
- parsed_label_config
- queue_done
- queue_total
- skipped_annotations_number
- start_training_on_annotation_update
- state
- task_number
- total_annotations_number
- total_predictions_number
- useful_annotation_number
type: object
ProjectDuplicateRequest:
properties:
description:
default: ''
description: Project Description
type: string
mode:
allOf:
- $ref: '#/components/schemas/ModeEnum'
description: |-
What to Duplicate (Project configuration only / Project configuration and tasks)
* `settings` - Only settings
* `settings,data` - Settings and tasks
title:
description: Project Name
maxLength: 50
minLength: 3
type: string
workspace:
description: Destination Workspace
type: integer
required:
- mode
- title
- workspace
type: object
ProjectGroup:
properties:
group:
description: Group name
type: string
project_id:
description: Project ID
type: integer
role:
allOf:
- $ref: '#/components/schemas/ProjectGroupRoleEnum'
description: |-
Project role (Inherit, Annotator, Reviewer)
* `Inherit` - Inherit
* `Annotator` - Annotator
* `Reviewer` - Reviewer
required:
- group
- project_id
- role
type: object
ProjectGroupRequest:
properties:
group:
description: Group name
minLength: 1
type: string
project_id:
description: Project ID
type: integer
role:
allOf:
- $ref: '#/components/schemas/ProjectGroupRoleEnum'
description: |-
Project role (Inherit, Annotator, Reviewer)
* `Inherit` - Inherit
* `Annotator` - Annotator
* `Reviewer` - Reviewer
required:
- group
- project_id
- role
type: object
ProjectGroupRoleEnum:
description: |-
* `Inherit` - Inherit
* `Annotator` - Annotator
* `Reviewer` - Reviewer
enum:
- Inherit
- Annotator
- Reviewer
type: string
ProjectImport:
properties:
annotation_count:
maximum: 2147483647
minimum: -2147483648
type: integer
commit_to_project:
type: boolean
could_be_tasks_list:
type: boolean
created_at:
description: Creation time
format: date-time
nullable: true
readOnly: true
type: string
data_columns: {}
duration:
maximum: 2147483647
minimum: -2147483648
type: integer
error:
nullable: true
type: string
file_upload_ids: {}
finished_at:
description: Complete or fail time
format: date-time
nullable: true
type: string
found_formats: {}
id:
readOnly: true
type: integer
preannotated_from_fields:
nullable: true
prediction_count:
maximum: 2147483647
minimum: -2147483648
type: integer
project:
nullable: true
type: integer
return_task_ids:
type: boolean
status:
$ref: '#/components/schemas/Status7bfEnum'
task_count:
maximum: 2147483647
minimum: -2147483648
type: integer
task_ids: {}
tasks:
nullable: true
updated_at:
description: Updated time
format: date-time
nullable: true
readOnly: true
type: string
url:
maxLength: 2048
nullable: true
type: string
required:
- created_at
- id
- updated_at
type: object
ProjectLabelConfig:
properties:
label_config:
description: Label config in XML format. See more about it in documentation
type: string
required:
- label_config
type: object
ProjectLabelConfigRequest:
properties:
label_config:
description: Label config in XML format. See more about it in documentation
minLength: 1
type: string
required:
- label_config
type: object
ProjectMember:
properties:
user:
type: integer
required:
- user
type: object
ProjectMemberBulkAssignRequest:
properties:
all:
description: Apply to all project members
type: boolean
excluded:
description: Excluded user IDs
items:
minimum: 1
type: integer
type: array
included:
description: Included user IDs
items:
minimum: 1
type: integer
type: array
roles:
description: Member roles
items:
$ref: '#/components/schemas/ProjectMemberBulkAssignRolesRequest'
type: array
required:
- all
type: object
ProjectMemberBulkAssignRolesRequest:
properties:
role:
allOf:
- $ref: '#/components/schemas/Role9e7Enum'
description: |-
Role
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
user_id:
description: User ID
minimum: 1
type: integer
required:
- role
- user_id
type: object
ProjectMemberRequest:
properties:
user:
type: integer
required:
- user
type: object
ProjectReimport:
properties:
annotation_count:
maximum: 2147483647
minimum: -2147483648
type: integer
data_columns: {}
duration:
maximum: 2147483647
minimum: -2147483648
type: integer
error:
nullable: true
type: string
file_upload_ids: {}
files_as_tasks_list:
type: boolean
found_formats: {}
id:
readOnly: true
type: integer
prediction_count:
maximum: 2147483647
minimum: -2147483648
type: integer
project:
nullable: true
type: integer
status:
$ref: '#/components/schemas/Status7bfEnum'
task_count:
maximum: 2147483647
minimum: -2147483648
type: integer
required:
- id
type: object
ProjectRole:
properties:
id:
readOnly: true
type: integer
project:
type: integer
role:
$ref: '#/components/schemas/Role9e7Enum'
user:
type: integer
required:
- id
- project
- role
- user
type: object
ProjectRoleRequest:
properties:
project:
type: integer
role:
$ref: '#/components/schemas/Role9e7Enum'
user:
type: integer
required:
- project
- role
- user
type: object
ProjectSubsetEnum:
description: |-
* `All` - All
* `HasGT` - HasGT
* `Sample` - Sample
enum:
- All
- HasGT
- Sample
type: string
ProjectSubsetItem:
properties:
columns_schema:
items:
additionalProperties: {}
type: object
type: array
count:
type: integer
subset:
type: string
required:
- count
- subset
type: object
ProjectSubsetTaskItem:
properties:
data:
additionalProperties: {}
type: object
error:
additionalProperties: {}
type: object
ground_truth:
additionalProperties: {}
type: object
id:
type: integer
prediction:
additionalProperties: {}
type: object
score:
format: double
nullable: true
type: number
required:
- data
type: object
ProjectSubsetTasksResponse:
properties:
next_cursor:
nullable: true
type: string
previous_cursor:
nullable: true
type: string
task_count:
description: Present only when include_total=true
type: integer
task_result_list:
items:
$ref: '#/components/schemas/ProjectSubsetTaskItem'
type: array
required:
- task_result_list
type: object
ProjectTemplate:
properties:
assignment_settings:
description: general dict serialized assignment settings
created_at:
format: date-time
readOnly: true
type: string
created_by:
nullable: true
type: integer
custom_script:
description: custom script (Plugin) for projects created from this template
nullable: true
type: string
description:
nullable: true
type: string
id:
readOnly: true
type: integer
name:
maxLength: 1000
type: string
organization:
nullable: true
type: integer
project_settings:
description: general dict serialized project settings
require_comment_on_skip:
description: flag to require comment on skip
type: boolean
review_settings:
description: general dict serialized review settings
show_unused_data_columns_to_annotators:
nullable: true
type: boolean
tags: {}
updated_at:
format: date-time
readOnly: true
type: string
required:
- created_at
- id
- name
- updated_at
type: object
ProjectTemplateRequest:
properties:
assignment_settings:
description: general dict serialized assignment settings
created_by:
nullable: true
type: integer
custom_script:
description: custom script (Plugin) for projects created from this template
minLength: 1
nullable: true
type: string
description:
minLength: 1
nullable: true
type: string
name:
maxLength: 1000
minLength: 1
type: string
organization:
nullable: true
type: integer
project_id:
type: integer
writeOnly: true
project_settings:
description: general dict serialized project settings
require_comment_on_skip:
description: flag to require comment on skip
type: boolean
review_settings:
description: general dict serialized review settings
show_unused_data_columns_to_annotators:
nullable: true
type: boolean
tags: {}
required:
- name
- project_id
type: object
PromptsStatusEnum:
description: |-
* `Enabled` - Enabled
* `Cloud license per organization disabled` - Cloud license per organization disabled
* `On-premise global license disabled` - On-premise global license disabled
* `Expired` - Expired
* `Adala not connected` - Adala not connected
* `Disabled for this organization [FF]` - Disabled for this organization [FF]
* `unknown` - unknown
enum:
- Enabled
- Cloud license per organization disabled
- On-premise global license disabled
- Expired
- Adala not connected
- Disabled for this organization [FF]
- unknown
type: string
ProviderEnum:
description: |-
* `OpenAI` - OpenAI
* `AzureOpenAI` - AzureOpenAI
* `AzureAIFoundry` - AzureAIFoundry
* `VertexAI` - VertexAI
* `Gemini` - Gemini
* `Anthropic` - Anthropic
* `Custom` - Custom
enum:
- OpenAI
- AzureOpenAI
- AzureAIFoundry
- VertexAI
- Gemini
- Anthropic
- Custom
type: string
ReasonEnum:
description: |-
* `MANUAL` - Manual
* `BEHAVIOR_BASED` - Behavior-based
* `ANNOTATOR_EVALUATION` - Annotator evaluation
* `ANNOTATION_LIMIT` - Annotation limit
* `CUSTOM_SCRIPT` - Custom script
enum:
- MANUAL
- BEHAVIOR_BASED
- ANNOTATOR_EVALUATION
- ANNOTATION_LIMIT
- CUSTOM_SCRIPT
type: string
RedisExportStorage:
properties:
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
db:
description: Server Database
maximum: 32767
minimum: 0
type: integer
description:
description: Cloud storage description
nullable: true
type: string
host:
description: Server Host IP (optional)
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
password:
description: Server Password (optional)
nullable: true
type: string
path:
description: Storage prefix (optional)
nullable: true
type: string
port:
description: Server Port (optional)
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
title: Port
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: redis
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
RedisImportStorage:
properties:
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
db:
description: Server Database
maximum: 32767
minimum: 0
type: integer
description:
description: Cloud storage description
nullable: true
type: string
host:
description: Server Host IP (optional)
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
password:
description: Server Password (optional)
nullable: true
type: string
path:
description: Storage prefix (optional)
nullable: true
type: string
port:
description: Server Port (optional)
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
title: Port
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: redis
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
RefinePromptRequestRequest:
properties:
project_id:
description: Project ID to target the refined prompt for
type: integer
teacher_model_name:
description: Name of the model to use to refine the prompt
minLength: 1
type: string
teacher_model_provider_connection_id:
description: Model Provider Connection ID to use to refine the prompt
type: integer
required:
- project_id
- teacher_model_name
- teacher_model_provider_connection_id
type: object
RefinedPromptResponse:
properties:
previous_version:
allOf:
- $ref: '#/components/schemas/ThirdPartyModelVersion'
description: Previous version of the prompt
nullable: true
prompt:
description: The refined prompt text
type: string
reasoning:
description: Reasoning behind the refinement
nullable: true
type: string
refinement_job_id:
description: Unique identifier for the refinement job
nullable: true
type: string
refinement_status:
description: Status of the refinement job
nullable: true
type: string
title:
description: Title of the refined prompt
nullable: true
type: string
total_cost:
description: Total cost of the refinement job (in USD)
nullable: true
type: string
required:
- previous_version
- prompt
- reasoning
- refinement_job_id
- refinement_status
- title
- total_cost
type: object
RequeueRejectedTasksModeEnum:
description: |-
* `requeue` - Requeue
* `remove` - Remove
* `flexible` - Flexible
enum:
- requeue
- remove
- flexible
type: string
ReviewCriteriaEnum:
description: |-
* `all` - Task is reviewed if all annotations are reviewed
* `one` - Task is reviewed if at least one annotation is reviewed
enum:
- all
- one
type: string
ReviewSettings:
properties:
anonymize_annotations:
description: Hide annotator names from annotations while review
type: boolean
id:
readOnly: true
type: integer
instruction:
description: Instructions
nullable: true
type: string
only_finished_tasks:
description: Show only finished tasks in the review stream
type: boolean
project:
nullable: true
type: integer
requeue_rejected_tasks_mode:
allOf:
- $ref: '#/components/schemas/RequeueRejectedTasksModeEnum'
description: |-
Remove rejected annotations from labeling queue / Requeue rejected annotations back to annotators / Allow reviewer to decide: Remove or Requeue
* `requeue` - Requeue
* `remove` - Remove
* `flexible` - Flexible
nullable: true
requeue_rejected_tasks_to_annotator:
readOnly: true
type: boolean
require_comment_on_reject:
description: Reviewers must leave a comment on reject
type: boolean
review_criteria:
allOf:
- $ref: '#/components/schemas/ReviewCriteriaEnum'
description: |-
Task is reviewed after at least one accepted annotation / Task is reviewed when all annotations are reviewed
* `all` - Task is reviewed if all annotations are reviewed
* `one` - Task is reviewed if at least one annotation is reviewed
nullable: true
review_only_manual_assignments:
description: Show only manually assigned tasks in the review stream
type: boolean
review_task_limit_percent:
description: Task limit (%)
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
sampling:
allOf:
- $ref: '#/components/schemas/ReviewSettingsSamplingEnum'
description: |-
By Task ID / Random
* `task_id` - By Task ID
* `random` - Random
nullable: true
show_agreement_to_reviewers:
description: Show agreement to reviewers in the Data Manager
type: boolean
show_data_manager_to_reviewers:
description: Show the Data Manager to reviewers
type: boolean
show_instruction:
description: Show before reviewing
type: boolean
show_unused_data_columns_to_reviewers:
description: Show unused task data columns to reviewers in the Data Manager
nullable: true
type: boolean
required:
- id
- requeue_rejected_tasks_to_annotator
type: object
ReviewSettingsRequest:
properties:
anonymize_annotations:
description: Hide annotator names from annotations while review
type: boolean
instruction:
description: Instructions
nullable: true
type: string
only_finished_tasks:
description: Show only finished tasks in the review stream
type: boolean
project:
nullable: true
type: integer
requeue_rejected_tasks_mode:
allOf:
- $ref: '#/components/schemas/RequeueRejectedTasksModeEnum'
description: |-
Remove rejected annotations from labeling queue / Requeue rejected annotations back to annotators / Allow reviewer to decide: Remove or Requeue
* `requeue` - Requeue
* `remove` - Remove
* `flexible` - Flexible
nullable: true
require_comment_on_reject:
description: Reviewers must leave a comment on reject
type: boolean
review_criteria:
allOf:
- $ref: '#/components/schemas/ReviewCriteriaEnum'
description: |-
Task is reviewed after at least one accepted annotation / Task is reviewed when all annotations are reviewed
* `all` - Task is reviewed if all annotations are reviewed
* `one` - Task is reviewed if at least one annotation is reviewed
nullable: true
review_only_manual_assignments:
description: Show only manually assigned tasks in the review stream
type: boolean
review_task_limit_percent:
description: Task limit (%)
format: decimal
nullable: true
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
type: string
sampling:
allOf:
- $ref: '#/components/schemas/ReviewSettingsSamplingEnum'
description: |-
By Task ID / Random
* `task_id` - By Task ID
* `random` - Random
nullable: true
show_agreement_to_reviewers:
description: Show agreement to reviewers in the Data Manager
type: boolean
show_data_manager_to_reviewers:
description: Show the Data Manager to reviewers
type: boolean
show_instruction:
description: Show before reviewing
type: boolean
show_unused_data_columns_to_reviewers:
description: Show unused task data columns to reviewers in the Data Manager
nullable: true
type: boolean
type: object
ReviewSettingsSamplingEnum:
description: |-
* `task_id` - By Task ID
* `random` - Random
enum:
- task_id
- random
type: string
ReviewedEnum:
description: |-
* `only` - only
* `exclude` - exclude
* `None` - None
enum:
- only
- exclude
RevokeInviteRequest:
properties:
email:
description: Email address
minLength: 1
type: string
required:
- email
type: object
Role9e7Enum:
description: |-
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
enum:
- OW
- AD
- MA
- RE
- AN
- DI
- 'NO'
type: string
RoleBasedTask:
oneOf:
- $ref: '#/components/schemas/LseTask'
- $ref: '#/components/schemas/LseTaskSerializerForReviewers'
- $ref: '#/components/schemas/LseTaskSerializerForAnnotators'
S3DatasetStorage:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
dataset:
description: A unique integer value identifying this dataset.
type: integer
description:
description: Cloud storage description
nullable: true
type: string
glob_pattern:
description: Glob pattern for syncing from bucket
nullable: true
type: string
id:
readOnly: true
type: integer
job_id:
nullable: true
readOnly: true
title: The Job ID for the GCP Dataproc job that will import the records of this dataset into the vector db
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synced:
description: Flag if dataset has been previously synced or not
type: boolean
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: s3
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- dataset
- id
- job_id
- type
type: object
S3DatasetStorageRequest:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
dataset:
description: A unique integer value identifying this dataset.
type: integer
description:
description: Cloud storage description
nullable: true
type: string
glob_pattern:
description: Glob pattern for syncing from bucket
nullable: true
type: string
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synced:
description: Flag if dataset has been previously synced or not
type: boolean
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- dataset
type: object
S3ExportStorage:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
can_delete_objects:
description: Deletion from storage enabled
nullable: true
type: boolean
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
project:
description: A unique integer value identifying this project.
type: integer
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: s3
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
S3ImportStorage:
properties:
aws_access_key_id:
description: AWS_ACCESS_KEY_ID
nullable: true
type: string
aws_secret_access_key:
description: AWS_SECRET_ACCESS_KEY
nullable: true
type: string
aws_session_token:
description: AWS_SESSION_TOKEN
nullable: true
type: string
aws_sse_kms_key_id:
description: AWS SSE KMS Key ID
nullable: true
type: string
bucket:
description: S3 bucket name
nullable: true
type: string
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
description:
description: Cloud storage description
nullable: true
type: string
id:
readOnly: true
type: integer
last_sync:
description: Last sync finished time
format: date-time
nullable: true
type: string
last_sync_count:
description: Count of tasks synced last time
maximum: 2147483647
minimum: 0
nullable: true
type: integer
last_sync_job:
description: Last sync job ID
maxLength: 256
nullable: true
type: string
meta:
description: Meta and debug information about storage processes
nullable: true
prefix:
description: S3 bucket prefix
nullable: true
type: string
presign:
default: true
type: boolean
presign_ttl:
description: Presigned URLs TTL (in minutes)
maximum: 32767
minimum: 0
type: integer
project:
description: A unique integer value identifying this project.
type: integer
recursive_scan:
description: Perform recursive scan over the bucket content
type: boolean
regex_filter:
description: Cloud storage regex for filtering objects
nullable: true
type: string
region_name:
description: AWS Region
nullable: true
type: string
s3_endpoint:
description: S3 Endpoint
nullable: true
type: string
status:
$ref: '#/components/schemas/StatusC5aEnum'
synchronizable:
default: true
type: boolean
title:
description: Cloud storage title
maxLength: 256
nullable: true
type: string
traceback:
description: Traceback report for the last failed sync
nullable: true
type: string
type:
default: s3
readOnly: true
type: string
use_blob_urls:
description: Interpret objects as BLOBs and generate URLs
type: boolean
required:
- created_at
- id
- project
- type
type: object
SamlSettings:
description: |-
Serializer for reading SAML settings (GET requests).
Includes all model fields plus computed read-only fields for SP URLs
that are needed for IdP configuration.
properties:
acs_url:
readOnly: true
type: string
domain:
description: 'Organization web domain or domains; use comma separated list with no spaces for multiple. Example:
labelstud.io,humansignal.com
IMPORTANT: DO NOT PUT COMMON DOMAINS LIKE GMAIL.COM, YAHOO.COM, ETC. IN THIS FIELD'
maxLength: 65536
minLength: 3
type: string
idp_provider:
description: Identity Provider preset key (e.g. okta, azure, google, custom)
maxLength: 256
nullable: true
title: Identity provider
type: string
login_url:
readOnly: true
type: string
logout_url:
readOnly: true
type: string
mapping_email:
description: 'Mapping attributes: user email from SAML request'
maxLength: 1024
minLength: 1
nullable: true
title: Email
type: string
mapping_first_name:
description: 'Mapping attributes: user first name from SAML request'
maxLength: 1024
nullable: true
title: First name
type: string
mapping_groups:
description: 'Mapping attributes: groups attribute for user mapping to workspaces and roles'
maxLength: 1024
nullable: true
title: Groups
type: string
mapping_last_name:
description: 'Mapping attributes: user last name from SAML request'
maxLength: 1024
nullable: true
title: Last name
type: string
metadata_url:
description: URL SAML metadata from IdP
maxLength: 65536
type: string
metadata_xml:
description: Metadata XML file
type: string
metadata_xml_url:
readOnly: true
type: string
nameid_format:
readOnly: true
type: string
projects_groups:
description: Projects to groups mapping
nullable: true
roles_groups:
description: Roles to groups mapping
nullable: true
token:
maxLength: 256
type: string
workspaces_groups:
description: Workspaces to groups mapping
nullable: true
required:
- acs_url
- login_url
- logout_url
- metadata_xml_url
- nameid_format
type: object
SamlSettingsUpdate:
description: Serializer for updating SAML settings (POST requests).
properties:
domain:
description: 'Organization web domain or domains; use comma separated list with no spaces for multiple. Example:
labelstud.io,humansignal.com
IMPORTANT: DO NOT PUT COMMON DOMAINS LIKE GMAIL.COM, YAHOO.COM, ETC. IN THIS FIELD'
maxLength: 65536
minLength: 3
type: string
idp_provider:
description: Identity Provider preset key (e.g. okta, azure, google, custom)
maxLength: 256
nullable: true
title: Identity provider
type: string
mapping_email:
description: 'Mapping attributes: user email from SAML request'
maxLength: 1024
minLength: 1
nullable: true
title: Email
type: string
mapping_first_name:
description: 'Mapping attributes: user first name from SAML request'
maxLength: 1024
nullable: true
title: First name
type: string
mapping_groups:
description: 'Mapping attributes: groups attribute for user mapping to workspaces and roles'
maxLength: 1024
nullable: true
title: Groups
type: string
mapping_last_name:
description: 'Mapping attributes: user last name from SAML request'
maxLength: 1024
nullable: true
title: Last name
type: string
metadata_url:
description: URL SAML metadata from IdP
maxLength: 65536
type: string
metadata_xml:
description: Metadata XML file
type: string
projects_groups:
description: Projects to Groups Mapping. List of objects with project_id, group, role.
items:
$ref: '#/components/schemas/ProjectGroup'
type: array
roles_groups:
description: Organization Roles to Groups Mapping. List of [role_name, group_name] pairs.
items:
items:
type: string
type: array
type: array
workspaces_groups:
description: Workspaces to Groups Mapping. List of [workspace_title, group_name] pairs.
items:
items:
type: string
type: array
type: array
type: object
SamlSettingsUpdateRequest:
description: Serializer for updating SAML settings (POST requests).
properties:
domain:
description: 'Organization web domain or domains; use comma separated list with no spaces for multiple. Example:
labelstud.io,humansignal.com
IMPORTANT: DO NOT PUT COMMON DOMAINS LIKE GMAIL.COM, YAHOO.COM, ETC. IN THIS FIELD'
maxLength: 65536
minLength: 3
type: string
idp_provider:
description: Identity Provider preset key (e.g. okta, azure, google, custom)
maxLength: 256
nullable: true
title: Identity provider
type: string
mapping_email:
description: 'Mapping attributes: user email from SAML request'
maxLength: 1024
minLength: 1
nullable: true
title: Email
type: string
mapping_first_name:
description: 'Mapping attributes: user first name from SAML request'
maxLength: 1024
nullable: true
title: First name
type: string
mapping_groups:
description: 'Mapping attributes: groups attribute for user mapping to workspaces and roles'
maxLength: 1024
nullable: true
title: Groups
type: string
mapping_last_name:
description: 'Mapping attributes: user last name from SAML request'
maxLength: 1024
nullable: true
title: Last name
type: string
metadata_url:
description: URL SAML metadata from IdP
maxLength: 65536
type: string
metadata_xml:
description: Metadata XML file
type: string
projects_groups:
description: Projects to Groups Mapping. List of objects with project_id, group, role.
items:
$ref: '#/components/schemas/ProjectGroupRequest'
type: array
roles_groups:
description: Organization Roles to Groups Mapping. List of [role_name, group_name] pairs.
items:
items:
minLength: 1
type: string
type: array
type: array
workspaces_groups:
description: Workspaces to Groups Mapping. List of [workspace_title, group_name] pairs.
items:
items:
minLength: 1
type: string
type: array
type: array
type: object
SamplingDe5Enum:
description: |-
* `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)
enum:
- Sequential sampling
- Uniform sampling
- Uncertainty sampling
type: string
ScimSettings:
properties:
projects_groups:
description: Projects to groups mapping
nullable: true
roles_groups:
description: Roles to groups mapping
nullable: true
workspaces_groups:
description: Workspaces to groups mapping
nullable: true
type: object
ScimSettingsUpdate:
properties:
projects_groups:
description: Projects to Groups Mapping. List of objects with project_id, group, role.
items:
$ref: '#/components/schemas/ProjectGroup'
type: array
roles_groups:
description: Organization Roles to Groups Mapping. List of [role_name, group_name] pairs.
items:
items:
type: string
type: array
type: array
workspaces_groups:
description: Workspaces to Groups Mapping. List of [workspace_title, group_name] pairs.
items:
items:
type: string
type: array
type: array
type: object
ScimSettingsUpdateRequest:
properties:
projects_groups:
description: Projects to Groups Mapping. List of objects with project_id, group, role.
items:
$ref: '#/components/schemas/ProjectGroupRequest'
type: array
roles_groups:
description: Organization Roles to Groups Mapping. List of [role_name, group_name] pairs.
items:
items:
minLength: 1
type: string
type: array
type: array
workspaces_groups:
description: Workspaces to Groups Mapping. List of [workspace_title, group_name] pairs.
items:
items:
minLength: 1
type: string
type: array
type: array
type: object
ScopeEnum:
description: |-
* `Organization` - Organization
* `User` - User
* `Model` - Model
enum:
- Organization
- User
- Model
type: string
SegmentationEnum:
description: |-
* `none` - none
* `time` - time
* `user` - user
* `project` - project
* `matrix` - matrix
* `project_matrix` - project_matrix
enum:
- none
- time
- user
- project
- matrix
- project_matrix
type: string
SelectedItemsRequest:
properties:
all:
type: boolean
excluded:
items:
type: integer
type: array
included:
items:
type: integer
type: array
required:
- all
type: object
SendInviteRequest:
properties:
emails:
description: Email addresses
items:
minLength: 1
type: string
type: array
projects:
description: Project IDs to grant access to
items:
type: integer
type: array
role:
allOf:
- $ref: '#/components/schemas/Role9e7Enum'
description: |-
Organization role
* `OW` - Owner
* `AD` - Administrator
* `MA` - Manager
* `RE` - Reviewer
* `AN` - Annotator
* `DI` - Deactivated
* `NO` - Not Activated
workspaces:
description: Workspace IDs to grant access to
items:
type: integer
type: array
required:
- emails
- role
type: object
SerializationOption:
properties:
only_id:
default: false
description: Include a full json body or IDs only
type: boolean
type: object
SerializationOptionRequest:
properties:
only_id:
default: false
description: Include a full json body or IDs only
type: boolean
type: object
SerializationOptions:
properties:
annotations__completed_by:
allOf:
- $ref: '#/components/schemas/SerializationOption'
description: JSON dict with parameters
drafts:
allOf:
- $ref: '#/components/schemas/SerializationOption'
description: JSON dict with parameters
include_annotation_history:
default: false
description: Include annotation history
type: boolean
interpolate_key_frames:
default: false
description: Interpolate video key frames
type: boolean
predictions:
allOf:
- $ref: '#/components/schemas/SerializationOption'
description: JSON dict with parameters
type: object
SerializationOptionsRequest:
properties:
annotations__completed_by:
allOf:
- $ref: '#/components/schemas/SerializationOptionRequest'
description: JSON dict with parameters
drafts:
allOf:
- $ref: '#/components/schemas/SerializationOptionRequest'
description: JSON dict with parameters
include_annotation_history:
default: false
description: Include annotation history
type: boolean
interpolate_key_frames:
default: false
description: Interpolate video key frames
type: boolean
predictions:
allOf:
- $ref: '#/components/schemas/SerializationOptionRequest'
description: JSON dict with parameters
type: object
SessionTimeoutPolicy:
properties:
created_at:
format: date-time
readOnly: true
type: string
max_session_age:
description: Number of minutes that a session can be active before needing to re-login
maximum: 2147483647
minimum: 1
title: Max session age (minutes)
type: integer
max_time_between_activity:
description: Number of minutes that a session stays active without any activity
maximum: 2147483647
minimum: 1
title: Max time (minutes) between activity
type: integer
updated_at:
format: date-time
readOnly: true
type: string
required:
- created_at
- updated_at
type: object
SimpleOrganizationMemberTag:
properties:
id:
readOnly: true
type: integer
label:
maxLength: 255
type: string
required:
- id
- label
type: object
SkillNameEnum:
description: |-
* `TextClassification` - TextClassification
* `NamedEntityRecognition` - NamedEntityRecognition
enum:
- TextClassification
- NamedEntityRecognition
type: string
SkipQueueEnum:
description: |-
* `REQUEUE_FOR_ME` - Requeue for me
* `REQUEUE_FOR_OTHERS` - Requeue for others
* `IGNORE_SKIPPED` - Ignore skipped
enum:
- REQUEUE_FOR_ME
- REQUEUE_FOR_OTHERS
- IGNORE_SKIPPED
type: string
SkippedEnum:
description: |-
* `only` - only
* `exclude` - exclude
* `None` - None
enum:
- only
- exclude
StateBackfillCancelResponse:
properties:
cancelled_count:
description: Number of jobs successfully cancelled
type: integer
message:
description: Cancellation status message
type: string
required:
- cancelled_count
- message
type: object
StateBackfillJobItem:
properties:
job_id:
description: Database ID of the backfill job
type: integer
project_id:
description: Project ID being backfilled
type: integer
rq_job_id:
description: Redis queue job ID
nullable: true
type: string
required:
- job_id
- project_id
type: object
StateBackfillJobItemResponse:
properties:
completed_at:
format: date-time
nullable: true
type: string
created_at:
format: date-time
type: string
error_message:
nullable: true
type: string
job_id:
type: integer
progress_data:
allOf:
- $ref: '#/components/schemas/StateBackfillProgress'
nullable: true
rq_job_id:
nullable: true
type: string
started_at:
format: date-time
nullable: true
type: string
status:
type: string
triggered_by:
allOf:
- $ref: '#/components/schemas/StateTriggeredBy'
nullable: true
required:
- created_at
- job_id
- status
type: object
StateBackfillJobListResponse:
properties:
jobs:
items:
$ref: '#/components/schemas/StateBackfillJobItemResponse'
type: array
required:
- jobs
type: object
StateBackfillOrgStatus:
properties:
completed_projects:
type: integer
failed_projects:
type: integer
pending_projects:
type: integer
running_projects:
type: integer
total_entities_processed:
type: integer
total_projects:
description: Total projects in organization
type: integer
required:
- completed_projects
- failed_projects
- pending_projects
- running_projects
- total_entities_processed
- total_projects
type: object
StateBackfillProgress:
properties:
failed_projects:
description: Projects that failed
type: integer
successful_projects:
description: Projects completed successfully
type: integer
total_entities_processed:
description: Total entities processed so far
type: integer
total_projects:
description: Total projects involved
type: integer
type: object
StateBackfillResponse:
properties:
jobs:
items:
$ref: '#/components/schemas/StateBackfillJobItem'
type: array
jobs_queued:
description: Number of jobs queued
type: integer
message:
description: Status message
type: string
organization_id:
description: Organization ID
type: integer
projects_skipped:
description: Number of projects skipped because they are already completed
type: integer
required:
- jobs
- jobs_queued
- message
- organization_id
- projects_skipped
type: object
StateBackfillStatusResponse:
properties:
completed_at:
format: date-time
nullable: true
type: string
created_at:
format: date-time
nullable: true
type: string
error_message:
nullable: true
type: string
job_id:
description: Job ID (if fetching a specific job)
type: integer
org_status:
allOf:
- $ref: '#/components/schemas/StateBackfillOrgStatus'
description: Aggregated organization status
progress:
$ref: '#/components/schemas/StateBackfillProgress'
rq_job_id:
nullable: true
type: string
rq_job_info:
additionalProperties: {}
nullable: true
type: object
started_at:
format: date-time
nullable: true
type: string
status:
type: string
triggered_by:
$ref: '#/components/schemas/StateTriggeredBy'
type: object
StateEnum:
description: |-
* `CO` - Connected
* `DI` - Disconnected
* `ER` - Error
* `TR` - Training
* `PR` - Predicting
enum:
- CO
- DI
- ER
- TR
- PR
type: string
StateModel:
description: |-
Serializer for FSM state models.
Uses Serializer instead of ModelSerializer because BaseState is abstract.
Works with any concrete state model that inherits from BaseState.
properties:
context_data:
readOnly: true
created_at:
format: date-time
readOnly: true
type: string
id:
format: uuid
readOnly: true
type: string
previous_state:
nullable: true
readOnly: true
type: string
reason:
nullable: true
readOnly: true
type: string
state:
readOnly: true
type: string
transition_name:
nullable: true
readOnly: true
type: string
triggered_by:
allOf:
- $ref: '#/components/schemas/TriggeredBy'
nullable: true
readOnly: true
required:
- context_data
- created_at
- id
- previous_state
- reason
- state
- transition_name
- triggered_by
type: object
StateTriggeredBy:
properties:
email:
type: string
first_name:
nullable: true
type: string
id:
type: integer
last_name:
nullable: true
type: string
required:
- email
- id
type: object
Status7bfEnum:
description: |-
* `created` - Created
* `in_progress` - In progress
* `failed` - Failed
* `completed` - Completed
enum:
- created
- in_progress
- failed
- completed
type: string
StatusC5aEnum:
description: |-
* `initialized` - Initialized
* `queued` - Queued
* `in_progress` - In progress
* `failed` - Failed
* `completed` - Completed
* `completed_with_errors` - Completed with errors
enum:
- initialized
- queued
- in_progress
- failed
- completed
- completed_with_errors
type: string
TaskAgreementMatrixResponse:
properties:
matrix:
description: Pairwise agreement scores matrix where matrix[i][j] is the agreement between users[i] and users[j]
items:
items:
format: double
type: number
type: array
type: array
users:
description: Expanded participant details (annotators and/or model versions)
items:
additionalProperties: {}
type: object
type: array
required:
- matrix
- users
type: object
TaskAssignment:
description: |-
TaskAssignment Serializer with FSM state support.
Note: The 'state' field will be populated from the queryset annotation
if present, preventing N+1 queries. Use .with_state() on your queryset.
The state field display is controlled by both:
- fflag_feat_fit_568_finite_state_management (FSM background calculations)
- fflag_feat_fit_710_fsm_state_fields (state field display in APIs)
properties:
assignee:
description: Assigned user
type: integer
created_at:
description: Time of assignment
format: date-time
readOnly: true
type: string
id:
readOnly: true
type: integer
state:
readOnly: true
type: string
task:
description: Assigned task
type: integer
type:
allOf:
- $ref: '#/components/schemas/TypeEnum'
description: |-
Type of assignment: Annotate|Review
* `AN` - Annotate
* `RE` - Review
title: Assignment type
required:
- assignee
- created_at
- id
- state
- task
type: object
TaskEvent:
description: |-
Serializer for TaskEvent model to handle event creation from frontend.
This serializer validates and processes task events sent from the labeling interface,
ensuring proper data format and automatically setting required relationships.
properties:
actor:
readOnly: true
type: integer
annotation:
description: Annotation ID associated with this event
nullable: true
type: integer
annotation_draft_id:
description: Draft annotation ID associated with this event
nullable: true
type: integer
created_at:
format: date-time
readOnly: true
type: string
event_key:
description: Event type identifier (e.g., "annotation_loaded", "region_finished_drawing")
maxLength: 255
type: string
event_time:
description: Timestamp when the event occurred (frontend time)
format: date-time
type: string
id:
readOnly: true
type: integer
meta:
description: Additional event metadata (region data, hotkey info, etc.)
nullable: true
organization:
readOnly: true
type: integer
project:
readOnly: true
type: integer
review:
description: Review ID associated with this event
nullable: true
type: integer
task:
description: Task this event is associated with
readOnly: true
type: integer
required:
- actor
- created_at
- event_key
- event_time
- id
- organization
- project
- task
type: object
TaskEventRequest:
description: |-
Serializer for TaskEvent model to handle event creation from frontend.
This serializer validates and processes task events sent from the labeling interface,
ensuring proper data format and automatically setting required relationships.
properties:
annotation:
description: Annotation ID associated with this event
nullable: true
type: integer
annotation_draft_id:
description: Draft annotation ID associated with this event
nullable: true
type: integer
event_key:
description: Event type identifier (e.g., "annotation_loaded", "region_finished_drawing")
maxLength: 255
minLength: 1
type: string
event_time:
description: Timestamp when the event occurred (frontend time)
format: date-time
type: string
meta:
description: Additional event metadata (region data, hotkey info, etc.)
nullable: true
review:
description: Review ID associated with this event
nullable: true
type: integer
required:
- event_key
- event_time
type: object
TaskSimple:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
annotations:
default: []
items:
$ref: '#/components/schemas/Annotation'
readOnly: true
type: array
cancelled_annotations:
description: Number of total cancelled annotations for the current task
maximum: 2147483647
minimum: -2147483648
type: integer
comment_authors:
description: Users who wrote comments
items:
type: integer
type: array
comment_count:
description: Number of comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
created_at:
description: Time a task was created
format: date-time
readOnly: true
type: string
data:
description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
file_upload:
description: Uploaded file used as data source for this task
nullable: true
type: integer
id:
readOnly: true
type: integer
inner_id:
description: Internal task ID in the project, starts with 1
format: int64
maximum: 9223372036854775807
minimum: -9223372036854775808
nullable: true
type: integer
is_labeled:
description: True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
type: boolean
last_comment_updated_at:
description: When the last comment was updated
format: date-time
nullable: true
type: string
meta:
description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
nullable: true
overlap:
description: Number of distinct annotators that processed the current task
maximum: 2147483647
minimum: -2147483648
type: integer
predictions:
default: []
items:
$ref: '#/components/schemas/Prediction'
readOnly: true
type: array
project:
description: Project ID for this task
nullable: true
type: integer
total_annotations:
description: Number of total annotations for the current task except cancelled annotations
maximum: 2147483647
minimum: -2147483648
type: integer
total_predictions:
description: Number of total predictions for the current task
maximum: 2147483647
minimum: -2147483648
type: integer
unresolved_comment_count:
description: Number of unresolved comments in the task including all annotations
maximum: 2147483647
minimum: -2147483648
type: integer
updated_at:
description: Last time a task was updated
format: date-time
readOnly: true
type: string
updated_by:
description: Last annotator or reviewer who updated this task
nullable: true
type: integer
required:
- annotations
- created_at
- data
- id
- predictions
- updated_at
type: object
ThirdPartyModelVersion:
properties:
created_at:
format: date-time
readOnly: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/UserSimple'
description: User who created Dataset
readOnly: true
id:
readOnly: true
type: integer
model_provider_connection:
nullable: true
type: integer
organization:
nullable: true
type: integer
parent_model:
description: Parent model interface ID
type: integer
prompt:
description: Prompt to execute
type: string
provider:
allOf:
- $ref: '#/components/schemas/ProviderEnum'
description: |-
The model provider to use e.g. OpenAI
* `OpenAI` - OpenAI
* `AzureOpenAI` - AzureOpenAI
* `AzureAIFoundry` - AzureAIFoundry
* `VertexAI` - VertexAI
* `Gemini` - Gemini
* `Anthropic` - Anthropic
* `Custom` - Custom
provider_model_id:
description: The model ID to use within the given provider, e.g. gpt-3.5
maxLength: 255
type: string
score:
readOnly: true
type: string
title:
description: Model name
maxLength: 500
type: string
updated_at:
format: date-time
readOnly: true
type: string
required:
- created_at
- created_by
- id
- prompt
- provider_model_id
- score
- title
- updated_at
type: object
ThirdPartyModelVersionRequest:
properties:
model_provider_connection:
nullable: true
type: integer
organization:
nullable: true
type: integer
parent_model:
description: Parent model interface ID
type: integer
prompt:
description: Prompt to execute
minLength: 1
type: string
provider:
allOf:
- $ref: '#/components/schemas/ProviderEnum'
description: |-
The model provider to use e.g. OpenAI
* `OpenAI` - OpenAI
* `AzureOpenAI` - AzureOpenAI
* `AzureAIFoundry` - AzureAIFoundry
* `VertexAI` - VertexAI
* `Gemini` - Gemini
* `Anthropic` - Anthropic
* `Custom` - Custom
provider_model_id:
description: The model ID to use within the given provider, e.g. gpt-3.5
maxLength: 255
minLength: 1
type: string
title:
description: Model name
maxLength: 500
minLength: 1
type: string
required:
- prompt
- provider_model_id
- title
type: object
TokenRefreshRequest:
properties:
refresh:
minLength: 1
type: string
writeOnly: true
required:
- refresh
type: object
TokenRefreshResponse:
properties:
access:
type: string
required:
- access
type: object
TokenRotateResponse:
properties:
refresh:
type: string
required:
- refresh
type: object
TrialRoleEnum:
description: |-
* `annotator` - Annotator
* `annotator_team_manager` - Annotator Team Manager
* `business_analyst` - Business Analyst
* `business_or_data_team_leadership` - Business Or Data Team Leadership
* `data_engineer_platform_engineer` - Data Engineer Platform Engineer
* `data_scientist` - Data Scientist
* `other` - Other
enum:
- annotator
- annotator_team_manager
- business_analyst
- business_or_data_team_leadership
- data_engineer_platform_engineer
- data_scientist
- other
type: string
TriggeredBy:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
email:
format: email
maxLength: 254
title: Email address
type: string
id:
readOnly: true
type: integer
required:
- id
type: object
TypeEnum:
description: |-
* `AN` - Annotate
* `RE` - Review
enum:
- AN
- RE
type: string
UserSimple:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
avatar:
readOnly: true
type: string
email:
format: email
maxLength: 254
title: Email address
type: string
first_name:
maxLength: 256
type: string
id:
readOnly: true
type: integer
last_name:
maxLength: 256
type: string
username:
maxLength: 256
type: string
required:
- avatar
- id
- username
type: object
UserSimpleRequest:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
email:
format: email
maxLength: 254
title: Email address
type: string
first_name:
maxLength: 256
type: string
last_name:
maxLength: 256
type: string
username:
maxLength: 256
minLength: 1
type: string
required:
- username
type: object
ValidateSamlMetadataUrlRequestRequest:
properties:
metadata_url:
format: uri
minLength: 1
type: string
required:
- metadata_url
type: object
ValidateSamlMetadataUrlResponse:
properties:
valid:
type: boolean
required:
- valid
type: object
VersionResponse:
properties:
backend:
description: Additional backend information
dm2:
description: Information about the Data Manager 2.0 component
edition:
allOf:
- $ref: '#/components/schemas/EditionEnum'
description: |-
Label Studio edition (Community or Enterprise)
* `Community` - Community
* `Enterprise` - Enterprise
label-studio-converter:
description: Information about the Label Studio converter component
label-studio-frontend:
description: Information about the Label Studio frontend
label-studio-os-backend:
description: Information about the Label Studio backend
label-studio-os-package:
description: Information about the Label Studio open source package
lsf:
description: Information about the Label Studio Frontend library
release:
description: Current release version of Label Studio
type: string
required:
- backend
- dm2
- edition
- label-studio-converter
- label-studio-frontend
- label-studio-os-backend
- label-studio-os-package
- lsf
- release
type: object
View:
properties:
data:
description: Custom view data
nullable: true
filter_group:
$ref: '#/components/schemas/FilterGroup'
id:
readOnly: true
type: integer
order:
description: Position of the tab, starting at the left in data manager and increasing as the tabs go left to right
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
ordering:
description: Ordering parameters
nullable: true
project:
description: Project ID
type: integer
selected_items:
description: Selected items
nullable: true
user:
description: User who made this view
nullable: true
type: integer
required:
- id
- project
type: object
ViewOrderRequest:
properties:
ids:
description: A list of view IDs in the desired order.
items:
type: integer
type: array
project:
type: integer
required:
- ids
- project
type: object
Webhook:
properties:
actions:
default: []
items:
$ref: '#/components/schemas/ActionsEnum'
type: array
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
headers:
description: Key Value Json of headers
title: Request extra headers of webhook
id:
readOnly: true
type: integer
is_active:
description: If value is False the webhook is disabled
title: Is webhook active
type: boolean
organization:
readOnly: true
type: integer
project:
nullable: true
type: integer
send_for_all_actions:
description: If value is False - used only for actions from WebhookAction
title: Use webhook for all actions
type: boolean
send_payload:
description: If value is False send only action
title: Does webhook send the payload
type: boolean
updated_at:
description: Last update time
format: date-time
readOnly: true
type: string
url:
description: URL of webhook
format: uri
maxLength: 2048
title: URL of webhook
type: string
required:
- created_at
- id
- organization
- updated_at
- url
type: object
WebhookRequest:
properties:
actions:
default: []
items:
$ref: '#/components/schemas/ActionsEnum'
type: array
headers:
description: Key Value Json of headers
title: Request extra headers of webhook
is_active:
description: If value is False the webhook is disabled
title: Is webhook active
type: boolean
project:
nullable: true
type: integer
send_for_all_actions:
description: If value is False - used only for actions from WebhookAction
title: Use webhook for all actions
type: boolean
send_payload:
description: If value is False send only action
title: Does webhook send the payload
type: boolean
url:
description: URL of webhook
format: uri
maxLength: 2048
minLength: 1
title: URL of webhook
type: string
required:
- url
type: object
WebhookSerializerForUpdate:
description: |-
Serializer class for updating webhooks
Used to forbid updating project field.
properties:
actions:
default: []
items:
$ref: '#/components/schemas/ActionsEnum'
type: array
created_at:
description: Creation time
format: date-time
readOnly: true
type: string
headers:
description: Key Value Json of headers
title: Request extra headers of webhook
id:
readOnly: true
type: integer
is_active:
description: If value is False the webhook is disabled
title: Is webhook active
type: boolean
organization:
readOnly: true
type: integer
project:
nullable: true
readOnly: true
type: integer
send_for_all_actions:
description: If value is False - used only for actions from WebhookAction
title: Use webhook for all actions
type: boolean
send_payload:
description: If value is False send only action
title: Does webhook send the payload
type: boolean
updated_at:
description: Last update time
format: date-time
readOnly: true
type: string
url:
description: URL of webhook
format: uri
maxLength: 2048
title: URL of webhook
type: string
required:
- created_at
- id
- organization
- project
- updated_at
- url
type: object
WebhookSerializerForUpdateRequest:
description: |-
Serializer class for updating webhooks
Used to forbid updating project field.
properties:
actions:
default: []
items:
$ref: '#/components/schemas/ActionsEnum'
type: array
headers:
description: Key Value Json of headers
title: Request extra headers of webhook
is_active:
description: If value is False the webhook is disabled
title: Is webhook active
type: boolean
send_for_all_actions:
description: If value is False - used only for actions from WebhookAction
title: Use webhook for all actions
type: boolean
send_payload:
description: If value is False send only action
title: Does webhook send the payload
type: boolean
url:
description: URL of webhook
format: uri
maxLength: 2048
minLength: 1
title: URL of webhook
type: string
required:
- url
type: object
WhoAmILseFields:
properties:
active_organization_external_id:
nullable: true
readOnly: true
type: string
email_notification_settings:
readOnly: true
type: string
invite_activated:
nullable: true
type: boolean
invite_expired:
readOnly: true
type: string
invite_expired_at:
readOnly: true
type: string
invited_at:
format: date-time
nullable: true
type: string
invited_by:
nullable: true
type: integer
onboarding_state:
allOf:
- $ref: '#/components/schemas/OnboardingStateEnum'
description: |-
The current stage of user onboarding
* `not_started` - Not Started
* `signup` - Signup
* `trial_signup` - Trial Signup
* `first_tutorial` - First Tutorial
* `in_app_guidance` - In App Guidance
* `complete` - Complete
nullable: true
social_auth_finished:
description: Is user finished social authentication
nullable: true
type: boolean
trial_company:
maxLength: 1000
nullable: true
type: string
trial_experience_labeling:
maxLength: 1000
nullable: true
type: string
trial_license_enterprise:
nullable: true
type: boolean
trial_models_in_production:
maxLength: 1000
nullable: true
type: string
trial_role:
allOf:
- $ref: '#/components/schemas/TrialRoleEnum'
nullable: true
required:
- active_organization_external_id
- email_notification_settings
- invite_expired
- invite_expired_at
type: object
WhoAmIUser:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
active_organization:
nullable: true
type: integer
active_organization_meta:
readOnly: true
type: string
allow_newsletters:
description: Allow sending newsletters to user
nullable: true
type: boolean
avatar:
readOnly: true
type: string
custom_hotkeys:
description: Custom keyboard shortcuts configuration for the user interface
nullable: true
date_joined:
format: date-time
type: string
email:
format: email
maxLength: 254
title: Email address
type: string
first_name:
maxLength: 256
type: string
id:
readOnly: true
type: integer
initials:
default: '?'
readOnly: true
type: string
last_activity:
format: date-time
readOnly: true
type: string
last_name:
maxLength: 256
type: string
lse_fields:
allOf:
- $ref: '#/components/schemas/WhoAmILseFields'
readOnly: true
org_membership:
deprecated: true
items:
$ref: '#/components/schemas/OrganizationMembership'
readOnly: true
type: array
organization_membership:
allOf:
- $ref: '#/components/schemas/OrganizationMembership'
readOnly: true
pause:
readOnly: true
type: string
permissions:
items:
type: string
readOnly: true
type: array
phone:
maxLength: 256
type: string
username:
maxLength: 256
type: string
required:
- active_organization_meta
- avatar
- id
- initials
- last_activity
- lse_fields
- org_membership
- organization_membership
- pause
- permissions
- username
type: object
Workspace:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
color:
description: Color
maxLength: 16
nullable: true
type: string
created_by:
readOnly: true
type: integer
created_by_user:
readOnly: true
type: string
description:
description: Workspace description
nullable: true
type: string
id:
readOnly: true
type: integer
is_archived:
description: Workspace is archived
title: Archived
type: boolean
is_personal:
description: Workspace is a personal user workspace
title: Personal
type: boolean
membership:
readOnly: true
type: string
projects_count:
nullable: true
readOnly: true
type: integer
title:
description: Workspace Name
maxLength: 1000
type: string
required:
- created_by
- created_by_user
- id
- membership
- projects_count
- title
type: object
WorkspaceMemberBulkAssignRequest:
properties:
all:
description: Apply to all workspace members
type: boolean
excluded:
description: Excluded user IDs
items:
minimum: 1
type: integer
type: array
included:
description: Included user IDs
items:
minimum: 1
type: integer
type: array
required:
- all
type: object
WorkspaceMemberCreate:
properties:
user:
description: User ID
type: integer
workspace:
description: Workspace ID
type: integer
required:
- user
type: object
WorkspaceMemberCreateRequest:
properties:
user:
description: User ID
type: integer
workspace:
description: Workspace ID
type: integer
required:
- user
type: object
WorkspaceMemberList:
properties:
user:
$ref: '#/components/schemas/LseUser'
workspace:
description: Workspace ID
type: integer
required:
- user
type: object
WorkspaceProjectsRequest:
properties:
project:
description: Project ID
type: integer
required:
- project
type: object
WorkspaceRequest:
description: |-
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations
properties:
color:
description: Color
maxLength: 16
nullable: true
type: string
description:
description: Workspace description
nullable: true
type: string
is_archived:
description: Workspace is archived
title: Archived
type: boolean
is_personal:
description: Workspace is a personal user workspace
title: Personal
type: boolean
title:
description: Workspace Name
maxLength: 1000
minLength: 1
type: string
required:
- title
type: object
securitySchemes:
Token:
description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:
curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"
'
in: header
name: Authorization
type: apiKey
x-fern-header:
env: LABEL_STUDIO_API_KEY
name: api_key
prefix: 'Token '
servers:
- description: Label Studio
url: http://localhost:8000