v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Actor runs

Charge events in run

Charge for events in the run of your pay per event Actor. 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.

:::

post/v2/actor-runs/{runId}/charge

Path parameters

runIdstring required
Example:3KH8gEpp4d8uQSe8T

Actor run ID.

Headers

idempotency-keystring

Always pass a unique idempotency key (any unique string) for each charge to avoid double charging in case of retries or network errors.

Request body

eventNamestring required
countinteger required

Example request

{
  "eventName": "ANALYZE_PAGE",
  "count": 1
}

Response

The charge was successful. Note that you still have to make sure in your Actor that the total charge for the run respects the maximum value set by the user, as the API does not check this. Above the limit, the charges reported as successful in API will not be added to your payouts, but you will still bear the associated costs. Use the Apify charge manager or SDK to avoid having to deal with this manually.

object required