{ "openapi": "3.0.1", "info": { "title": "Short-Form Hook Library Builder", "version": "2.0", "x-build-id": "2xWXGhcFDexzyec1u" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kayhermes~short-form-hook-library-builder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kayhermes-short-form-hook-library-builder", "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/kayhermes~short-form-hook-library-builder/runs": { "post": { "operationId": "runs-sync-kayhermes-short-form-hook-library-builder", "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/kayhermes~short-form-hook-library-builder/run-sync": { "post": { "operationId": "run-sync-kayhermes-short-form-hook-library-builder", "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": { "posts": { "title": "Posts", "type": "array", "description": "Extract, classify, score, deduplicate, cluster, and template short-form content hooks using cohort-relative performance.", "default": [ { "postId": "p1", "creatorId": "c1", "platform": "tiktok", "category": "marketing", "hookText": "3 mistakes killing your conversion rate", "views": 100000, "likes": 8000, "comments": 500, "shares": 2000, "saves": 1000 }, { "postId": "p2", "creatorId": "c2", "platform": "tiktok", "category": "marketing", "hookText": "3 mistakes hurting your conversion rate", "views": 80000, "likes": 6000, "comments": 400, "shares": 1500, "saves": 700 }, { "postId": "p3", "creatorId": "c3", "platform": "tiktok", "category": "marketing", "hookText": "Why are your ads not converting?", "views": 20000, "likes": 500, "comments": 80, "shares": 40, "saves": 50 }, { "postId": "p4", "creatorId": "c4", "platform": "instagram", "category": "marketing", "caption": "Stop doing this if you want more sales. Here is the explanation.", "views": 50000, "likes": 4500, "comments": 300, "shares": 900, "saves": 800 } ] }, "datasetId": { "title": "Source Dataset ID", "type": "string", "description": "Configure source dataset id for this Actor." }, "sourceUrls": { "title": "CSV or JSON source URLs", "type": "array", "description": "Configure csv or json source urls for this Actor.", "default": [], "items": { "type": "string" } }, "options": { "title": "Analysis options", "type": "object", "description": "Configure analysis options for this Actor.", "default": { "similarityThreshold": 0.45, "maxHookWords": 24 } }, "stateStoreName": { "title": "Optional named state store", "type": "string", "description": "Configure optional named state store for this Actor." }, "maxItems": { "title": "Maximum records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Configure maximum records for this Actor.", "default": 10000 }, "webhookUrl": { "title": "Alert or completion webhook", "type": "string", "description": "Configure alert or completion webhook for this Actor." } } }, "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 } } } } } } } } } }