Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apify-api/openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ info:
If the Actor is not runnable anonymously, you will receive a 401 or 403
[response code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status).
This means you need to add your [secret API
token](https://console.apify.com/account#/integrations) to the request's
token](https://docs.apify.com/integrations/api#api-token) to the request's
`Authorization` header ([recommended](#/introduction/authentication)) or as a
URL query parameter `?token=[your_token]` (less secure).

Expand All @@ -110,7 +110,7 @@ info:
`Apify.call()` method from the [Apify
SDK](https://sdk.apify.com/docs/api/apify#apifycallactid-input-options). It
runs the Actor using the account you are currently logged into (determined
by the [secret API token](https://console.apify.com/account#/integrations)).
by the [secret API token](https://docs.apify.com/integrations/api#api-token)).
The result is an [Actor run
object](https://sdk.apify.com/docs/typedefs/actor-run) and its output (if
any).
Expand Down
4 changes: 3 additions & 1 deletion sources/_partials/_create-api-token.mdx
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
To get an API token, go to [**Settings > API & Integrations**](https://console.apify.com/settings/integrations) in Apify Console, select **Create a new token**, enter a description, select **Create**, and copy the token. You can view it only once, so store it somewhere safe, such as a password manager. If you lose it, [rotate the token](/integrations/api#rotation) or create a new one.
import { CreateTokenLink } from '@site/src/components/ApiToken';

To get an API token, <CreateTokenLink integration={props.integration}>create one in Apify Console</CreateTokenLink> and copy it. You can view it only once, so store it somewhere safe, such as a password manager. If you lose it, [rotate the token](/integrations/api#rotation) or create a new one.
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/antigravity.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ With the default permission preset, Antigravity runs agent commands in a [termin

The MCP sign-in doesn't need a browser on the machine that runs Antigravity. Over SSH or in a container, open the sign-in link that Antigravity shows in a browser on any machine, then paste the authorization code back at the `agy` prompt.

If you can't use OAuth at all, use the skills that don't need the MCP server and authenticate them with a token. <CreateApiTokenLink /> Set it before starting Antigravity:
If you can't use OAuth at all, use the skills that don't need the MCP server and authenticate them with a token. <CreateApiTokenLink integration="Antigravity" /> Set it before starting Antigravity:

```bash
export APIFY_TOKEN=<YOUR_API_TOKEN>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Plugins require a local installation of the Claude Code CLI. They aren't availab

If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually.

If you're running Claude Code in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink /> Set it before starting Claude Code:
If you're running Claude Code in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink integration="Claude Code" /> Set it before starting Claude Code:

```bash
export APIFY_TOKEN=<YOUR_API_TOKEN>
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/cursor.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Start your request with `@apify` so the routing agent handles it. The agent owns

If the browser doesn't open automatically, copy the OAuth URL shown by Cursor and paste it into your browser manually.

If you're running Cursor in a remote session, devcontainer, or over SSH where no browser is available, use token authentication instead. <CreateApiTokenLink /> Set it in your environment before starting Cursor:
If you're running Cursor in a remote session, devcontainer, or over SSH where no browser is available, use token authentication instead. <CreateApiTokenLink integration="Cursor" /> Set it in your environment before starting Cursor:

```bash
export APIFY_TOKEN=<YOUR_API_TOKEN>
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/deepseek-harness.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The plugin enables the Apify MCP server on install. Searching Apify Store, inspe

`dsh` sends static MCP headers and has no OAuth flow, so authenticate with an API token:

1. <CreateApiTokenLink /> <CopyTokenStep />
1. <CreateApiTokenLink integration="DeepSeek Harness" /> <CopyTokenStep />

1. Create a `.env` file in the directory you launch `dsh` from:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ On the first start, Copilot may report that `apify-mcp-server` is taking longer

If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually.

If you're running the CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink /> Set it before starting the CLI:
If you're running the CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink integration="GitHub Copilot" /> Set it before starting the CLI:

```bash
export APIFY_TOKEN=<YOUR_API_TOKEN>
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/grok-bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Open **Settings** > **Plugins**, find the **Apify** connector, and complete auth

If the browser doesn't open automatically, copy the OAuth URL shown by Grok Bot and paste it into your browser manually.

If the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink /> Set it on the Grok Bot computer:
If the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink integration="Grok Bot" /> Set it on the Grok Bot computer:

```bash
export APIFY_TOKEN=<YOUR_API_TOKEN>
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/grok-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ If the OAuth flow still can't complete, for example because no browser is availa
apify login
```

In a non-interactive environment, use token authentication instead. <CreateApiTokenLink /> Then pass it to `apify login`:
In a non-interactive environment, use token authentication instead. <CreateApiTokenLink integration="Grok Build" /> Then pass it to `apify login`:

```bash
apify login -t <YOUR_API_TOKEN>
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/hermes-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For more details about Hermes Agent, refer to the [official documentation](https
Before integrating Apify with Hermes Agent, you'll need:

- _An Apify account_ - If you don't have one, [sign up here](https://console.apify.com/sign-up).
- _Apify API token_ - <CreateApiTokenLink />
- _Apify API token_ - <CreateApiTokenLink integration="Hermes Agent" />
- _Hermes Agent_ - Version 0.18.1 or later. Install the CLI from the [official documentation](https://hermes-agent.nousresearch.com/docs).
- _Python 3.11 to 3.13_ - Required to install the plugin.

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/kimi-code-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Run `/mcp-config login apify` explicitly rather than waiting for an automatic pr

If you're running Kimi Code in a headless environment (SSH, remote container) or in non-interactive prompt mode (`kimi -p`), the OAuth handshake can't complete. Authenticate on a machine with a browser first, then point the headless machine at the same `KIMI_CODE_HOME` so it picks up `credentials/mcp/`. Alternatively, override the `apify` entry in `~/.kimi-code/mcp.json` or `.kimi-code/mcp.json` with a static token - a project-level entry with the same name overrides the plugin's declaration.

For the CLI and SDK skills, use token authentication. <CreateApiTokenLink /> Export it before starting Kimi Code:
For the CLI and SDK skills, use token authentication. <CreateApiTokenLink integration="Kimi Code" /> Export it before starting Kimi Code:

```bash
export APIFY_TOKEN=<YOUR_API_TOKEN>
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/lovable.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Apify is available as an app and chat connector: one connection works both in th
Before you connect the two platforms, you need:

- _An Apify account_ - If you don't have one, [sign up here](https://console.apify.com/sign-up).
- _Apify API token_ - <CreateApiTokenLink /> See [API token](/integrations/api#api-token) for scope and expiration options.
- _Apify API token_ - <CreateApiTokenLink integration="Lovable" /> See [API token](/integrations/api#api-token) for scope and expiration options.
- _A Lovable account_ - App and chat connectors are available on the Free, Pro, and Business plans.
- _Permission to create connections_ - Enterprise plans restrict connection creation to **No one** by default, until an admin changes it in **Connectors > Admin settings > App + chat connectors**.

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/manus.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Manus will load the skill instructions and use the appropriate Apify Actors to c

If the OAuth prompt fails or you can't complete the login flow, you can connect using your Apify API token directly.

1. <CreateApiTokenLink /> <CopyTokenStep />
1. <CreateApiTokenLink integration="Manus" /> <CopyTokenStep />
1. In Manus, open the Apify connector settings and add a custom header:
- **Header name** - `Authorization`
- **Header value** - `Bearer <APIFY_API_TOKEN>` (replace `<APIFY_API_TOKEN>` with your actual token)
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/openai/chatgpt.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ In this tutorial, you'll learn how to connect _ChatGPT_ to the _Apify MCP server
Before connecting ChatGPT to Apify, you'll need:

- _An Apify account_ - If you don't have an Apify account already, you can [sign up](https://console.apify.com/sign-up)
- _Apify API token_ - <CreateApiTokenLink /> This token authorizes the MCP server to run Actors on your behalf.
- _Apify API token_ - <CreateApiTokenLink integration="ChatGPT" /> This token authorizes the MCP server to run Actors on your behalf.
- _An OpenAI account with access to ChatGPT_ - You need an OpenAI account to use ChatGPT.
- _ChatGPT with Developer mode enabled_ - You must enable [Developer Mode](https://platform.openai.com/docs/guides/developer-mode) to add custom connectors (when the Developer mode is active, the message input box is outlined in orange).

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/openai/codex-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Plugins require a local installation of Codex with plugin support enabled. Insta

If the browser doesn't open automatically, copy the OAuth URL shown by Codex and paste it into your browser manually.

If you're running Codex in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink /> Set it before starting Codex:
If you're running Codex in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink integration="Codex" /> Set it before starting Codex:

```bash
export APIFY_TOKEN=<YOUR_API_TOKEN>
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/openai/codex-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Reopen `/plugins`, move to the **Apify Plugin** tab, and confirm the marketplace

If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually.

If you're running the Codex CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink /> Set it before starting Codex:
If you're running the Codex CLI in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink integration="Codex" /> Set it before starting Codex:

```bash
export APIFY_TOKEN=<YOUR_API_TOKEN>
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/openclaw.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Watch a quick demo of the Apify plugin for OpenClaw:
Before integrating Apify with OpenClaw, you'll need:

- _An Apify account_ - If you don't have one, [sign up here](https://console.apify.com/sign-up).
- _Apify API token_ - <CreateApiTokenLink />
- _Apify API token_ - <CreateApiTokenLink integration="OpenClaw" />
- _OpenClaw_ - Version 2026.1.0 or later. Install from the [OpenClaw website](https://openclaw.io/).
- _Node.js 22+_ - Required to run the plugin. Install from [nodejs.org](https://nodejs.org/en/download/).

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/opencode.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Check that `opencode-apify` is listed under `plugin`. If it's missing, add it to

If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually.

If you're running OpenCode in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink /> Set it before starting OpenCode:
If you're running OpenCode in a headless environment (SSH, remote container) or the OAuth flow still fails, use token authentication instead. <CreateApiTokenLink integration="OpenCode" /> Set it before starting OpenCode:

```bash
export APIFY_TOKEN=<YOUR_API_TOKEN>
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/agents/qoder/qwen.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ If the sign-in page doesn't open or the server stays disconnected:
- **Qwen Code:** copy the authorization URL from the terminal and open it manually. If sign-in still fails, add an `Authorization: Bearer <APIFY_TOKEN>` header to the `apify` server in `~/.qwen/settings.json` under `mcpServers` - see the [Streamable HTTP configuration](/mcp#streamable-http-with-oauth-recommended) for the shape.
- **QwenWork:** remove the connector and add it again. If OAuth still won't complete, re-add it with an `Authorization` header set to `Bearer <APIFY_TOKEN>`.

For the `Authorization` header, use an API token. <GetApiTokenHint /> Setting `APIFY_TOKEN` in your shell doesn't authenticate the MCP server; it only covers the Apify CLI and `apify-client` used by the Actor development, actorization, and SDK integration skills, so run `apify login` once for those.
For the `Authorization` header, use an API token. <GetApiTokenHint integration="Qwen" /> Setting `APIFY_TOKEN` in your shell doesn't authenticate the MCP server; it only covers the Apify CLI and `apify-client` used by the Actor development, actorization, and SDK integration skills, so run `apify login` once for those.

## Limitations

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/ai/agno.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This guide shows how to integrate Apify Actors with Agno to empower your AI agen

### Prerequisites

- _Apify API token_: <CreateApiTokenLink />
- _Apify API token_: <CreateApiTokenLink integration="Agno" />
- _OpenAI API key_: Get your API key from the [OpenAI platform](https://platform.openai.com/account/api-keys).

:::tip Alternative LLM providers
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/ai/crewai.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This guide demonstrates how to integrate Apify Actors with CrewAI by building a

### Prerequisites

- **Apify API token**: <CreateApiTokenLink />
- **Apify API token**: <CreateApiTokenLink integration="CrewAI" />
- **OpenAI API key**: To power the agents in CrewAI, you need an OpenAI API key. Get one from the [OpenAI platform](https://platform.openai.com/account/api-keys).
- **Python packages**: Install the following Python packages:

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/ai/flowise.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Now you need to configure the crawler. You can find more information about at [W

In the configuration, provide your Apify API token.

<CreateApiToken />
<CreateApiToken integration="Flowise" />

![Apify API token screen](../images/flowise-apify-api.png)

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/ai/google-adk.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Apify is a marketplace of web scraping and automation tools, AI agents, and MCP

### Prerequisites

- _Apify API token_: <CreateApiTokenLink />
- _Apify API token_: <CreateApiTokenLink integration="Google ADK" />
- _Python packages_: Install the following Python packages:

```bash
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/ai/langchain/langgraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This guide shows how to use Apify Actors with LangGraph by building a ReAct agen

### Prerequisites

- **Apify API token**: <CreateApiTokenLink />
- **Apify API token**: <CreateApiTokenLink integration="LangGraph" />

- **OpenAI API key**: To work with agents in LangGraph, you need an OpenAI API key. If you don't have one, you can get it from the [OpenAI platform](https://platform.openai.com/account/api-keys).

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/ai/langflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This guide will demonstrate two different ways to use Apify Actors with Langflow

### Prerequisites

- **Apify API token**: <CreateApiTokenLink />
- **Apify API token**: <CreateApiTokenLink integration="Langflow" />

- **OpenAI API key**: To work with agents in Langflow, you need an OpenAI API key. If you don't have one, you can get it from the [OpenAI platform](https://platform.openai.com/account/api-keys).

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/ai/mastra.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This guide demonstrates how to integrate Apify Actors with Mastra by building an

### Prerequisites

- _Apify API token_: <CreateApiTokenLink />
- _Apify API token_: <CreateApiTokenLink integration="Mastra" />
- _LLM provider API key_: To power the agents, you need an LLM provider API key. For example, get one from the [OpenAI](https://platform.openai.com/account/api-keys) or [Anthropic](https://platform.claude.com/settings/keys).
- _Node.js_: Ensure you have Node.js installed.
- _Packages_: Install the following packages:
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/ai/openai/openai-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For more details about the OpenAI Agents SDK, refer to the [official documentati
Before integrating Apify with OpenAI Agents SDK, you'll need:

- _An Apify account_ - If you don't have an Apify account already, you can [sign up](https://console.apify.com/sign-up)
- _Apify API token_ - <CreateApiTokenLink /> This token authorizes the Apify MCP server to run Actors on your behalf.
- _Apify API token_ - <CreateApiTokenLink integration="OpenAI Agents SDK" /> This token authorizes the Apify MCP server to run Actors on your behalf.
- _OpenAI API key_ - Get your API key from the [OpenAI platform](https://platform.openai.com/account/api-keys). You need this to use OpenAI Agents SDK.
- _Python packages_ - Install the required packages:

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/ai/upsonic.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This guide shows how to integrate Apify Actors with Upsonic using the built-in `

### Prerequisites

- Apify API token: <CreateApiTokenLink />
- Apify API token: <CreateApiTokenLink integration="Upsonic" />
- Anthropic API key (or another LLM provider): Get one from the [Anthropic Console](https://console.anthropic.com).
- Python environment: Python 3.9 or later.
- Required packages: Install the following dependencies:
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/ai/vercel-ai-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Apify is a marketplace of ready-to-use web scraping and automation tools, AI age

### Prerequisites

- _Apify API token_: <CreateApiTokenLink /> Set it as the `APIFY_TOKEN` environment variable.
- _Apify API token_: <CreateApiTokenLink integration="Vercel AI SDK" /> Set it as the `APIFY_TOKEN` environment variable.
- _Node.js packages_: Install the following Node.js packages:

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This guide shows you how to set up an Apify dataset as a source in Airbyte and c
The Apify Dataset source reads items from a single dataset, identified by its ID. Each Actor run writes to a new default dataset. To keep syncing the results of repeated runs, have your Actor write to a [named dataset](/storage#named-and-unnamed-storages) and use its ID.

1. In [Apify Console](https://console.apify.com), open **Storage > Datasets**, select your dataset, and copy its ID.
1. <CreateApiTokenLink /> <CopyTokenStep />
1. <CreateApiTokenLink integration="Airbyte" /> <CopyTokenStep />
1. In Airbyte, open the **Sources** tab and select **Apify Dataset**.
1. Enter the **Dataset ID** and **API token** you copied, and save the source.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ In the next step, you can choose the action you want to perform:

After selecting the action, you will need to provide your Apify API token in the provided form.

<CreateApiToken />
<CreateApiToken integration="Keboola" />

![Keboola API authentication](../images/keboola/keboola-setup-api-token.png)

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/programming/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ In such situation, to build your Actor automatically on every push, manually add
https://api.apify.com/v2/actors/YOUR-ACTOR-NAME/builds?token=<YOUR_API_TOKEN>&version=0.0&tag=latest&waitForFinish=60
```

1. Replace the `<YOUR_API_TOKEN>` placeholder in the URL with an API token. <GetApiTokenHint />
1. Replace the `<YOUR_API_TOKEN>` placeholder in the URL with an API token. <GetApiTokenHint integration="GitHub" />
1. In your GitHub repository, go to **Settings > Webhooks > Add webhook**.
1. Paste the endpoint URL into **Payload URL** and set **Content type** to `application/json`.
1. Save your changes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ To connect your Apify account to Activepieces:
1. In Activepieces, open the **Connections** section.
1. Click **+ New Connection**.
1. Search for and select the Apify piece.
1. Enter your Apify API token in the **API Key** field. <GetApiTokenHint />
1. Enter your Apify API token in the **API Key** field. <GetApiTokenHint integration="Activepieces" />
1. Save the connection.

![Apify API key setup](../images/activepieces/api-token.png)
Expand Down
Loading
Loading