You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/content/docs/en/tools/apify.mdx
+72-1Lines changed: 72 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ These operations equip your agents to automate, scrape, and orchestrate data col
30
30
31
31
## Usage Instructions
32
32
33
-
Integrate Apify into your workflow. Run any Apify actor with custom inputand retrieve results. Supports both synchronous and asynchronous execution with automatic dataset fetching.
33
+
Integrate Apify into your workflow. Run any Apify actor or saved task with custom input, fetch dataset items, and check run status. Supports both synchronous and asynchronous execution with automatic dataset fetching.
34
34
35
35
36
36
@@ -87,4 +87,75 @@ Run an APIFY actor asynchronously with polling for long-running tasks
87
87
|`datasetId`| string | Dataset ID containing results |
88
88
|`items`| array | Dataset items \(if completed\)|
89
89
90
+
### `apify_run_task`
91
+
92
+
Run a saved APIFY actor task synchronously and get dataset items (max 5 minutes)
93
+
94
+
#### Input
95
+
96
+
| Parameter | Type | Required | Description |
97
+
| --------- | ---- | -------- | ----------- |
98
+
|`apiKey`| string | Yes | APIFY API token from console.apify.com/account#/integrations |
99
+
|`taskId`| string | Yes | Task ID or username/task-name. Examples: "janedoe/my-task", "moJRLRc85AitArpNN" |
100
+
|`input`| string | No | JSON string that overrides the task\'s saved input. Example: \{"startUrls": \[\{"url": "https://example.com"\}\]\}|
101
+
|`itemLimit`| number | No | Max dataset items to return \(1-250000\). Example: 500 |
102
+
|`memory`| number | No | Memory in megabytes allocated for the run \(128-32768\). Example: 1024 for 1GB |
103
+
|`timeout`| number | No | Timeout in seconds for the run. Example: 300 for 5 minutes |
104
+
|`build`| string | No | Actor build to run. Examples: "latest", "beta", "1.2.3" |
105
+
106
+
#### Output
107
+
108
+
| Parameter | Type | Description |
109
+
| --------- | ---- | ----------- |
110
+
|`success`| boolean | Whether the task run succeeded |
111
+
|`status`| string | Run status \(SUCCEEDED, FAILED, etc.\)|
112
+
|`items`| array | Dataset items produced by the run |
113
+
114
+
### `apify_get_dataset_items`
115
+
116
+
Retrieve items stored in an APIFY dataset
117
+
118
+
#### Input
119
+
120
+
| Parameter | Type | Required | Description |
121
+
| --------- | ---- | -------- | ----------- |
122
+
|`apiKey`| string | Yes | APIFY API token from console.apify.com/account#/integrations |
123
+
|`datasetId`| string | Yes | Dataset ID to read items from. Example: "9RnD3Pql2vGZkc5H5" |
124
+
|`itemLimit`| number | No | Max items to return \(1-250000\). Default: all items. Example: 500 |
125
+
|`offset`| number | No | Number of items to skip at the start. Default: 0 |
126
+
|`fields`| string | No | Comma-separated list of fields to include. Example: "title,url,price" |
127
+
128
+
#### Output
129
+
130
+
| Parameter | Type | Description |
131
+
| --------- | ---- | ----------- |
132
+
|`success`| boolean | Whether the items were retrieved |
133
+
|`datasetId`| string | Dataset ID the items were read from |
134
+
|`items`| array | Items stored in the dataset |
135
+
|`count`| number | Number of items returned |
136
+
137
+
### `apify_get_run`
138
+
139
+
Get the status and details of an APIFY actor run
140
+
141
+
#### Input
142
+
143
+
| Parameter | Type | Required | Description |
144
+
| --------- | ---- | -------- | ----------- |
145
+
|`apiKey`| string | Yes | APIFY API token from console.apify.com/account#/integrations |
146
+
|`runId`| string | Yes | Actor run ID to fetch. Example: "HG7ML7M8z78YcAPEB" |
147
+
148
+
#### Output
149
+
150
+
| Parameter | Type | Description |
151
+
| --------- | ---- | ----------- |
152
+
|`success`| boolean | Whether the run was found |
153
+
|`runId`| string | APIFY run ID |
154
+
|`status`| string | Run status \(READY, RUNNING, SUCCEEDED, FAILED, etc.\)|
155
+
|`startedAt`| string | When the run started \(ISO timestamp\)|
156
+
|`finishedAt`| string | When the run finished \(ISO timestamp\)|
157
+
|`datasetId`| string | Default dataset ID for the run |
158
+
|`keyValueStoreId`| string | Default key-value store ID for the run |
159
+
|`stats`| json | Run statistics \(memory, CPU, duration\)|
0 commit comments