← Scale AI

Create Document Transcription Task with Scale AI API

Pipedream makes it easy to connect APIs for Scale AI and 2,400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Document Transcription Task with the Scale AI API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Document Transcription Task with the Scale AI API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create Document Transcription Task action
    1. Connect your Scale AI account
    2. Optional- Select a Project
    3. Optional- Configure Instruction
    4. Optional- Configure Callback URL
    5. Optional- Configure Attachment
    6. Optional- Configure Attachments
    7. Optional- Configure Language
    8. Optional- Select a Geometry
    9. Optional- Configure Unique ID
    10. Configure Number Of Features
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Document Transcription Task with Scale AI API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Scale AI
 
Try it
Create Document Transcription Task with Scale AI API on New Submission from Typeform API
Typeform + Scale AI
 
Try it
Create Document Transcription Task with Scale AI API on Custom Events from Zoom API
Zoom + Scale AI
 
Try it
Create Document Transcription Task with Scale AI API on New Submission (Instant) from Jotform API
Jotform + Scale AI
 
Try it
Create Document Transcription Task with Scale AI API on New Scheduled Tasks from Pipedream API
Pipedream + Scale AI
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Document Transcription Task on Scale AI
Description:Create a document transcription task. [See the documentation](https://docs.scale.com/reference/document-transcription-1)
Version:0.0.2
Key:scale_ai-create-document-transcription-task

Code

import app from "../../scale_ai.app.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "scale_ai-create-document-transcription-task",
  name: "Create Document Transcription Task",
  description: "Create a document transcription task. [See the documentation](https://docs.scale.com/reference/document-transcription-1)",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    project: {
      propDefinition: [
        app,
        "project",
      ],
    },
    instruction: {
      propDefinition: [
        app,
        "instruction",
      ],
    },
    callbackUrl: {
      propDefinition: [
        app,
        "callbackUrl",
      ],
    },
    attachment: {
      description: "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.",
      propDefinition: [
        app,
        "attachment",
      ],
    },
    attachments: {
      type: "string[]",
      label: "Attachments",
      description: "Used instead of **Attachment** - The urls of a multi-page document. Either **Attachment** or **Attachments** is required.",
      optional: true,
    },
    lang: {
      type: "string",
      label: "Language",
      description: "Language of the attachment. Defaults to `en-U`.",
      optional: true,
      default: "en-US",
    },
    geometry: {
      type: "string",
      label: "Geometry",
      description: "Geometry type for the annotations. Supported values are `box` for axis-aligned rectangles or `polygon` for rotated rectangles. Defaults to `box`.",
      optional: true,
      options: Object.values(constants.GEOMETRY_TYPE),
      default: constants.GEOMETRY_TYPE.BOX,
    },
    uniqueId: {
      propDefinition: [
        app,
        "uniqueId",
      ],
    },
    numberOfFeatures: {
      type: "integer",
      label: "Number Of Features",
      description: "The number of features to be collected. Defaults to `1`.",
      default: 1,
      reloadProps: true,
    },
  },
  methods: {
    featuresPropsMapper(prefix) {
      const {
        [`${prefix}type`]: type,
        [`${prefix}label`]: label,
        [`${prefix}title`]: title,
        [`${prefix}flags`]: flags,
      } = this;

      return {
        type,
        label,
        title,
        flags,
      };
    },
    getFeaturesPropDefinitions({
      prefix,
      label,
    } = {}) {
      return {
        [`${prefix}type`]: {
          type: "string",
          label: `${label} - Type`,
          description: "One of `text`, `block`, or `group`. See \"Feature Types\" for more information.",
          options: Object.values(constants.FEATURE_TYPE),
        },
        [`${prefix}label`]: {
          type: "string",
          label: `${label} - Label`,
          description: "Label for the annotation. It is required for block and text features.",
          optional: true,
        },
        [`${prefix}title`]: {
          type: "string",
          label: `${label} - Title`,
          description: "For `group`-type features, a group title must be provided as opposed to a label since a group itself is not labeled.",
          optional: true,
        },
        [`${prefix}flags`]: {
          type: "string[]",
          label: `${label} - Flags`,
          description: "A list of ContentFlag values. Content flags allow Scale to transcribe documents more effectively by enabling special tooling or modifying the default behavior for certain features.",
          optional: true,
          options: Object.values(constants.CONTENT_FLAG),
        },
      };
    },
    createDocumentTranscriptionTask(args = {}) {
      return this.app.post({
        path: "/task/documenttranscription",
        ...args,
      });
    },
  },
  async additionalProps() {
    const {
      numberOfFeatures,
      getFeaturesPropDefinitions,
    } = this;

    return utils.getAdditionalProps({
      numberOfFields: numberOfFeatures,
      fieldName: "feature",
      getPropDefinitions: getFeaturesPropDefinitions,
    });
  },
  async run({ $: step }) {
    const {
      createDocumentTranscriptionTask,
      project,
      instruction,
      callbackUrl,
      attachment,
      attachments,
      lang,
      geometry,
      uniqueId,
      numberOfFeatures,
      featuresPropsMapper,
    } = this;

    const response = await createDocumentTranscriptionTask({
      step,
      data: {
        project,
        instruction,
        callback_url: callbackUrl,
        attachment,
        attachments,
        lang,
        geometry,
        unique_id: uniqueId,
        features: utils.getFieldsProps({
          numberOfFields: numberOfFeatures,
          fieldName: "feature",
          propsMapper: featuresPropsMapper,
        }),
      },
    });

    step.export("$summary", `Successfully created document transcription task with ID  \`${response.task_id}\``);

    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
Scale AIappappThis component uses the Scale AI app.
ProjectprojectstringSelect a value from the drop down menu.
Instructioninstructionstring

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.

Callback URLcallbackUrlstring

The full url (including the scheme http:// or https://) or email address of the callback that will be used when the task is completed.

Attachmentattachmentstring

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.

Attachmentsattachmentsstring[]

Used instead of Attachment - The urls of a multi-page document. Either Attachment or Attachments is required.

Languagelangstring

Language of the attachment. Defaults to en-U.

GeometrygeometrystringSelect a value from the drop down menu:boxpolygon
Unique IDuniqueIdstring

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.

Number Of FeaturesnumberOfFeaturesinteger

The number of features to be collected. Defaults to 1.

Authentication

Scale AI uses API keys for authentication. When you connect your Scale AI account, Pipedream securely stores the keys so you can easily authenticate to Scale AI APIs in both code and no-code steps.

Sign in and copy your API key directly from your dashboard.

About Scale AI

Make the best models with the best data. Scale Data Engine leverages your enterprise data, and with Scale Generative AI Platform, safely unlocks the value of AI.

More Ways to Use Scale AI

Actions

Create Image Annotation Task with the Scale AI API

Create an image annotation task. See the documentation

 
Try it
Create Text Annotation Task with the Scale AI API

Create a text annotation task. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.