Skip to main content
Scale ai logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 40
  • Triggers: 0
  • Slug: SCALE_AI
  • Version: 20261101_00

Tools

Slug: SCALE_AI_ADD_STUDIO_ASSIGNMENTSTool 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.

Input Parameters

array
required
Array of email addresses of teammates to assign projects to.
array
required
Array of project names to assign to the specified teammates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_ADD_TASK_TAGSTool to add tags to an existing task. Use when you need to tag or categorize tasks for organization and filtering. Automatically avoids duplicate tags.

Input Parameters

array
required
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.
string
required
The unique identifier of the task to add tags to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_CREATE_BATCHTool to create a new batch within a project. Use when you need to group multiple tasks together for organizational and processing purposes.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_CREATE_DOCUMENT_TRANSCRIPTION_TASKTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_CREATE_IMAGE_ANNOTATION_TASKTool 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.

Input Parameters

array
Up to 5 arbitrary string labels for task organization and filtering
string
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
object
Read-only pre-drawn annotations
Defines connections between annotations
integer
Image padding in pixels applied to all sides
string
Name of the project to associate this task with
object
Custom key-value pairs for arbitrary data (max 10KB)
integer
Horizontal image padding in pixels. Overrides padding parameter
integer
Vertical image padding in pixels. Overrides padding parameter
integer ("10" | "20" | "30")
Task priority level: 10 (low), 20 (medium), or 30 (high)
string
Arbitrary identifier that must be unique across account. Prevents duplicate task creation
string
required
URL to the image to be annotated
object
required
Specifies annotation shapes and their configurations. At least one geometry type must be provided (box, polygon, line, point, cuboid, or ellipse)
object
Pre-labels from model predictions for refinement. Contains annotations array matching response schema
string
Markdown-enabled instructions for annotators explaining how to do the task. Omit for Scale Rapid unless overriding project defaults
string
Full URL (http/https) or email address for completion notification
object
Metadata about the image being annotated.
string
Editable pre-drawn annotations with optional locking capabilities
array
Reference images displayed to annotators but not labeled. Cannot include the task’s primary attachment
object
Captures additional metadata per annotation
boolean
Permits adding new annotations beyond base_annotations
boolean
Unsets unique_id if task errors after submission
boolean
Allows modification of base_annotations position/attributes
boolean
Allows removal of base_annotations
boolean
Permits label changes to base_annotations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_CREATE_LIDAR_ANNOTATION_TASKTool 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.

Input Parameters

