Scale AI ACTION
Create Text Annotation Task
Create a text annotation task. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Scale AI account once, then configure and run Create Text Annotation Task from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "scale_ai-create-text-annotation-task",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
scale_ai: { authProvisionId: "apn_xxxxxxx" },
project: "Project",
batch: "Batch",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "scale_ai-create-text-annotation-task",
"configured_props": {
"scale_ai": { "authProvisionId": "apn_xxxxxxx" },
"project": "Project",
"batch": "Batch"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "scale_ai",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "scale_ai-create-text-annotation-task",
arguments: {
project: "Project",
batch: "Batch",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
project Project | string | The name of the project to associate this task with. Optional Dynamic |
batch Batch | string | The name of the batch to associate this task with. Note that if a batch is specified, you need not specify the project, as the task will automatically be associated with the batch's project. For Scale Rapid projects specifying a batch is required. See Batches section for more details. Optional |
instruction Instruction | string | A markdown-enabled string or iframe embedded Google Doc explaining how to do the task. You can use markdown to show example images, give structure to your instructions, and more. See our instruction best practices for more details. For Scale Rapid projects, DO NOT set this field unless you specifically want to override the project level instructions. Optional |
callbackUrl Callback URL | string | The full url (including the scheme http:// or https://) or email address of the callback that will be used when the task is completed. Optional |
title Title | string | The title of the task to be shown to scalers. Optional |
description Description | string | The description of the task to be shown to scalers. Optional |
responsesRequired Responses Required | integer | The number of responses required for the task to build consensus before returning the callback response. Upper bound of 100. Optional |
priority Priority | integer | A value of 10, 20, or 30 that defines the priority of a task within a project. The higher the number, the higher the priority. Optional |
uniqueId Unique ID | string | A arbitrary ID that you can assign to a task and then query for later. This ID must be unique across all projects under your account, otherwise the task submission will be rejected. See Avoiding Duplicate Tasks for more details. Optional |
clearUniqueIdOnError Clear Unique ID on Error | boolean | If set to be true, if a task errors out after being submitted, the Unique ID on the task will be unset. This param allows workflows where you can re-submit the same Unique ID to recover from errors automatically. Optional |
numberOfFields Number of Fields | integer | The number of fields to be labeled Required |
numberOfAttachments Number of Attachments | integer | The number of attachments to be labeled Required |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- scale_ai-create-text-annotation-task
- Version
- 0.0.3
- App
- Scale AI
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