{ "openapi": "3.0.1", "info": { "title": "Open Graph Image Generator (Social Cards)", "description": "Make clean Open Graph and social share images from text: title, subtitle, label, footer and your logo, in three templates and your brand colours. 1200x630 by default or any size up to 2400 px, PNG or JPEG, one image per card in bulk. Invalid cards are free.", "version": "1.0", "x-build-id": "YRnCcw1A69h04gQ9l" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kelp_forest_labs~og-image-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kelp_forest_labs-og-image-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/kelp_forest_labs~og-image-generator/runs": { "post": { "operationId": "runs-sync-kelp_forest_labs-og-image-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/kelp_forest_labs~og-image-generator/run-sync": { "post": { "operationId": "run-sync-kelp_forest_labs-og-image-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": { "title": { "title": "Title (single card)", "type": "string", "description": "Quick mode: one card with this title." }, "subtitle": { "title": "Subtitle (single card)", "type": "string", "description": "Optional second line." }, "eyebrow": { "title": "Eyebrow (single card)", "type": "string", "description": "Small label above the title, e.g. a category." }, "footer": { "title": "Footer (single card)", "type": "string", "description": "Small text at the bottom, e.g. your domain." }, "logoUrl": { "title": "Logo URL (single card)", "type": "string", "description": "Public http(s) image URL. No other network requests are made." }, "cards": { "title": "Cards (bulk)", "type": "array", "description": "List of objects with title, subtitle, eyebrow, footer, logoUrl and optional template/background/foreground/accent overrides." }, "template": { "title": "Template", "enum": [ "classic", "split", "minimal" ], "type": "string", "description": "Layout used when a card does not set its own.", "default": "classic" }, "background": { "title": "Background colour", "type": "string", "description": "Hex colour.", "default": "#0b2545" }, "foreground": { "title": "Text colour", "type": "string", "description": "Hex colour.", "default": "#ffffff" }, "accent": { "title": "Accent colour", "type": "string", "description": "Hex colour.", "default": "#e0b04a" }, "width": { "title": "Width (px)", "minimum": 200, "maximum": 2400, "type": "integer", "description": "Image width in px (200-2400). Common sizes: 1200×630 Open Graph (default), 1080×1080 square post, 1600×900 16:9, 1500×500 or 1500×300 banner.", "default": 1200 }, "height": { "title": "Height (px)", "minimum": 200, "maximum": 2400, "type": "integer", "description": "Image height in px (200-2400). Text is scaled down to fit; if it would need a title under 12 px, the card is a free error row.", "default": 630 }, "format": { "title": "Format", "enum": [ "png", "jpeg" ], "type": "string", "description": "Output image format.", "default": "png" } } }, "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 } } } } } } } } } }