Spawn Workers avatar

Spawn Workers

Try for free

No credit card required

Go to Store
Spawn Workers

Spawn Workers

pocesar/spawn-workers
Try for free

No credit card required

This actor lets you spawn tasks or other actors in parallel on the Apify platform that shares a common output dataset, splitting a RequestQueue-like dataset containing request URLs

You can access the Spawn Workers 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": "1.0",
5    "x-build-id": "B5TBJUV0liM8zIxEo"
6  },
7  "servers": [
8    {
9      "url": "https://api.apify.com/v2"
10    }
11  ],
12  "paths": {
13    "/acts/pocesar~spawn-workers/run-sync-get-dataset-items": {
14      "post": {
15        "operationId": "run-sync-get-dataset-items-pocesar-spawn-workers",
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/pocesar~spawn-workers/runs": {
50      "post": {
51        "operationId": "runs-sync-pocesar-spawn-workers",
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/pocesar~spawn-workers/run-sync": {
93      "post": {
94        "operationId": "run-sync-pocesar-spawn-workers",
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          "inputUrlsDatasetId": {
135            "title": "Input dataset Id",
136            "type": "string",
137            "description": "The dataset id containing RequestQueue-like items"
138          },
139          "outputDatasetId": {
140            "title": "Output dataset",
141            "type": "string",
142            "description": "Optionally pass an output dataset name where all workers can push items"
143          },
144          "workerActorId": {
145            "title": "Actor Id",
146            "type": "string",
147            "description": "Provide the actor id"
148          },
149          "workerTaskId": {
150            "title": "Task Id",
151            "type": "string",
152            "description": "Provide the task id instead of actor id"
153          },
154          "workerInput": {
155            "title": "Actor / Task input",
156            "type": "object",
157            "description": "Additional input to pass to the tasks / actors",
158            "default": {}
159          },
160          "workerOptions": {
161            "title": "Actor / Task options",
162            "type": "object",
163            "description": "Options to pass to the tasks / actors",
164            "default": {}
165          },
166          "workerCount": {
167            "title": "Worker count",
168            "type": "integer",
169            "description": "How many instances should be spawned",
170            "default": 2
171          },
172          "abortOthers": {
173            "title": "Abort on failure",
174            "type": "boolean",
175            "description": "Abort other runs if any of them fail",
176            "default": true
177          },
178          "fireAndForget": {
179            "title": "Fire and forget",
180            "type": "boolean",
181            "description": "Start the workers and don't keep track of their completion. The run information will still be available in the OUTPUT",
182            "default": false
183          },
184          "token": {
185            "title": "Token",
186            "type": "string",
187            "description": "Use another account token"
188          }
189        }
190      },
191      "runsResponseSchema": {
192        "type": "object",
193        "properties": {
194          "data": {
195            "type": "object",
196            "properties": {
197              "id": {
198                "type": "string"
199              },
200              "actId": {
201                "type": "string"
202              },
203              "userId": {
204                "type": "string"
205              },
206              "startedAt": {
207                "type": "string",
208                "format": "date-time",
209                "example": "2025-01-08T00:00:00.000Z"
210              },
211              "finishedAt": {
212                "type": "string",
213                "format": "date-time",
214                "example": "2025-01-08T00:00:00.000Z"
215              },
216              "status": {
217                "type": "string",
218                "example": "READY"
219              },
220              "meta": {
221                "type": "object",
222                "properties": {
223                  "origin": {
224                    "type": "string",
225                    "example": "API"
226                  },
227                  "userAgent": {
228                    "type": "string"
229                  }
230                }
231              },
232              "stats": {
233                "type": "object",
234                "properties": {
235                  "inputBodyLen": {
236                    "type": "integer",
237                    "example": 2000
238                  },
239                  "rebootCount": {
240                    "type": "integer",
241                    "example": 0
242                  },
243                  "restartCount": {
244                    "type": "integer",
245                    "example": 0
246                  },
247                  "resurrectCount": {
248                    "type": "integer",
249                    "example": 0
250                  },
251                  "computeUnits": {
252                    "type": "integer",
253                    "example": 0
254                  }
255                }
256              },
257              "options": {
258                "type": "object",
259                "properties": {
260                  "build": {
261                    "type": "string",
262                    "example": "latest"
263                  },
264                  "timeoutSecs": {
265                    "type": "integer",
266                    "example": 300
267                  },
268                  "memoryMbytes": {
269                    "type": "integer",
270                    "example": 1024
271                  },
272                  "diskMbytes": {
273                    "type": "integer",
274                    "example": 2048
275                  }
276                }
277              },
278              "buildId": {
279                "type": "string"
280              },
281              "defaultKeyValueStoreId": {
282                "type": "string"
283              },
284              "defaultDatasetId": {
285                "type": "string"
286              },
287              "defaultRequestQueueId": {
288                "type": "string"
289              },
290              "buildNumber": {
291                "type": "string",
292                "example": "1.0.0"
293              },
294              "containerUrl": {
295                "type": "string"
296              },
297              "usage": {
298                "type": "object",
299                "properties": {
300                  "ACTOR_COMPUTE_UNITS": {
301                    "type": "integer",
302                    "example": 0
303                  },
304                  "DATASET_READS": {
305                    "type": "integer",
306                    "example": 0
307                  },
308                  "DATASET_WRITES": {
309                    "type": "integer",
310                    "example": 0
311                  },
312                  "KEY_VALUE_STORE_READS": {
313                    "type": "integer",
314                    "example": 0
315                  },
316                  "KEY_VALUE_STORE_WRITES": {
317                    "type": "integer",
318                    "example": 1
319                  },
320                  "KEY_VALUE_STORE_LISTS": {
321                    "type": "integer",
322                    "example": 0
323                  },
324                  "REQUEST_QUEUE_READS": {
325                    "type": "integer",
326                    "example": 0
327                  },
328                  "REQUEST_QUEUE_WRITES": {
329                    "type": "integer",
330                    "example": 0
331                  },
332                  "DATA_TRANSFER_INTERNAL_GBYTES": {
333                    "type": "integer",
334                    "example": 0
335                  },
336                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
337                    "type": "integer",
338                    "example": 0
339                  },
340                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
341                    "type": "integer",
342                    "example": 0
343                  },
344                  "PROXY_SERPS": {
345                    "type": "integer",
346                    "example": 0
347                  }
348                }
349              },
350              "usageTotalUsd": {
351                "type": "number",
352                "example": 0.00005
353              },
354              "usageUsd": {
355                "type": "object",
356                "properties": {
357                  "ACTOR_COMPUTE_UNITS": {
358                    "type": "integer",
359                    "example": 0
360                  },
361                  "DATASET_READS": {
362                    "type": "integer",
363                    "example": 0
364                  },
365                  "DATASET_WRITES": {
366                    "type": "integer",
367                    "example": 0
368                  },
369                  "KEY_VALUE_STORE_READS": {
370                    "type": "integer",
371                    "example": 0
372                  },
373                  "KEY_VALUE_STORE_WRITES": {
374                    "type": "number",
375                    "example": 0.00005
376                  },
377                  "KEY_VALUE_STORE_LISTS": {
378                    "type": "integer",
379                    "example": 0
380                  },
381                  "REQUEST_QUEUE_READS": {
382                    "type": "integer",
383                    "example": 0
384                  },
385                  "REQUEST_QUEUE_WRITES": {
386                    "type": "integer",
387                    "example": 0
388                  },
389                  "DATA_TRANSFER_INTERNAL_GBYTES": {
390                    "type": "integer",
391                    "example": 0
392                  },
393                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
394                    "type": "integer",
395                    "example": 0
396                  },
397                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
398                    "type": "integer",
399                    "example": 0
400                  },
401                  "PROXY_SERPS": {
402                    "type": "integer",
403                    "example": 0
404                  }
405                }
406              }
407            }
408          }
409        }
410      }
411    }
412  }
413}

Spawn Workers 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 Spawn Workers 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:

Developer
Maintained by Community

Actor Metrics

  • 1 monthly user

  • 2 stars

  • Created in Apr 2020

  • Modified 2 years ago