{ "openapi": "3.0.1", "info": { "title": "Screenshot Privacy Redaction Tool - RedactShot", "description": "Find personal data and PII risks in a screenshot based on where it will be shared. Review a signed, annotated redaction plan before locally overwriting only the approved regions in a metadata-free PNG.", "version": "1.1", "x-build-id": "e38oaVUQtCsRiChxR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/westerly_palisade~redactshot-by-dravara/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-westerly_palisade-redactshot-by-dravara", "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/westerly_palisade~redactshot-by-dravara/runs": { "post": { "operationId": "runs-sync-westerly_palisade-redactshot-by-dravara", "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/westerly_palisade~redactshot-by-dravara/run-sync": { "post": { "operationId": "run-sync-westerly_palisade-redactshot-by-dravara", "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": [ "action", "image", "destination" ], "properties": { "action": { "title": "Action", "enum": [ "preview", "apply" ], "type": "string", "description": "Create a reviewable preview first, or apply an exact previously reviewed and signed plan.", "default": "preview" }, "image": { "title": "Screenshot", "type": "string", "description": "One PNG, JPEG, or WebP screenshot. Console uploads/HTTPS: up to 12 MB. Inline data URLs: up to 6 MB raw. Maximum 20 megapixels." }, "destination": { "title": "Where will it be shared?", "enum": [ "public_social", "customer_support", "coworker", "bug_report", "ai_assistant", "external" ], "type": "string", "description": "Choose the intended audience so the preview can apply destination-aware privacy rules.", "default": "public_social" }, "context": { "title": "Optional preview guidance", "maxLength": 2000, "type": "string", "description": "State anything that must remain visible. Used only for preview." }, "confirmed_regions": { "title": "Reviewed regions for apply", "type": "array", "description": "For apply only: copy the preview regions exactly. If anything is wrong or missing, create a new preview with clearer guidance instead of editing this list.", "items": { "type": "object", "properties": { "data_type": { "title": "Sensitive data type", "type": "string", "description": "The category of sensitive information identified in this reviewed region." }, "region": { "title": "Normalized region", "type": "object", "description": "The exact reviewed rectangle, expressed as normalized image coordinates from zero to one.", "properties": { "x": { "title": "Left edge", "type": "number", "description": "Normalized horizontal position of the region's left edge.", "minimum": 0, "maximum": 1 }, "y": { "title": "Top edge", "type": "number", "description": "Normalized vertical position of the region's top edge.", "minimum": 0, "maximum": 1 }, "width": { "title": "Width", "type": "number", "description": "Normalized width of the reviewed region.", "minimum": 0, "maximum": 1 }, "height": { "title": "Height", "type": "number", "description": "Normalized height of the reviewed region.", "minimum": 0, "maximum": 1 } }, "required": [ "x", "y", "width", "height" ], "additionalProperties": false }, "reason": { "title": "Redaction reason", "type": "string", "description": "Why this reviewed region should be hidden for the selected destination." }, "visible_hint": { "title": "Visible hint", "type": "string", "description": "A non-sensitive visual hint identifying the reviewed region." } }, "required": [ "data_type", "region", "reason", "visible_hint" ], "additionalProperties": false } }, "expected_input_sha256": { "title": "Reviewed image SHA-256", "pattern": "^[0-9a-f]{64}$", "type": "string", "description": "For apply only: copy input_sha256 from the reviewed preview. Apply fails if the image changed." }, "preview_token": { "title": "Signed preview token", "type": "string", "description": "For apply only: copy preview_token from the reviewed preview. It proves a preview was created for this image and destination." }, "confirmation": { "title": "Apply confirmation", "maxLength": 32, "type": "string", "description": "For apply only, enter exactly: APPLY REDACTIONS" } } }, "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 } } } } } } } } } }