diff --git a/docs-v2/pages/_meta.tsx b/docs-v2/pages/_meta.tsx index aab0d67fdd3bc..a26a1be06fdde 100644 --- a/docs-v2/pages/_meta.tsx +++ b/docs-v2/pages/_meta.tsx @@ -1,9 +1,27 @@ export default { - "index": "What is Pipedream?", + "index": "Introduction", "workspaces": "Workspaces", "projects": "Projects", - "connect": "Connect", - "workflows": "Workflows", + "--connect": { + type: "separator", + title: "Connect", + }, + "connect": { + title: "Integrate APIs", + // display: "children", + }, + "--workflows": { + type: "separator", + title: "Workflows", + }, + "workflows": { + title: "Build Workflows", + // display: "children", + }, + "--platform": { + type: "separator", + title: "Platform", + }, "apps": "Apps", "components": "Components", "rest-api": "REST API", diff --git a/docs-v2/pages/account/billing-settings.mdx b/docs-v2/pages/account/billing-settings.mdx index f1a498395a51a..72c0806da4603 100644 --- a/docs-v2/pages/account/billing-settings.mdx +++ b/docs-v2/pages/account/billing-settings.mdx @@ -6,19 +6,21 @@ You'll find information on your usage data (for specific [Pipedream limits](/wor ## Subscription -You can upgrade to [paid plans](https://pipedream.com/pricing) from this section. - If you've already upgraded, you'll see an option to **Manage Subscription** here, which directs you to your personal Stripe portal. Here, you can change your payment method, review the details of previous invoices, and more. ## Usage -[Credits](/pricing/#credits) are Pipedream's billable unit, and users on the [free tier](/pricing/#free-tier) are limited on the number of daily free credits allocated. The **Usage** section displays a chart of the daily credits across a historical range of time to provide insight into your usage patterns. +[Credits](/pricing/#credits-and-billing) are Pipedream's billable unit, and users on the [free plan](/pricing/#free-plan) are limited on the number of daily free credits allocated. The **Usage** section displays a chart of the daily credits across a historical range of time to provide insight into your usage patterns. + + +Credit usage from [Connect](/connect) is not yet reflected in this section. + Hover over a specific column in the chart to see the number of credits run for that specific day: ![Daily credits tooltip](/images/account/daily-invocations-tooltip.png) -_Click_ on a specific column to see credits for that day, broken out by workflow / source: +Click on a specific column to see credits for that day, broken out by workflow / source: ![Credits broken out by workflow / source](/images/account/usage-by-resource.png) @@ -26,18 +28,18 @@ Users on the free tier will see the last 30 days of usage in this chart. Users o ## Compute Budget -Control the maximum number of compute credits permitted on your account with an _Credit Budget_. +Control the maximum number of credits permitted on your account with a **Credit Budget**. -This will restrict your account-wide usage to the specified number of [credits](/pricing/#credits) on a monthly or daily basis. The compute budget does not apply to credits incurred by [dedicated workers](/workflows/building-workflows/settings/#eliminate-cold-starts). +This will restrict your workspace-wide usage to the specified number of [credits](/pricing/#credits-and-billing) on a monthly or daily basis. The compute budget does not apply to credits incurred by [dedicated workers](/workflows/building-workflows/settings/#eliminate-cold-starts) or Pipedream Connect. -To enable this feature, _click_ on the toggle and define your maximum number of credits in the period. +To enable this feature, click on the toggle and define your maximum number of credits in the period. -Due to how credits are accrued, there may be cases where your credit usage may _slightly_ go over the cap. +Due to how credits are accrued, there may be cases where your credit usage may go slightly over the cap. In an example scenario, with a cap set at 20 credits and a long-running workflow that uses 10 credits per run, it's possible that two concurrent events trigger the workflow, and the cap won't apply until after the concurrent events are processed. ## Limits -For users on the [Free tier](/pricing/#free-tier), this section displays your usage towards your [credits quota](/workflows/limits/#daily-credits-limit) for the current UTC day. +For users on the [Free tier](/pricing/#free-plan), this section displays your usage towards your [credits quota](/workflows/limits/#daily-credits-limit) for the current UTC day. diff --git a/docs-v2/pages/connect/_meta.tsx b/docs-v2/pages/connect/_meta.tsx index a2ee66af99dc2..60567f020b21e 100644 --- a/docs-v2/pages/connect/_meta.tsx +++ b/docs-v2/pages/connect/_meta.tsx @@ -1,5 +1,5 @@ export default { - "index": "Overview", + "index": "Pipedream Connect", "use-cases": "Use Cases", "managed-auth": "Managed Auth", "components": "Tool Use", diff --git a/docs-v2/pages/connect/api-proxy.mdx b/docs-v2/pages/connect/api-proxy.mdx index 6e226516c92f9..61322d2c0f016 100644 --- a/docs-v2/pages/connect/api-proxy.mdx +++ b/docs-v2/pages/connect/api-proxy.mdx @@ -79,7 +79,7 @@ import { createBackendClient } from "@pipedream/sdk/server"; const pd = createBackendClient({ environment: {development | production}, - projectId: {your_pipedream_project_i_d}, + projectId: {your_pipedream_project_id}, credentials: { clientId: {your_oauth_client_id}, clientSecret: {your_oauth_client_secret} diff --git a/docs-v2/pages/connect/api.mdx b/docs-v2/pages/connect/api.mdx index 30e2e823e3601..03ee2a68440d3 100644 --- a/docs-v2/pages/connect/api.mdx +++ b/docs-v2/pages/connect/api.mdx @@ -235,10 +235,6 @@ curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/actions/run ## API Reference -### Invoke workflows - -You can use the SDK to [invoke workflows on behalf of any end user](/connect/workflows/). **Write one workflow, run it for all of your users**. - ### Tokens Your app will initiate the account connection flow for your end users in your frontend. To securely scope connection to a specific end user, on your server, **you retrieve a short-lived token for that user**, and return that token to your frontend. @@ -3726,3 +3722,9 @@ curl -X PUT \ ] } ``` + +### Workflows + +#### Invoke workflows + +You can use the SDK to [invoke workflows on behalf of any end user](/connect/workflows/). **Write one workflow, run it for all of your users**. diff --git a/docs-v2/pages/connect/mcp/openai.mdx b/docs-v2/pages/connect/mcp/openai.mdx index 6885ba533770e..e3c7e3819c95c 100644 --- a/docs-v2/pages/connect/mcp/openai.mdx +++ b/docs-v2/pages/connect/mcp/openai.mdx @@ -101,7 +101,6 @@ const pd = createBackendClient({ // For this example, we'll use Notion const apps = await pd.getApps({ q: "notion" }); const appSlug = apps.data[0].name_slug; // e.g., "notion", -const appLabel = apps.data[0].name; // e.g., "Notion" // Get access token for MCP server auth const accessToken = await pd.rawAccessToken(); @@ -118,7 +117,7 @@ const response = await client.responses.create({ tools: [ { type: 'mcp', - server_label: appLabel, + server_label: appSlug, server_url: `https://remote.mcp.pipedream.net`, headers: { Authorization: `Bearer ${accessToken}`, diff --git a/docs-v2/pages/glossary.mdx b/docs-v2/pages/glossary.mdx index 874ed896e6cf1..f07e41c5d36cc 100644 --- a/docs-v2/pages/glossary.mdx +++ b/docs-v2/pages/glossary.mdx @@ -104,7 +104,7 @@ You can restrict access to connected accounts to specific individuals or share w ### Credit -Pipedream charges one credit per 30 seconds of compute time at 256MB megabytes of memory (the default) per workflow execution. Credits are also charged for [dedicated workers](#dedicated-workers). [See the docs](/pricing/#credits) for more details. +Pipedream charges one credit per 30 seconds of compute time at 256MB megabytes of memory (the default) per workflow execution. Credits are also charged for [dedicated workers](#dedicated-workers). [See the docs](/pricing/#credits-and-billing) for more details. ### Custom domain diff --git a/docs-v2/pages/index.mdx b/docs-v2/pages/index.mdx index e0c5601ecff35..b11182c4aee66 100644 --- a/docs-v2/pages/index.mdx +++ b/docs-v2/pages/index.mdx @@ -2,13 +2,16 @@ import VideoPlayer from "@/components/VideoPlayer"; # Introduction to Pipedream -Pipedream is the fastest way to automate any process that connects APIs. Build and run workflows with code-level control when you need it, and no code when you don't. Easily add thousands of customer-facing integrations to your app or AI agent in minutes. +Pipedream is the easiest way to automate any process that connects APIs: + +- [Pipedream Connect](/connect) makes it easy to add thousands of customer-facing integrations to your app or AI agent in minutes +- Our [visual builder](/workflows) lets you build and run complex workflows with code-level control when you need it, and no code when you don't The Pipedream platform includes: - A [serverless runtime](/workflows/building-workflows/code/) and [workflow service](/workflows/building-workflows/) -- SDK to handle [customer authentication](/connect/) for {process.env.PUBLIC_APPS}+ APIs -- Source-available pre-built [triggers](/workflows/building-workflows/triggers/) and [actions](/workflows/building-workflows/actions/) for [thousands of integrated apps](https://pipedream.com/explore/) +- SDKs to handle [user authentication](/connect/) for {process.env.PUBLIC_APPS}+ APIs +- Source-available [triggers](/workflows/building-workflows/triggers/) and [actions](/workflows/building-workflows/actions/) for [thousands of integrated apps](https://pipedream.com/explore/) - One-click [OAuth and key-based authentication](/apps/connected-accounts/) for more than {process.env.PUBLIC_APPS} APIs (use tokens directly in code or with pre-built actions) Developing a workflow with test events in the Pipedream workflow builder is free. No credit usage is incurred. @@ -64,7 +86,7 @@ Developing a workflow with test events in the Pipedream workflow builder is free If an active workflow isn't executed in a billing period no credit usage is incurred. Pipedream only charges credits for workflow executions. -##### Workflow segments configured to use 256MB memory (default) +**Workflow segments configured to use 256MB memory (default)** | Scenario | Credits Used | | --- | --- | @@ -75,7 +97,7 @@ If an active workflow isn't executed in a billing period no credit usage is incu | Workflow with a branch - 3 seconds before the branch- 15 seconds within the executed branch | 2 credits | | Workflow with a branch - 3 seconds before the branch, 15 seconds within the executed branch, 3 seconds after the branch in the parent flow | 3 credits | -##### Workflow segments configured to use 1GB memory +**Workflow segments configured to use 1GB memory** | Scenario | Credits Used | | --- | --- | @@ -86,9 +108,9 @@ If an active workflow isn't executed in a billing period no credit usage is incu | Workflow with a branch - 3 seconds before the branch- 15 seconds within the executed branch | 8 credits | | Workflow with a branch - 3 seconds before the branch, 15 seconds within the executed branch, 3 seconds after the branch in the parent flow | 24 credits | -#### Source Credit Usage +#### Source credit usage -When an [event source](/workflows/building-workflows/triggers/) triggers a workflow, **the source execution is included for free.** This includes workspaces on the [Free Tier](/pricing/#free-tier). +When an [event source](/workflows/building-workflows/triggers/) triggers a workflow, **the source execution is included for free.** This includes workspaces on the [Free plan](/pricing/#free-plan). When a source is configured as a workflow trigger, the core value is in the workflow. You won't be charged for two credits (one to run the source, one to run the workflow) when the workflow contains the core logic. @@ -118,23 +140,16 @@ A custom source that finished under 30 seconds per execution This would result in **1 credit** per execution because the initial free credit only applies to Pipedream Public Registry sources attached to at least one workflow. -### Billing Period - -Many of the usage statistics for paid users are tied to a **billing period**. Your billing period starts when you sign up for a paid plan, and recurs roughly once a month for the duration of your subscription. - -For example, if you sign up on Jan 1st, your first billing period will last one month, ending around Feb 1st, at which point you'll start a new billing period. - -Your invoices are tied to your billing period. [Read more about invoicing / billing here](/pricing/faq/#when-am-i-billed-for-paid-plans). -### Included Credits +#### Included credits When you sign up for a paid plan, you pay a platform fee at the start of each [billing period](#billing-period). This minimum monthly charge grants you a base of included credits that you can use for the rest of your billing period (see your [Billing and Usage Settings](https://pipedream.com/settings/billing) for your exact quota). If you have been granted any additional credit increases by Pipedream, that is added to the included credits. -### Additional Credits +#### Additional credits Any credits you run over your [included credit](/workflows/limits/#daily-credits-limit) are called **additional credits**. This usage is added to the invoice for your next [billing period](#billing-period), according to the [invoicing cycle described here](/pricing/faq/#when-am-i-billed-for-paid-plans). -### Data Store Keys +#### Data store keys A Data Store key represents a single record in a Data Store. @@ -142,26 +157,38 @@ In the example below, there are two records in the Data Store, and therefore the ![Example of a Data Store with two keys](https://res.cloudinary.com/pipedreamin/image/upload/v1673537163/docs/CleanShot_2023-01-12_at_10.25.25_z6yg8t.png) -## Managing my plan +## Managing your plan To cancel, upgrade or downgrade your plan, open the [pricing page](https://pipedream.com/pricing). To update your billing details, such as your VAT number, email address, etc. use the **Manage Billing Information** button in your [workspace billing settings](https://pipedream.com/settings/billing) to change your plan. Within this portal you can cancel, upgrade or downgrade your plan at any time. -### Upgrading behavior +### Billing period + +Many of the usage statistics for paid users are tied to a **billing period**. Your billing period starts when you sign up for a paid plan, and recurs roughly once a month for the duration of your subscription. + +For example, if you sign up on Jan 1st, your first billing period will last one month, ending around Feb 1st, at which point you'll start a new billing period. + +Your invoices are tied to your billing period. [Read more about invoicing / billing here](/pricing/faq/#when-am-i-billed-for-paid-plans). + +### Upgrading -Upgrading your subscription instantly activates the features available to your workspace. For example, if you upgrade your workspace from Free to Basic, that workspace will be able to activate more workflows and connected accounts. +Upgrading your subscription instantly activates the features available to your workspace. For example, if you upgrade your workspace from Free to Basic, that workspace will immediately be able to activate more workflows and connected accounts. -### Downgrading behavior +### Downgrading -Downgrades will apply at the end of your billing cycle, and any workflows that use features outside of the new billing plan will be automatically disabled. +Downgrades will apply at the end of your billing cycle, and any workflows or integrations that use features outside the new billing plan will be automatically disabled. For example, if your workspace downgrades from Advanced to Basic and a workflow uses an Advanced feature such as [auto-retries](/workflows/building-workflows/settings/#auto-retry-errors), then this workflow will be disabled because the workspace plan no longer qualifies for that feature. Additionally, resource limits such as the number of active workflows and connected accounts will also be enforced at this same time. -### Cancellation behavior +### Cancelling your plan To cancel your plan, open the [pricing page](https://pipedream.com/pricing) and click **Cancel** beneath your current plan. Cancelling your subscription will apply at the end of your current billing period. Workflows, connected accounts and sources will be deactivated from newest to oldest until the Free limits have been reached. + +## Detailed pricing information + +Refer to our [pricing page](https://pipedream.com/pricing) for detailed pricing information. \ No newline at end of file diff --git a/docs-v2/pages/workflows/building-workflows/code/nodejs/delay.mdx b/docs-v2/pages/workflows/building-workflows/code/nodejs/delay.mdx index 9671f792a5e80..169343f94c0b2 100644 --- a/docs-v2/pages/workflows/building-workflows/code/nodejs/delay.mdx +++ b/docs-v2/pages/workflows/building-workflows/code/nodejs/delay.mdx @@ -53,7 +53,7 @@ One credit is used to initially start the workflow, then the second credit is us Exact credit usage depends on duration and memory configuration -If your workflow's [execution timeout limit](/workflows/building-workflows/settings/#execution-timeout-limit) is set to longer than [default limit](/workflows/limits/#time-per-execution), it may incur more than two [credits](/pricing/#credits) when using `pd.flow.delay`. +If your workflow's [execution timeout limit](/workflows/building-workflows/settings/#execution-timeout-limit) is set to longer than [default limit](/workflows/limits/#time-per-execution), it may incur more than two [credits](/pricing/#credits-and-billing) when using `pd.flow.delay`. ## `cancel_url` and `resume_url` diff --git a/docs-v2/pages/workflows/building-workflows/code/nodejs/rerun.mdx b/docs-v2/pages/workflows/building-workflows/code/nodejs/rerun.mdx index 877f73609258e..e556d07979d4b 100644 --- a/docs-v2/pages/workflows/building-workflows/code/nodejs/rerun.mdx +++ b/docs-v2/pages/workflows/building-workflows/code/nodejs/rerun.mdx @@ -256,7 +256,7 @@ These functions will only suspend and resume when run in production. ## Credits when using `suspend` / `rerun` -You are not charged for the time your workflow is suspended during a `$.flow.rerun` or `$.flow.suspend`. Only when workflows are resumed will compute time count toward [credit usage](/pricing/#credits). +You are not charged for the time your workflow is suspended during a `$.flow.rerun` or `$.flow.suspend`. Only when workflows are resumed will compute time count toward [credit usage](/pricing/#credits-and-billing). When a suspended workflow reawakens, it will reset the credit counter. diff --git a/docs-v2/pages/workflows/building-workflows/code/python/delay.mdx b/docs-v2/pages/workflows/building-workflows/code/python/delay.mdx index 568cf5cbd3fb4..3c5a2f543da75 100644 --- a/docs-v2/pages/workflows/building-workflows/code/python/delay.mdx +++ b/docs-v2/pages/workflows/building-workflows/code/python/delay.mdx @@ -51,7 +51,7 @@ One credit is used to initially start the workflow, then the second credit is us Exact credit usage depends on duration and memory configuration -If your workflow's [execution timeout limit](/workflows/building-workflows/settings/#execution-timeout-limit) is set to longer than [default limit](/workflows/limits/#time-per-execution), it may incur more than two [credits](/pricing/#credits) when using `pd.flow.delay`. +If your workflow's [execution timeout limit](/workflows/building-workflows/settings/#execution-timeout-limit) is set to longer than [default limit](/workflows/limits/#time-per-execution), it may incur more than two [credits](/pricing/#credits-and-billing) when using `pd.flow.delay`. ## `cancel_url` and `resume_url` diff --git a/docs-v2/pages/workflows/building-workflows/code/python/rerun.mdx b/docs-v2/pages/workflows/building-workflows/code/python/rerun.mdx index 01f9463bbf8d1..b14720e96bf58 100644 --- a/docs-v2/pages/workflows/building-workflows/code/python/rerun.mdx +++ b/docs-v2/pages/workflows/building-workflows/code/python/rerun.mdx @@ -170,7 +170,7 @@ These functions will only suspend and resume when run in production. ## Credits usage when using `pd.flow.suspend` / `pd.flow.rerun` -You are not charged for the time your workflow is suspended during a `pd.flow.suspend` or `pd.flow.rerun`. Only when workflows are resumed will compute time count toward [credit usage](/pricing/#credits). +You are not charged for the time your workflow is suspended during a `pd.flow.suspend` or `pd.flow.rerun`. Only when workflows are resumed will compute time count toward [credit usage](/pricing/#credits-and-billing). When a suspended workflow reawakens, it will reset the credit counter. diff --git a/docs-v2/pages/workflows/building-workflows/sharing.mdx b/docs-v2/pages/workflows/building-workflows/sharing.mdx index b1a060e8cc60a..1f777eeedf711 100644 --- a/docs-v2/pages/workflows/building-workflows/sharing.mdx +++ b/docs-v2/pages/workflows/building-workflows/sharing.mdx @@ -125,13 +125,13 @@ No, each link you generate will be available even if you create new versions bas ### What plan is this feature available on? -Sharing workflows via link is available on all plans, including the Free tier plans. +Sharing workflows via link is available on all plans, including the Free plan. ### Do users of my workflow need to have a subscription? To copy a workflow, a subscription is not required. However, the copied workflow is subject to the current workspace's plan limits. -For example, if a workflow requires more connected accounts than what's available on the [Free tier](/pricing/#free-tier), then users of your workflow will require a plan to run the workflow properly. +For example, if a workflow requires more connected accounts than what's available on the [Free plan](/pricing/#free-plan), then users of your workflow will require a plan to run the workflow properly. ### Will copies of my workflow use my credits? diff --git a/docs-v2/theme.config.tsx b/docs-v2/theme.config.tsx index 78c563cdce552..ab02f0f801d1d 100644 --- a/docs-v2/theme.config.tsx +++ b/docs-v2/theme.config.tsx @@ -61,6 +61,16 @@ const config: DocsThemeConfig = { search: { component: DocSearch, }, + // We can add banners to the docs for product announcements + // banner: { + // key: "announcement-key", // Used for dismissible state in localStorage + // dismissible: true, // Makes the banner dismissible + // content: ( + // + // Check out the new Pipedream Connect SDK Playground → + // + // ), + // }, }; export default config;