Apify Run
CertifiedStart an Apify actor run
Apify Run
Start an Apify actor run
Triggers an Apify actor with optional input and run caps, adding query parameters only when set. Returns the run detail from Apify.
type: io.kestra.plugin.apify.actor.RunExamples
Save dataset with given id as temp file.
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
actorId *Requiredstring
Actor ID
Actor ID or owner~actor name to execute.
apiToken *Requiredstring
Apify API token
Personal Apify API token used for all requests; required.
build string
Build
Build tag or number to run; defaults to the actor's configured build (typically latest).
input object
Input
JSON payload passed to the actor; omitted when empty so the actor uses its default input.
maxItems integerstring
Max items
Cap number of items returned to control pay-per-result charges.
maxTotalChargeUsd numberstring
Max total charge (USD)
Maximum allowed cost for the run; stops charges beyond this ceiling.
memory string
MB_128MB_256MB_512MB_1024MB_2048MB_4096MB_8192MB_16384MB_32768Memory (MB)
Memory allocation for the run; must be a power of two between 128 MB and 32768 MB.
options Non-dynamic
HTTP client options
Optional HttpConfiguration applied to every Apify call, including timeouts, retries, and proxy settings.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
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.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
requestTimeout numberstring
Timeout (seconds)
Actor run timeout override in seconds; falls back to the actor's default if unset.
waitForFinish integerstring
Wait for finish (seconds)
Seconds to wait synchronously for the run to complete (0–60); 0 returns immediately with a transitional status if still running. Maximum is 60 seconds.
webhooks string
Webhooks
Base64-encoded JSON array describing webhooks for lifecycle events.
Outputs
actId string
ID of the Actor that was run
actorTaskId string
ID of the Actor task, if the run was started from a task
buildId string
ID of the Actor build used for the run
buildNumber string
Build number of the Actor build used for the run
chargedEventCounts object
Counts of charged events by event name
containerUrl string
URL of the running Actor container
defaultDatasetId string
ID of the run's default dataset
defaultKeyValueStoreId string
ID of the run's default key-value store
defaultRequestQueueId string
ID of the run's default request queue
exitCode number
Process exit code of the run
finishedAt string
Time the run finished
generalAccess string
FOLLOW_USER_SETTINGRESTRICTEDANYONE_WITH_ID_CAN_READGeneral access setting for the run
gitBranchName string
Git branch the Actor build was made from
id string
Run ID
isContainerServerReady boolean
Whether the container HTTP server is ready
meta
Run metadata such as origin and client info
io.kestra.plugin.apify.actor.ActorRunMeta
options
Options the Actor was started with
io.kestra.plugin.apify.actor.ActorRunOptions
pricingInfo
Pricing model applied to the run
io.kestra.plugin.apify.actor.pricinginfo.PricePerEventActorPricingInfo
io.kestra.plugin.apify.actor.pricinginfo.PricingPerEvent
io.kestra.plugin.apify.actor.pricinginfo.ActorChargeEvent
io.kestra.plugin.apify.actor.pricinginfo.PricePerDatasetItemActorPricingInfo
io.kestra.plugin.apify.actor.pricinginfo.FlatPricePerMonthActorPricingInfo
io.kestra.plugin.apify.actor.pricinginfo.FreeActorPricingInfo
startedAt string
Time the run started
stats
Run statistics
io.kestra.plugin.apify.actor.ActorRunStats
status string
READYRUNNINGSUCCEEDEDFAILEDTIMING_OUTTIMED_OUTABORTINGABORTEDRun status
statusMessage string
Human-readable status message for the run
usage
Resource usage of the run
io.kestra.plugin.apify.actor.ActorRunUsage
usageTotalUsd string
Total usage cost of the run, in USD
usageUsd
Resource usage of the run, in USD
io.kestra.plugin.apify.actor.ActorRunUsage
userId string
ID of the user that started the run
