{ "openapi": "3.0.1", "info": { "title": "Jobs Intelligence Bundle", "description": "Track hiring signals and company hiring intent from job boards, career pages, and web discovery, then save scored AI-ready jobs intelligence records.", "version": "0.1", "x-build-id": "HFc4RJsSHrAI1j85p" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/runtime~jobs-intelligence-bundle/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-runtime-jobs-intelligence-bundle", "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/runtime~jobs-intelligence-bundle/runs": { "post": { "operationId": "runs-sync-runtime-jobs-intelligence-bundle", "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/runtime~jobs-intelligence-bundle/run-sync": { "post": { "operationId": "run-sync-runtime-jobs-intelligence-bundle", "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": { "workflow": { "title": "Workflow", "enum": [ "company-hiring-radar", "french-job-market-watch", "custom" ], "type": "string", "description": "Business workflow label stored on each output item.", "default": "company-hiring-radar" }, "keyword": { "title": "Keyword", "type": "string", "description": "Single role or keyword. Used when Keywords is empty.", "default": "data analyst" }, "keywords": { "title": "Keywords", "type": "array", "description": "Batch roles or keywords, one per line. When non-empty, this overrides Keyword.", "items": { "type": "string" }, "default": [] }, "company": { "title": "Company", "type": "string", "description": "Optional single target company. Used when Companies is empty.", "default": "" }, "companies": { "title": "Companies", "type": "array", "description": "Target companies, one per line.", "items": { "type": "string" }, "default": [] }, "location": { "title": "Location", "type": "string", "description": "Single target location. Used when Locations is empty.", "default": "Paris" }, "locations": { "title": "Locations", "type": "array", "description": "Target locations, one per line.", "items": { "type": "string" }, "default": [] }, "country": { "title": "Country", "type": "string", "description": "Country context stored on normalized records.", "default": "France" }, "targetProviders": { "title": "Target providers", "type": "array", "description": "Provider domains to include in generated search queries.", "items": { "type": "string", "enum": [ "welcometothejungle", "hellowork", "jobteaser", "indeed", "cadremploi", "upwork" ], "enumTitles": [ "Welcome to the Jungle", "Hellowork", "JobTeaser", "Indeed", "Cadremploi", "Upwork" ] }, "default": [ "welcometothejungle", "hellowork", "jobteaser" ] }, "includeManualJobs": { "title": "Include manual jobs", "type": "boolean", "description": "Normalize jobs provided in Manual jobs.", "default": true }, "manualJobs": { "title": "Manual jobs", "type": "array", "description": "Optional jobs or hiring pages from providers to normalize into the bundle dataset.", "items": { "type": "object", "properties": { "provider": { "title": "Provider", "description": "Source provider, such as welcometothejungle, hellowork, jobteaser, or company-careers.", "type": "string" }, "title": { "title": "Title", "description": "Job title or hiring-page title.", "type": "string" }, "company": { "title": "Company", "description": "Company hiring for the role.", "type": "string" }, "location": { "title": "Location", "description": "Job location.", "type": "string" }, "country": { "title": "Country", "description": "Job country.", "type": "string" }, "applyUrl": { "title": "Apply URL", "description": "Job or hiring-page URL.", "type": "string" }, "description": { "title": "Description", "description": "Job or hiring-page description.", "type": "string" } } }, "default": [] }, "includeWebDiscovery": { "title": "Collect web signals", "type": "boolean", "description": "Collect supporting hiring and job signals using direct web search.", "default": true }, "searchQueries": { "title": "Custom search queries", "type": "array", "description": "Optional custom search queries, one per line. If empty, the Actor generates provider-aware job queries.", "items": { "type": "string" }, "default": [] }, "searchProviders": { "title": "Search providers", "type": "array", "description": "Search providers to use. Brave requires BRAVE_SEARCH_API_KEY or braveApiKey.", "items": { "type": "string", "enum": [ "duckduckgo", "brave" ], "enumTitles": [ "DuckDuckGo", "Brave Search API" ] }, "default": [ "duckduckgo" ] }, "braveApiKey": { "title": "Brave API key", "type": "string", "description": "Optional Brave Search API key. Prefer using the BRAVE_SEARCH_API_KEY environment variable." }, "maxResults": { "title": "Max output records", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum normalized records saved by the bundle.", "default": 25 }, "maxWebQueries": { "title": "Max web queries", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum generated/custom web queries to execute.", "default": 6 }, "maxWebResults": { "title": "Max web results", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum web-discovery results to normalize.", "default": 20 }, "mockMode": { "title": "Mock mode", "type": "boolean", "description": "Generate sample jobs intelligence records without network access.", "default": false }, "failOnNoResults": { "title": "Fail on no results", "type": "boolean", "description": "Fail the run if no normalized records are produced.", "default": true }, "requestTimeoutSecs": { "title": "Request timeout seconds", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for web search requests.", "default": 20 }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Enable Apify Proxy for direct web discovery.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Advanced Apify Proxy or custom proxy settings.", "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 } } }, "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 } } } } } } } } } }