55 description : |
66 Runs a specific Actor and returns its output.
77
8-
98 The POST payload including its `Content-Type` header is passed as `INPUT` to
109 the Actor (usually <code>application/json</code>).
11-
1210 The HTTP response contains Actors `OUTPUT` record from its default
1311 key-value store.
1412
15-
1613 The Actor is started with the default options; you can override them using
1714 various URL query parameters.
18-
1915 If the Actor run exceeds 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds,
2016 the HTTP response will have status 408 (Request Timeout).
2117
22-
2318 Beware that it might be impossible to maintain an idle HTTP connection for a
2419 long period of time, due to client timeout or network conditions. Make sure your HTTP client is
2520 configured to have a long enough connection timeout.
26-
2721 If the connection breaks, you will not receive any information about the run
2822 and its status.
2923
30-
3124 To run the Actor asynchronously, use the [Run
3225 Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
3326 operationId : act_runSync_post
4235 example : janedoe~my-actor
4336 - name : outputRecordKey
4437 in : query
45- description : |-
38+ description : |
4639 Key of the record from run's default key-value store to be returned
47- in the response. By default, it is `OUTPUT`.
40+ in the response. By default, it is `OUTPUT`.
4841 style : form
4942 explode : true
5043 schema :
@@ -103,12 +96,9 @@ post:
10396 description : |
10497 Specifies optional webhooks associated with the Actor run, which can be
10598 used to receive a notification
106-
10799 e.g. when the Actor finished or failed. The value is a Base64-encoded
108100 JSON array of objects defining the webhooks. For more information, see
109-
110- [Webhooks
111- documentation](https://docs.apify.com/platform/integrations/webhooks).
101+ [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
112102 style : form
113103 explode : true
114104 schema :
@@ -143,9 +133,8 @@ post:
143133 example :
144134 error :
145135 type : run-failed
146- message : >-
147- Actor run did not succeed (run ID: 55uatRrZib4xbZs, status:
148- FAILED)
136+ message : |
137+ Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)
149138 ' 408 ' :
150139 description : ' '
151140 headers : {}
@@ -161,29 +150,24 @@ post:
161150 x-legacy-doc-urls :
162151 - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously/with-input
163152 - https://docs.apify.com/api/v2#/reference/actors/with-input
153+ - https://docs.apify.com/api/v2#tag/ActorsRun-actor-synchronously/operation/act_runSync_post
164154get :
165155 tags :
166156 - Actors/Run actor synchronously
167157 summary : Without input
168158 description : |
169159 Runs a specific Actor and returns its output.
170-
171160 The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
172161 otherwise the API endpoint returns a timeout error.
173-
174162 The Actor is not passed any input.
175163
176-
177164 Beware that it might be impossible to maintain an idle HTTP connection for a
178165 long period of time,
179-
180166 due to client timeout or network conditions. Make sure your HTTP client is
181167 configured to have a long enough connection timeout.
182-
183168 If the connection breaks, you will not receive any information about the run
184169 and its status.
185170
186-
187171 To run the Actor asynchronously, use the [Run
188172 Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
189173 operationId : act_runSync_get
198182 example : janedoe~my-actor
199183 - name : outputRecordKey
200184 in : query
201- description : |-
185+ description : |
202186 Key of the record from run's default key-value store to be returned
203- in the response. By default, it is `OUTPUT`.
187+ in the response. By default, it is `OUTPUT`.
204188 style : form
205189 explode : true
206190 schema :
@@ -259,12 +243,9 @@ get:
259243 description : |
260244 Specifies optional webhooks associated with the Actor run, which can be
261245 used to receive a notification
262-
263246 e.g. when the Actor finished or failed. The value is a Base64-encoded
264247 JSON array of objects defining the webhooks. For more information, see
265-
266- [Webhooks
267- documentation](https://docs.apify.com/platform/integrations/webhooks).
248+ [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
268249 style : form
269250 explode : true
270251 schema :
308289 x-legacy-doc-urls :
309290 - https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously/without-input
310291 - https://docs.apify.com/api/v2#/reference/actors/without-input
292+ - https://docs.apify.com/api/v2#tag/ActorsRun-actor-synchronously/operation/act_runSync_get
0 commit comments