How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pipedream Components API

The Components API from Pipedream — 4 operation(s) for components.

Pipedream Components API is one of 16 APIs that Pipedream publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Components. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and 7 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 70 schemas. It is described by OpenAPI 3.2.0, at version 2026-05-22.

Requests are made against a single base URL, https://api.pipedream.com.

4 operations 4 paths 70 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-05-22
Base URL
https://api.pipedream.com/v1
Authentication
OAuth 2.0, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Pipedream Components API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 16 scopes. It accepts HTTP bearer tokens (^ctok_[0-9a-f]{32}$) (ConnectToken).

  • OAuth2 — A short-lived OAuth access token for server-side requests. Generate one via the Generate OAuth Token flow or automatically when initializing the SDK client.
  • ConnectToken — A short-lived Connect token for client-side requests on behalf of an end user. Generate one via the Create Connect token endpoint.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Components 4
GET
/v1/connect/{project_id}/components
List Components
listComponents 9 params → 200400429
GET
/v1/connect/{project_id}/components/{component_id}
Retrieve Component
retrieveComponent 4 params → 200429
POST
/v1/connect/{project_id}/components/configure
Configure Component Prop
configureComponentProp 2 params body → 200202429
POST
/v1/connect/{project_id}/components/props
Reload Component Props
reloadComponentProps 2 params body → 200202429

Schemas 70

The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are ConfigurablePropBase (12 properties), ConfigurePropOpts (10 properties), Component (8 properties), HttpRequestConfig (7 properties). Each schema is shown below with its type and property counts.

ConfiguredPropValue
ErrorResponse
object
Error response returned by the API in case of an error
3 properties 1 required
ConfigurablePropStringArray
Observation
object
Any logs produced during the configuration of the prop
4 properties 2 required
ConfiguredPropValueApp
object
1 property 1 required
ConfigurablePropAlert
ConfigurablePropDiscord
ConfigurablePropAirtableBaseId
Component
object
8 properties 4 required
PropOption
object
A configuration option for a component's prop
2 properties 2 required
ConfigurablePropSql
ConfigurePropOpts
object
Request options for configuring a component's prop
10 properties 3 required
ConfigurablePropDiscordChannelArray
GetComponentsResponse
object
Response received when retrieving a list of components
2 properties 2 required
ConfigurablePropHttpRequest
ReloadPropsOpts
object
Request options for reloading a component's props when dealing with dynamic props
6 properties 2 required
ConfigurablePropApp
ConfigurablePropObject
ConfiguredProps
object
The configured properties of the component
ObservationError
object
Details about an observed error message
3 properties
ConfigurablePropDb
HttpRequestConfig
objectnull
Configuration for an HTTP request prop
7 properties
PropOptionValue
The value of a prop option
ConfigurablePropDirAccessMode
string
The mode in which the component may access File Stash
ConfiguredPropValueAny
ConfigurePropResponse
object
Response received after configuring a component's prop
5 properties
TimerInterval
object
Timer configuration using interval in seconds
1 property 1 required
ProjectEnvironment
string
The environment in which the server client is running
ConfigurablePropAlertType
string
The severity level of the alert.
ConfigurableProp
A configuration or input field for a component. This is a discriminated union based on the type field.
ConfigurablePropHttp
ConfigurablePropTimerDefault
Default timer configuration
ConfigurablePropTimerStatic
Static timer configuration
ToolAnnotations
objectnull
Optional properties describing component behavior
5 properties
ConfigurablePropDiscordChannel
ConfigurablePropAirtableViewId
HttpRequestField
object
A name-value field for HTTP request configuration
2 properties 2 required
ReloadPropsResponse
object
Response from reloading component props
3 properties
ConfigurablePropAny
ConfigurablePropAirtableFieldId
ConfigurablePropTimer
ConfigurablePropBase
object
A configuration or input field for a component.
12 properties 2 required
PropOptionNested
object
A configuration option for a component's prop (nested under lv)
1 property 1 required
ConfigurablePropStringFormat
stringnull
The format of the string value. file-ref indicates a URL of a file or path to a file in the component's /tmp directory.
HttpRequestBody
objectnull
Body configuration for HTTP request
5 properties
ConfigurablePropAirtableTableId
ConfigurablePropTimerOption
Timer configuration options
ConfigurablePropBoolean
ConfigurablePropString
ConfigurablePropDir
ComponentStash
stringnull
Indicates if a File Stash ID is optional or required to run the component
GetComponentResponse
object
Response received when retrieving a specific component
1 property 1 required
ConfigurablePropInteger
ConfigurablePropIntegerArray
PageInfo
object
4 properties
ConfiguredPropValueInteger
number
TimerCron
object
Timer configuration using cron expression
1 property 1 required
AccountId
string
The unique ID of the account.
HttpRequestAuth
objectnull
Authentication configuration for HTTP request
4 properties
ConfigurablePropSqlAuth
objectnull
1 property
ConfiguredPropValueString
string
ConfigurablePropDataStore
ConfigurePropOptions
arraynull
Available options (with labels) for the configured prop
ConfiguredPropValueObject
object
ConfiguredPropValueSql
object
4 properties 4 required
ConfiguredPropValueBoolean
boolean
ComponentType
string
The type of component (trigger or action)
DynamicProps
object
Dynamic properties of a saved component
2 properties
ConfiguredPropValueStringArray
array
ConfigurablePropApphook

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pipedream-components-api-openapi.yml Raw ↑

Other APIs Pipedream publishes across the network.

Pipedream Accounts API
Pipedream Actions API
Pipedream App Categories API
Pipedream Apps API
Pipedream Deployed Triggers API
Pipedream File Stash API
Pipedream MCP API
Pipedream OAuth API
Pipedream Projects API
Pipedream Proxy API
Pipedream Tokens API
Pipedream Triggers API
Where this information came from

This is an independent, third-party profile of Pipedream Components API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.