{ "openapi": "3.0.1", "info": { "title": "BizTrend AI Analyst", "description": "Evidence-backed Amazon product, keyword, score, history, and semantic analysis.", "version": "0.1", "x-build-id": "trOpU6WMslAsIPyjb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ib4ngz~biztrend-ai-analyst/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ib4ngz-biztrend-ai-analyst", "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/ib4ngz~biztrend-ai-analyst/runs": { "post": { "operationId": "runs-sync-ib4ngz-biztrend-ai-analyst", "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/ib4ngz~biztrend-ai-analyst/run-sync": { "post": { "operationId": "run-sync-ib4ngz-biztrend-ai-analyst", "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": [ "query" ], "properties": { "query": { "title": "Question", "type": "string", "description": "Ask one natural-language question about Amazon products, keywords, rankings, history, scores, comparisons, or product ideas. A marketplace hostname mentioned in the question is used automatically unless Marketplace is set below." }, "openAIApiKey": { "title": "OpenAI API key (required)", "type": "string", "description": "Your OpenAI API key for this run. It is handled as a protected secret and is never included in Actor output or logs." }, "region": { "title": "Marketplace override", "enum": [ "amazon.com", "amazon.ca", "amazon.com.mx", "amazon.com.br", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.nl", "amazon.pl", "amazon.se", "amazon.com.be", "amazon.com.tr", "amazon.ae", "amazon.sa", "amazon.in", "amazon.sg", "amazon.co.jp", "amazon.com.au", "amazon.co.za", "amazon.eg", "amazon.ie" ], "type": "string", "description": "Optional canonical Amazon hostname. When omitted, a hostname such as amazon.co.uk is read from the question; otherwise amazon.com is used. An explicit value here always wins." }, "limit": { "title": "Maximum results", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of products returned.", "default": 10 }, "includeEvidence": { "title": "Include evidence sources", "type": "boolean", "description": "Include source labels used to support the answer.", "default": true }, "includeNearMatches": { "title": "Include near matches", "type": "boolean", "description": "Allow explicitly labelled near matches; structured filters are never relaxed silently.", "default": false }, "forceRefreshKeyword": { "title": "Force keyword refresh", "type": "boolean", "description": "Request one fresh collection for an explicit keyword question.", "default": false }, "autoEnrich": { "title": "On-demand data collection", "type": "object", "description": "Collection budgets. The Actor targets the effective result limit and selects pages adaptively without exceeding these maximums.", "default": { "missingAsins": true, "missingKeywords": true, "refreshStaleKeywords": false, "keywordFreshnessHours": 168, "noResultRetryHours": 168, "maxRuns": 1, "maxKeywordsPerRun": 1, "maxPages": 10, "maxProducts": 50 } } } }, "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 } } } } } } } } } }