{ "openapi": "3.0.1", "info": { "title": "CatchAll [Job] Submit Only (returns jobId)", "description": "Submit a CatchAll job and return the job ID. Does not poll or pull results.", "version": "0.0", "x-build-id": "RFkpW9t5jDs9FZeDS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/newscatcher~catchall-create-job/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-newscatcher-catchall-create-job", "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/newscatcher~catchall-create-job/runs": { "post": { "operationId": "runs-sync-newscatcher-catchall-create-job", "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/newscatcher~catchall-create-job/run-sync": { "post": { "operationId": "run-sync-newscatcher-catchall-create-job", "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": [ "apiKey", "query" ], "properties": { "apiKey": { "title": "CatchAll API Key", "type": "string", "description": "Your CatchAll API key (sent as x-api-key header)." }, "query": { "title": "Query", "type": "string", "description": "Natural-language question. Keywords and search queries are extracted automatically." }, "schema": { "title": "Schema", "type": "string", "description": "Advanced: custom JSON schema string that overrides the default extraction schema. Use POST /initialize to discover a suitable schema." }, "context": { "title": "Context", "type": "string", "description": "Additional context to sharpen the search scope (geography, industry, time frame, etc.)." }, "limit": { "title": "Limit", "type": "integer", "description": "Maximum number of validated records to collect. Minimum 10. Defaults to the plan limit. Use POST /continue to raise the limit later." }, "startDate": { "title": "Start Date", "type": "string", "description": "Earliest article date (ISO-8601 or free-text like '2024-01-01'). If start_date is provided and end_date is omitted, end_date defaults to now." }, "endDate": { "title": "End Date", "type": "string", "description": "Latest article date. Cannot be provided without start_date." }, "validators": { "title": "Validators", "type": "string", "description": "Boolean classifiers. Only articles where every validator returns true are counted in valid_records. Provide at least one item or omit entirely. Provide valid JSON matching OpenAPI schema." }, "enrichments": { "title": "Enrichments", "type": "string", "description": "Custom extraction fields added to each result record under enrichments.. Provide at least one item or omit entirely. Provide valid JSON matching OpenAPI schema." }, "mode": { "title": "ProcessingMode", "enum": [ "base", "lite" ], "type": "string", "description": "Processing mode. 'base' runs the full pipeline with clustering and enrichment. 'lite' is faster with no clustering.", "default": "base" }, "connectedDatasetIds": { "title": "Connected Dataset Ids", "type": "string", "description": "IDs of datasets whose entities narrow the retrieval scope. When provided, ed_score_min defaults to 2 if not specified. Provide valid JSON matching OpenAPI schema." }, "edScoreMin": { "title": "Ed Score Min", "type": "integer", "description": "Minimum entity-domain relevance score (1–10). Only relevant when connected_dataset_ids is set. Defaults to 2." }, "edAssociationType": { "title": "EntityAssociationType", "enum": [ "mention", "event_associated" ], "type": "string", "description": "Filter events by entity association type. 'event_associated' keeps only events where the entity is a direct actor. 'mention' keeps only events where the entity is merely referenced. Only relevant when connected_dataset_ids is set." }, "webhookIds": { "title": "Webhook Ids", "type": "string", "description": "Webhook IDs to notify when the job completes. Max 5 per job. Provide valid JSON matching OpenAPI schema." }, "projectId": { "title": "Project Id", "type": "string", "description": "Project ID to associate this job with." }, "fetchAllWatchlistNews": { "title": "Fetch All Watchlist News", "type": "boolean", "description": "When true, retrieves all news for connected Company Watchlist entities without topic filtering. Requires connected_dataset_ids to be set.", "default": false } } }, "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 } } } } } } } } } }