Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,9 @@ byRunId:
- Actor runs
summary: Charge events in Actor run
description: |
Charge for events in the run of your [pay per event Actor](https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event).
Charge for events in the run of your [pay-per-event Actor](/actors/monetize/pay-per-event).
The event you are charging for must be one of the configured events in your Actor. If the Actor is not set up as pay per event, or if the event is not configured,
the endpoint will return an error. The endpoint must be called from the Actor run itself, with the same API token that the run was started with.

:::info Learn more about pay-per-event pricing

For more details about pay-per-event (PPE) pricing, refer to our [PPE documentation](/actors/publishing/monetize/pay-per-event).

:::

operationId: PostChargeRun
parameters:
- $ref: "../../parameters/runAndBuildParameters.yaml#/runId"
Expand Down
10 changes: 7 additions & 3 deletions nginx.conf
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ server {
rewrite ^/academy/apify-platform/deploying-your-code/input-schema$ /academy/deploying-your-code/input-schema permanent;
rewrite ^/academy/apify-platform/deploying-your-code/inputs-outputs$ /academy/deploying-your-code/inputs-outputs permanent;
rewrite ^/academy/apify-platform/get-most-of-actors/actor-readme$ /actors/publishing/actor-readme permanent;
rewrite ^/academy/apify-platform/get-most-of-actors/monetizing-your-actor$ /platform/actors/publishing/monetize permanent;
rewrite ^/academy/apify-platform/get-most-of-actors/monetizing-your-actor$ /actors/monetize permanent;
rewrite ^/academy/apify-platform/get-most-of-actors/naming-your-actor$ /academy/actor-marketing-playbook/actor-basics/name-your-actor permanent;
rewrite ^/academy/apify-platform/get-most-of-actors/seo-and-promotion$ /academy/actor-marketing-playbook/promote-your-actor/seo permanent;
rewrite ^/academy/apify-platform/getting-started/actors$ /academy/getting-started/actors permanent;
Expand Down Expand Up @@ -805,13 +805,17 @@ server {
# Actor marketing playbook redirects (index page removed)
rewrite ^/academy/get-most-of-actors$ /academy/actor-marketing-playbook/promote-your-actor/checklist permanent;
rewrite ^/academy/actor-marketing-playbook$ /academy/actor-marketing-playbook/promote-your-actor/checklist permanent;
rewrite ^/academy/get-most-of-actors/monetizing-your-actor$ /platform/actors/publishing/monetize permanent;
rewrite ^/academy/get-most-of-actors/monetizing-your-actor$ /actors/monetize permanent;

# Actor README guide moved from the Academy to Publishing section
rewrite ^/academy/actor-marketing-playbook/actor-basics/how-to-create-an-actor-readme$ /actors/publishing/actor-readme permanent;

# Monetization overview moved from the Academy to Monetize section
rewrite ^/academy/actor-marketing-playbook/store-basics/how-actor-monetization-works$ /actors/publishing/monetize permanent;
rewrite ^/academy/actor-marketing-playbook/store-basics/how-actor-monetization-works$ /actors/monetize permanent;

# Monetization section moved out of Publishing: /actors/publishing/monetize/* -> /actors/monetize/*
# Covers the /platform-prefixed URLs too, so they redirect in one hop, including .md twins.
rewrite ^/(platform/)?actors/publishing/monetize(\.md|/.*)?$ /actors/monetize$2 permanent;

# Misc
rewrite ^/platform/integrations/llama$ /platform/integrations/llama-index permanent;
Expand Down
6 changes: 3 additions & 3 deletions sources/_partials/_agentic-payments-eligibility.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
To be eligible for per-request agentic payments, an Actor must:

- Use the [pay-per-event](/actors/publishing/monetize/pay-per-event) pricing model. Pay-per-usage Actors are not supported.
- Charge only for events, not for [platform usage](/actors/publishing/monetize/pay-per-event#platform-usage-costs). Actors with the **Pay per event + usage** option switched on are excluded.
- Use the [pay-per-event](/actors/monetize/pay-per-event) pricing model. Pay-per-usage Actors are not supported.
- Charge only for events, not for [platform usage](/actors/monetize/pay-per-event#platform-usage-costs). Actors with the **Pay per event + usage** option switched on are excluded.
- Run with [limited permissions](/actors/development/permissions). Actors that request full permissions are excluded.
- Not use [Standby](/actors/running/standby) mode.

The Actor's developer must also have completed [identity verification (KYC)](/actors/publishing/monetize/monthly-payouts#verify-your-identity). Until they do, none of their Actors are eligible.
The Actor's developer must also have completed [identity verification (KYC)](/actors/monetize/monthly-payouts#verify-your-identity). Until they do, none of their Actors are eligible.
2 changes: 1 addition & 1 deletion sources/academy/ai/ai-agents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ Apify's pay-per-event (PPE) pricing model allows charging users based on specifi

:::info How pay-per-event pricing works

If you want more details about PPE pricing, refer to our [PPE documentation](/actors/publishing/monetize/pay-per-event).
If you want more details about PPE pricing, refer to our [PPE documentation](/actors/monetize/pay-per-event).

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Actors on Apify Store can be public or private:

## How Actor monetization works (briefly)

You can monetize your Actors using pay-per-event pricing, where users pay for specific events triggered by the Actor. For details, see [Monetize Actors](/actors/publishing/monetize).
You can monetize your Actors using pay-per-event pricing, where users pay for specific events triggered by the Actor. For details, see [Monetize Actors](/actors/monetize).

## Actor ownership on Store

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Once you’ve saved the settings, go to the **Endpoints** tab, and click the **T

Ready to monetize your Actor and start earning? Check out these guides:

- [Set up monetization for your Actor](https://docs.apify.com/actors/publishing/monetize)
- [Set up monetization for your Actor](https://docs.apify.com/actors/monetize)
- [Publish your Actor on Apify Store](https://docs.apify.com/actors/publishing/publish)

You can also extend your Actor with custom logic and leverage additional Apify platform features, such as storage or web scraping capabilities.
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ If you plan to charge for the Actor, ask the AI agent to help you think through

```text
Read the Actor monetization and pricing guide:
https://docs.apify.com/actors/publishing/monetize
https://docs.apify.com/actors/monetize
Then inspect this repository and recommend the most suitable
pricing model for this Actor. Explain your reasoning and flag
anything we should fix before publishing.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Actors have the following elements:

The documentation and the input and output schemas make it possible for people to easily understand what the Actor does, enter the required inputs both in the user interface or API, and integrate the Actor's results with their other workflows. Actors can easily call and interact with each other, enabling building more complex systems on top of simple ones.

The Apify platform provides an open [API](/api/v2), cron-style [scheduler](/actors/running/schedules), [webhooks](../../../integrations/programming/webhooks/index.md), and [integrations](../../integrations) to services such as Zapier or Make, which make it easy for users to integrate Actors with their existing workflows. Anyone is welcome to [publish Actors](/actors/publishing) in [Apify Store](https://apify.com/store), and you can even [monetize your Actors](/actors/publishing/monetize).
The Apify platform provides an open [API](/api/v2), cron-style [scheduler](/actors/running/schedules), [webhooks](../../../integrations/programming/webhooks/index.md), and [integrations](../../integrations) to services such as Zapier or Make, which make it easy for users to integrate Actors with their existing workflows. Anyone is welcome to [publish Actors](/actors/publishing) in [Apify Store](https://apify.com/store), and you can even [monetize your Actors](/actors/monetize).

Actors can be developed and run locally and then easily deployed to the Apify platform using the [Apify CLI](/cli) or a [GitHub integration](../../../integrations/programming/github.md). For more details, see the [Deployment](../deployment/index.md) section.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -207,4 +207,4 @@ Requests to the Standby URL require an Apify API token. See [how to authenticate

You can monetize Standby Actors just like any other Actor.

For best results with Standby workflows, use the [pay-per-event pricing model](/actors/publishing/monetize/pay-per-event). In this model, users cover both the platform usage costs of their runs, as well as the event costs.
For best results with Standby workflows, use the [pay-per-event pricing model](/actors/monetize/pay-per-event). In this model, users cover both the platform usage costs of their runs, as well as the event costs.
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Pay-per-event pricing can charge users per token. To do this, extract token coun

## Monetize with pay-per-event pricing

[Pay-per-event (PPE)](/actors/publishing/monetize/pay-per-event) pricing lets you charge users for specific actions your agent performs. Use `Actor.charge()` from the [JavaScript SDK](/sdk/js/reference/class/Actor#charge) or [Python SDK](/sdk/python/reference/class/Actor#charge) to bill users for events like API calls, generated results, or token usage.
[Pay-per-event (PPE)](/actors/monetize/pay-per-event) pricing lets you charge users for specific actions your agent performs. Use `Actor.charge()` from the [JavaScript SDK](/sdk/js/reference/class/Actor#charge) or [Python SDK](/sdk/python/reference/class/Actor#charge) to bill users for events like API calls, generated results, or token usage.

### PPE for AI agents

Expand All @@ -143,7 +143,7 @@ If an Actor's net profit goes negative (for example, from free-tier users consum

:::

For detailed pricing guidance, see the [pay-per-event documentation](/actors/publishing/monetize/pay-per-event).
For detailed pricing guidance, see the [pay-per-event documentation](/actors/monetize/pay-per-event).

## Deploy to Apify

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/actors/development/quick-start/web-ide.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ Now it's time to iterate. Each change follows the same cycle: edit the code, bui

- If you need inspiration, see [Find ideas for new Actors](/academy/build-and-publish/actor-ideas/find-actor-ideas).
- To understand Actors in detail, read the [Actor Whitepaper](https://whitepaper.actor/).
- When your first Actor is ready, you can [publish](/actors/publishing) it on Apify Store and [monetize](/actors/publishing/monetize) it to earn revenue.
- When your first Actor is ready, you can [publish](/actors/publishing) it on Apify Store and [monetize](/actors/monetize) it to earn revenue.
8 changes: 4 additions & 4 deletions sources/platform/actors/monetizing/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Monetize Actors
description: Monetize your Actors on Apify Store and earn regular passive income.
slug: /actors/publishing/monetize
slug: /actors/monetize
sidebar_position: 4
sidebar_label: Monetize
---
Expand All @@ -17,20 +17,20 @@ You can monetize your automation, AI agent, and web scraping projects by publish

You can publish Actors on Apify Store under one of the following pricing models:

- [Pay per event (PPE)](/actors/publishing/monetize/pay-per-event): Users pay for specific events that are programmatically triggered from the Actor's source code. You can define these events and include actions such as generating a single result or starting an Actor. You can also choose whether to pass the platform usage costs on to users.
- [Pay per event (PPE)](/actors/monetize/pay-per-event): Users pay for specific events that are programmatically triggered from the Actor's source code. You can define these events and include actions such as generating a single result or starting an Actor. You can also choose whether to pass the platform usage costs on to users.
- Pay per usage: Users can run the Actor without any additional charges beyond the platform usage costs generated by the Actor.

For a detailed comparison of pricing models from the perspective of your users, see [Actors in Store](/actors/running/actors-in-store).

## Fees and costs

Your payout is your Actor's revenue minus Apify's commission and platform usage costs. For details, see [Pricing and costs](/actors/publishing/monetize/pricing-and-costs).
Your payout is your Actor's revenue minus Apify's commission and platform usage costs. For details, see [Pricing and costs](/actors/monetize/pricing-and-costs).

### Platform usage

Running Actors generates platform usage costs for infrastructure, proxies, and storage. Who covers these costs depends on the pricing model and the mode in which the Actor runs.

For pay-per-event Actors, Apify deducts platform usage costs from your payout. If your Actor pricing doesn't cover these costs, you might run into a [negative profit](/actors/publishing/monetize/pay-per-event#avoid-negative-profit). However, you'll never have to pay Apify for other users running your Actors.
For pay-per-event Actors, Apify deducts platform usage costs from your payout. If your Actor pricing doesn't cover these costs, you might run into a [negative profit](/actors/monetize/pay-per-event#avoid-negative-profit). However, you'll never have to pay Apify for other users running your Actors.

### Testing costs

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/actors/monetizing/monthly-payouts.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Manage payouts
description: Learn about the monthly payouts and how to become eligible for them.
slug: /actors/publishing/monetize/monthly-payouts
slug: /actors/monetize/monthly-payouts
sidebar_position: 5
---

Expand Down
12 changes: 6 additions & 6 deletions sources/platform/actors/monetizing/pay_per_event.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Pay-per-event pricing model
description: Learn how to monetize your Actor with pay-per-event (PPE) pricing, charging users for specific actions like Actor starts, dataset items, or API calls.
slug: /actors/publishing/monetize/pay-per-event
slug: /actors/monetize/pay-per-event
sidebar_position: 1.1
sidebar_label: Pay per event pricing model
---
Expand All @@ -27,7 +27,7 @@ An event is a specific, measurable action that your Actor triggers programmatica
- Processing an item.
- Calling an external API.

You define the events and can set different pricing for each event type and [discount tier](/actors/publishing/monetize/pricing-and-costs#discount-tiers).
You define the events and can set different pricing for each event type and [discount tier](/actors/monetize/pricing-and-costs#discount-tiers).

### Synthetic events

Expand Down Expand Up @@ -75,7 +75,7 @@ where:

Only revenue and cost generated by users on paid plans count toward your profit. Users on the free plan are excluded from the calculation. They don't bring you revenue and Apify covers their platform usage costs.

For details, see [Actor pricing and costs](/actors/publishing/monetize/pricing-and-costs).
For details, see [Actor pricing and costs](/actors/monetize/pricing-and-costs).

### Avoid negative profit

Expand All @@ -102,7 +102,7 @@ To avoid negative profit margins during initial development or when testing pric

:::caution Reduced pricing transparency

Charging platform usage separately is less transparent for users and may discourage them from using your Actor. It also negatively impacts your [**Actor quality score**](../quality-score). Use this approach only until you determine accurate event prices.
Charging platform usage separately is less transparent for users and may discourage them from using your Actor. It also negatively impacts your [**Actor quality score**](/actors/publishing/quality-score). Use this approach only until you determine accurate event prices.

:::

Expand Down Expand Up @@ -348,7 +348,7 @@ To stop charging for default dataset items automatically, remove this event from

Memory allocation is the user's choice. By setting an upper limit, you prevent users from selecting more memory than your Actor needs and avoid higher platform costs.

To set memory limits, use the `minMemoryMbytes` and `maxMemoryMbytes` properties in your [`actor.json`](https://docs.apify.com/actors/development/actor-definition/actor-json) file:
To set memory limits, use the `minMemoryMbytes` and `maxMemoryMbytes` properties in your [`actor.json`](/actors/development/actor-definition/actor-json) file:

```json
{
Expand Down Expand Up @@ -458,7 +458,7 @@ Limit the number of events. Fewer events make it easier for users to understand

Avoid cases where producing a single result triggers too many events. It makes your Actor more expensive.

### Make events produce visible results {#actor-events}
### Make events produce visible results

Don't charge users for actions they don't see. For Actors that produce data, events should map to concrete results in the user's dataset or storage.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Actor pricing and costs
sidebar_label: Pricing and costs
description: Learn how to set Actor pricing and calculate your costs, including platform usage rates, discount tiers, and profit formulas for the PPE model.
slug: /actors/publishing/monetize/pricing-and-costs
slug: /actors/monetize/pricing-and-costs
sidebar_position: 4
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Tips for defining the Actor price
sidebar_label: Pricing tips
description: Learn how to price your Actor by comparing competing tools, accounting for the platform features, and adjusting the pricing based on conversion rates.
slug: /actors/publishing/monetize/pricing-tips
slug: /actors/monetize/pricing-tips
sidebar_position: 1
---

Expand Down Expand Up @@ -36,7 +36,7 @@ Use your [Actor README](/actors/publishing/actor-readme) to communicate the bene

## Adapt your pricing

Don’t be afraid to experiment with pricing, especially at the beginning. You can also [pass platform usage costs to users](/actors/publishing/monetize/pay-per-event#platform-usage-costs) while figuring out the right price.
Don’t be afraid to experiment with pricing, especially at the beginning. You can also [pass platform usage costs to users](/actors/monetize/pay-per-event#platform-usage-costs) while figuring out the right price.

Keep an eye on SEO. If you monitor the volume of the keywords your Actor is targeting as well as how well your Actor's page is ranking for those keywords, you can estimate the number of people who actually end up trying your tool. It's called the conversion rate.

Expand Down
10 changes: 5 additions & 5 deletions sources/platform/actors/monetizing/set-up-monetization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ To set up monetization for your Actor, first complete your billing and payment d
The monetization setup consists of three steps:

1. In the **Actor pricing** step, you can:
- Modify or delete the [`apify-actor-start`](/actors/publishing/monetize/pay-per-event#synthetic-start-event) event.
- Modify or delete the [`apify-default-dataset-item`](/actors/publishing/monetize/pay-per-event#synthetic-default-dataset-item-event) event.
- Define [custom events](/actors/publishing/monetize/pay-per-event#actor-events) and their prices.
- [Transfer the platform usage costs on to users](/actors/publishing/monetize/pay-per-event#platform-usage-costs).
- Modify or delete the [`apify-actor-start`](/actors/monetize/pay-per-event#synthetic-start-event) event.
- Modify or delete the [`apify-default-dataset-item`](/actors/monetize/pay-per-event#synthetic-default-dataset-item-event) event.
- Define [custom events](/actors/monetize/pay-per-event#actor-events) and their prices.
- [Transfer the platform usage costs on to users](/actors/monetize/pay-per-event#platform-usage-costs).
- Set the minimal cost that users can choose as max cost per run.
1. In the **Primary event** step, select the event that best represents the main value of your Actor. By default, the dataset event or the only existing event is used.
1. In the **Review** step, verify the final pricing for your Actor before confirming.
Expand All @@ -39,7 +39,7 @@ Be careful about increasing prices. If you make your Actor too expensive, users

:::tip Negative profit

If your Actor generates negative profit, [follow the recommendations](/actors/publishing/monetize/pay-per-event#avoid-negative-profit) before increasing the price.
If your Actor generates negative profit, [follow the recommendations](/actors/monetize/pay-per-event#avoid-negative-profit) before increasing the price.

:::

Expand Down
Loading
Loading