{ "openapi": "3.0.1", "info": { "title": "Schema Markup Generator: JSON-LD for Google Rich Results", "description": "Generate valid schema.org JSON-LD structured data for Product, Article, FAQPage, LocalBusiness, Review, Recipe, Event, JobPosting, HowTo, VideoObject, Organization and WebSite — from structured fields, or auto-detected from a page URL. Validated against Google's rich-result requirements.", "version": "0.1", "x-build-id": "5toFpIgfaixOV7Kp3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/raional~schema-markup-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-raional-schema-markup-generator", "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/raional~schema-markup-generator/runs": { "post": { "operationId": "runs-sync-raional-schema-markup-generator", "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/raional~schema-markup-generator/run-sync": { "post": { "operationId": "run-sync-raional-schema-markup-generator", "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": { "items": { "title": "Mode A: structured items you supply", "type": "array", "description": "Leave this EMPTY unless you want to build schema from fields you type in yourself. Each item here produces one schema and is billed as one, so an item left in this box will show up in your results even if you only meant to scan URLs below.\n\nSupported types: Product, Article, FAQPage, LocalBusiness, Organization, BreadcrumbList, Review, Recipe, Event, JobPosting, HowTo, VideoObject, WebSite.\n\nEXAMPLE ONLY, not included in your run. Copy it, edit the values, and paste it above if you want Mode A:\n\n[ { \"schemaType\": \"Product\", \"fields\": { \"name\": \"Wireless Mechanical Keyboard\", \"description\": \"Compact 65% wireless mechanical keyboard with hot-swappable switches.\", \"image\": \"https://example.com/keyboard.jpg\", \"url\": \"https://example.com/products/keyboard\", \"price\": \"89.99\", \"priceCurrency\": \"USD\", \"availability\": \"InStock\", \"brand\": \"Example Brand\", \"sku\": \"KB-65-WL\" } } ]" }, "pageUrls": { "title": "Mode B: page URLs to auto-detect schema from", "type": "array", "description": "Mode B: page URLs to scan. The type is inferred (Product, Article, or WebSite/WebPage) from Open Graph meta tags, and JSON-LD is generated automatically. Only scan sites you own or have permission to analyze.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "outputFormat": { "title": "Output format", "enum": [ "jsonld", "scriptTag", "both" ], "type": "string", "description": "How to format the generated schema in each result row.", "default": "both" }, "renderJs": { "title": "Render JavaScript (advanced)", "type": "boolean", "description": "Mode B only. Use a full browser to render pages before reading meta tags. Only needed for sites that inject meta tags client-side (rare); most sites render meta tags server-side.", "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 } } }, "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 } } } } } } } } } }