View as Markdown
Scale AI icon

Scale AI ACTION

Create Document Transcription Task

Create a document transcription 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 Document Transcription 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-document-transcription-task",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    scale_ai: { authProvisionId: "apn_xxxxxxx" },
    project: "Project",
    instruction: "Instruction",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Document Transcription Task inputs
Property Type Description
project Project string
The name of the project to associate this task with.
Optional Dynamic
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
attachment Attachment string
The url of the attachment of the data to be collected. We will use the HTTP content type to determine the type of the attachment. Either Attachment or Attachments is required. You can supply attachments instead of attachment if needed.
Optional
attachments Attachments string[]
Used instead of Attachment - The urls of a multi-page document. Either Attachment or Attachments is required.
Optional
lang Language string
Language of the attachment. Defaults to en-U.
Optional
geometry Geometry string
Geometry type for the annotations. Supported values are box for axis-aligned rectangles or polygon for rotated rectangles. Defaults to box.
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
numberOfFeatures Number Of Features integer
The number of features to be collected. Defaults to 1.
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-document-transcription-task
Version
0.0.3
App
Scale AI
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes