Plainly ACTION
Create Render Job
Creates a render job for a video template. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Plainly account once, then configure and run Create Render 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: "plainly-create-render-job",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
plainly: { authProvisionId: "apn_xxxxxxx" },
projectId: "Project ID",
templateId: "Template ID",
},
})
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": "plainly-create-render-job",
"configured_props": {
"plainly": { "authProvisionId": "apn_xxxxxxx" },
"projectId": "Project ID",
"templateId": "Template ID"
}
}'// 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": "plainly",
},
},
},
)
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: "plainly-create-render-job",
arguments: {
projectId: "Project ID",
templateId: "Template ID",
},
})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 |
|---|---|---|
projectId Project ID | string | The ID of a project Required Dynamic |
templateId Template ID | string | The ID of the video template Required Dynamic |
attributes Attributes | object | User-defined attributes of the render. The field batchRenderId is reserved and should be a string. The field batchRenderSequenceNo is reserved and should be a number. Keys in this map must not contain dots. Optional |
parameters Parameters | object | Map of parameters to use in order to resolve the template parametrized layers. Keys in this map must not contain dots. Optional |
configureOptions Configure Options | boolean | Set to true to enter values for the map of additional options for the render Optional |
captionsPosition Captions Position | string | The position of captions. Default: BOTTOM Optional |
captionsStyle Captions Style | string | The style of captions. Default: BASIC Optional |
srtFileUrl SRT File URL | string | Url to the srt file Optional |
passthrough Passthrough | string | Data to be sent to the integration as the integrationPassthrough parameter. Serves to pass arbitrary data to your active integrations. Could be any string or a render parameter reference in formats {{parameterName}} or {{parameterName:defaultValue}}, including a reference to {{webhookPassthrough}} in the same manner`. Optional |
skipAll Skip All | boolean | If true, any active integration for this project or template will not be triggered. Optional |
thumbnailAtSeconds Thumbnail At Seconds | string[] | Generated thumbnails would be PNG thumbnails based on specified timestamps in seconds Optional |
thumbnailFormat Thumbnail Format | string | The format of the thumbnails Optional |
thumbnailFrequencySeconds Thumbnail Frequency Seconds | integer | Frequency in seconds to export a frame. For example, having the value frequencySeconds=5 and a rendered video that lasts 15 sec, would create 3 PNGs. Optional |
thumbnailFromEncodedVideo Thumbnail From Encoded Video | boolean | When set to true, the thumbnails will be generated from the encoded video. If set to false, the thumbnails will be generated from the video outputted by the After Effects rendering process. Optional |
watermarkEncodingParamsLine Watermark Encodeing Params Line | string | Additional ffmpeg command line parameters to change watermark position, size, etc. If not specified, the watermark is placed at the top left corner with opacity of 0.8. Optional |
watermarkUrl Watermark URL | string | A public url to the watermark image or video Optional |
uploadEnabled Upload Enabled | boolean | Enables uploading modified project files as a zip archive Optional |
configureOutputFormat Configure Output Format | boolean | Set to true to enter values used for rendering output. If not specified defaults to default output format for the target After Effects version Optional |
attachment Attachment | boolean | If the output file should be consider as an attachment, meaning that the video link will initiate a download of the file in a web browser. Optional |
attachmentFileName Attachment File Name | string | Optional, name of the file when downloading as attachment. Note that this has effect only if attachment is true. The file name must be provided without extension which will be added automatically based on the selected format. Optional |
outputModule Output Module | string | The output module defines the format of the video generated by the After Effects Optional |
settingsTemplate Settings Template | string | Defines render settings template to be used during After Effects rendering Optional |
configureWebhook Configure Webhook | boolean | Set to true to enter webhook properties. A webhook HTTP(S) call expects a 2xx status code in order to be marked as successful. In case of a failed delivery, Plainly will attempt to re-call your webhook for up to one day in space of 15 minutes. A webhook HTTP(S) request has a timeout of 30 seconds. A webhook HTTP(S) request does follow redirects. Optional |
onFailure On Failure | boolean | Should webhook be called also on the failed renders Optional |
onInvalid On Invalid | boolean | Should webhook be called also on the invalid renders Optional |
webhookUrl Webhook URL | string | The HTTP(S) webhook URL to execute the POST call once the rendering is finished 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
- plainly-create-render-job
- Version
- 0.0.2
- App
- Plainly
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