{ "openapi": "3.0.1", "info": { "title": "Brand Carousel Batch Renderer", "description": "Turn brand colors and supplied copy into ready-to-use social carousel cards. Batch-render consistent PNG slides, generate captions, and download the complete image set and assets as a ZIP package.", "version": "0.0", "x-build-id": "Ztm9N66e8wbhqvEfx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bread-kim~brand-carousel-batch-renderer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bread-kim-brand-carousel-batch-renderer", "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/bread-kim~brand-carousel-batch-renderer/runs": { "post": { "operationId": "runs-sync-bread-kim-brand-carousel-batch-renderer", "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/bread-kim~brand-carousel-batch-renderer/run-sync": { "post": { "operationId": "run-sync-bread-kim-brand-carousel-batch-renderer", "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", "required": [ "brand", "carousels" ], "properties": { "brand": { "title": "Brand rules", "required": [ "name", "background", "text", "accent" ], "type": "object", "description": "Name and exact uppercase six-digit hexadecimal colors applied to every slide.", "properties": { "name": { "title": "Brand name", "description": "Literal brand name shown at the top; one to forty supported characters and no newline.", "type": "string", "editor": "textfield", "minLength": 1, "maxLength": 40, "pattern": "^[^\\r\\n]+$" }, "background": { "title": "Background color", "description": "Background as uppercase #RRGGBB.", "type": "string", "editor": "textfield", "minLength": 7, "maxLength": 7, "pattern": "^#[0-9A-F]{6}$" }, "text": { "title": "Text color", "description": "Text as uppercase #RRGGBB; runtime requires at least 4.5:1 contrast against the background.", "type": "string", "editor": "textfield", "minLength": 7, "maxLength": 7, "pattern": "^#[0-9A-F]{6}$" }, "accent": { "title": "Accent color", "description": "Decorative accent bar as uppercase #RRGGBB; it is never used for body text.", "type": "string", "editor": "textfield", "minLength": 7, "maxLength": 7, "pattern": "^#[0-9A-F]{6}$" } } }, "format": { "title": "Slide format", "enum": [ "portrait", "square" ], "type": "string", "description": "Portrait creates 1080 by 1350 slides; Square creates 1080 by 1080 slides.", "default": "portrait" }, "carousels": { "title": "Carousel batches", "minItems": 1, "maxItems": 5, "type": "array", "description": "One to five carousels, with two to ten approved-copy slides each and fifty slides total.", "items": { "type": "object", "required": [ "id", "caption", "slides" ], "properties": { "id": { "title": "Safe carousel ID", "description": "Unique ASCII letters, digits, underscore, or hyphen; one to forty characters. IDs are evidence only, never filenames.", "type": "string", "editor": "textfield", "minLength": 1, "maxLength": 40, "pattern": "^[A-Za-z0-9_-]+$" }, "caption": { "title": "Approved caption", "description": "Literal caption saved beside the PNGs; zero to 1500 supported characters.", "type": "string", "editor": "textarea", "maxLength": 1500 }, "slides": { "title": "Approved slides", "description": "Two to ten slides rendered in this order.", "type": "array", "editor": "json", "minItems": 2, "maxItems": 10, "items": { "type": "object", "required": [ "title", "body" ], "properties": { "title": { "title": "Slide title", "description": "Literal one-line title; one to 110 supported characters.", "type": "string", "editor": "textfield", "minLength": 1, "maxLength": 110, "pattern": "^[^\\r\\n]+$" }, "body": { "title": "Slide body", "description": "Literal body copy with optional newlines; zero to 600 supported characters.", "type": "string", "editor": "textarea", "maxLength": 600 } } } } } } } } }, "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 } } } } } } } } } }