> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vibeflow.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Apify

> Run Apify actors for web scraping and automation

Apify integration for running actors on the [Apify platform](https://apify.com) — start an actor run with custom input, optionally wait for completion, fetch dataset results, and poll long-running runs by ID.

**Required Configuration:**

* API key authentication

## Setup

<Steps>
  <Step title="Create an Apify Account">
    Sign up or log in at [apify.com](https://apify.com).
  </Step>

  <Step title="Generate an API Token">
    Go to [Settings > API & Integrations](https://console.apify.com/settings/integrations) in your Apify console and copy your personal API token.
  </Step>

  <Step title="Add API Token to VibeFlow">
    In VibeFlow, navigate to **Settings** > **Connectors**, select **Apify**, and paste your API token into the connector modal.

    Your API token is encrypted by default and stored securely.
  </Step>
</Steps>

## Choosing an Actor

Apify actors are pre-built scrapers and automation scripts. You have two options:

* **Bring your own actor:** if you already know which actor you want to run (e.g. `apify/web-scraper`, `apify/instagram-scraper`), pass its ID directly to the run endpoint.
* **Let the Vibe Agent find one:** describe what you want to scrape or automate, and the agent will search the [Apify Store](https://apify.com/store) for a suitable actor and wire it up for you.

## Available Endpoints

<AccordionGroup>
  <Accordion title="POST /api/actions/apify/actor">
    Run an Apify actor with custom input. Optionally waits for the run to complete and returns the dataset results.
  </Accordion>

  <Accordion title="GET /api/actions/apify/actor/run/{runId}">
    Get the status and output of an Apify actor run by its run ID — useful for polling long-running jobs started asynchronously.
  </Accordion>
</AccordionGroup>