Actor Build Starter
No credit card required
Actor Build Starter
No credit card required
Run builds for multiple actors in your account simultaneously. This can be useful when many actors in a given project have been updated. For example, the documentation might have been updated in 50 actors. This tool will help you trigger actor builds for all 50 at once.
You can access the Actor Build Starter programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "0.0",
5 "x-build-id": "7VopjBKQAaxPnevW8"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/fjvs0283~actor-batch-builder/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-fjvs0283-actor-batch-builder",
16 "x-openai-isConsequential": false,
17 "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18 "tags": [
19 "Run Actor"
20 ],
21 "requestBody": {
22 "required": true,
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/inputSchema"
27 }
28 }
29 }
30 },
31 "parameters": [
32 {
33 "name": "token",
34 "in": "query",
35 "required": true,
36 "schema": {
37 "type": "string"
38 },
39 "description": "Enter your Apify token here"
40 }
41 ],
42 "responses": {
43 "200": {
44 "description": "OK"
45 }
46 }
47 }
48 },
49 "/acts/fjvs0283~actor-batch-builder/runs": {
50 "post": {
51 "operationId": "runs-sync-fjvs0283-actor-batch-builder",
52 "x-openai-isConsequential": false,
53 "summary": "Executes an Actor and returns information about the initiated run in response.",
54 "tags": [
55 "Run Actor"
56 ],
57 "requestBody": {
58 "required": true,
59 "content": {
60 "application/json": {
61 "schema": {
62 "$ref": "#/components/schemas/inputSchema"
63 }
64 }
65 }
66 },
67 "parameters": [
68 {
69 "name": "token",
70 "in": "query",
71 "required": true,
72 "schema": {
73 "type": "string"
74 },
75 "description": "Enter your Apify token here"
76 }
77 ],
78 "responses": {
79 "200": {
80 "description": "OK",
81 "content": {
82 "application/json": {
83 "schema": {
84 "$ref": "#/components/schemas/runsResponseSchema"
85 }
86 }
87 }
88 }
89 }
90 }
91 },
92 "/acts/fjvs0283~actor-batch-builder/run-sync": {
93 "post": {
94 "operationId": "run-sync-fjvs0283-actor-batch-builder",
95 "x-openai-isConsequential": false,
96 "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97 "tags": [
98 "Run Actor"
99 ],
100 "requestBody": {
101 "required": true,
102 "content": {
103 "application/json": {
104 "schema": {
105 "$ref": "#/components/schemas/inputSchema"
106 }
107 }
108 }
109 },
110 "parameters": [
111 {
112 "name": "token",
113 "in": "query",
114 "required": true,
115 "schema": {
116 "type": "string"
117 },
118 "description": "Enter your Apify token here"
119 }
120 ],
121 "responses": {
122 "200": {
123 "description": "OK"
124 }
125 }
126 }
127 }
128 },
129 "components": {
130 "schemas": {
131 "inputSchema": {
132 "type": "object",
133 "properties": {
134 "batchType": {
135 "title": "Batch Mode",
136 "enum": [
137 "actorNameContains",
138 "actorIds",
139 "all"
140 ],
141 "type": "string",
142 "description": "Choose how to identify the target actors to batch process. You can target actors that contain specific text as part of the actor name, target actors by their id, or target all actors in your account.",
143 "default": "actorNameContains"
144 },
145 "actorNameContains": {
146 "title": "Actor Name Contains",
147 "type": "string",
148 "description": "Text included in names of target actors."
149 },
150 "actorIds": {
151 "title": "Actor IDs",
152 "type": "array",
153 "description": "Enter the ids of the target actors."
154 }
155 }
156 },
157 "runsResponseSchema": {
158 "type": "object",
159 "properties": {
160 "data": {
161 "type": "object",
162 "properties": {
163 "id": {
164 "type": "string"
165 },
166 "actId": {
167 "type": "string"
168 },
169 "userId": {
170 "type": "string"
171 },
172 "startedAt": {
173 "type": "string",
174 "format": "date-time",
175 "example": "2025-01-08T00:00:00.000Z"
176 },
177 "finishedAt": {
178 "type": "string",
179 "format": "date-time",
180 "example": "2025-01-08T00:00:00.000Z"
181 },
182 "status": {
183 "type": "string",
184 "example": "READY"
185 },
186 "meta": {
187 "type": "object",
188 "properties": {
189 "origin": {
190 "type": "string",
191 "example": "API"
192 },
193 "userAgent": {
194 "type": "string"
195 }
196 }
197 },
198 "stats": {
199 "type": "object",
200 "properties": {
201 "inputBodyLen": {
202 "type": "integer",
203 "example": 2000
204 },
205 "rebootCount": {
206 "type": "integer",
207 "example": 0
208 },
209 "restartCount": {
210 "type": "integer",
211 "example": 0
212 },
213 "resurrectCount": {
214 "type": "integer",
215 "example": 0
216 },
217 "computeUnits": {
218 "type": "integer",
219 "example": 0
220 }
221 }
222 },
223 "options": {
224 "type": "object",
225 "properties": {
226 "build": {
227 "type": "string",
228 "example": "latest"
229 },
230 "timeoutSecs": {
231 "type": "integer",
232 "example": 300
233 },
234 "memoryMbytes": {
235 "type": "integer",
236 "example": 1024
237 },
238 "diskMbytes": {
239 "type": "integer",
240 "example": 2048
241 }
242 }
243 },
244 "buildId": {
245 "type": "string"
246 },
247 "defaultKeyValueStoreId": {
248 "type": "string"
249 },
250 "defaultDatasetId": {
251 "type": "string"
252 },
253 "defaultRequestQueueId": {
254 "type": "string"
255 },
256 "buildNumber": {
257 "type": "string",
258 "example": "1.0.0"
259 },
260 "containerUrl": {
261 "type": "string"
262 },
263 "usage": {
264 "type": "object",
265 "properties": {
266 "ACTOR_COMPUTE_UNITS": {
267 "type": "integer",
268 "example": 0
269 },
270 "DATASET_READS": {
271 "type": "integer",
272 "example": 0
273 },
274 "DATASET_WRITES": {
275 "type": "integer",
276 "example": 0
277 },
278 "KEY_VALUE_STORE_READS": {
279 "type": "integer",
280 "example": 0
281 },
282 "KEY_VALUE_STORE_WRITES": {
283 "type": "integer",
284 "example": 1
285 },
286 "KEY_VALUE_STORE_LISTS": {
287 "type": "integer",
288 "example": 0
289 },
290 "REQUEST_QUEUE_READS": {
291 "type": "integer",
292 "example": 0
293 },
294 "REQUEST_QUEUE_WRITES": {
295 "type": "integer",
296 "example": 0
297 },
298 "DATA_TRANSFER_INTERNAL_GBYTES": {
299 "type": "integer",
300 "example": 0
301 },
302 "DATA_TRANSFER_EXTERNAL_GBYTES": {
303 "type": "integer",
304 "example": 0
305 },
306 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
307 "type": "integer",
308 "example": 0
309 },
310 "PROXY_SERPS": {
311 "type": "integer",
312 "example": 0
313 }
314 }
315 },
316 "usageTotalUsd": {
317 "type": "number",
318 "example": 0.00005
319 },
320 "usageUsd": {
321 "type": "object",
322 "properties": {
323 "ACTOR_COMPUTE_UNITS": {
324 "type": "integer",
325 "example": 0
326 },
327 "DATASET_READS": {
328 "type": "integer",
329 "example": 0
330 },
331 "DATASET_WRITES": {
332 "type": "integer",
333 "example": 0
334 },
335 "KEY_VALUE_STORE_READS": {
336 "type": "integer",
337 "example": 0
338 },
339 "KEY_VALUE_STORE_WRITES": {
340 "type": "number",
341 "example": 0.00005
342 },
343 "KEY_VALUE_STORE_LISTS": {
344 "type": "integer",
345 "example": 0
346 },
347 "REQUEST_QUEUE_READS": {
348 "type": "integer",
349 "example": 0
350 },
351 "REQUEST_QUEUE_WRITES": {
352 "type": "integer",
353 "example": 0
354 },
355 "DATA_TRANSFER_INTERNAL_GBYTES": {
356 "type": "integer",
357 "example": 0
358 },
359 "DATA_TRANSFER_EXTERNAL_GBYTES": {
360 "type": "integer",
361 "example": 0
362 },
363 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
364 "type": "integer",
365 "example": 0
366 },
367 "PROXY_SERPS": {
368 "type": "integer",
369 "example": 0
370 }
371 }
372 }
373 }
374 }
375 }
376 }
377 }
378 }
379}
Actor Build Starter OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Actor Build Starter from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
Actor Metrics
1 monthly user
-
2 bookmarks
>99% runs succeeded
Created in Oct 2021
Modified 2 years ago