pluginsplugin-apify

Run Apify Actor

yaml
type: "io.kestra.plugin.apify.actor.run"

Save dataset with given id as temp file.

yaml
 id: run_actor
 namespace: company.team

 tasks:
   - id: run_actor
     type: io.kestra.plugin.apify.actor.Run
     actorId: GdWCkxBtKWOsKjdch
     maxItems: 1
     apiToken: "{{ secret('APIFY_API_TOKEN') }}"
     input:
       excludePinnedPosts: false
       hashtags: ["fyp"]
       resultsPerPage: 2
Properties

Actor ID

Actor ID or a tilde-separated owner's username and Actor name.

Apify API token

Api Token for Apify. You can find it in your Apify account settings.

Build

Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the default run configuration for the Actor (typically latest).

Input

Input for the Actor run. The input is optional and can be used to pass data to the Actor.If no value is provided then the Actor will run with default run configuration for the Actor.

Max items

The maximum number of items that the Actor run should return. This is useful for pay-per-result Actors, as it allows you to limit the number of results that will be charged to your subscription.

Max total charge USD

Specifies the maximum cost of the Actor run. This parameter is useful for pay-per-event Actors, as it allows you to limit the amount charged to your subscription.

Memory

Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the default run configuration for the Actor.

The HTTP client configuration.

Timeout

Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the default run configuration for the Actor.

Wait for finish

The maximum number of seconds the server waits for the run to finish. By default, it is 0, the maximum value is 60. If the run finishes in time then the returned run object will have a terminal status (e.g. SUCCEEDED), otherwise it will have a transitional status (e.g. RUNNING).

Webhooks

Specifies optional webhooks associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks.

SubType number
Possible Values
FOLLOW_USER_SETTINGRESTRICTEDANYONE_WITH_ID_CAN_READ
Possible Values
READYRUNNINGSUCCEEDEDFAILEDTIMING_OUTTIMED_OUTABORTINGABORTED
Format duration

The time allowed to establish a connection to the server before failing.

Default PT5M
Format duration

The time allowed for a read connection to remain idle before closing it.

The password for HTTP basic authentication.

The username for HTTP basic authentication.

The address of the proxy server.

The password for proxy authentication.

The port of the proxy server.

Default DIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

The username for proxy authentication.

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

Default false

If true, allow a failed response code (response code >= 400)

SubType integer

List of response code allowed for this request

The authentification to use.

Default UTF-8

The default charset for the request.

Default true

Whether redirects should be followed automatically.

SubType string
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

The proxy configuration.

The SSL request options

The timeout configuration.

The token for bearer token authentication.