{ "openapi": "3.0.1", "info": { "title": "Social Card Maker", "description": "Generate polished social-card images (link previews, posts, comments, reviews) across platforms — customizable layout, branding, and downloadable image outputs (PNG) ready to post.", "version": "0.1", "x-build-id": "dGZhKwfsuTG46gTGB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/happitap~social-card-maker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-happitap-social-card-maker", "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/happitap~social-card-maker/runs": { "post": { "operationId": "runs-sync-happitap-social-card-maker", "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/happitap~social-card-maker/run-sync": { "post": { "operationId": "run-sync-happitap-social-card-maker", "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": { "targetUrl": { "title": "Target post URL (single)", "type": "string", "description": "Full URL to a single public post. Use this for generating one card. For multiple URLs, use 'Target URLs' field below." }, "targetUrls": { "title": "Target URLs (multiple)", "type": "array", "description": "Array of URLs for batch processing. Each URL will generate a separate social card. Leave empty if using single URL above." }, "platform": { "title": "Social platform", "enum": [ "twitter", "linkedin", "facebook", "instagram", "youtube", "custom" ], "type": "string", "description": "Platform style to mimic. If omitted, the actor attempts to infer it from the URL hostname or defaults to Twitter." }, "custom": { "title": "Custom card data", "type": "object", "description": "Optional overrides when the URL does not provide metadata or when you want to craft a custom card.", "properties": { "title": { "title": "Card title", "description": "Main headline or post text to display on the card.", "type": "string" }, "description": { "title": "Card description", "description": "Supporting copy that appears under the headline.", "type": "string" }, "mediaUrl": { "title": "Media URL", "description": "Public URL to an image that should be embedded in the card.", "type": "string" }, "logoUrl": { "title": "Logo URL", "description": "Optional brand logo to show in the header of custom cards.", "type": "string" }, "authorName": { "title": "Author name", "description": "Display name of the author or account.", "type": "string" }, "authorHandle": { "title": "Author handle", "description": "Username or handle text (for example, @apify).", "type": "string" }, "avatarUrl": { "title": "Avatar URL", "description": "Public URL to the avatar image for the author.", "type": "string" }, "postedAt": { "title": "Timestamp", "description": "Date or timestamp string to display, e.g. 'Nov 10, 2025'.", "type": "string" }, "platformName": { "title": "Platform name", "description": "Overrides the platform label shown on the card footer.", "type": "string" }, "ctaLabel": { "title": "Call-to-action label", "description": "Optional button text such as 'Read more' or 'Watch now'.", "type": "string" } } }, "output": { "title": "Output options", "type": "object", "description": "Configure size and format of the generated social card image.", "properties": { "format": { "title": "Image format", "description": "Select png (default) or jpeg for the rendered card.", "type": "string", "enum": [ "png", "jpeg" ] }, "width": { "title": "Image width", "description": "Pixel width of the output image. Defaults to 1200.", "type": "integer" }, "height": { "title": "Image height", "description": "Pixel height of the output image. Defaults to 630.", "type": "integer" }, "quality": { "title": "Image quality (JPEG only)", "description": "JPEG quality from 0-100. Ignored when format is png.", "type": "integer" } } } } }, "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 } } } } } } } } } }