# 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

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 40
- **Triggers:** 0
- **Slug:** `SCALE_AI`
- **Version:** 20260312_00

## Tools

### Add Studio Assignments

**Slug:** `SCALE_AI_ADD_STUDIO_ASSIGNMENTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Array of email addresses of teammates to assign projects to. |
| `projects` | array | Yes | Array of project names to assign to the specified teammates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Task Tags

**Slug:** `SCALE_AI_ADD_TASK_TAGS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | 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_id` | string | Yes | The unique identifier of the task to add tags to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Batch

**Slug:** `SCALE_AI_CREATE_BATCH`

Tool to create a new batch within a project. Use when you need to group multiple tasks together for organizational and processing purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name identifying this batch. Must be unique among all batches belonging to a customer. |
| `project` | string | Yes | The name of the project this batch (and its tasks) belong to. |
| `callback` | string | No | 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_batch` | boolean | No | Only applicable for Rapid projects. Create a self label batch by setting this flag to true. |
| `calibration_batch` | boolean | No | Only applicable for Rapid projects. Create a calibration batch by setting this flag to true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document Transcription Task

**Slug:** `SCALE_AI_CREATE_DOCUMENT_TRANSCRIPTION_TASK`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Image Annotation Task

**Slug:** `SCALE_AI_CREATE_IMAGE_ANNOTATION_TASK`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Lidar Annotation Task

**Slug:** `SCALE_AI_CREATE_LIDAR_ANNOTATION_TASK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Task labels (max 5 per task). |
| `batch` | string | No | Batch name; auto-associates with batch's project. |
| `labels` | array | Yes | Object types to annotate. Maximum 50 objects supported. |
| `project` | string | No | Project name for task association. |
| `metadata` | object | No | Custom key-value pairs (max 10KB). |
| `priority` | integer | No | Task priority: 10, 20, or 30. |
| `unique_id` | string | No | Custom unique identifier for task deduplication. |
| `attachments` | array | Yes | List of URLs to the Frame objects you'd like to be labeled. Frames should be time-ordered naturally. |
| `instruction` | string | No | Markdown-enabled task instructions for annotators. |
| `callback_url` | string | No | The full url (including the scheme http:// or https://) of the callback when the task is completed. |
| `attachment_type` | string | Yes | Specifies file format: 'json' (default) or 'protobuf'. |
| `meters_per_unit` | integer | No | Conversion rate of point data units to meters. |
| `polygons_labels` | array | No | Polygon types to annotate. |
| `polygons_enabled` | boolean | No | Enables polygon annotations. |
| `frames_per_second` | integer | No | Frame capture frequency. |
| `max_distance_meters` | integer | No | Maximum labeling distance from sensor in meters. |
| `labeling_sample_rate` | integer | No | 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_attributes` | object | No | Additional per-annotation attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create LiDAR Segmentation Task

**Slug:** `SCALE_AI_CREATE_LIDAR_SEGMENTATION_TASK`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Named Entity Recognition Task

**Slug:** `SCALE_AI_CREATE_NAMED_ENTITY_RECOGNITION_TASK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Custom labels (maximum 5 per task) |
| `text` | string | Yes | The text from which to extract named entities |
| `batch` | string | No | Batch association (required for Scale Rapid projects) |
| `labels` | array | Yes | Array of label definitions for entity types to identify |
| `project` | string | No | Project association for the task |
| `metadata` | object | No | Custom metadata object for the task |
| `unique_id` | string | No | Arbitrary unique identifier for the task |
| `attachments` | array | No | Array of attachments with additional context |
| `instruction` | string | Yes | Markdown-enabled instructions for task completion |
| `callback_url` | string | No | Webhook URL for task completion notifications |
| `relationships` | array | No | Array of relationship definitions between entities |
| `merge_newlines` | boolean | No | Controls newline character handling in text |
| `allow_overlapping_annotations` | boolean | No | Permits overlapping text spans in annotations |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Segmentation Annotation Task

**Slug:** `SCALE_AI_CREATE_SEGMENTATION_ANNOTATION_TASK`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Text Collection Task

**Slug:** `SCALE_AI_CREATE_TEXT_COLLECTION_TASK`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Video Annotation Task

**Slug:** `SCALE_AI_CREATE_VIDEO_ANNOTATION_TASK`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Video Playback Annotation Task

**Slug:** `SCALE_AI_CREATE_VIDEO_PLAYBACK_ANNOTATION_TASK`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Task Tags

**Slug:** `SCALE_AI_DELETE_TASK_TAGS`

Tool to remove specified tags from a Scale AI task. Use when you need to clean up or modify task tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | List of tag strings to remove from the task |
| `task_id` | string | Yes | ID of the task to remove tags from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Task Unique ID

**Slug:** `SCALE_AI_DELETE_TASK_UNIQUE_ID`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | ID of the Task to modify |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Finalize Batch

**Slug:** `SCALE_AI_FINALIZE_BATCH`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_name` | string | Yes | The name of the batch to finalize. This batch must exist before it can be finalized. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Assets

