Save To S3
Pricing
Pay per usage
Go to Store
Save To S3
Designed to be run from an ACTOR.RUN.SUCCEEDED webhook, this actor downloads a task run's default dataset and saves it to an S3 bucket.
0.0 (0)
Pricing
Pay per usage
3
Monthly users
14
Runs succeeded
17%
Last modified
2 years ago
You can access the Save To S3 programmatically from your own applications by using the Apify API. You can also 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.1",
5 "x-build-id": "K6mwi4jeedzGpb3Tp"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/drinksight~save-to-s3/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-drinksight-save-to-s3",
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/drinksight~save-to-s3/runs": {
50 "post": {
51 "operationId": "runs-sync-drinksight-save-to-s3",
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/drinksight~save-to-s3/run-sync": {
93 "post": {
94 "operationId": "run-sync-drinksight-save-to-s3",
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 "accessKeyId": {
135 "title": "AWS Key ID",
136 "type": "string",
137 "description": "Enter the access key ID for the AWS user"
138 },
139 "secretAccessKey": {
140 "title": "AWS Secret Access Key",
141 "type": "string",
142 "description": "Enter the secret access key for the AWS user"
143 },
144 "region": {
145 "title": "AWS region",
146 "type": "string",
147 "description": "Enter the AWS region your S3 bucket is located in"
148 },
149 "bucket": {
150 "title": "AWS bucket",
151 "type": "string",
152 "description": "Enter the name of the S3 bucket to use"
153 },
154 "objectKeyFormat": {
155 "title": "Object key format",
156 "type": "string",
157 "description": "The key to use for the filename",
158 "default": "${resource.id}_${resource.startedAt}.${format}"
159 },
160 "format": {
161 "title": "Data format",
162 "enum": [
163 "json",
164 "jsonl",
165 "xml",
166 "html",
167 "csv",
168 "xslx",
169 "rss"
170 ],
171 "type": "string",
172 "description": "The data format to download the dataset in",
173 "default": "json"
174 },
175 "clean": {
176 "title": "Clean items only",
177 "type": "boolean",
178 "description": "Crawler will ignore SSL certificate errors.",
179 "default": false
180 },
181 "datasetOptions": {
182 "title": "Dataset options",
183 "type": "object",
184 "description": "An object whose properties will be enumerated and added to the dataset get items API request. See https://apify.com/docs/api/v2#/reference/datasets/item-collection/get-items.",
185 "default": {}
186 },
187 "debugLog": {
188 "title": "Debug log",
189 "type": "boolean",
190 "description": "Debug messages will be included in the log. Use <code>context.log.debug('message')</code> to log your own debug messages.",
191 "default": false
192 }
193 }
194 },
195 "runsResponseSchema": {
196 "type": "object",
197 "properties": {
198 "data": {
199 "type": "object",
200 "properties": {
201 "id": {
202 "type": "string"
203 },
204 "actId": {
205 "type": "string"
206 },
207 "userId": {
208 "type": "string"
209 },
210 "startedAt": {
211 "type": "string",
212 "format": "date-time",
213 "example": "2025-01-08T00:00:00.000Z"
214 },
215 "finishedAt": {
216 "type": "string",
217 "format": "date-time",
218 "example": "2025-01-08T00:00:00.000Z"
219 },
220 "status": {
221 "type": "string",
222 "example": "READY"
223 },
224 "meta": {
225 "type": "object",
226 "properties": {
227 "origin": {
228 "type": "string",
229 "example": "API"
230 },
231 "userAgent": {
232 "type": "string"
233 }
234 }
235 },
236 "stats": {
237 "type": "object",
238 "properties": {
239 "inputBodyLen": {
240 "type": "integer",
241 "example": 2000
242 },
243 "rebootCount": {
244 "type": "integer",
245 "example": 0
246 },
247 "restartCount": {
248 "type": "integer",
249 "example": 0
250 },
251 "resurrectCount": {
252 "type": "integer",
253 "example": 0
254 },
255 "computeUnits": {
256 "type": "integer",
257 "example": 0
258 }
259 }
260 },
261 "options": {
262 "type": "object",
263 "properties": {
264 "build": {
265 "type": "string",
266 "example": "latest"
267 },
268 "timeoutSecs": {
269 "type": "integer",
270 "example": 300
271 },
272 "memoryMbytes": {
273 "type": "integer",
274 "example": 1024
275 },
276 "diskMbytes": {
277 "type": "integer",
278 "example": 2048
279 }
280 }
281 },
282 "buildId": {
283 "type": "string"
284 },
285 "defaultKeyValueStoreId": {
286 "type": "string"
287 },
288 "defaultDatasetId": {
289 "type": "string"
290 },
291 "defaultRequestQueueId": {
292 "type": "string"
293 },
294 "buildNumber": {
295 "type": "string",
296 "example": "1.0.0"
297 },
298 "containerUrl": {
299 "type": "string"
300 },
301 "usage": {
302 "type": "object",
303 "properties": {
304 "ACTOR_COMPUTE_UNITS": {
305 "type": "integer",
306 "example": 0
307 },
308 "DATASET_READS": {
309 "type": "integer",
310 "example": 0
311 },
312 "DATASET_WRITES": {
313 "type": "integer",
314 "example": 0
315 },
316 "KEY_VALUE_STORE_READS": {
317 "type": "integer",
318 "example": 0
319 },
320 "KEY_VALUE_STORE_WRITES": {
321 "type": "integer",
322 "example": 1
323 },
324 "KEY_VALUE_STORE_LISTS": {
325 "type": "integer",
326 "example": 0
327 },
328 "REQUEST_QUEUE_READS": {
329 "type": "integer",
330 "example": 0
331 },
332 "REQUEST_QUEUE_WRITES": {
333 "type": "integer",
334 "example": 0
335 },
336 "DATA_TRANSFER_INTERNAL_GBYTES": {
337 "type": "integer",
338 "example": 0
339 },
340 "DATA_TRANSFER_EXTERNAL_GBYTES": {
341 "type": "integer",
342 "example": 0
343 },
344 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
345 "type": "integer",
346 "example": 0
347 },
348 "PROXY_SERPS": {
349 "type": "integer",
350 "example": 0
351 }
352 }
353 },
354 "usageTotalUsd": {
355 "type": "number",
356 "example": 0.00005
357 },
358 "usageUsd": {
359 "type": "object",
360 "properties": {
361 "ACTOR_COMPUTE_UNITS": {
362 "type": "integer",
363 "example": 0
364 },
365 "DATASET_READS": {
366 "type": "integer",
367 "example": 0
368 },
369 "DATASET_WRITES": {
370 "type": "integer",
371 "example": 0
372 },
373 "KEY_VALUE_STORE_READS": {
374 "type": "integer",
375 "example": 0
376 },
377 "KEY_VALUE_STORE_WRITES": {
378 "type": "number",
379 "example": 0.00005
380 },
381 "KEY_VALUE_STORE_LISTS": {
382 "type": "integer",
383 "example": 0
384 },
385 "REQUEST_QUEUE_READS": {
386 "type": "integer",
387 "example": 0
388 },
389 "REQUEST_QUEUE_WRITES": {
390 "type": "integer",
391 "example": 0
392 },
393 "DATA_TRANSFER_INTERNAL_GBYTES": {
394 "type": "integer",
395 "example": 0
396 },
397 "DATA_TRANSFER_EXTERNAL_GBYTES": {
398 "type": "integer",
399 "example": 0
400 },
401 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
402 "type": "integer",
403 "example": 0
404 },
405 "PROXY_SERPS": {
406 "type": "integer",
407 "example": 0
408 }
409 }
410 }
411 }
412 }
413 }
414 }
415 }
416 }
417}Save To S3 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 Save To S3 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:
Pricing
Pricing model
Pay per usageThis Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage.
