{
"openapi": "3.0.1",
"info": {
"title": "SiteVerdict — Social Link Preview Checker",
"description": "See how your links look on Facebook, LinkedIn, X, WhatsApp and Slack before you post. Checks Open Graph, Twitter Cards and oEmbed, measures the image (size, ratio, weight), renders preview mockups and gives paste-ready meta tags.",
"version": "1.0",
"x-build-id": "OiMDvmRdYh8dhuF3y"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/siteverdict~siteverdict-social-preview-checker/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-social-preview-checker",
"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/siteverdict~siteverdict-social-preview-checker/runs": {
"post": {
"operationId": "runs-sync-siteverdict-siteverdict-social-preview-checker",
"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/siteverdict~siteverdict-social-preview-checker/run-sync": {
"post": {
"operationId": "run-sync-siteverdict-siteverdict-social-preview-checker",
"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": {
"executionMode": {
"title": "Mode",
"enum": [
"live",
"sample"
],
"type": "string",
"description": "Live checks your URLs. Sample checks two recorded demo pages (one good, one broken) for free, with no network calls.",
"default": "live"
},
"urls": {
"title": "Page URLs",
"type": "array",
"description": "Pages whose link previews you want to check (max 500 per run): blog posts, product pages, landing pages.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"checkImages": {
"title": "Measure the og:image",
"type": "boolean",
"description": "Download the preview image to check that it loads and to measure its pixel size, aspect ratio, format and file weight against each platform's limits.",
"default": true
},
"checkOembed": {
"title": "Check oEmbed endpoint",
"type": "boolean",
"description": "If the page advertises an oEmbed endpoint (used by Slack, WordPress, Discord and others), fetch and validate it.",
"default": true
},
"savePreviews": {
"title": "Save a preview page per URL",
"type": "boolean",
"description": "Store an HTML page with the five preview mockups for each URL in the run's key-value store (linked from each row). A combined REPORT is always saved.",
"default": true
},
"outputMode": {
"title": "Output",
"enum": [
"all",
"changes"
],
"type": "string",
"description": "'Only changes' outputs a URL only when its tags or image changed since the last run with the same state store; useful on a schedule to catch a CMS or plugin update breaking previews.",
"default": "all"
},
"stateStoreName": {
"title": "State store name",
"type": "string",
"description": "Named key-value store with the last tag fingerprint of each URL.",
"default": "siteverdict-social-preview-checker"
},
"maxConcurrency": {
"title": "Pages in parallel",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Requests to the same host are sequential, at most 1 per second.",
"default": 4
},
"timeoutSecs": {
"title": "Request timeout (seconds)",
"minimum": 5,
"maximum": 120,
"type": "integer",
"description": "Per request.",
"default": 30
},
"aiEnabled": {
"title": "AI fix suggestions (your own key)",
"type": "boolean",
"description": "Off by default. For pages scoring under 90, your chosen LLM (with YOUR API key) writes a better og:title, og:description, alt text and an image brief from the page's own data. One 'ai-fix' event per successful answer; your provider bills tokens separately.",
"default": false
},
"aiProvider": {
"title": "AI provider",
"enum": [
"anthropic",
"openai"
],
"type": "string",
"description": "Which API your key belongs to.",
"default": "anthropic"
},
"aiApiKey": {
"title": "AI API key",
"type": "string",
"description": "Your Anthropic or OpenAI API key. Stored encrypted by Apify, never logged or written to the output."
},
"aiModel": {
"title": "AI model (optional)",
"type": "string",
"description": "Leave empty for the default (Anthropic: claude-sonnet-5-5, OpenAI: gpt-5-mini)."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}