{ "openapi": "3.0.1", "info": { "title": "Obsidian Mcp Actor", "description": "A lightweight Obsidian MCP Actor built for fast, local note automation. It parses, indexes, and transforms vault content with zero bloat. Perfect for workflows that need speed, clean structure, and reliable processing across markdown files, tags, metadata, and linked notes.", "version": "0.0", "x-build-id": "h4LxvgTgtLlSBjMXT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/breezy_overthrow~obsidian-mcp-actor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-breezy_overthrow-obsidian-mcp-actor", "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/breezy_overthrow~obsidian-mcp-actor/runs": { "post": { "operationId": "runs-sync-breezy_overthrow-obsidian-mcp-actor", "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/breezy_overthrow~obsidian-mcp-actor/run-sync": { "post": { "operationId": "run-sync-breezy_overthrow-obsidian-mcp-actor", "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": [ "vaultPath" ], "properties": { "url": { "title": "Website URL", "type": "string", "description": "The URL of the website to scrape (use this for single scrapes)" }, "urls": { "title": "Multiple URLs (Bulk Mode)", "type": "array", "description": "Array of URLs to scrape in bulk. Use when bulkMode is true", "items": { "type": "string" } }, "vaultPath": { "title": "Obsidian Vault Path", "type": "string", "description": "Absolute path to your Obsidian vault folder" }, "noteName": { "title": "Note Name (Optional)", "type": "string", "description": "Custom name for the note. If not provided, will use the page title" }, "folderPath": { "title": "Folder Path", "type": "string", "description": "Subfolder within vault to save notes (relative to vault root)", "default": "scraped" }, "addMetadata": { "title": "Add Metadata", "type": "boolean", "description": "Include YAML front-matter with metadata", "default": true }, "tags": { "title": "Manual Tags", "type": "array", "description": "Manual tags to add to the note", "default": [], "items": { "type": "string" } }, "autoTag": { "title": "Intelligent Auto-Tagging", "type": "boolean", "description": "Automatically generate tags from content analysis", "default": true }, "autoLink": { "title": "Automatic Internal Linking", "type": "boolean", "description": "Automatically link related notes based on shared tags", "default": true }, "bulkMode": { "title": "Bulk Import Mode", "type": "boolean", "description": "Set to true to process multiple URLs at once", "default": false }, "updateExisting": { "title": "Update Existing Notes", "type": "boolean", "description": "Allow updating of existing notes with fresh content", "default": false }, "templatePath": { "title": "Template Path (Optional)", "type": "string", "description": "Path to an Obsidian template file to define scraping parameters and format" }, "rateLimitDelay": { "title": "Rate Limit Delay (ms)", "type": "integer", "description": "Delay in milliseconds between requests in bulk mode", "default": 2000 }, "downloadImages": { "title": "Download Images", "type": "boolean", "description": "Whether to download images found on the page into the vault", "default": false }, "imagesFolder": { "title": "Images Folder", "type": "string", "description": "Subfolder inside the note folder to store downloaded images", "default": "images" }, "usePlaywright": { "title": "Use Playwright Mode", "type": "boolean", "description": "Enable Playwright browser automation for JavaScript-heavy sites. Use when CheerioCrawler fails. WARNING: Much slower and more resource-intensive", "default": false }, "playwrightTimeout": { "title": "Playwright Timeout (seconds)", "type": "integer", "description": "Maximum time to wait for page load in Playwright mode", "default": 30 } } }, "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 } } } } } } } } } }