{ "openapi": "3.0.1", "info": { "title": "Link Preview API - Open Graph, Twitter Card & oEmbed Metadata", "description": "For chat apps, CMS editors and AI agents that unfurl links: send URLs, get title, description, image, site name, favicon, canonical URL and language from Open Graph, Twitter Card, oEmbed and the HTML head. About a second per URL. Respects robots.txt; URLs that cannot be previewed are free.", "version": "0.1", "x-build-id": "eZplP3GZiDR8JyUYH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neverempty~link-preview-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neverempty-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/neverempty~link-preview-api/runs": { "post": { "operationId": "runs-sync-neverempty-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/neverempty~link-preview-api/run-sync": { "post": { "operationId": "run-sync-neverempty-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": "Page URLs to turn into link previews, one per line (1 to 1,000 per run). A URL without http:// or https:// is read as https://. The same URL given twice (also when only the #fragment differs) is read and charged once. If this is empty, the example URL https://github.com/apify/crawlee is used.", "items": { "type": "string" } }, "acceptLanguage": { "title": "Preferred language (Accept-Language)", "type": "string", "description": "Optional. Sent as the Accept-Language header, for sites that show a different language version (and different title and description) by language, for example \"en\", \"ja-JP\" or \"de-DE,de;q=0.9\". Leave empty to get the version the site shows by default (nothing is sent). The language column reports what the page itself declares." }, "includeOembed": { "title": "Read oEmbed when the page offers it", "type": "boolean", "description": "When a page links to its own oEmbed JSON endpoint in its (for example YouTube and Spotify), also read that endpoint and add the oembed object (type, provider, author, thumbnail, embed HTML, width, height). It is one extra small request for those pages only. The endpoint's robots.txt is respected too.", "default": true }, "onlyChanges": { "title": "Monitor mode: only URLs whose preview changed", "type": "boolean", "description": "Return only URLs whose title, description, image, site name, canonical URL or type changed since the last run with the same watch name (plus URLs new to the watch). The first run returns every URL as the starting point. A change is confirmed by reading the page a second time a moment later; a value that differs between those two reads (for example a rotating image) is not reported and is ignored for that URL from then on. Image URLs are compared without their query string. A run in which nothing changed returns a free row saying so and charges only the run start fee.", "default": false }, "watchName": { "title": "Watch name", "type": "string", "description": "Name of the remembered state used to compare runs (letters, digits, dot, dash, underscore; up to 40). Setting it (or turning on monitor mode) fills changeType and the previous-value columns. Use a different name for each list of URLs you track on its own schedule. With monitor mode on and no name, the name \"default\" is used." }, "resetMonitoringState": { "title": "Forget what this watch remembered", "type": "boolean", "description": "Start this watch over: forget the remembered previews before this run, so every URL is returned as a first check.", "default": false }, "maxConcurrency": { "title": "URLs read at the same time", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many URLs are read in parallel (1 to 8). Each page is read only up to the end of its , so memory stays small.", "default": 4 }, "requestTimeoutSecs": { "title": "Time limit per request (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "How long to wait for one site to answer (5 to 60 seconds). HTTP 429, 500, 502, 503 and 504 are asked again up to two more times; a site that does not answer in time is asked once more.", "default": 20 } } }, "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 } } } } } } } } } }