{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Intelligence Scraper",
    "description": "Extract TikTok videos with AI viral scoring (0-100), trend detection, creator quality ratings & sponsorship flagging. Not just data — intelligence. Flat output, no cleanup needed. Use multiple hashtags or creators to build datasets of 400+ scored videos in under a minute.",
    "version": "1.0",
    "x-build-id": "SFav7YhTrTNGrBPWQ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lokki~tiktok-intelligence-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lokki-tiktok-intelligence-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/lokki~tiktok-intelligence-scraper/runs": {
      "post": {
        "operationId": "runs-sync-lokki-tiktok-intelligence-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/lokki~tiktok-intelligence-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-lokki-tiktok-intelligence-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",
        "properties": {
          "_section_1": {
            "title": "🔍 WHAT TO ANALYZE",
            "type": "string",
            "description": "Choose what content to analyze"
          },
          "searchType": {
            "title": "📌 Search Type",
            "enum": [
              "hashtags",
              "creators",
              "keywords",
              "trending_now"
            ],
            "type": "string",
            "description": "Choose your target:\n🏷️ Hashtags = analyze trending/niche hashtags (50-100 videos per hashtag)\n👤 Creators = spy on specific creators (best for competitor analysis)\n🔎 Keywords = search across video descriptions\n🔥 Trending Now = grab what's hot RIGHT NOW on the For You feed",
            "default": "trending_now"
          },
          "searchQuery": {
            "title": "🎯 What to Search",
            "type": "array",
            "description": "Add multiple queries to get more results!\n\nExamples:\n• Hashtags: #fitness, #gym, #workout\n• Creators: @tiktok, @charlidamelio\n• Keywords: \"ecommerce hacks\", \"morning routine\"\n\n💡 Pro tip: Use 3-5 related hashtags to build a comprehensive dataset (each returns 50-100 videos)",
            "default": [
              "#trending"
            ],
            "items": {
              "type": "string"
            }
          },
          "_section_2": {
            "title": "📊 DATA SCOPE & FILTERING",
            "type": "string",
            "description": "Set how many videos and filter by quality"
          },
          "maxVideos": {
            "title": "📹 Max Videos Per Query",
            "minimum": 10,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum videos to extract per hashtag/creator/keyword.\n\nTikTok returns 50-100 videos per query depending on content availability.\nTo get more data, add multiple queries above.\n\nExample: 5 hashtags × ~80 videos each = ~400 total videos",
            "default": 100
          },
          "minEngagementRate": {
            "title": "⚡ Engagement Filter",
            "minimum": 0,
            "maximum": 50,
            "type": "number",
            "description": "Skip low-engagement videos. Only return videos above this rate:\n• 0% = all videos (default)\n• 2% = typical performing\n• 5% = good videos (top 40%)\n• 10%+ = viral-ready (top 5%)",
            "default": 0
          },
          "_section_3": {
            "title": "🧠 INTELLIGENCE & OUTPUT",
            "type": "string",
            "description": "Enable AI scoring and choose output format"
          },
          "includeIntelligence": {
            "title": "🤖 Enable AI Scoring",
            "type": "boolean",
            "description": "✅ Get virality predictions (0-100), trending hashtag analysis, creator quality scores\n❌ Turn off for raw data only",
            "default": true
          },
          "detectSponsorships": {
            "title": "🏷️ Flag Sponsored Content",
            "type": "boolean",
            "description": "Auto-detect #ad, #sponsored, #gifted tags\nUseful for: compliance checks, filtering ads",
            "default": true
          },
          "brandList": {
            "title": "🎁 Custom Brands to Track (Optional)",
            "type": "array",
            "description": "Detect mentions of YOUR brands or competitors\nExamples: [\"Nike\", \"Apple\", \"Starbucks\"]\n(Leave blank to skip)",
            "default": [],
            "items": {
              "type": "string"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}