{ "openapi": "3.0.1", "info": { "title": "MP4 Renderer for HyperFrames (Unofficial)", "description": "Render a HyperFrames HTML video composition (ZIP in a key-value store, or inline HTML) to an MP4, up to 1080p and 120 s per run. Unofficial; not affiliated with HeyGen.", "version": "0.0", "x-build-id": "c7AX64eymPau98OKp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/optimdex~hyperframes-render/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-optimdex-hyperframes-render", "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/optimdex~hyperframes-render/runs": { "post": { "operationId": "runs-sync-optimdex-hyperframes-render", "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/optimdex~hyperframes-render/run-sync": { "post": { "operationId": "run-sync-optimdex-hyperframes-render", "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": { "projectZipStore": { "title": "Project ZIP: key-value store", "type": "string", "description": "The key-value store that holds your project ZIP as a record. Upload the .zip in Console (Storage > Key-value stores > your store > upload a record) or with the API. Max 100 MiB compressed, 500 MiB extracted, 2,000 files. The actor gets read access to this store only." }, "projectZipKey": { "title": "Project ZIP: record key", "pattern": "^[a-zA-Z0-9!\\-_.'()]{1,256}$", "type": "string", "description": "Key of the ZIP record in the store above, for example project.zip. Required together with the store." }, "html": { "title": "Inline HTML", "maxLength": 1000000, "type": "string", "description": "A complete single-file composition (max 1,000,000 bytes). Prefilled with a 1-second example; ignored when project ZIP store and key are set." }, "entryFile": { "title": "Entry file (ZIP only)", "pattern": "^[A-Za-z0-9_][A-Za-z0-9._ -]*(/[A-Za-z0-9_][A-Za-z0-9._ -]*)*\\.html?$", "maxLength": 255, "type": "string", "description": "Path of the HTML entry file inside the ZIP.", "default": "index.html" }, "format": { "title": "Output format", "enum": [ "mp4" ], "type": "string", "description": "v1 renders MP4 (H.264, yuv420p) only.", "default": "mp4" }, "fps": { "title": "Frames per second", "minimum": 24, "maximum": 60, "type": "integer", "description": "24, 30 or 60. Price scales with output frames: 60 fps costs twice as much per second as 30 fps.", "default": 30 }, "quality": { "title": "Quality", "enum": [ "draft", "standard", "high" ], "type": "string", "description": "Encoder preset. draft is fastest; high is slowest and largest.", "default": "standard" }, "variables": { "title": "Variables", "type": "object", "description": "Optional JSON object passed to the composition as HyperFrames variables (max 64 KB serialized).", "default": {} } } }, "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 } } } } } } } } } }