{ "openapi": "3.0.1", "info": { "title": "GCP Uploader", "description": "Upload datasets and KV store records to Google cloud storage", "version": "0.0", "x-build-id": "3GqPGa8G9B2laHwcG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/circ_le~gcp-uploader/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-circ_le-gcp-uploader", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/circ_le~gcp-uploader/runs": { "post": { "operationId": "runs-sync-circ_le-gcp-uploader", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/circ_le~gcp-uploader/run-sync": { "post": { "operationId": "run-sync-circ_le-gcp-uploader", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "key", "bucketName" ], "properties": { "key": { "title": "GCP Service account key", "type": "string", "description": "Service account key in the JSON format." }, "bucketName": { "title": "Bucket name", "type": "string", "description": "" }, "uploadPath": { "title": "Upload path", "type": "string", "description": "Path where files should be uploaded to. If not provided, files will be uploaded to the root of the bucket. Example: 'my-folder/my-subfolder'" }, "datasetId": { "title": "Dataset ID", "type": "string", "description": "" }, "datasetFormat": { "title": "Dataset format", "enum": [ "json", "jsonl", "xml", "html", "csv", "xlsx", "rss" ], "type": "string", "description": "" }, "fileName": { "title": "File name", "type": "string", "description": "File name to be uploaded to the bucket, otherwise the dataset ID will be used." }, "kvStoreId": { "title": "Key-value store ID", "type": "string", "description": "" }, "kvStoreRegex": { "title": "Key-value store record regex", "type": "string", "description": "Only records matching this regex will be uploaded to the key-value store." }, "transformFileNameFunction": { "title": "Transform file name function", "type": "string", "description": "Function that creates the name of the uploaded file from the record key. It receives the record key as an argument and must return the new file name." }, "compression": { "title": "Compression", "enum": [ "none", "gzip", "zip" ], "type": "string", "description": "" }, "uploadMetadata": { "title": "Upload metadata", "type": "boolean", "description": "If checked, metadata (currently only `contentType`) will be uploaded to the bucket along with the file.", "default": true }, "storeEntriesToDataset": { "title": "Store entries to dataset", "type": "boolean", "description": "If checked, uploaded file entries will be stored to the Apify dataset.", "default": true }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "Test the GCP uploader without actually uploading anything", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }