{ "openapi": "3.0.1", "info": { "title": "Document Permission Unlocker & Authorized Recovery Gateway", "description": "Analyzes document lock state, removes non-opening permission restrictions where possible, and submits authorized password recovery jobs to a private backend.", "version": "0.1", "x-build-id": "hh552xUAfyKRimsQv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/offerastudio~document-permission-unlocker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-offerastudio-document-permission-unlocker", "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/offerastudio~document-permission-unlocker/runs": { "post": { "operationId": "runs-sync-offerastudio-document-permission-unlocker", "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/offerastudio~document-permission-unlocker/run-sync": { "post": { "operationId": "run-sync-offerastudio-document-permission-unlocker", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "submit", "check", "extend" ], "type": "string", "description": "submit a new document job, check an existing recovery job, or extend (buy more time to continue) a resumable job.", "default": "submit" }, "fileUrl": { "title": "File URL", "type": "string", "description": "Directly accessible file URL for submit mode." }, "fileBase64": { "title": "File Base64", "type": "string", "description": "Alternative upload path for submit mode. Keep files small; the Actor deletes temporary data after analysis." }, "fileName": { "title": "File name", "type": "string", "description": "Original file name when using Base64 input." }, "jobId": { "title": "Recovery job ID", "type": "string", "description": "Job ID returned by submit mode. Required for check mode." }, "passwordHint": { "title": "Optional password hint", "type": "string", "description": "Optional user-provided hint, such as remembered words or date patterns." }, "ownershipType": { "title": "Document ownership type", "enum": [ "personal", "corporate" ], "type": "string", "description": "Select whether this is a personal document or a corporate / enterprise document.", "default": "personal" }, "recoveryReason": { "title": "Recovery reason", "enum": [ "forgotten_password", "former_colleague", "archived_document", "corporate_it_recovery", "other" ], "type": "string", "description": "Primary reason for requesting password recovery.", "default": "forgotten_password" }, "contactEmailOrNotes": { "title": "Contact email or reference (Optional)", "type": "string", "description": "Optional contact email, company domain, or internal ticket reference." }, "authorizationEvidence": { "title": "Authorization statement", "type": "string", "description": "Explanation of ownership or authorized custody (e.g. context of creation, document details). Minimum 20 characters." }, "acceptDisclaimer": { "title": "Accept terms", "type": "boolean", "description": "I confirm I own this file or am authorized to recover access, and I understand recovery is not guaranteed.", "default": false }, "allowPrivateRecovery": { "title": "Allow private recovery", "type": "boolean", "description": "Submit an authorized password recovery job when the file requires an open password. Requires backend configuration and review policy.", "default": false }, "recoveryTier": { "title": "Recovery tier", "enum": [ "standard", "extended" ], "type": "string", "description": "standard = fast 10-minute dictionary micro-block. extended = deep 30-minute attempt per block (26-stage masks + rules + dictionaries, resumable).", "default": "standard" }, "recoveryBlocks": { "title": "Time blocks (extended tier)", "minimum": 1, "maximum": 48, "type": "integer", "description": "Extended tier only: how many compute blocks to buy now. Each block is 30 minutes of dedicated recovery cluster time. You can later run mode=extend to continue from where it stopped.", "default": 1 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }