{
  "openapi": "3.0.1",
  "info": {
    "title": "Twitter X Reply Scraper: Reply Sentiment & Tone Breakdown",
    "description": "💬 Twitter/X Reply Scraper extracts tweet replies at scale—usernames, text, timestamps, IDs & thread context. 🔎 Perfect for social listening, sentiment, competitor research & engagement tracking. ⚡ CSV/JSON export for dashboards, BI & automation. 🚀",
    "version": "0.1",
    "x-build-id": "mcyM02s2vwnGoO0Aj"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapio~twitter-x-reply-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapio-twitter-x-reply-scraper",
        "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/scrapio~twitter-x-reply-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapio-twitter-x-reply-scraper",
        "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/scrapio~twitter-x-reply-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapio-twitter-x-reply-scraper",
        "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": [
          "startUrls"
        ],
        "properties": {
          "startUrls": {
            "title": "🔗 Start URLs — where to look on X",
            "type": "array",
            "description": "Add one or more X links. Three kinds are accepted: (1) PROFILE link — `https://x.com/NASA` → that account's latest posts and their replies, works with no login; (2) POST link — `https://x.com/NASA/status/1234567890` → that single post and its replies, works with no login; (3) SEARCH link — `https://x.com/search?q=...` → uses the link's `q=` as the query, but ONLY works when you also supply your X session below (X answers guest search requests with HTTP 404). Legacy `urls` key is also accepted and merged.",
            "items": {
              "type": "string"
            }
          },
          "maxSearchResults": {
            "title": "📊 Maximum posts to collect",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Hard cap on how many posts to collect per link — the run never returns more than this. A post link always yields exactly 1. Example: maxSearchResults=10 → up to 10 posts per profile or search link. Default is 10.",
            "default": 10
          },
          "maxReplies": {
            "title": "💬 Maximum replies per post",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Hard cap on direct replies kept and analyzed per post, applied AFTER the language filter so the cap counts kept replies only. Note: without an X session, X itself only exposes the first couple of replies of a conversation to logged-out visitors, so runs without a session typically return 2 replies per post no matter how high this is set. With a session the full cap applies. Default is 5.",
            "default": 5
          },
          "replyLanguage": {
            "title": "🌍 Reply language filter (optional)",
            "type": "string",
            "description": "Keep only replies whose language matches this code before scoring. Uses X's own per-reply language tag (ISO-639-1-style, e.g. `en`, `es`, `pt`, `fr`, `de`, `ja`). Leave blank to analyze replies in every language. Example: replyLanguage=en → English replies only.",
            "default": ""
          },
          "aiEnhancement": {
            "title": "🤖 AI reply enrichment (optional, off by default)",
            "type": "boolean",
            "description": "When ON, each reply also gets an AI sentiment + tone label (aiReplySentiment / aiReplyTone) alongside the always-on rule-based fields. Requires an API key below. If the AI call fails, those fields are left null (never fabricated). Off by default.",
            "default": false
          },
          "aiModel": {
            "title": "🧠 AI Model / Provider",
            "enum": [
              "claude-haiku-4-5",
              "claude-sonnet-5",
              "claude-opus-4-8",
              "gpt-4o-mini",
              "gpt-4o",
              "gpt-4.1-mini",
              "o3-mini",
              "gemini-2.0-flash-lite",
              "gemini-2.0-flash",
              "gemini-2.5-flash",
              "grok-3-mini",
              "grok-3",
              "deepseek-chat",
              "sonar",
              "mistral-small-latest"
            ],
            "type": "string",
            "description": "Provider auto-detected from the name: claude-*=Anthropic, gpt-*/o1/o3=OpenAI, gemini-*=Google, grok-*=xAI, deepseek-*=DeepSeek, sonar*=Perplexity, mistral-*=Mistral. Cheaper mini/flash/haiku models are recommended for classification. Only used when AI enrichment is ON.",
            "default": "claude-haiku-4-5"
          },
          "aiApiKey": {
            "title": "🔑 AI API key (optional)",
            "type": "string",
            "description": "API key for the chosen provider. Only needed when AI enrichment is ON. If left blank, the actor falls back to the provider's environment variable (e.g. ANTHROPIC_API_KEY, OPENAI_API_KEY, GEMINI_API_KEY, XAI_API_KEY, DEEPSEEK_API_KEY, PERPLEXITY_API_KEY, MISTRAL_API_KEY)."
          },
          "authToken": {
            "title": "🔐 Session — auth token",
            "type": "string",
            "description": "OPTIONAL. Your X account session auth_token cookie (or set the AUTH_TOKEN environment variable). Leave blank to run in public mode (profile and post links, first replies of each conversation). Supply it to unlock SEARCH links and deep reply threads. Keep it private — never share it publicly."
          },
          "ct0": {
            "title": "🛡️ Session — security (ct0)",
            "type": "string",
            "description": "OPTIONAL. The companion ct0 cookie for your X session (or use the CT0 env var). It works together with your auth token as the CSRF value. Only needed for search links and deep reply threads."
          },
          "proxyConfiguration": {
            "title": "🌐 Connection & privacy (proxy)",
            "type": "object",
            "description": "Optional Apify Proxy settings. Off by default: the run goes direct first, then escalates to datacenter and residential on blocks. Turn it on to route through Apify's network from the start."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}