Skip to main content
POST
cURL
Run components by key, not by saved component ID. Referencing a component by its saved component ID (sc_…) is deprecated for new integrations. Publish the component (from the public registry, or privately as a custom tool) and pass its key as id: for example slack-send-message or ~/my-custom-action. When you need an exact version to stay fixed, pin it with key@version (for example ~/my-custom-action@0.1.2) or the version parameter.Saved component IDs keep working for components that are published to the public registry or published by your workspace for the request’s environment. A component that was created but never published cannot be run or configured by ID, and the API returns 403 with a message asking you to publish it first.

Error handling

When an action fails, the response includes an error object with an attribution field that classifies where the error originated. See the docs on error responses for the full list of attribution origins and details on how attribution works.

Authorizations

Authorization
string
header
required

A short-lived Connect token for client-side requests on behalf of an end user. Generate one via the Create Connect token endpoint.

Headers

x-pd-environment
enum<string>
required

The environment in which the server client is running

Available options:
development,
production

Path Parameters

project_id
string
required

The project ID, which starts with proj_.

Pattern: ^proj_[a-zA-Z0-9]+$

Body

application/json

Request options for running an action

id
string
required

The action component ID

external_user_id
string
required

The external user ID

version
string | null
default:latest

Action component semantic version

Example:

"1.0.0"

configured_props
object

The configured properties of the component

dynamic_props_id
string

The ID for dynamic props

stash_id

The ID of the File Stash to use for syncing the action's /tmp directory, or either true or 'NEW' to create a new stash

Response

action ran

The response received after running an action. See https://pipedream.com/docs/components/api#returning-data-from-steps for more details.

exports
object

The key-value pairs resulting from calls to $.export

os
object[]

Any logs produced during the execution of the action

ret
any | null

The value returned by the action

stash_id
string | null

The ID of the File Stash