Pipeline Controller
Under maintenancePricing
Pay per usage
Go to Apify Store
Pipeline Controller
Under maintenanceCoordinates source discovery, enrichment, monitoring, diffing, and alert routing.
Pipeline Controller
Under maintenancePricing
Pay per usage
Coordinates source discovery, enrichment, monitoring, diffing, and alert routing.
You can access the Pipeline Controller programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "1.0", "x-build-id": "mPHu6RiV0dM6E32Qg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ironjellyfish~pipeline-controller/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ironjellyfish-pipeline-controller", "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/ironjellyfish~pipeline-controller/runs": { "post": { "operationId": "runs-sync-ironjellyfish-pipeline-controller", "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/ironjellyfish~pipeline-controller/run-sync": { "post": { "operationId": "run-sync-ironjellyfish-pipeline-controller", "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": [ "company_name" ], "properties": { "company_name": { "title": "Company / competitor name", "type": "string", "description": "The company or competitor to process." }, "domain": { "title": "Domain", "type": "string", "description": "Primary domain or website." }, "source_urls": { "title": "Source URLs", "type": "array", "description": "Optional source pages to inspect.", "items": { "type": "string" } }, "profile_urls": { "title": "Profile URLs", "type": "array", "description": "Optional profile pages to inspect.", "items": { "type": "string" } }, "launch_watch_keywords": { "title": "Launch watch keywords", "type": "array", "description": "Keywords that signal launches or product updates.", "items": { "type": "string" }, "default": [ "launch", "announces", "new", "beta", "pricing", "release", "update" ] }, "previous_snapshot": { "title": "Previous snapshot", "type": "object", "description": "Optional prior snapshot for diffing." }, "alert_threshold": { "title": "Alert threshold", "type": "number", "description": "Launch score threshold for alerting." }, "max_sources": { "title": "Maximum sources", "type": "integer", "description": "Maximum number of source pages to inspect." }, "output_format": { "title": "Output format", "enum": [ "json", "csv", "webhook" ], "type": "string", "description": "Primary export format.", "default": "json" }, "monitor_enabled": { "title": "Enable monitoring", "type": "boolean", "description": "Turn monitoring on or off.", "default": true }, "monitor_interval": { "title": "Monitoring interval", "enum": [ "hourly", "daily", "weekly", "adhoc" ], "type": "string", "description": "How often to run the worker.", "default": "daily" }, "alert_channels": { "title": "Alert channels", "type": "array", "description": "Where alerts should be sent.", "items": { "type": "string" } }, "contact_points": { "title": "Contact points", "type": "array", "description": "Optional contact points to attach to the canonical record.", "items": { "type": "string" } }, "size": { "title": "Company size", "type": "string", "description": "Optional company size bucket." }, "industry": { "title": "Industry", "type": "string", "description": "Optional industry classification." } } }, "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Pipeline Controller from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: