Scale ai
scale_aiScale AI provides data labeling and annotation services for machine learning, offering access to a global workforce and sophisticated tools for training AI models with high-quality labeled data
Acciones disponibles (41)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Studio AssignmentsSCALE_AI_ADD_STUDIO_ASSIGNMENTSAcciónTool to add project assignments to team members in Scale AI Studio. Use when you need to assign specific projects to team members by their email addresses. This action creates new assignments for the specified team members and projects.
SCALE_AI_ADD_STUDIO_ASSIGNMENTSAcciónTool to add project assignments to team members in Scale AI Studio. Use when you need to assign specific projects to team members by their email addresses. This action creates new assignments for the specified team members and projects.
Parámetros de entrada
emailsstring[]ObligatorioArray of email addresses of teammates to assign projects to.
projectsstring[]ObligatorioArray of project names to assign to the specified teammates.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Task TagsSCALE_AI_ADD_TASK_TAGSAcciónTool to add tags to an existing task. Use when you need to tag or categorize tasks for organization and filtering. Automatically avoids duplicate tags.
SCALE_AI_ADD_TASK_TAGSAcciónTool to add tags to an existing task. Use when you need to tag or categorize tasks for organization and filtering. Automatically avoids duplicate tags.
Parámetros de entrada
tagsstring[]ObligatorioList of tags to add to the task. Tags must be non-empty strings. If a tag already exists on the task, it will be ignored to avoid duplication.
task_idstringObligatorioThe unique identifier of the task to add tags to.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create BatchSCALE_AI_CREATE_BATCHAcciónTool to create a new batch within a project. Use when you need to group multiple tasks together for organizational and processing purposes.
SCALE_AI_CREATE_BATCHAcciónTool to create a new batch within a project. Use when you need to group multiple tasks together for organizational and processing purposes.
Parámetros de entrada
namestringObligatorioName identifying this batch. Must be unique among all batches belonging to a customer.
projectstringObligatorioThe name of the project this batch (and its tasks) belong to.
callbackstringThe full URL (including the scheme http:// or https://) or email address of the callback that will be used when tasks are completed.
self_label_batchbooleanOnly applicable for Rapid projects. Create a self label batch by setting this flag to true.
calibration_batchbooleanOnly applicable for Rapid projects. Create a calibration batch by setting this flag to true.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Document Transcription TaskSCALE_AI_CREATE_DOCUMENT_TRANSCRIPTION_TASKAcciónTool to create a document transcription task where workers transcribe and annotate information from single or multi-page documents. Use when you need to extract structured data from documents like invoices, forms, or screenshots.
SCALE_AI_CREATE_DOCUMENT_TRANSCRIPTION_TASKAcciónTool to create a document transcription task where workers transcribe and annotate information from single or multi-page documents. Use when you need to extract structured data from documents like invoices, forms, or screenshots.
Parámetros de entrada
langstringLanguage code for the attachment (Default: 'en-US')
tagsstring[]Arbitrary labels for task organization (maximum 5 tags allowed)
batchstringBatch name; automatically associates task with the batch's project
titlestringTask title
projectstringName of the project to associate this task with
featuresobject[]Array of field definitions describing what data to transcribe
geometrystringGeometry type for annotations: 'box' (axis-aligned rectangles) or 'polygon' (rotated rectangles). Default: 'box'
metadataobjectCustom metadata as key-value pairs for storing additional structured information
priorityintegerTask priority level (Range: 0-100, Default: 30)
unique_idstringArbitrary unique identifier for task deduplication and later querying
attachmentstringURL of a single document to be transcribed. Either attachment or attachments is required
hypothesisobjectPre-labels to accelerate annotation, matching the task's response schema
attachmentsstring[]Array of URLs for multi-page documents. Either attachment or attachments is required
descriptionstringTask description
instructionstringObligatorioMarkdown-enabled instructions explaining the task to taskers
callback_urlstringFull URL (including scheme) or email address for completion notification
responses_requiredintegerNumber of responses needed (Default: 1)
clear_unique_id_on_errorbooleanIf true, unsets unique_id if task errors after submission
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Image Annotation TaskSCALE_AI_CREATE_IMAGE_ANNOTATION_TASKAcciónTool to create an image annotation task where annotators label images with vector geometric shapes (box, polygon, line, point, cuboid, ellipse). Use when you need to annotate objects in images with bounding boxes, polygons, or other geometric annotations.
SCALE_AI_CREATE_IMAGE_ANNOTATION_TASKAcciónTool to create an image annotation task where annotators label images with vector geometric shapes (box, polygon, line, point, cuboid, ellipse). Use when you need to annotate objects in images with bounding boxes, polygons, or other geometric annotations.
Parámetros de entrada
tagsstring[]Up to 5 arbitrary string labels for task organization and filtering
batchstringName of the batch to associate this task with. Required for Scale Rapid projects. If batch is specified, project need not be specified as task will automatically be associated with the batch's project
layerobjectRead-only pre-drawn annotations
linksobjectDefines connections between annotations
paddingintegerImage padding in pixels applied to all sides
projectstringName of the project to associate this task with
metadataobjectCustom key-value pairs for arbitrary data (max 10KB)
paddingXintegerHorizontal image padding in pixels. Overrides padding parameter
paddingYintegerVertical image padding in pixels. Overrides padding parameter
priorityintegerenumTask priority level: 10 (low), 20 (medium), or 30 (high)
102030unique_idstringArbitrary identifier that must be unique across account. Prevents duplicate task creation
attachmentstringObligatorioURL to the image to be annotated
geometriesobjectObligatorioSpecifies annotation shapes and their configurations. At least one geometry type must be provided (box, polygon, line, point, cuboid, or ellipse)
hypothesisobjectPre-labels from model predictions for refinement. Contains annotations array matching response schema
instructionstringMarkdown-enabled instructions for annotators explaining how to do the task. Omit for Scale Rapid unless overriding project defaults
callback_urlstringFull URL (http/https) or email address for completion notification
image_metadataobjectMetadata about the image being annotated.
base_annotationsanyEditable pre-drawn annotations with optional locking capabilities
context_attachmentsobject[]Reference images displayed to annotators but not labeled. Cannot include the task's primary attachment
annotation_attributesobjectCaptures additional metadata per annotation
can_add_base_annotationsbooleanPermits adding new annotations beyond base_annotations
clear_unique_id_on_errorbooleanUnsets unique_id if task errors after submission
can_edit_base_annotationsbooleanAllows modification of base_annotations position/attributes
can_delete_base_annotationsbooleanAllows removal of base_annotations
can_edit_base_annotation_labelsbooleanPermits label changes to base_annotations
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Lidar Annotation TaskSCALE_AI_CREATE_LIDAR_ANNOTATION_TASKAcciónTool to create a lidar annotation task where annotators mark objects with 3D cuboids in 3D space. Use when you need to annotate LIDAR frame sequences with 3D object detection.
SCALE_AI_CREATE_LIDAR_ANNOTATION_TASKAcciónTool to create a lidar annotation task where annotators mark objects with 3D cuboids in 3D space. Use when you need to annotate LIDAR frame sequences with 3D object detection.
Parámetros de entrada
tagsstring[]Task labels (max 5 per task).
batchstringBatch name; auto-associates with batch's project.
labelsstring[]ObligatorioObject types to annotate. Maximum 50 objects supported.
projectstringProject name for task association.
metadataobjectCustom key-value pairs (max 10KB).
priorityintegerTask priority: 10, 20, or 30.
unique_idstringCustom unique identifier for task deduplication.
attachmentsstring[]ObligatorioList of URLs to the Frame objects you'd like to be labeled. Frames should be time-ordered naturally.
instructionstringMarkdown-enabled task instructions for annotators.
callback_urlstringThe full url (including the scheme http:// or https://) of the callback when the task is completed.
attachment_typestringObligatorioSpecifies file format: 'json' (default) or 'protobuf'.
meters_per_unitintegerConversion rate of point data units to meters.
polygons_labelsstring[]Polygon types to annotate.
polygons_enabledbooleanEnables polygon annotations.
frames_per_secondintegerFrame capture frequency.
max_distance_metersintegerMaximum labeling distance from sensor in meters.
labeling_sample_rateintegerSampling rate for full frame labeling. With rate k and n frames total, labeled frames are 1st, (k+1)th, (2k+1)th, etc.
annotation_attributesobjectAdditional per-annotation attributes.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create LiDAR Segmentation TaskSCALE_AI_CREATE_LIDAR_SEGMENTATION_TASKAcciónTool to create a LiDAR segmentation task where annotators assign semantic class labels to individual LiDAR points. Use when you need to annotate point cloud data with object classes such as vehicles, pedestrians, roads, buildings, etc. Either 'project' or 'batch' must be provided in the request.
SCALE_AI_CREATE_LIDAR_SEGMENTATION_TASKAcciónTool to create a LiDAR segmentation task where annotators assign semantic class labels to individual LiDAR points. Use when you need to annotate point cloud data with object classes such as vehicles, pedestrians, roads, buildings, etc. Either 'project' or 'batch' must be provided in the request.
Parámetros de entrada
tagsstring[]Up to 5 arbitrary labels per task for organization and filtering purposes.
batchstringBatch name to associate with this task. If batch is provided, the batch's project is auto-assigned. Either 'project' or 'batch' must be provided.
labelsstring[]ObligatorioObject classes for which semantic information is desired. Annotators will assign these semantic classes to each LiDAR point.
projectstringProject name to associate with this task. Either 'project' or 'batch' must be provided.
metadataobjectKey-value pairs (max 10KB) for structured task information. Use this to store custom data related to the task.
priorityintegerenumTask priority level. Valid values are 10 (low), 20 (medium), or 30 (high).
102030unique_idstringArbitrary unique identifier across your account. Use this to prevent duplicate task creation.
attachmentsstring[]ObligatorioURLs to Frame objects you'd like to be labeled. Each URL should point to a valid frame data file.
instructionstringMarkdown-enabled task instructions with examples to guide annotators.
callback_urlstringFull URL (http:// or https://) for task completion notification. Scale will send a POST request to this URL when the task is completed.
attachment_typestringObligatorioenumFile format of the attachments. Must be either 'json' or 'protobuf'.
jsonprotobufannotation_attributesobjectAdditional attributes to capture per annotation. Define custom attributes for the annotation process.
clear_unique_id_on_errorbooleanReset unique_id if task errors. Set to true to allow resubmission of failed tasks with the same unique_id.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Named Entity Recognition TaskSCALE_AI_CREATE_NAMED_ENTITY_RECOGNITION_TASKAcciónTool to create a named entity recognition task for labelers to highlight text entity mentions. Use when you need to extract and label entities such as people, organizations, or locations from text.
SCALE_AI_CREATE_NAMED_ENTITY_RECOGNITION_TASKAcciónTool to create a named entity recognition task for labelers to highlight text entity mentions. Use when you need to extract and label entities such as people, organizations, or locations from text.
Parámetros de entrada
tagsstring[]Custom labels (maximum 5 per task)
textstringObligatorioThe text from which to extract named entities
batchstringBatch association (required for Scale Rapid projects)
labelsobject[]ObligatorioArray of label definitions for entity types to identify
projectstringProject association for the task
metadataobjectCustom metadata object for the task
unique_idstringArbitrary unique identifier for the task
attachmentsobject[]Array of attachments with additional context
instructionstringObligatorioMarkdown-enabled instructions for task completion
callback_urlstringWebhook URL for task completion notifications
relationshipsobject[]Array of relationship definitions between entities
merge_newlinesbooleanControls newline character handling in text
allow_overlapping_annotationsbooleanPermits overlapping text spans in annotations
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Segmentation Annotation TaskSCALE_AI_CREATE_SEGMENTATION_ANNOTATION_TASKAcciónTool to create a segmentation task where annotators classify pixels in an image according to provided labels. Use when you need pixel-wise semantic segmentation of images.
SCALE_AI_CREATE_SEGMENTATION_ANNOTATION_TASKAcciónTool to create a segmentation task where annotators classify pixels in an image according to provided labels. Use when you need pixel-wise semantic segmentation of images.
Parámetros de entrada
tagsstring[]Arbitrary labels to assign to task. Maximum 5 per task
batchstringBatch name for task association; overrides project requirement
labelsarrayObligatorioArray of strings or LabelDescription objects describing different types of objects for image segmentation. Maximum 50 labels.
projectstringName of the project to associate this task with
metadataobjectSet of key/value pairs to attach to task object. Maximum 10KB
unique_idstringCustom identifier; must be unique across your account
attachmentstringObligatorioURL to the image requiring segmentation
hypothesisobjectPre-labeled annotations for refinement by annotators. Editable annotations that a task should be initialized with, useful for model pre-labeling scenarios
instructionstringMarkdown-enabled string or iframe embed Google Doc explaining how to do the segmentation
callback_urlstringFull URL (including http:// or https://) or email address for callback notification
allow_unlabeledbooleanWhether this image can be completed without every pixel being labeled
attachment_typestringDescribes file type; currently supports 'image' only
context_attachmentsobject[]Reference images in [{"attachment": "<url>"}] format; cannot include task URL
annotation_attributesobjectAdditional attributes to capture per annotation with structure containing type, description, choices, and conditions
clear_unique_id_on_errorbooleanAuto-reset unique_id if task errors post-submission
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Text Collection TaskSCALE_AI_CREATE_TEXT_COLLECTION_TASKAcciónTool to create a textcollection task for collecting information from attachments and/or web sources. Use when you need to gather structured data from documents, websites, images, or other content by having taskers fill out defined fields.
SCALE_AI_CREATE_TEXT_COLLECTION_TASKAcciónTool to create a textcollection task for collecting information from attachments and/or web sources. Use when you need to gather structured data from documents, websites, images, or other content by having taskers fill out defined fields.
Parámetros de entrada
tagsstring[]Arbitrary labels for task organization (maximum 5 tags allowed)
batchstringBatch name; automatically associates task with the batch's project
titlestringTask title
fieldsobject[]ObligatorioArray of field definitions describing data to collect
projectstringProject name to associate this task with
metadataobjectCustom metadata as key-value pairs
priorityintegerTask priority level. Must be one of: 10, 20, 30, 40, or 50. Default: 30
unique_idstringUnique identifier for task deduplication and later querying
hypothesisobjectPre-labels to accelerate annotation, matching the task's response schema
attachmentsobject[]Array of attachments to collect information from
descriptionstringTask description
instructionstringObligatorioMarkdown-enabled instructions explaining the task to taskers
callback_urlstringFull URL (http:// or https://) or email address for completion callback
responses_requiredintegerNumber of responses needed (default: 1)
clear_unique_id_on_errorbooleanIf true, unsets unique_id if task errors after submission
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Video Annotation TaskSCALE_AI_CREATE_VIDEO_ANNOTATION_TASKAcciónTool to create a video annotation task where annotators draw geometric shapes around specified objects across video frames. Use when you need to annotate video content with bounding boxes, polygons, lines, points, cuboids, or ellipses. Accepts either individual image frames or video files.
SCALE_AI_CREATE_VIDEO_ANNOTATION_TASKAcciónTool to create a video annotation task where annotators draw geometric shapes around specified objects across video frames. Use when you need to annotate video content with bounding boxes, polygons, lines, points, cuboids, or ellipses. Accepts either individual image frames or video files.
Parámetros de entrada
tagsstring[]Up to 5 arbitrary labels per task
batchstringBatch name; automatically associates with the batch's project
paddingintegerPixel padding around all video frame edges
projectstringProject name for task association
metadataobjectKey-value pairs for structured task info (max 10KB)
paddingXintegerLeft/right padding in pixels; overrides padding if set
paddingYintegerTop/bottom padding in pixels; overrides padding if set
priorityintegerenumTask priority level where higher values indicate higher priority
102030unique_idstringArbitrary unique identifier for later retrieval (must be unique across all projects)
attachmentstringVideo file URL (mp4, webm, or ogg format). Required if attachment_type is 'video'.
frame_rateintegerFrames per second to annotate
geometriesobjectObligatorioMapping of annotation types to their configurations. At least one geometry type must be specified.
attachmentsstring[]Array of image frame URLs. Required if attachment_type is 'image'.
instructionstringTask instructions in markdown format or Google Doc URL explaining the annotation task
callback_urlstringFull URL or email address for completion notification
attachment_typestringObligatorioenumEither 'image' or 'video' to specify input format. Use 'image' for individual frames or 'video' for video files.
imagevideoevents_to_annotatestring[]List of event descriptions to annotate in the video
annotation_attributesobjectAdditional attributes to capture per annotation with type, description, choices, and conditions
clear_unique_id_on_errorbooleanIf true, unsets unique_id if task errors post-submission
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Video Playback Annotation TaskSCALE_AI_CREATE_VIDEO_PLAYBACK_ANNOTATION_TASKAcciónTool to create a video playback annotation task where annotators draw shapes around specified objects in video files. Use when you need to annotate videos with bounding boxes, polygons, lines, points, cuboids, or ellipses for object detection and tracking.
SCALE_AI_CREATE_VIDEO_PLAYBACK_ANNOTATION_TASKAcciónTool to create a video playback annotation task where annotators draw shapes around specified objects in video files. Use when you need to annotate videos with bounding boxes, polygons, lines, points, cuboids, or ellipses for object detection and tracking.
Parámetros de entrada
tagsstring[]Up to 5 arbitrary labels per task
batchstringBatch name; required for Scale Rapid projects
paddingintegerPixel padding around all video frame edges
projectstringProject name for task association
metadataobjectKey-value pairs for structured task info (max 10KB)
paddingXintegerLeft/right padding in pixels; overrides padding if set
paddingYintegerTop/bottom padding in pixels; overrides padding if set
priorityintegerenumTask priority level where higher values indicate higher priority
102030unique_idstringArbitrary unique identifier for later retrieval (must be unique across all projects)
attachmentstringObligatorioURL to video file in mp4, webm, or ogg format
frame_rateintegerFrames per second to capture for annotation
geometriesobjectObligatorioMapping of annotation types to their configurations. At least one geometry type must be specified.
start_timeintegerStart time in seconds for video annotation
attachmentsstring[]Array of image frame URLs. Use this instead of attachment if attachment_type is 'image'.
instructionstringTask instructions in markdown format or Google Doc URL explaining the annotation task
callback_urlstringFull URL or email address for task completion notification
duration_timeinteger[]Video duration range in seconds [start, end]
attachment_typestringenumEither 'image' or 'video' to specify input format. Defaults to 'video' for video playback tasks.
imagevideobase_annotationsobjectPre-labeled annotations for refinement. Keys are frame identifiers, values are arrays of annotations.
events_to_annotatestring[]List of event descriptions to annotate in the video
annotation_attributesobjectAdditional attributes to capture per annotation with type, description, choices, and conditions
can_add_base_annotationsbooleanWhether annotators can add new annotations beyond base_annotations
clear_unique_id_on_errorbooleanIf true, unsets unique_id if task errors post-submission
can_edit_base_annotationsbooleanWhether annotators can modify existing base_annotations
can_delete_base_annotationsbooleanWhether annotators can remove base_annotations
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Task TagsSCALE_AI_DELETE_TASK_TAGSAcciónTool to remove specified tags from a Scale AI task. Use when you need to clean up or modify task tags.
SCALE_AI_DELETE_TASK_TAGSAcciónTool to remove specified tags from a Scale AI task. Use when you need to clean up or modify task tags.
Parámetros de entrada
tagsstring[]ObligatorioList of tag strings to remove from the task
task_idstringObligatorioID of the task to remove tags from
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Task Unique IDSCALE_AI_DELETE_TASK_UNIQUE_IDAcciónTool to remove the unique identifier from a task. Use when you need to remove a task's unique identifier for enhanced data management control.
SCALE_AI_DELETE_TASK_UNIQUE_IDAcciónTool to remove the unique identifier from a task. Use when you need to remove a task's unique identifier for enhanced data management control.
Parámetros de entrada
task_idstringObligatorioID of the Task to modify
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Finalize BatchSCALE_AI_FINALIZE_BATCHAcciónTool to finalize a batch so its tasks can be worked on. Use when you need to finalize a batch for Scale Rapid and Studio customers. For other customer types, this endpoint returns success without performing any action.
SCALE_AI_FINALIZE_BATCHAcciónTool to finalize a batch so its tasks can be worked on. Use when you need to finalize a batch for Scale Rapid and Studio customers. For other customer types, this endpoint returns success without performing any action.
Parámetros de entrada
batch_namestringObligatorioThe name of the batch to finalize. This batch must exist before it can be finalized.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get AssetsSCALE_AI_GET_ASSETSAcciónTool to retrieve file assets with filtering capabilities by project and metadata. Use when you need to list or search for files uploaded to Scale AI, filtered by project and optionally by metadata. Supports cursor-based pagination for large result sets.
SCALE_AI_GET_ASSETSAcciónTool to retrieve file assets with filtering capabilities by project and metadata. Use when you need to list or search for files uploaded to Scale AI, filtered by project and optionally by metadata. Supports cursor-based pagination for large result sets.
Parámetros de entrada
cursorstringCursor for pagination to retrieve the next page of results. Use the cursor value from a previous response to get the next page.
projectstringObligatorioProject filter to retrieve assets associated with a specific project. This parameter is required.
metadatastringMetadata filter to retrieve assets matching specific metadata criteria.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get BatchSCALE_AI_GET_BATCHAcciónTool to retrieve the details of a batch with the specified name. Use when you need to check the status or configuration of an existing batch.
SCALE_AI_GET_BATCHAcciónTool to retrieve the details of a batch with the specified name. Use when you need to check the status or configuration of an existing batch.
Parámetros de entrada
batch_namestringObligatorioThe batch identifier to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Batch StatusSCALE_AI_GET_BATCH_STATUSAcciónTool to retrieve the current status of a batch and task completion counts. Use when you need to monitor batch progress or check how many tasks are pending or completed.
SCALE_AI_GET_BATCH_STATUSAcciónTool to retrieve the current status of a batch and task completion counts. Use when you need to monitor batch progress or check how many tasks are pending or completed.
Parámetros de entrada
batch_namestringObligatorioThe name of the batch to retrieve status for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Fixless AuditsSCALE_AI_GET_FIXLESS_AUDITSAcciónTool to retrieve fixless audits by task ID or audit ID. Use when you need to fetch audit information for quality assessment. At least one of task_id or id must be provided.
SCALE_AI_GET_FIXLESS_AUDITSAcciónTool to retrieve fixless audits by task ID or audit ID. Use when you need to fetch audit information for quality assessment. At least one of task_id or id must be provided.
Parámetros de entrada
idstringIdentifier for the specific audit. At least one of task_id or id must be provided.
task_idstringIdentifier for the task being audited. At least one of task_id or id must be provided.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ProjectSCALE_AI_GET_PROJECTAcciónTool to retrieve details about a specific Scale AI project using its unique identifier. Use when you need to get project metadata including type, name, parameter history, and creation timestamp.
SCALE_AI_GET_PROJECTAcciónTool to retrieve details about a specific Scale AI project using its unique identifier. Use when you need to get project metadata including type, name, parameter history, and creation timestamp.
Parámetros de entrada
namestringObligatorioThe unique project identifier to retrieve. This is the project name.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Quality LabelersSCALE_AI_GET_QUALITY_LABELERSAcciónTool to retrieve training attempts matching provided filter parameters. Use when you need to assess labeler performance and understanding of task instructions. At least one of quality_task_ids or labeler_emails must be provided.
SCALE_AI_GET_QUALITY_LABELERSAcciónTool to retrieve training attempts matching provided filter parameters. Use when you need to assess labeler performance and understanding of task instructions. At least one of quality_task_ids or labeler_emails must be provided.
Parámetros de entrada
limitintegerMaximum number of training attempt records to return per request.
next_tokenstringPagination token for retrieving subsequent result pages. Use the next_token value from a previous response to get the next page of results.
labeler_emailsstring[]Filter results by labeler email addresses. At least one of quality_task_ids or labeler_emails must be provided.
quality_task_idsstring[]Filter results by specific quality task identifiers. At least one of quality_task_ids or labeler_emails must be provided.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Studio AssignmentsSCALE_AI_GET_STUDIO_ASSIGNMENTSAcciónTool to retrieve current project assignments of all active team users in Scale AI Studio. Use when you need to view team member assignments and workload distribution. Excludes invited or disabled team members.
SCALE_AI_GET_STUDIO_ASSIGNMENTSAcciónTool to retrieve current project assignments of all active team users in Scale AI Studio. Use when you need to view team member assignments and workload distribution. Excludes invited or disabled team members.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Studio BatchesSCALE_AI_GET_STUDIO_BATCHESAcciónTool to retrieve basic information about all pending batches in Studio. Use when you need to list batches organized by priority level.
SCALE_AI_GET_STUDIO_BATCHESAcciónTool to retrieve basic information about all pending batches in Studio. Use when you need to list batches organized by priority level.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TaskSCALE_AI_GET_TASKAcciónTool to retrieve detailed information about a specific task in Scale AI. Use when you need to check task status, review task parameters, or access task results.
SCALE_AI_GET_TASKAcciónTool to retrieve detailed information about a specific task in Scale AI. Use when you need to check task status, review task parameters, or access task results.
Parámetros de entrada
task_idstringObligatorioThe unique identifier of the task to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TeamsSCALE_AI_GET_TEAMSAcciónTool to retrieve basic information about all team members associated with the account. Use when you need to list team members, check roles, or view notification preferences.
SCALE_AI_GET_TEAMSAcciónTool to retrieve basic information about all team members associated with the account. Use when you need to list team members, check roles, or view notification preferences.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Task by IDSCALE_AI_GET_V1_TASKAcciónTool to retrieve detailed information about a specific task using its task ID. Use when you need to check task status, retrieve results, or analyze task metadata.
SCALE_AI_GET_V1_TASKAcciónTool to retrieve detailed information about a specific task using its task ID. Use when you need to check task status, retrieve results, or analyze task metadata.
Parámetros de entrada
task_idstringObligatorioThe unique identifier of the task to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Secure Task Response URLSCALE_AI_GET_V1_TASK_RESPONSE_URLAcciónTool to retrieve secure authenticated task response data. Use when you need to access stored response data for 2D segmentation, video, and lidar tasks that cannot be included in the task JSON.
SCALE_AI_GET_V1_TASK_RESPONSE_URLAcciónTool to retrieve secure authenticated task response data. Use when you need to access stored response data for 2D segmentation, video, and lidar tasks that cannot be included in the task JSON.
Parámetros de entrada
uuidstringObligatorioThe unique identifier for the secure result URL
task_idstringObligatorioThe unique identifier for the task
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Import FileSCALE_AI_IMPORT_FILEAcciónTool to import files from an external URL endpoint into Scale's system rather than uploading directly from local storage. Use when you need to import files from remote URLs for Scale AI projects or data labeling tasks.
SCALE_AI_IMPORT_FILEAcciónTool to import files from an external URL endpoint into Scale's system rather than uploading directly from local storage. Use when you need to import files from remote URLs for Scale AI projects or data labeling tasks.
Parámetros de entrada
file_urlstringObligatorioThe file URL to be imported. Files are subject to Scale's 80 MB per-file size limit.
project_namestringAssociates the imported file with a specific project; only used for Scale Rapid data labeling tool.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Invite Team MemberSCALE_AI_INVITE_TEAM_MEMBERAcciónTool to invite users by email to team with specified role. Use when you need to add new team members with roles like labeler, member, or manager.
SCALE_AI_INVITE_TEAM_MEMBERAcciónTool to invite users by email to team with specified role. Use when you need to add new team members with roles like labeler, member, or manager.
Parámetros de entrada
emailsstring[]ObligatorioArray of email addresses of teammates you want to invite.
team_rolestringObligatorioRole of invited teammate. Must be one of: 'labeler' (Studio only), 'member', or 'manager'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List BatchesSCALE_AI_LIST_BATCHESAcciónTool to retrieve all batches in descending order by creation date. Use when you need to list batches with optional filtering by project, status, or time range. Supports pagination via limit and offset parameters.
SCALE_AI_LIST_BATCHESAcciónTool to retrieve all batches in descending order by creation date. Use when you need to list batches with optional filtering by project, status, or time range. Supports pagination via limit and offset parameters.
Parámetros de entrada
limitintegerPage size determining number of results per request.
offsetintegerNumber of results to skip for pagination.
statusstringenumFilters by batch status. Valid values: 'staging', 'in_progress', or 'completed'.
stagingin_progresscompletedprojectstringFilters batches by project name.
detailedbooleanReturns additional progress information about batches when set to true.
end_timestringMaximum value of created_at for returned batches in ISO 8601 format.
start_timestringMinimum value of created_at for returned batches in ISO 8601 format.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ProjectsSCALE_AI_LIST_PROJECTSAcciónTool to retrieve information for all projects in the Scale AI account with optional archived filtering. Use when you need to browse or manage project metadata. Returns project details including type, name, parameter history, and creation timestamps.
SCALE_AI_LIST_PROJECTSAcciónTool to retrieve information for all projects in the Scale AI account with optional archived filtering. Use when you need to browse or manage project metadata. Returns project details including type, name, parameter history, and creation timestamps.
Parámetros de entrada
archivedbooleanFilter to display only archived or unarchived projects. If not provided, all projects are returned.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TasksSCALE_AI_LIST_TASKSAcciónTool to retrieve a paginated list of tasks in descending order by creation time. Use when you need to browse tasks with optional filtering by status, type, project, batch, tags, timestamps, or unique identifiers. Supports pagination via limit and next_token.
SCALE_AI_LIST_TASKSAcciónTool to retrieve a paginated list of tasks in descending order by creation time. Use when you need to browse tasks with optional filtering by status, type, project, batch, tags, timestamps, or unique identifiers. Supports pagination via limit and next_token.
Parámetros de entrada
tagsstring[]Filter by task tags. Only tasks with these tags will be returned.
typestringFilter by task type (e.g., 'imageannotation', 'textcollection').
batchstringFilter by batch name. Only tasks belonging to this batch will be returned.
limitstringResults per page (1-100, default: 100). Controls how many tasks are returned in a single request.
statusstring[]Filter by task status. Can include multiple values from: 'completed', 'pending', 'canceled'.
projectstringFilter by project name. Only tasks belonging to this project will be returned.
end_timestringMaximum created_at timestamp in ISO 8601 format (e.g., '2024-12-31T23:59:59Z'). Only tasks created on or before this time will be returned.
unique_idstring[]Filter by task unique identifiers. Can include multiple unique IDs to retrieve specific tasks.
next_tokenstringPagination token for retrieving subsequent pages. Use the next_token value from a previous response to get the next page of results.
start_timestringMinimum created_at timestamp in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Only tasks created on or after this time will be returned.
updated_afterstringMinimum updated_at timestamp in ISO 8601 format. Only tasks updated on or after this time will be returned.
updated_beforestringMaximum updated_at timestamp in ISO 8601 format. Only tasks updated on or before this time will be returned.
completed_afterstringMinimum completed_at timestamp in ISO 8601 format. Only tasks completed on or after this time will be returned.
completed_beforestringMaximum completed_at timestamp in ISO 8601 format. Only tasks completed on or before this time will be returned.
customer_review_statusstring[]Filter by audit result status. Can include multiple values from: 'accepted', 'fixed', 'commented', 'rejected'.
include_attachment_urlbooleanInclude presigned attachment URLs in the response. Set to true if you need to access task attachments directly.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Re-send Task CallbackSCALE_AI_POST_V1_TASK_SEND_CALLBACKAcciónTool to re-send a callback for a completed or errored task to the callback_url. Use when you need to manually trigger a callback resend for a task that has already been processed.
SCALE_AI_POST_V1_TASK_SEND_CALLBACKAcciónTool to re-send a callback for a completed or errored task to the callback_url. Use when you need to manually trigger a callback resend for a task that has already been processed.
Parámetros de entrada
task_idstringObligatorioThe unique identifier for the task whose callback should be resent
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove Studio AssignmentsSCALE_AI_REMOVE_STUDIO_ASSIGNMENTSAcciónTool to unassign projects from specified team members in Scale AI Studio. Use when you need to remove project assignments from one or more team members.
SCALE_AI_REMOVE_STUDIO_ASSIGNMENTSAcciónTool to unassign projects from specified team members in Scale AI Studio. Use when you need to remove project assignments from one or more team members.
Parámetros de entrada
emailsstring[]ObligatorioArray of email addresses of teammates to remove assignments from.
projectsstring[]Optional array of project IDs to unassign from the specified team members. If not provided, all projects will be unassigned.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reset Batch PrioritiesSCALE_AI_RESET_BATCH_PRIORITIESAcciónTool to restore batch priority order to default order (calibration batches first, then sorted by creation date). Use when you need to reset custom batch priorities back to the default ordering.
SCALE_AI_RESET_BATCH_PRIORITIESAcciónTool to restore batch priority order to default order (calibration batches first, then sorted by creation date). Use when you need to reset custom batch priorities back to the default ordering.
Parámetros de entrada
groupsstringFilter parameter for groups to reset priorities
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Batch PrioritiesSCALE_AI_SET_BATCH_PRIORITIESAcciónTool to modify batch priority order in Scale AI Studio. Use when you need to adjust the priority order of pending batches. You must include all pending studio batches in the request.
SCALE_AI_SET_BATCH_PRIORITIESAcciónTool to modify batch priority order in Scale AI Studio. Use when you need to adjust the priority order of pending batches. You must include all pending studio batches in the request.
Parámetros de entrada
batchesobject[]ObligatorioArray of batch objects specifying the priority order. Must include all pending studio batches.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Project OntologySCALE_AI_SET_PROJECT_ONTOLOGYAcciónTool to set ontologies on a Scale AI project. Ontologies define the labels or classes that tasks will reference, and projects maintain complete history of ontology versions. Use when you need to configure or update the classification labels for a project.
SCALE_AI_SET_PROJECT_ONTOLOGYAcciónTool to set ontologies on a Scale AI project. Ontologies define the labels or classes that tasks will reference, and projects maintain complete history of ontology versions. Use when you need to configure or update the classification labels for a project.
Parámetros de entrada
ontologystring[]ObligatorioA collection of ontology entries as strings. Ontology choices must be unique throughout the ontology. These define the labels or classes that tasks in this project will reference.
project_namestringObligatorioThe unique project identifier to set the ontology for. This is the project name.
ontology_namestringA label identifying the specific version of the ontology being set. This is optional and helps track different ontology versions.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Project ParametersSCALE_AI_SET_PROJECT_PARAMSAcciónTool to set default parameters for tasks created under a project. Use when you need to establish or update default parameters that apply to future tasks unless overridden.
SCALE_AI_SET_PROJECT_PARAMSAcciónTool to set default parameters for tasks created under a project. Use when you need to establish or update default parameters that apply to future tasks unless overridden.
Parámetros de entrada
namestringObligatorioProject identifier (name). This is used in the URL path.
patchbooleanWhen true, merges new parameters with existing ones; defaults to false. Field-level overrides take precedence.
paramsobjectDefault parameters for tasks created under this project. Any parameters specified here will be set if omitted in a task request.
priorityintegerDefault priority for tasks created under this project.
instructionstringText combined with task-level instructions.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Task MetadataSCALE_AI_SET_TASK_METADATAAcciónTool to set key-value metadata on an existing Scale AI task. Use when you need to attach custom metadata to track or organize tasks. This operation is idempotent.
SCALE_AI_SET_TASK_METADATAAcciónTool to set key-value metadata on an existing Scale AI task. Use when you need to attach custom metadata to track or organize tasks. This operation is idempotent.
Parámetros de entrada
task_idstringObligatorioThe unique identifier of the task to set metadata on.
metadataobjectObligatorioKey-value pairs of metadata to attach to the task. Accepts strings, numbers, dates, and other JSON-compatible values.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Task Unique IDSCALE_AI_UPDATE_TASK_UNIQUE_IDAcciónTool to update or assign a unique identifier to a task. Use when you need to set a custom identifier for task tracking in your system.
SCALE_AI_UPDATE_TASK_UNIQUE_IDAcciónTool to update or assign a unique identifier to a task. Use when you need to set a custom identifier for task tracking in your system.
Parámetros de entrada
task_idstringObligatorioID of the task to modify. This is the Scale AI task identifier.
unique_idstringObligatorioThe unique identifier to be assigned to the task. This is a custom identifier that can be used to reference the task in your own system.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload FileSCALE_AI_UPLOAD_FILEAcciónTool to upload a local file to Scale's servers with a maximum size limit of 80 MB per file. Use when you need to upload files for Scale AI projects or data labeling tasks.
SCALE_AI_UPLOAD_FILEAcciónTool to upload a local file to Scale's servers with a maximum size limit of 80 MB per file. Use when you need to upload files for Scale AI projects or data labeling tasks.
Parámetros de entrada
fileobjectObligatorioThe local file to upload (max 80 MB). FileUploadable object where 'name' is the filename.
metadataobjectA JSON object used to store additional data associated with the file.
file_pathstringOptional local file path to read the file content from. If provided, this will be used instead of downloading from temp S3 via file.s3key. Useful for testing or when the file is available locally.
display_namestringA human readable name for the file.
project_namestringAssociates the file with a specific project; only used for Scale Rapid data labeling tool.
reference_idstringUnique identifier for upload idempotency; uploading with duplicate IDs returns 409 error.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not