**Slug:** `SCALE_AI_GET_ASSETS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor for pagination to retrieve the next page of results. Use the cursor value from a previous response to get the next page. |
| `project` | string | Yes | Project filter to retrieve assets associated with a specific project. This parameter is required. |
| `metadata` | string | No | Metadata filter to retrieve assets matching specific metadata criteria. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batch

**Slug:** `SCALE_AI_GET_BATCH`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_name` | string | Yes | The batch identifier to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batch Status

**Slug:** `SCALE_AI_GET_BATCH_STATUS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_name` | string | Yes | The name of the batch to retrieve status for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fixless Audits

**Slug:** `SCALE_AI_GET_FIXLESS_AUDITS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Identifier for the specific audit. At least one of task_id or id must be provided. |
| `task_id` | string | No | Identifier for the task being audited. At least one of task_id or id must be provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `SCALE_AI_GET_PROJECT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The unique project identifier to retrieve. This is the project name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Quality Labelers

**Slug:** `SCALE_AI_GET_QUALITY_LABELERS`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Studio Assignments

**Slug:** `SCALE_AI_GET_STUDIO_ASSIGNMENTS`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Studio Batches

**Slug:** `SCALE_AI_GET_STUDIO_BATCHES`

Tool to retrieve basic information about all pending batches in Studio. Use when you need to list batches organized by priority level.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Teams

**Slug:** `SCALE_AI_GET_TEAMS`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Task by ID

**Slug:** `SCALE_AI_GET_V1_TASK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | The unique identifier of the task to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Secure Task Response URL

**Slug:** `SCALE_AI_GET_V1_TASK_RESPONSE_URL`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uuid` | string | Yes | The unique identifier for the secure result URL |
| `task_id` | string | Yes | The unique identifier for the task |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import File

**Slug:** `SCALE_AI_IMPORT_FILE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_url` | string | Yes | The file URL to be imported. Files are subject to Scale's 80 MB per-file size limit. |
| `project_name` | string | No | Associates the imported file with a specific project; only used for Scale Rapid data labeling tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Invite Team Member

**Slug:** `SCALE_AI_INVITE_TEAM_MEMBER`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Array of email addresses of teammates you want to invite. |
| `team_role` | string | Yes | Role of invited teammate. Must be one of: 'labeler' (Studio only), 'member', or 'manager'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Batches

**Slug:** `SCALE_AI_LIST_BATCHES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Page size determining number of results per request. |
| `offset` | integer | No | Number of results to skip for pagination. |
| `status` | string ("staging" | "in_progress" | "completed") | No | Filters by batch status. Valid values: 'staging', 'in_progress', or 'completed'. |
| `project` | string | No | Filters batches by project name. |
| `detailed` | boolean | No | Returns additional progress information about batches when set to true. |
| `end_time` | string | No | Maximum value of created_at for returned batches in ISO 8601 format. |
| `start_time` | string | No | Minimum value of created_at for returned batches in ISO 8601 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `SCALE_AI_LIST_PROJECTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `archived` | boolean | No | Filter to display only archived or unarchived projects. If not provided, all projects are returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tasks

**Slug:** `SCALE_AI_LIST_TASKS`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Re-send Task Callback

**Slug:** `SCALE_AI_POST_V1_TASK_SEND_CALLBACK`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | The unique identifier for the task whose callback should be resent |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Studio Assignments

**Slug:** `SCALE_AI_REMOVE_STUDIO_ASSIGNMENTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Array of email addresses of teammates to remove assignments from. |
| `projects` | array | No | Optional array of project IDs to unassign from the specified team members. If not provided, all projects will be unassigned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset Batch Priorities

**Slug:** `SCALE_AI_RESET_BATCH_PRIORITIES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `groups` | string | No | Filter parameter for groups to reset priorities |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Batch Priorities

**Slug:** `SCALE_AI_SET_BATCH_PRIORITIES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batches` | array | Yes | Array of batch objects specifying the priority order. Must include all pending studio batches. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Project Ontology

**Slug:** `SCALE_AI_SET_PROJECT_ONTOLOGY`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ontology` | array | Yes | 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_name` | string | Yes | The unique project identifier to set the ontology for. This is the project name. |
| `ontology_name` | string | No | A label identifying the specific version of the ontology being set. This is optional and helps track different ontology versions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Project Parameters

**Slug:** `SCALE_AI_SET_PROJECT_PARAMS`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Task Metadata

**Slug:** `SCALE_AI_SET_TASK_METADATA`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | The unique identifier of the task to set metadata on. |
| `metadata` | object | Yes | Key-value pairs of metadata to attach to the task. Accepts strings, numbers, dates, and other JSON-compatible values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Task Unique ID

**Slug:** `SCALE_AI_UPDATE_TASK_UNIQUE_ID`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | ID of the task to modify. This is the Scale AI task identifier. |
| `unique_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File

**Slug:** `SCALE_AI_UPLOAD_FILE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | The local file to upload (max 80 MB). |
| `metadata` | object | No | A JSON object used to store additional data associated with the file. |
| `file_path` | string | No | Optional local file path to read the file content from. If provided, this will be used instead of the file reference. Useful for testing or when the file is available locally. |
| `display_name` | string | No | A human readable name for the file. |
| `project_name` | string | No | Associates the file with a specific project; only used for Scale Rapid data labeling tool. |
| `reference_id` | string | No | Unique identifier for upload idempotency; uploading with duplicate IDs returns 409 error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |