{ "openapi": "3.0.1", "info": { "title": "Link Preview API [$0.99/1K💰] | OG + JSON-LD", "description": "Turn any URL into 42 metadata fields - Open Graph, Twitter Cards, JSON-LD, oEmbed, feeds, favicon, canonical and publish dates - over plain HTTP. Batch runs, a Standby REST API and MCP, with SSRF protection built in.", "version": "0.1", "x-build-id": "bP7rNx90cGqFJanbJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ahmed_jasarevic~link-preview-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ahmed_jasarevic-link-preview-api", "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/ahmed_jasarevic~link-preview-api/runs": { "post": { "operationId": "runs-sync-ahmed_jasarevic-link-preview-api", "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/ahmed_jasarevic~link-preview-api/run-sync": { "post": { "operationId": "run-sync-ahmed_jasarevic-link-preview-api", "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", "properties": { "urls": { "title": "URLs", "type": "array", "description": "URLs to preview. Accepts plain URL strings or a list of { \"url\": \"...\" } objects (batch runs only - ignored in Standby mode). Leave empty to only use the HTTP endpoints.", "default": [] }, "maxItems": { "title": "Max URLs", "minimum": 0, "type": "integer", "description": "Maximum number of URLs to preview in this run. Set 0 to process all URLs from the list.", "default": 0 }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many URLs are fetched in parallel. Higher values are faster but hammer the target sites harder.", "default": 10 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 3, "maximum": 120, "type": "integer", "description": "Seconds to wait for a single URL before giving up.", "default": 20 }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Extra attempts for failed requests (network errors, 429, 5xx).", "default": 1 }, "includeJsonLd": { "title": "Include JSON-LD", "type": "boolean", "description": "Return parsed schema.org (JSON-LD) objects in the jsonLd field.", "default": true }, "includeRawTags": { "title": "Include raw meta tags", "type": "boolean", "description": "Return every name/property and content in the metaTags field. Larger records.", "default": false }, "fetchOembed": { "title": "Fetch oEmbed fallback", "type": "boolean", "description": "When the page has no title or image, query the site's oEmbed endpoint (YouTube, X, Spotify, ...) to fill the gaps.", "default": true }, "cacheTtlSecs": { "title": "Cache TTL", "minimum": 0, "maximum": 604800, "type": "integer", "description": "Seconds to cache previews of the same URL. 0 disables caching. Cached results are still charged but are returned instantly.", "default": 3600 }, "useKvCache": { "title": "Persistent cache", "type": "boolean", "description": "Store the cache in the key-value store so it survives across runs. Slower per request, cheaper for repeated URLs.", "default": false }, "allowPrivateNetwork": { "title": "Allow private addresses", "type": "boolean", "description": "Allow previewing http://localhost and private/internal IPs. Keep off unless you trust every URL in the input (SSRF protection).", "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 }, "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 } } } } } } } } } }