array
Task labels (max 5 per task).
string
Batch name; auto-associates with batch’s project.
array
required
Object types to annotate. Maximum 50 objects supported.
string
Project name for task association.
object
Custom key-value pairs (max 10KB).
integer
Task priority: 10, 20, or 30.
string
Custom unique identifier for task deduplication.
array
required
List of URLs to the Frame objects you’d like to be labeled. Frames should be time-ordered naturally.
string
Markdown-enabled task instructions for annotators.
string
The full url (including the scheme http:// or https://) of the callback when the task is completed.
string
required
Specifies file format: ‘json’ (default) or ‘protobuf’.
integer
Conversion rate of point data units to meters.
array
Polygon types to annotate.
boolean
Enables polygon annotations.
integer
Frame capture frequency.
integer
Maximum labeling distance from sensor in meters.
integer
Sampling rate for full frame labeling. With rate k and n frames total, labeled frames are 1st, (k+1)th, (2k+1)th, etc.
object
Additional per-annotation attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_CREATE_LIDAR_SEGMENTATION_TASKTool 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.

Input Parameters

array
Up to 5 arbitrary labels per task for organization and filtering purposes.
string
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.
array
required
Object classes for which semantic information is desired. Annotators will assign these semantic classes to each LiDAR point.
string
Project name to associate with this task. Either ‘project’ or ‘batch’ must be provided.
object
Key-value pairs (max 10KB) for structured task information. Use this to store custom data related to the task.
integer ("10" | "20" | "30")
Task priority level. Valid values are 10 (low), 20 (medium), or 30 (high).
string
Arbitrary unique identifier across your account. Use this to prevent duplicate task creation.
array
required
URLs to Frame objects you’d like to be labeled. Each URL should point to a valid frame data file.
string
Markdown-enabled task instructions with examples to guide annotators.
string
Full URL (http:// or https://) for task completion notification. Scale will send a POST request to this URL when the task is completed.
string ("json" | "protobuf")
required
File format of the attachments. Must be either ‘json’ or ‘protobuf’.
object
Additional attributes to capture per annotation. Define custom attributes for the annotation process.
boolean
Reset unique_id if task errors. Set to true to allow resubmission of failed tasks with the same unique_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_CREATE_NAMED_ENTITY_RECOGNITION_TASKTool 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.

Input Parameters

array
Custom labels (maximum 5 per task)
string
required
The text from which to extract named entities
string
Batch association (required for Scale Rapid projects)
array
required
Array of label definitions for entity types to identify
string
Project association for the task
object
Custom metadata object for the task
string
Arbitrary unique identifier for the task
array
Array of attachments with additional context
string
required
Markdown-enabled instructions for task completion
string
Webhook URL for task completion notifications
array
Array of relationship definitions between entities
boolean
Controls newline character handling in text
boolean
Permits overlapping text spans in annotations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_CREATE_SEGMENTATION_ANNOTATION_TASKTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_CREATE_TEXT_COLLECTION_TASKTool 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.

Input Parameters

array
Arbitrary labels for task organization (maximum 5 tags allowed)
string
Batch name; automatically associates task with the batch’s project
string
Task title
array
required
Array of field definitions describing data to collect
string
Project name to associate this task with
object
Custom metadata as key-value pairs
integer
Task priority level. Must be one of: 10, 20, 30, 40, or 50. Default: 30
string
Unique identifier for task deduplication and later querying
object
Pre-labels to accelerate annotation, matching the task’s response schema
array
Array of attachments to collect information from
string
Task description
string
required
Markdown-enabled instructions explaining the task to taskers
string
Full URL (http:// or https://) or email address for completion callback
integer
Number of responses needed (default: 1)
boolean
If true, unsets unique_id if task errors after submission

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_CREATE_VIDEO_ANNOTATION_TASKTool 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.

Input Parameters

array
Up to 5 arbitrary labels per task
string
Batch name; automatically associates with the batch’s project
integer
Pixel padding around all video frame edges
string
Project name for task association
object
Key-value pairs for structured task info (max 10KB)
integer
Left/right padding in pixels; overrides padding if set
integer
Top/bottom padding in pixels; overrides padding if set
integer ("10" | "20" | "30")
Task priority level where higher values indicate higher priority
string
Arbitrary unique identifier for later retrieval (must be unique across all projects)
string
Video file URL (mp4, webm, or ogg format). Required if attachment_type is ‘video’.
integer
Frames per second to annotate
object
required
Mapping of annotation types to their configurations. At least one geometry type must be specified.
array
Array of image frame URLs. Required if attachment_type is ‘image’.
string
Task instructions in markdown format or Google Doc URL explaining the annotation task
string
Full URL or email address for completion notification
string ("image" | "video")
required
Either ‘image’ or ‘video’ to specify input format. Use ‘image’ for individual frames or ‘video’ for video files.
array
List of event descriptions to annotate in the video
object
Additional attributes to capture per annotation with type, description, choices, and conditions
boolean
If true, unsets unique_id if task errors post-submission

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_CREATE_VIDEO_PLAYBACK_ANNOTATION_TASKTool 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.

Input Parameters

array
Up to 5 arbitrary labels per task
string
Batch name; required for Scale Rapid projects
integer
Pixel padding around all video frame edges
string
Project name for task association
object
Key-value pairs for structured task info (max 10KB)
integer
Left/right padding in pixels; overrides padding if set
integer
Top/bottom padding in pixels; overrides padding if set
integer ("10" | "20" | "30")
Task priority level where higher values indicate higher priority
string
Arbitrary unique identifier for later retrieval (must be unique across all projects)
string
required
URL to video file in mp4, webm, or ogg format
integer
Frames per second to capture for annotation
object
required
Mapping of annotation types to their configurations. At least one geometry type must be specified.
integer
Start time in seconds for video annotation
array
Array of image frame URLs. Use this instead of attachment if attachment_type is ‘image’.
string
Task instructions in markdown format or Google Doc URL explaining the annotation task
string
Full URL or email address for task completion notification
array
Video duration range in seconds [start, end]
string ("image" | "video")
Either ‘image’ or ‘video’ to specify input format. Defaults to ‘video’ for video playback tasks.
object
Pre-labeled annotations for refinement. Keys are frame identifiers, values are arrays of annotations.
array
List of event descriptions to annotate in the video
object
Additional attributes to capture per annotation with type, description, choices, and conditions
boolean
Whether annotators can add new annotations beyond base_annotations
boolean
If true, unsets unique_id if task errors post-submission
boolean
Whether annotators can modify existing base_annotations
boolean
Whether annotators can remove base_annotations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_DELETE_TASK_TAGSTool to remove specified tags from a Scale AI task. Use when you need to clean up or modify task tags.

Input Parameters

array
required
List of tag strings to remove from the task
string
required
ID of the task to remove tags from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_DELETE_TASK_UNIQUE_IDTool to remove the unique identifier from a task. Use when you need to remove a task’s unique identifier for enhanced data management control.

Input Parameters

string
required
ID of the Task to modify

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_FINALIZE_BATCHTool 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.

Input Parameters

string
required
The name of the batch to finalize. This batch must exist before it can be finalized.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_ASSETSTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_BATCHTool 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.

Input Parameters

string
required
The batch identifier to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_BATCH_STATUSTool 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.

Input Parameters

string
required
The name of the batch to retrieve status for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_FIXLESS_AUDITSTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_PROJECTTool 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.

Input Parameters

string
required
The unique project identifier to retrieve. This is the project name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_QUALITY_LABELERSTool 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.

Input Parameters

integer
Maximum number of training attempt records to return per request.
string
Pagination token for retrieving subsequent result pages. Use the next_token value from a previous response to get the next page of results.
array
Filter results by labeler email addresses. At least one of quality_task_ids or labeler_emails must be provided.
array
Filter results by specific quality task identifiers. At least one of quality_task_ids or labeler_emails must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_STUDIO_ASSIGNMENTSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_STUDIO_BATCHESTool to retrieve basic information about all pending batches in Studio. Use when you need to list batches organized by priority level.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_TEAMSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_V1_TASKTool 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.

Input Parameters

string
required
The unique identifier of the task to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_GET_V1_TASK_RESPONSE_URLRetrieve a secure task response URL using a task ID and response UUID for stored 2D segmentation, video, or lidar results. Redirects return the URL; a direct response returns its text content and content type.

Input Parameters

string
required
The unique identifier for the secure result URL
string
required
The unique identifier for the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_IMPORT_FILETool 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.

Input Parameters

string
required
The file URL to be imported. Files are subject to Scale’s 80 MB per-file size limit.
string
Associates the imported file with a specific project; only used for Scale Rapid data labeling tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_INVITE_TEAM_MEMBERTool 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.

Input Parameters

array
required
Array of email addresses of teammates you want to invite.
string
required
Role of invited teammate. Must be one of: ‘labeler’ (Studio only), ‘member’, or ‘manager’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_LIST_BATCHESList batches in descending order by creation date, with optional filtering by project, status, or time range. Supports pagination via limit and offset.

Input Parameters

integer
Page size determining number of results per request.
integer
Number of results to skip for pagination.
string ("staging" | "in_progress" | "completed")
Filters by batch status. Valid values: ‘staging’, ‘in_progress’, or ‘completed’.
string
Filters batches by project name.
boolean
Returns additional progress information about batches when set to true.
string
Maximum value of created_at for returned batches in ISO 8601 format.
string
Minimum value of created_at for returned batches in ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_LIST_PROJECTSList Scale AI account projects with optional archived filtering and pagination. Returns project details including type, name, parameter history, and creation timestamps.

Input Parameters

integer
Maximum number of projects to return per page.
integer
Number of projects to skip for pagination.
boolean
Filter to display only archived or unarchived projects. If not provided, all projects are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_LIST_TASKSTool 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.

Input Parameters

array
Filter by task tags. Only tasks with these tags will be returned.
string
Filter by task type (e.g., ‘imageannotation’, ‘textcollection’).
string
Filter by batch name. Only tasks belonging to this batch will be returned.
string
Results per page (1-100, default: 100). Controls how many tasks are returned in a single request.
array
Filter by task status. Can include multiple values from: ‘completed’, ‘pending’, ‘canceled’.
string
Filter by project name. Only tasks belonging to this project will be returned.
string
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.
array
Filter by task unique identifiers. Can include multiple unique IDs to retrieve specific tasks.
string
Pagination token for retrieving subsequent pages. Use the next_token value from a previous response to get the next page of results.
string
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.
string
Minimum updated_at timestamp in ISO 8601 format. Only tasks updated on or after this time will be returned.
string
Maximum updated_at timestamp in ISO 8601 format. Only tasks updated on or before this time will be returned.
string
Minimum completed_at timestamp in ISO 8601 format. Only tasks completed on or after this time will be returned.
string
Maximum completed_at timestamp in ISO 8601 format. Only tasks completed on or before this time will be returned.
array
Filter by audit result status. Can include multiple values from: ‘accepted’, ‘fixed’, ‘commented’, ‘rejected’.
boolean
Include presigned attachment URLs in the response. Set to true if you need to access task attachments directly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_POST_V1_TASK_SEND_CALLBACKTool 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.

Input Parameters

string
required
The unique identifier for the task whose callback should be resent

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_REMOVE_STUDIO_ASSIGNMENTSTool 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.

Input Parameters

array
required
Array of email addresses of teammates to remove assignments from.
array
Optional array of project IDs to unassign from the specified team members. If not provided, all projects will be unassigned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_RESET_BATCH_PRIORITIESTool 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.

Input Parameters

string
Filter parameter for groups to reset priorities

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_SET_BATCH_PRIORITIESTool 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.

Input Parameters

array
required
Array of batch objects specifying the priority order. Must include all pending studio batches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_SET_PROJECT_ONTOLOGYSet a Scale AI project’s ontology using a list of string labels, optionally naming the ontology version. Projects maintain a history of ontology versions.

Input Parameters

array
required
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.
string
required
The unique project identifier to set the ontology for. This is the project name.
string
A label identifying the specific version of the ontology being set. This is optional and helps track different ontology versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_SET_PROJECT_PARAMSSet default parameters for tasks created under a project. Task-level parameters override project defaults, except instructions, which are combined with project-level instructions.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_SET_TASK_METADATATool 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.

Input Parameters

string
required
The unique identifier of the task to set metadata on.
object
required
Key-value pairs of metadata to attach to the task. Accepts strings, numbers, dates, and other JSON-compatible values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_UPDATE_TASK_UNIQUE_IDTool 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.

Input Parameters

string
required
ID of the task to modify. This is the Scale AI task identifier.
string
required
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCALE_AI_UPLOAD_FILETool 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.

Input Parameters

object
required
The local file to upload (max 80 MB).
object
A JSON object used to store additional data associated with the file.
string
A human readable name for the file.
string
Associates the file with a specific project; only used for Scale Rapid data labeling tool.
string
Unique identifier for upload idempotency; uploading with duplicate IDs returns 409 error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not