{
  "openapi": "3.0.1",
  "info": {
    "title": "Nexus-IQ: Enterprise-Grade Competitive Intelligence",
    "description": "Extract competitive intelligence and sentiment analysis from 16 sources using AI-powered hierarchical summarization.",
    "version": "0.0",
    "x-build-id": "E7vUj5IeIQYflZXhc"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rexreus~Nexus-IQ/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rexreus-Nexus-IQ",
        "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/rexreus~Nexus-IQ/runs": {
      "post": {
        "operationId": "runs-sync-rexreus-Nexus-IQ",
        "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/rexreus~Nexus-IQ/run-sync": {
      "post": {
        "operationId": "run-sync-rexreus-Nexus-IQ",
        "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": [
          "target_company",
          "sources"
        ],
        "properties": {
          "target_company": {
            "title": "Target Company",
            "type": "string",
            "description": "Company name to research"
          },
          "sources": {
            "title": "Sources",
            "type": "array",
            "description": "Platforms to extract reviews from",
            "items": {
              "type": "string",
              "enum": [
                "G2",
                "Capterra",
                "TrustRadius",
                "Reddit",
                "Glassdoor",
                "Trustpilot",
                "Product Hunt",
                "Hacker News",
                "LinkedIn Jobs",
                "Twitter/X",
                "GetApp",
                "Software Advice",
                "PeerSpot",
                "Crunchbase",
                "Google Play",
                "Apple App Store"
              ]
            }
          },
          "timeframe_days": {
            "title": "Timeframe (Days)",
            "minimum": 1,
            "type": "integer",
            "description": "Number of days in the past to collect reviews (e.g. 7)",
            "default": 7
          },
          "target_language": {
            "title": "Target Language",
            "enum": [
              "english",
              "indonesia",
              "spanish",
              "german",
              "french"
            ],
            "type": "string",
            "description": "Language to use for AI output/summaries.",
            "default": "english"
          },
          "ai_provider": {
            "title": "AI Provider",
            "enum": [
              "gemini",
              "openai",
              "anthropic"
            ],
            "type": "string",
            "description": "Preferred AI provider used for analysis.",
            "default": "gemini"
          },
          "ai_model": {
            "title": "AI Model",
            "type": "string",
            "description": "Specific model ID"
          },
          "gemini_api_key": {
            "title": "Gemini API Key",
            "type": "string",
            "description": "(Optional) API key for Gemini provider; required if `ai_provider` is `gemini`."
          },
          "openai_api_key": {
            "title": "OpenAI API Key",
            "type": "string",
            "description": "(Optional) API key for OpenAI; required if `ai_provider` is `openai`."
          },
          "anthropic_api_key": {
            "title": "Anthropic API Key",
            "type": "string",
            "description": "(Optional) API key for Anthropic; required if `ai_provider` is `anthropic`."
          },
          "skip_ai": {
            "title": "Skip AI Processing",
            "type": "boolean",
            "description": "When true, the pipeline returns raw extractions without AI summarization or analysis.",
            "default": false
          },
          "force_refresh": {
            "title": "Force Refresh Cache",
            "type": "boolean",
            "description": "Bypass cached results and force fresh extraction from sources.",
            "default": false
          },
          "max_proxy_cost_usd": {
            "title": "Max Proxy Cost (USD)",
            "type": "number",
            "description": "Maximum allowed proxy expenditure in USD for a single run (guardrail).",
            "default": 5
          },
          "proxyConfiguration": {
            "title": "Proxy Configuration",
            "type": "object",
            "description": "Select proxies to be used by the crawler. Datacenter proxies may get blocked by anti-scraping tools. Residential proxies are recommended.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}