Pipedream Python Library
The Pipedream Python library provides convenient access to the Pipedream APIs from Python.
Table of Contents
- Installation
- Reference
- Usage
- Environments
- Async Client
- Exception Handling
- Pagination
- Oauth Token Override
- Advanced
- Contributing
Installation
pip install pipedream
Reference
A full reference for this library is available here.
Usage
Instantiate and use the client with the following:
from pipedream import Pipedream
client = Pipedream(
client_id="<clientId>",
client_secret="<clientSecret>",
)
client.actions.run(
id="id",
external_user_id="external_user_id",
)
Environments
This SDK allows you to configure different environments for API requests.
from pipedream import Pipedream
from pipedream.environment import PipedreamEnvironment
client = Pipedream(
environment=PipedreamEnvironment.PROD,
)
Async Client
The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).
import asyncio
from pipedream import AsyncPipedream
client = AsyncPipedream(
client_id="<clientId>",
client_secret="<clientSecret>",
)
async def main() -> None:
await client.actions.run(
id="id",
external_user_id="external_user_id",
)
asyncio.run(main())
Exception Handling
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.
from pipedream.core.api_error import ApiError
try:
client.actions.run(...)
except ApiError as e:
print(e.status_code)
print(e.body)
Pagination
Paginated requests will return a SyncPager or AsyncPager, which can be used as generators for the underlying object.
from pipedream import Pipedream
client = Pipedream(
client_id="<clientId>",
client_secret="<clientSecret>",
)
client.apps.list(
after="after",
before="before",
limit=1,
q="q",
sort_key="name",
sort_direction="asc",
category_ids=[
"category_ids"
],
has_components=True,
has_actions=True,
has_triggers=True,
)
# You can also iterate through pages and access the typed response per page
pager = client.apps.list(...)
for page in pager.iter_pages():
print(page.response) # access the typed response for each page
for item in page:
print(item)
Oauth Token Override
This SDK supports two authentication methods: OAuth client credentials flow (automatic token management) or direct bearer token authentication. You can choose between these options when initializing the client:
from pipedream import Pipedream
# Option 1: Direct bearer token (bypass OAuth flow)
client = Pipedream(
...,
token="my-pre-generated-bearer-token",
)
# Option 2: OAuth client credentials flow (automatic token management)
client = Pipedream(
...,
client_id="your-client-id",
client_secret="your-client-secret",
)
Advanced
Access Raw Response Data
The SDK provides access to raw response data, including headers, through the .with_raw_response property.
The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.
from pipedream import Pipedream
client = Pipedream(...)
response = client.actions.with_raw_response.run(...)
print(response.headers) # access the response headers
print(response.status_code) # access the response status code
print(response.data) # access the underlying object
Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
Which status codes are retried depends on the retryStatusCodes generator configuration:
legacy (current default): retries on
recommended: retries on
- 408 (Timeout)
- 409 (Conflict)
- 429 (Too Many Requests)
- 502 (Bad Gateway)
- 503 (Service Unavailable)
- 504 (Gateway Timeout)
Use the max_retries request option to configure this behavior.
client.actions.run(..., request_options={
"max_retries": 1
})
Timeouts
The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
from pipedream import Pipedream
client = Pipedream(..., timeout=20.0)
# Override timeout for a specific method
client.actions.run(..., request_options={
"timeout_in_seconds": 1
})
Custom Client
You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies
and transports.
import httpx
from pipedream import Pipedream
client = Pipedream(
...,
httpx_client=httpx.Client(
proxy="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)
Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
3 maintainers
Metadata
3 maintainers
Release files for pipedream 2.1.20
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pipedream-2.1.20.tar.gz | 108.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pipedream-2.1.20-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 342.8 kB
Release files / pipedream-2.1.20.tar.gz
| Download URL | pipedream-2.1.20.tar.gz |
|---|---|
| Size | 108.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0cb62054b299ba79750f63e3bc9efec1ba9ad65093248273ba4ad0a7234c2849
|
|
BLAKE2b-256 checksum How to use checksums |
2e9f4c1266042d2ffd2a42feac0d7a5e3a934da44c29c0cf491254f99f520bca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pipedream-2.1.20-py3-none-any.whl
| Download URL | pipedream-2.1.20-py3-none-any.whl |
|---|---|
| Size | 234.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
548e66b80d04bcca73b9c41899bb67b0fc9beabf878ed6a74984d113d3e2b624
|
|
BLAKE2b-256 checksum How to use checksums |
d37029fa4f5cb65e6ad2257bbdd702461dc04d94fdebd53c46c0c290108a52bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency log
