View as Markdown
Cloud Convert icon

Cloud Convert ACTION

Create Job

Creates a new job for one or more tasks. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Cloud Convert account once, then configure and run Create Job 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: "cloud_convert-create-job",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    cloud_convert: { authProvisionId: "apn_xxxxxxx" },
    tasks: "Tasks",
    tag: "Tag",
  },
})

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 Job inputs
Property Type Description
tasks Tasks object

An object containing named tasks that form the job workflow. You can name tasks however you want, but only alphanumeric characters, hyphens (-), and underscores (_) are allowed.

Each task object must include:

  • operation (string, required): The endpoint for creating the task (e.g., convert, import/url, import/s3, export/s3, etc.)
  • input (string or array, optional): The name(s) of the input task(s). Use this to reference other tasks within the same job. Multiple task names can be provided as an array.
  • ignore_error (boolean, optional): By default, the job fails if one task fails. Set to true to continue the job even if this specific task fails.
  • Task-specific options (optional): Additional parameters that depend on the operation type. These are the same parameters used when creating the task via its direct endpoint.

Example:

{
  "import-my-file": {
    "operation": "import/url",
    "url": "https://example.com/document.pdf"
  },
  "convert-my-file": {
    "operation": "convert",
    "input": "import-my-file",
    "output_format": "jpg",
    "pages": "1-3"
  },
  "export-my-file": {
    "operation": "export/url",
    "input": ["convert-my-file"]
  }
}

See the tasks documentation

Required
tag Tag string
An arbitrary string to identify the job. Does not have any effect and can be used to associate with your application
Optional
webhookUrl Webhook URL string
Single-job webhook URL receiving job.finished or job.failed events
Optional

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
cloud_convert-create-job
Version
0.0.1
App
Cloud Convert
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes