The Scale AI connector lets your AI agent act in each user's Scale AI account. Each user connects their own Scale AI API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 20 tools.
- Tools
- 20
- What they doRead · write · destructive
- 8 · 10 · 28 read10 write2 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Scale AI connection
In AgentKit > Connections, create a Scale AI connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolscaleai_audits_listGet the fixless audits of a task, or one audit by ID, with their feedback items (errors, flags, comments).Read-onlyList Fixless Audits
Get the fixless audits of a task, or one audit by ID, with their feedback items (errors, flags, comments). Returns audit objects.
Inputs
idstring- Audit ID to get. Example: 6560a1b2c3d4e5f6a7b8c9d0.
task_idstring- Task ID to get audits for. Example: 576ba74eec471ff9b01557cc.
scaleai_batch_getGet one batch by name with its project, status and callback.Read-onlyGet Batch
Get one batch by name with its project, status and callback. Returns the batch object. Use scaleai_batch_status_get for task counts.
Inputs
batch_namestringrequired- Batch name, from scaleai_batches_list. Example: kitten_labeling_2020-07.
scaleai_batch_status_getGet a batch's status and the count of its tasks by status (pending, completed, error, canceled).Read-onlyGet Batch Status
Get a batch's status and the count of its tasks by status (pending, completed, error, canceled). Returns the counts.
Inputs
batch_namestringrequired- Batch name, from scaleai_batches_list. Example: kitten_labeling_2020-07.
scaleai_batches_listList batches, newest first, optionally by project, status or creation time, with limit and offset paging.Read-onlyList Batches
List batches, newest first, optionally by project, status or creation time, with limit and offset paging. Returns batches with name, project, status and, with detailed, task counts.
Inputs
detailedboolean- Set to true to include progress details. Example: true.
end_timestring- Only batches created at or before this ISO 8601 time. Example: 2026-01-31.
limitinteger- Page size, up to 100. Example: 100.
offsetinteger- Number of batches to skip. Example: 0.
projectstring- Only batches of this project name. Example: kitten_labeling.
start_timestring- Only batches created at or after this ISO 8601 time. Example: 2026-01-01.
statusstring- Only batches in this status. Example: in_progress.one of
stagingin_progresscompleted
scaleai_project_getGet one project by name with its task type, current parameters and parameter history.Read-onlyGet Project
Get one project by name with its task type, current parameters and parameter history. Returns the project object.
Inputs
project_namestringrequired- Project name, from scaleai_projects_list. Example: kitten_labeling.
scaleai_projects_listList all projects in the account, optionally only archived or only active ones.Read-onlyList Projects
List all projects in the account, optionally only archived or only active ones. Returns projects with name, task type, parameters and creation time. Use scaleai_project_get for one project.
Inputs
archivedboolean- Set to true for archived projects only, false for active projects only. Example: false.
scaleai_task_getGet one task by ID with its status, parameters, metadata and, when completed, the response (annotations).Read-onlyGet Task
Get one task by ID with its status, parameters, metadata and, when completed, the response (annotations). Returns the task object.
Inputs
task_idstringrequired- Task ID, from scaleai_tasks_list or the create response. Example: 576ba74eec471ff9b01557cc.
scaleai_tasks_listList tasks, newest first, filtered by project, batch, type, status, review status, unique ID, tags or created/completed/updated time, with token paging.Read-onlyList Tasks
List tasks, newest first, filtered by project, batch, type, status, review status, unique ID, tags or created/completed/updated time, with token paging. Returns tasks and next_token.
Inputs
batchstring- Only tasks of this batch name. Example: kitten_labeling_2026-01.
completed_afterstring- Only tasks completed at or after this ISO 8601 time. Example: 2026-01-10.
completed_beforestring- Only tasks completed at or before this ISO 8601 time. Example: 2026-01-20.
customer_review_statusstring- Only tasks with this audit result; several comma-separated values allowed (accepted, fixed, commented, rejected). Example: accepted.
end_timestring- Only tasks created at or before this ISO 8601 time. Example: 2026-01-31.
include_attachment_urlboolean- Set to true to include presigned attachment URLs. Example: true.
limitinteger- Page size, 1 to 100. Defaults to 100. Example: 100.
next_tokenstring- next_token from the previous page. Example: eyJpZCI6IjU3NmJhNzRlIn0.
projectstring- Only tasks of this project name. Example: kitten_labeling.
start_timestring- Only tasks created at or after this ISO 8601 time. Example: 2026-01-01.
statusstring- Only tasks in this status. Example: completed.one of
completedpendingcanceled tagsstring- Only tasks with this tag; several comma-separated values allowed. Example: pilot.
typestring- Only tasks of this type. Example: imageannotation.one of
imageannotationsegmentannotationvideoannotationvideoplaybackannotationtextcollectionnamedentityrecognitionlidarannotationlidarsegmentationlidarlinkinglidartopdownsensorfusionmultistage unique_idstring- Only tasks with this unique_id; several comma-separated values allowed. Example: kitten-01.jpg.
updated_afterstring- Only tasks updated at or after this ISO 8601 time. Example: 2026-01-10.
updated_beforestring- Only tasks updated at or before this ISO 8601 time. Example: 2026-01-20.
scaleai_batch_createCreate a batch in a project to group tasks; Rapid batches can be calibration or self-label batches.WriteCreate Batch
Create a batch in a project to group tasks; Rapid batches can be calibration or self-label batches. Returns the new batch. Add tasks with scaleai_task_create and, for Rapid or Studio, finalize with scaleai_batch_finalize.
Inputs
namestringrequired- Batch name, unique in the account. Example: kitten_labeling_2026-01.
projectstringrequired- Name of the project the batch belongs to. Example: kitten_labeling.
calibration_batchboolean- Rapid only: set to true for a calibration batch. Example: false.
callbackstring- URL or email address notified when tasks complete. Example: https://example.com/hooks/scale.
self_label_batchboolean- Rapid only: set to true for a self-label batch. Example: false.
scaleai_batch_finalizeFinalize a Scale Rapid or Studio batch so its tasks start being worked on (and billed).WriteFinalize Batch
Finalize a Scale Rapid or Studio batch so its tasks start being worked on (and billed). Returns the batch. A no-op for other accounts.
- Idempotent
Inputs
batch_namestringrequired- Batch name, from scaleai_batches_list. Example: kitten_labeling_2020-07.
scaleai_batch_prioritizeSet the priority of a batch's tasks that have not started, from 10 (lowest) to 30 (highest).WritePrioritize Batch
Set the priority of a batch's tasks that have not started, from 10 (lowest) to 30 (highest). Returns the result.
- Idempotent
Inputs
batch_namestringrequired- Batch name, from scaleai_batches_list. Example: kitten_labeling_2020-07.
priorityintegerrequired- Priority from 10 (lowest) to 30 (highest). Example: 20.
scaleai_project_createCreate a project for one task type, with default task parameters such as instructions.WriteCreate Project
Create a project for one task type, with default task parameters such as instructions. Returns the new project. Tasks and batches reference it by name.
Inputs
namestringrequired- Project name, unique in the account. Example: kitten_labeling.
typestringrequired- Task type of every task in the project. Example: imageannotation.one of
imageannotationsegmentannotationvideoannotationvideoplaybackannotationtextcollectionnamedentityrecognitionlidarannotationlidarsegmentationlidarlinkinglidartopdownsensorfusionmultistage consensus_attemptsinteger- Studio consensus projects only: number of attempts. Example: 3.
paramsobject- Default task parameters, for example {"instruction": "Label every kitten"}; task requests override them. Example: {"instruction": "Please label the kittens"}
pipelinestring- Studio only: standard_task or consensus_task. Example: standard_task.one of
standard_taskconsensus_task rapidboolean- Set to true for a Scale Rapid project (self-serve accounts); enterprise customers leave it out. Example: true.
studioboolean- Set to true for a Scale Studio project. Example: false.
scaleai_project_params_setSet new default task parameters on a project; future tasks inherit them unless the task request overrides them.WriteSet Project Parameters
Set new default task parameters on a project; future tasks inherit them unless the task request overrides them. With patch true the new values are merged into the current ones. Returns the updated project.
- Idempotent
Inputs
project_namestringrequired- Project name, from scaleai_projects_list. Example: kitten_labeling.
instructionstring- Instructions added to every task's own instruction. Example: Label every kitten, including partly hidden ones.
paramsobject- Other default task parameters, for example geometries or attachment settings. Example: {"geometries": {"box": {"objects_to_annotate": ["kitten"]}}}
patchboolean- Set to true to merge with the current parameters instead of replacing them. Defaults to false. Example: true.
scaleai_task_createCreate a labeling task of a given type (image, segmentation, video, text collection, named entity recognition, lidar, sensor fusion or multi-stage) with instructions, attachments and type-specific parameters.WriteCreate Task
Create a labeling task of a given type (image, segmentation, video, text collection, named entity recognition, lidar, sensor fusion or multi-stage) with instructions, attachments and type-specific parameters. Returns the task with its ID. Live-key tasks are done by people and billed; test-key tasks are not.
Inputs
typestringrequired- Task type; it decides which type-specific parameters are needed. Example: imageannotation.one of
imageannotationsegmentannotationvideoannotationvideoplaybackannotationtextcollectionnamedentityrecognitionlidarannotationlidarsegmentationlidarlinkinglidartopdownsensorfusionmultistage attachmentstring- URL of the image, video or file to label. Example: https://example.com/images/kitten-01.jpg.
attachmentsarray- Attachments for multi-attachment types such as textcollection, each an object. Example: [{"type": "website", "content": "https://example.com"}]
batchstring- Batch name; required for Scale Rapid projects. Example: kitten_labeling_2026-01.
callback_urlstring- URL or email address notified when the task completes. Example: https://example.com/hooks/scale.
clear_unique_id_on_errorboolean- Set to true to free the unique_id if the task errors. Example: true.
instructionstring- Markdown instructions for the labelers. Example: Draw a box around every kitten.
metadataobject- Your own key/value data stored with the task. Example: {"source": "camera-3"}
paramsobject- Type-specific parameters merged into the request, for example geometries for imageannotation, fields for textcollection, text and labels for namedentityrecognition. Example: {"geometries": {"box": {"objects_to_annotate": ["kitten"], "min_height": 10, "min_width": 10}}}
projectstring- Project name; not needed when batch is given. Example: kitten_labeling.
tagsarray- Up to 5 tags. Example: ["pilot"]
unique_idstring- Your own ID for the task, unique across the account; a repeat returns 409. Example: kitten-01.jpg.
scaleai_task_metadata_setReplace a task's metadata with the given key/value data.WriteSet Task Metadata
Replace a task's metadata with the given key/value data. Returns the task.
- Idempotent
Inputs
metadataobjectrequired- Key/value data to store on the task. Example: {"source": "camera-3", "reviewed": true}
task_idstringrequired- Task ID, from scaleai_tasks_list or the create response. Example: 576ba74eec471ff9b01557cc.
scaleai_task_unique_id_setSet or change a task's unique_id.WriteSet Task Unique ID
Set or change a task's unique_id. Returns the task.
- Idempotent
Inputs
task_idstringrequired- Task ID, from scaleai_tasks_list or the create response. Example: 576ba74eec471ff9b01557cc.
unique_idstringrequired- New unique ID, unique across the account. Example: kitten-01.jpg.
scaleai_task_cancelCancel a pending task, optionally freeing its unique_id for reuse.DestructiveCancel Task
Cancel a pending task, optionally freeing its unique_id for reuse. Returns the task. Completed tasks cannot be canceled.
- Idempotent
Inputs
task_idstringrequired- Task ID, from scaleai_tasks_list or the create response. Example: 576ba74eec471ff9b01557cc.
clear_unique_idboolean- Set to true to clear the task's unique_id so it can be reused. Example: true.
scaleai_task_unique_id_deleteRemove a task's unique_id so the value can be used again.DestructiveDelete Task Unique ID
Remove a task's unique_id so the value can be used again. Returns the task.
- Idempotent
Inputs
task_idstringrequired- Task ID, from scaleai_tasks_list or the create response. Example: 576ba74eec471ff9b01557cc.
No tools match.