Scale ai

scale_ai

Scale 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

Artificial Intelligence AI Models Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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[]Obligatorio
Array of email addresses of teammates to assign projects to.
projectsstring[]Obligatorio
Array of project names to assign to the specified teammates.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Task TagsSCALE_AI_ADD_TASK_TAGSAcción

Tool 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[]Obligatorio
List 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_idstringObligatorio
The unique identifier of the task to add tags to.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create BatchSCALE_AI_CREATE_BATCHAcción

Tool 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

namestringObligatorio
Name identifying this batch. Must be unique among all batches belonging to a customer.
projectstringObligatorio
The name of the project this batch (and its tasks) belong to.
callbackstring
The full URL (including the scheme http:// or https://) or email address of the callback that will be used when tasks are completed.
self_label_batchboolean
Only applicable for Rapid projects. Create a self label batch by setting this flag to true.
calibration_batchboolean
Only applicable for Rapid projects. Create a calibration batch by setting this flag to true.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Document Transcription TaskSCALE_AI_CREATE_DOCUMENT_TRANSCRIPTION_TASKAcción

Tool 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

langstring
Language code for the attachment (Default: 'en-US')
tagsstring[]
Arbitrary labels for task organization (maximum 5 tags allowed)
batchstring
Batch name; automatically associates task with the batch's project
titlestring
Task title
projectstring
Name of the project to associate this task with
featuresobject[]
Array of field definitions describing what data to transcribe
geometrystring
Geometry type for annotations: 'box' (axis-aligned rectangles) or 'polygon' (rotated rectangles). Default: 'box'
metadataobject
Custom metadata as key-value pairs for storing additional structured information
priorityinteger
Task priority level (Range: 0-100, Default: 30)
unique_idstring
Arbitrary unique identifier for task deduplication and later querying
attachmentstring
URL of a single document to be transcribed. Either attachment or attachments is required
hypothesisobject
Pre-labels to accelerate annotation, matching the task's response schema
attachmentsstring[]
Array of URLs for multi-page documents. Either attachment or attachments is required
descriptionstring
Task description
instructionstringObligatorio
Markdown-enabled instructions explaining the task to taskers
callback_urlstring
Full URL (including scheme) or email address for completion notification
responses_requiredinteger
Number of responses needed (Default: 1)
clear_unique_id_on_errorboolean
If true, unsets unique_id if task errors after submission

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Image Annotation TaskSCALE_AI_CREATE_IMAGE_ANNOTATION_TASKAcción

Tool 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
batchstring
Name 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
layerobject
Read-only pre-drawn annotations
linksobject
Defines connections between annotations
paddinginteger
Image padding in pixels applied to all sides
projectstring
Name of the project to associate this task with
metadataobject
Custom key-value pairs for arbitrary data (max 10KB)
paddingXinteger
Horizontal image padding in pixels. Overrides padding parameter
paddingYinteger
Vertical image padding in pixels. Overrides padding parameter
priorityintegerenum
Task priority level: 10 (low), 20 (medium), or 30 (high)
102030
unique_idstring
Arbitrary identifier that must be unique across account. Prevents duplicate task creation
attachmentstringObligatorio
URL to the image to be annotated
geometriesobjectObligatorio
Specifies annotation shapes and their configurations. At least one geometry type must be provided (box, polygon, line, point, cuboid, or ellipse)
hypothesisobject
Pre-labels from model predictions for refinement. Contains annotations array matching response schema
instructionstring
Markdown-enabled instructions for annotators explaining how to do the task. Omit for Scale Rapid unless overriding project defaults
callback_urlstring
Full URL (http/https) or email address for completion notification
image_metadataobject
Metadata about the image being annotated.
base_annotationsany
Editable 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_attributesobject
Captures additional metadata per annotation
can_add_base_annotationsboolean
Permits adding new annotations beyond base_annotations
clear_unique_id_on_errorboolean
Unsets unique_id if task errors after submission
can_edit_base_annotationsboolean
Allows modification of base_annotations position/attributes
can_delete_base_annotationsboolean
Allows removal of base_annotations
can_edit_base_annotation_labelsboolean
Permits label changes to base_annotations

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Lidar Annotation TaskSCALE_AI_CREATE_LIDAR_ANNOTATION_TASKAcción

Tool 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).
batchstring
Batch name; auto-associates with batch's project.
labelsstring[]Obligatorio
Object types to annotate. Maximum 50 objects supported.
projectstring
Project name for task association.
metadataobject
Custom key-value pairs (max 10KB).
priorityinteger
Task priority: 10, 20, or 30.
unique_idstring
Custom unique identifier for task deduplication.
attachmentsstring[]Obligatorio
List of URLs to the Frame objects you'd like to be labeled. Frames should be time-ordered naturally.
instructionstring
Markdown-enabled task instructions for annotators.
callback_urlstring
The full url (including the scheme http:// or https://) of the callback when the task is completed.
attachment_typestringObligatorio
Specifies file format: 'json' (default) or 'protobuf'.
meters_per_unitinteger
Conversion rate of point data units to meters.
polygons_labelsstring[]
Polygon types to annotate.
polygons_enabledboolean
Enables polygon annotations.
frames_per_secondinteger
Frame capture frequency.
max_distance_metersinteger
Maximum labeling distance from sensor in meters.
labeling_sample_rateinteger
Sampling rate for full frame labeling. With rate k and n frames total, labeled frames are 1st, (k+1)th, (2k+1)th, etc.
annotation_attributesobject
Additional per-annotation attributes.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create LiDAR Segmentation TaskSCALE_AI_CREATE_LIDAR_SEGMENTATION_TASKAcción

Tool 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.
batchstring
Batch 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[]Obligatorio
Object classes for which semantic information is desired. Annotators will assign these semantic classes to each LiDAR point.
projectstring
Project name to associate with this task. Either 'project' or 'batch' must be provided.
metadataobject
Key-value pairs (max 10KB) for structured task information. Use this to store custom data related to the task.
priorityintegerenum
Task priority level. Valid values are 10 (low), 20 (medium), or 30 (high).
102030
unique_idstring
Arbitrary unique identifier across your account. Use this to prevent duplicate task creation.
attachmentsstring[]Obligatorio
URLs to Frame objects you'd like to be labeled. Each URL should point to a valid frame data file.
instructionstring
Markdown-enabled task instructions with examples to guide annotators.
callback_urlstring
Full URL (http:// or https://) for task completion notification. Scale will send a POST request to this URL when the task is completed.
attachment_typestringObligatorioenum
File format of the attachments. Must be either 'json' or 'protobuf'.
jsonprotobuf
annotation_attributesobject
Additional attributes to capture per annotation. Define custom attributes for the annotation process.
clear_unique_id_on_errorboolean
Reset unique_id if task errors. Set to true to allow resubmission of failed tasks with the same unique_id.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Named Entity Recognition TaskSCALE_AI_CREATE_NAMED_ENTITY_RECOGNITION_TASKAcción

Tool 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)
textstringObligatorio
The text from which to extract named entities
batchstring
Batch association (required for Scale Rapid projects)
labelsobject[]Obligatorio
Array of label definitions for entity types to identify
projectstring
Project association for the task
metadataobject
Custom metadata object for the task
unique_idstring
Arbitrary unique identifier for the task
attachmentsobject[]
Array of attachments with additional context
instructionstringObligatorio
Markdown-enabled instructions for task completion
callback_urlstring
Webhook URL for task completion notifications
relationshipsobject[]
Array of relationship definitions between entities
merge_newlinesboolean
Controls newline character handling in text
allow_overlapping_annotationsboolean
Permits overlapping text spans in annotations

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Segmentation Annotation TaskSCALE_AI_CREATE_SEGMENTATION_ANNOTATION_TASKAcción

Tool 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
batchstring
Batch name for task association; overrides project requirement
labelsarrayObligatorio
Array of strings or LabelDescription objects describing different types of objects for image segmentation. Maximum 50 labels.
projectstring
Name of the project to associate this task with
metadataobject
Set of key/value pairs to attach to task object. Maximum 10KB
unique_idstring
Custom identifier; must be unique across your account
attachmentstringObligatorio
URL to the image requiring segmentation
hypothesisobject
Pre-labeled annotations for refinement by annotators. Editable annotations that a task should be initialized with, useful for model pre-labeling scenarios
instructionstring
Markdown-enabled string or iframe embed Google Doc explaining how to do the segmentation
callback_urlstring
Full URL (including http:// or https://) or email address for callback notification
allow_unlabeledboolean
Whether this image can be completed without every pixel being labeled
attachment_typestring
Describes file type; currently supports 'image' only
context_attachmentsobject[]
Reference images in [{"attachment": "<url>"}] format; cannot include task URL
annotation_attributesobject
Additional attributes to capture per annotation with structure containing type, description, choices, and conditions
clear_unique_id_on_errorboolean
Auto-reset unique_id if task errors post-submission

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Text Collection TaskSCALE_AI_CREATE_TEXT_COLLECTION_TASKAcción

Tool 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)
batchstring
Batch name; automatically associates task with the batch's project
titlestring
Task title
fieldsobject[]Obligatorio
Array of field definitions describing data to collect
projectstring
Project name to associate this task with
metadataobject
Custom metadata as key-value pairs
priorityinteger
Task priority level. Must be one of: 10, 20, 30, 40, or 50. Default: 30
unique_idstring
Unique identifier for task deduplication and later querying
hypothesisobject
Pre-labels to accelerate annotation, matching the task's response schema
attachmentsobject[]
Array of attachments to collect information from
descriptionstring
Task description
instructionstringObligatorio
Markdown-enabled instructions explaining the task to taskers
callback_urlstring
Full URL (http:// or https://) or email address for completion callback
responses_requiredinteger
Number of responses needed (default: 1)
clear_unique_id_on_errorboolean
If true, unsets unique_id if task errors after submission

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Video Annotation TaskSCALE_AI_CREATE_VIDEO_ANNOTATION_TASKAcción

Tool 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
batchstring
Batch name; automatically associates with the batch's project
paddinginteger
Pixel padding around all video frame edges
projectstring
Project name for task association
metadataobject
Key-value pairs for structured task info (max 10KB)
paddingXinteger
Left/right padding in pixels; overrides padding if set
paddingYinteger
Top/bottom padding in pixels; overrides padding if set
priorityintegerenum
Task priority level where higher values indicate higher priority
102030
unique_idstring
Arbitrary unique identifier for later retrieval (must be unique across all projects)
attachmentstring
Video file URL (mp4, webm, or ogg format). Required if attachment_type is 'video'.
frame_rateinteger
Frames per second to annotate
geometriesobjectObligatorio
Mapping 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'.
instructionstring
Task instructions in markdown format or Google Doc URL explaining the annotation task
callback_urlstring
Full URL or email address for completion notification
attachment_typestringObligatorioenum
Either 'image' or 'video' to specify input format. Use 'image' for individual frames or 'video' for video files.
imagevideo
events_to_annotatestring[]
List of event descriptions to annotate in the video
annotation_attributesobject
Additional attributes to capture per annotation with type, description, choices, and conditions
clear_unique_id_on_errorboolean
If true, unsets unique_id if task errors post-submission

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Video Playback Annotation TaskSCALE_AI_CREATE_VIDEO_PLAYBACK_ANNOTATION_TASKAcción

Tool 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
batchstring
Batch name; required for Scale Rapid projects
paddinginteger
Pixel padding around all video frame edges
projectstring
Project name for task association
metadataobject
Key-value pairs for structured task info (max 10KB)
paddingXinteger
Left/right padding in pixels; overrides padding if set
paddingYinteger
Top/bottom padding in pixels; overrides padding if set
priorityintegerenum
Task priority level where higher values indicate higher priority
102030
unique_idstring
Arbitrary unique identifier for later retrieval (must be unique across all projects)
attachmentstringObligatorio
URL to video file in mp4, webm, or ogg format
frame_rateinteger
Frames per second to capture for annotation
geometriesobjectObligatorio
Mapping of annotation types to their configurations. At least one geometry type must be specified.
start_timeinteger
Start time in seconds for video annotation
attachmentsstring[]
Array of image frame URLs. Use this instead of attachment if attachment_type is 'image'.
instructionstring
Task instructions in markdown format or Google Doc URL explaining the annotation task
callback_urlstring
Full URL or email address for task completion notification
duration_timeinteger[]
Video duration range in seconds [start, end]
attachment_typestringenum
Either 'image' or 'video' to specify input format. Defaults to 'video' for video playback tasks.
imagevideo
base_annotationsobject
Pre-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_attributesobject
Additional attributes to capture per annotation with type, description, choices, and conditions
can_add_base_annotationsboolean
Whether annotators can add new annotations beyond base_annotations
clear_unique_id_on_errorboolean
If true, unsets unique_id if task errors post-submission
can_edit_base_annotationsboolean
Whether annotators can modify existing base_annotations
can_delete_base_annotationsboolean
Whether annotators can remove base_annotations

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Task TagsSCALE_AI_DELETE_TASK_TAGSAcción

Tool 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[]Obligatorio
List of tag strings to remove from the task
task_idstringObligatorio
ID of the task to remove tags from

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Task Unique IDSCALE_AI_DELETE_TASK_UNIQUE_IDAcción

Tool 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_idstringObligatorio
ID of the Task to modify

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Finalize BatchSCALE_AI_FINALIZE_BATCHAcción

Tool 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_namestringObligatorio
The name of the batch to finalize. This batch must exist before it can be finalized.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get AssetsSCALE_AI_GET_ASSETSAcción

Tool 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

cursorstring
Cursor for pagination to retrieve the next page of results. Use the cursor value from a previous response to get the next page.
projectstringObligatorio
Project filter to retrieve assets associated with a specific project. This parameter is required.
metadatastring
Metadata filter to retrieve assets matching specific metadata criteria.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get BatchSCALE_AI_GET_BATCHAcción

Tool 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_namestringObligatorio
The batch identifier to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Batch StatusSCALE_AI_GET_BATCH_STATUSAcción

Tool 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_namestringObligatorio
The name of the batch to retrieve status for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Fixless AuditsSCALE_AI_GET_FIXLESS_AUDITSAcción

Tool 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

idstring
Identifier for the specific audit. At least one of task_id or id must be provided.
task_idstring
Identifier for the task being audited. At least one of task_id or id must be provided.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ProjectSCALE_AI_GET_PROJECTAcción

Tool 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

namestringObligatorio
The unique project identifier to retrieve. This is the project name.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Quality LabelersSCALE_AI_GET_QUALITY_LABELERSAcción

Tool 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

limitinteger
Maximum number of training attempt records to return per request.
next_tokenstring
Pagination 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Studio AssignmentsSCALE_AI_GET_STUDIO_ASSIGNMENTSAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Studio BatchesSCALE_AI_GET_STUDIO_BATCHESAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TaskSCALE_AI_GET_TASKAcción

Tool 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_idstringObligatorio
The unique identifier of the task to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TeamsSCALE_AI_GET_TEAMSAcción

Tool 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Task by IDSCALE_AI_GET_V1_TASKAcción

Tool 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_idstringObligatorio
The unique identifier of the task to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Secure Task Response URLSCALE_AI_GET_V1_TASK_RESPONSE_URLAcción

Tool 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

uuidstringObligatorio
The unique identifier for the secure result URL
task_idstringObligatorio
The unique identifier for the task

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import FileSCALE_AI_IMPORT_FILEAcción

Tool 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_urlstringObligatorio
The file URL to be imported. Files are subject to Scale's 80 MB per-file size limit.
project_namestring
Associates the imported file with a specific project; only used for Scale Rapid data labeling tool.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Invite Team MemberSCALE_AI_INVITE_TEAM_MEMBERAcción

Tool 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[]Obligatorio
Array of email addresses of teammates you want to invite.
team_rolestringObligatorio
Role of invited teammate. Must be one of: 'labeler' (Studio only), 'member', or 'manager'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List BatchesSCALE_AI_LIST_BATCHESAcción

Tool 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

limitinteger
Page size determining number of results per request.
offsetinteger
Number of results to skip for pagination.
statusstringenum
Filters by batch status. Valid values: 'staging', 'in_progress', or 'completed'.
stagingin_progresscompleted
projectstring
Filters batches by project name.
detailedboolean
Returns additional progress information about batches when set to true.
end_timestring
Maximum value of created_at for returned batches in ISO 8601 format.
start_timestring
Minimum value of created_at for returned batches in ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ProjectsSCALE_AI_LIST_PROJECTSAcción

Tool 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

archivedboolean
Filter to display only archived or unarchived projects. If not provided, all projects are returned.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TasksSCALE_AI_LIST_TASKSAcción

Tool 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.
typestring
Filter by task type (e.g., 'imageannotation', 'textcollection').
batchstring
Filter by batch name. Only tasks belonging to this batch will be returned.
limitstring
Results 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'.
projectstring
Filter by project name. Only tasks belonging to this project will be returned.
end_timestring
Maximum 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_tokenstring
Pagination token for retrieving subsequent pages. Use the next_token value from a previous response to get the next page of results.
start_timestring
Minimum 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_afterstring
Minimum updated_at timestamp in ISO 8601 format. Only tasks updated on or after this time will be returned.
updated_beforestring
Maximum updated_at timestamp in ISO 8601 format. Only tasks updated on or before this time will be returned.
completed_afterstring
Minimum completed_at timestamp in ISO 8601 format. Only tasks completed on or after this time will be returned.
completed_beforestring
Maximum 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_urlboolean
Include presigned attachment URLs in the response. Set to true if you need to access task attachments directly.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Re-send Task CallbackSCALE_AI_POST_V1_TASK_SEND_CALLBACKAcción

Tool 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_idstringObligatorio
The unique identifier for the task whose callback should be resent

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Studio AssignmentsSCALE_AI_REMOVE_STUDIO_ASSIGNMENTSAcción

Tool 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[]Obligatorio
Array 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Reset Batch PrioritiesSCALE_AI_RESET_BATCH_PRIORITIESAcción

Tool 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

groupsstring
Filter parameter for groups to reset priorities

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set Batch PrioritiesSCALE_AI_SET_BATCH_PRIORITIESAcción

Tool 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[]Obligatorio
Array of batch objects specifying the priority order. Must include all pending studio batches.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set Project OntologySCALE_AI_SET_PROJECT_ONTOLOGYAcción

Tool 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[]Obligatorio
A 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_namestringObligatorio
The unique project identifier to set the ontology for. This is the project name.
ontology_namestring
A label identifying the specific version of the ontology being set. This is optional and helps track different ontology versions.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set Project ParametersSCALE_AI_SET_PROJECT_PARAMSAcción

Tool 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

namestringObligatorio
Project identifier (name). This is used in the URL path.
patchboolean
When true, merges new parameters with existing ones; defaults to false. Field-level overrides take precedence.
paramsobject
Default parameters for tasks created under this project. Any parameters specified here will be set if omitted in a task request.
priorityinteger
Default priority for tasks created under this project.
instructionstring
Text combined with task-level instructions.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set Task MetadataSCALE_AI_SET_TASK_METADATAAcción

Tool 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_idstringObligatorio
The unique identifier of the task to set metadata on.
metadataobjectObligatorio
Key-value pairs of metadata to attach to the task. Accepts strings, numbers, dates, and other JSON-compatible values.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Task Unique IDSCALE_AI_UPDATE_TASK_UNIQUE_IDAcción

Tool 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_idstringObligatorio
ID of the task to modify. This is the Scale AI task identifier.
unique_idstringObligatorio
The 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload FileSCALE_AI_UPLOAD_FILEAcción

Tool 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

fileobjectObligatorio
The local file to upload (max 80 MB). FileUploadable object where 'name' is the filename.
metadataobject
A JSON object used to store additional data associated with the file.
file_pathstring
Optional 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_namestring
A human readable name for the file.
project_namestring
Associates the file with a specific project; only used for Scale Rapid data labeling tool.
reference_idstring
Unique identifier for upload idempotency; uploading with duplicate IDs returns 409 error.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not