Skip to content
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
8096af0
Better titles
jancurn Aug 5, 2025
7f2f1d1
One more nit
jancurn Aug 5, 2025
f9f618d
Merge branch 'master' into feat/jan-3
jancurn Aug 21, 2025
a92b6a6
Better copy
jancurn Aug 22, 2025
e060da9
Better copy
jancurn Aug 22, 2025
94d56fa
Better copy
jancurn Aug 22, 2025
6342941
Better copy
jancurn Aug 22, 2025
dd2a76a
Merge branch 'master' into feat/jan-3
jancurn Sep 18, 2025
333a116
Rename "Get items" API endpoint to "Get dataset items" for more clarity
jancurn Sep 18, 2025
c7ee3f8
Better copy
jancurn Sep 18, 2025
18cbe88
Better copy
jancurn Sep 25, 2025
c95b219
Better copy
jancurn Sep 25, 2025
0f4f2e1
Better copy
jancurn Sep 25, 2025
036d162
Better copy
jancurn Sep 25, 2025
0ae9c1a
Merge branch 'master' into feat/jan-3
jancurn Nov 6, 2025
882f22c
Renamed "Web Scraping Academy" to "Apify Academy"
jancurn Nov 6, 2025
17e7686
Better writing
jancurn Nov 6, 2025
d30fced
Better writing
jancurn Nov 6, 2025
1af8434
Merge branch 'master' into feat/jan-3
jancurn Nov 6, 2025
2d18b8b
Better writing
jancurn Nov 6, 2025
4c39c86
Better writing
jancurn Nov 6, 2025
d61bc87
Better writing
jancurn Nov 6, 2025
ca51b03
Update sources/platform/quick-start/build_with_ai.md
jancurn Nov 6, 2025
7fb9268
Update sources/platform/quick-start/build_with_ai.md
jancurn Nov 6, 2025
0b12859
Update sources/platform/index.mdx
jancurn Nov 6, 2025
88ffcdf
Update sources/platform/index.mdx
jancurn Nov 6, 2025
8ad5ec1
Update sources/platform/actors/development/actor_definition/input_sch…
jancurn Nov 6, 2025
e7eb054
Update sources/platform/actors/development/actor_definition/input_sch…
jancurn Nov 6, 2025
a24dd14
Update sources/platform/actors/development/actor_definition/input_sch…
jancurn Nov 6, 2025
bd74223
Expanded Actor ideas
jancurn Nov 6, 2025
bf72ea6
Merge remote-tracking branch 'origin/feat/jan-3' into feat/jan-3
jancurn Nov 6, 2025
33d8029
Update sources/platform/quick-start/build_with_ai.md
jancurn Nov 6, 2025
36ec1d2
Merge branch 'master' into feat/jan-3
jancurn Nov 6, 2025
7a8fbf4
Better writing
jancurn Nov 6, 2025
41ecd81
Update sources/academy/build-and-publish/actor-ideas/what_software_an…
TC-MO Nov 6, 2025
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
2 changes: 1 addition & 1 deletion apify-api/openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ info:
```

However, there are a few explicitly described exceptions, such as
Dataset [Get items](#/reference/datasets/item-collection/get-items) or
[Get dataset items](#/reference/datasets/item-collection/get-items) or
Key-value store [Get record](#/reference/key-value-stores/record/get-record)
API endpoints, which return data in other formats.
In case of an error, the response has the HTTP status code in the range of
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ post:
To fetch the Actor run results that are typically stored in the default
dataset, you'll need to pass the ID received in the `defaultDatasetId` field
received in the response JSON to the
[Get items](#/reference/datasets/item-collection/get-items) API endpoint.
[Get dataset items](#/reference/datasets/item-collection/get-items) API endpoint.
operationId: actorTask_runs_post
parameters:
- name: actorTaskId
Expand Down
2 changes: 1 addition & 1 deletion apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ post:

To fetch the Actor run results that are typically stored in the default
dataset, you'll need to pass the ID received in the `defaultDatasetId` field
received in the response JSON to the [Get items](#/reference/datasets/item-collection/get-items)
received in the response JSON to the [Get dataset items](#/reference/datasets/item-collection/get-items)
API endpoint.
operationId: act_runs_post
parameters:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
get:
tags:
- Storage/Datasets
summary: Get items
summary: Get dataset items
description: |
Returns data stored in the dataset in a desired format.

Expand Down
2 changes: 1 addition & 1 deletion sources/academy/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Web Scraping Academy
title: Apify Academy
description: Learn everything about web scraping and automation with our free courses that will turn you into an expert scraper developer.
sidebar_position: 0
slug: /
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ The **run info** JSON also contains the IDs of the default [dataset](/platform/s

> If you are scraping products, or any list of items with similar fields, the [dataset](/platform/storage/dataset) should be your storage of choice. Don't forget though, that dataset items are immutable. This means that you can only add to the dataset, and not change the content that is already inside it.

To retrieve the data from a dataset, send a GET request to the [**Get items**](/api/v2/dataset-items-get) endpoint and pass the `defaultDatasetId` into the URL. For a GET request to the default dataset, no token is needed.
To retrieve the data from a dataset, send a GET request to the [**Get dataset items**](/api/v2/dataset-items-get) endpoint and pass the `defaultDatasetId` into the URL. For a GET request to the default dataset, no token is needed.

```cURL
https://api.apify.com/v2/datasets/DATASET_ID/items
Expand Down
2 changes: 1 addition & 1 deletion sources/legal/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ hide_table_of_contents: true
<!-- vale off -->
<!-- markdownlint-disable -->

## Company details (Impressum)
## Legal info (Imprint)

**Apify Technologies s.r.o.**<br/>
Registered seat: Vodickova 704/36, 110 00 Prague 1, Czech Republic<br/>
Expand Down
2 changes: 1 addition & 1 deletion sources/legal/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module.exports = {
legal: [
{
type: 'link',
label: 'Company details (Impressum)',
label: 'Legal info (Imprint)',
href: '/legal',
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ If you read the `INPUT` key from the Actor run's default key-value store directl
> await Actor.getValue('INPUT');
{
username: 'username',
password: 'ENCRYPTED_VALUE:Hw/uqRMRNHmxXYYDJCyaQX6xcwUnVYQnH4fWIlKZL2Vhtq1rZmtoGXQSnhIXmF58+DjKlMZpTlK2zN3YUXk1ylzU6LfXyysOG/PISAfwm27FUgy3IfdgMyQggQ4MydLzdlzefX0mPRyixBviRcFhRTC+K7nK9lkATt3wJpj91YAZm104ZYkcd5KmsU2JX39vxN0A0lX53NjIenzs3wYPaPYLdjKIe+nqG9fHlL7kALyi7Htpy91ZgnQJ1s9saJRkKfWXvmLYIo5db69zU9dGCeJzUc0ca154O+KYYP7QTebJxqZNQsC8EH6sVMQU3W0qYKjuN8fUm1fRzyw/kKFacQ==:VfQd2ZbUt3S0RZ2ciywEWYVBbTTZOTiy'
password: 'ENCRYPTED_VALUE:Hw/uqRMRNHmxXYYDJCyaQX6xcwUnVYQnH4fWIlKZL...'
}
```

Expand Down

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion sources/platform/actors/running/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,4 +118,4 @@ print(dataset_items)

The newly started Actor runs under the account associated with the provided `token`, and therefore all resources consumed are charged to this user account.

Internally, the `call()` function invokes the [Run Actor](/api/v2/#/reference/actors/run-collection/run-actor) API endpoint, waits for the Actor to finish, and reads its output using the [Get items](/api/v2/#/reference/datasets/item-collection/get-items) API endpoint.
Internally, the `call()` function invokes the [Run Actor](/api/v2/#/reference/actors/run-collection/run-actor) API endpoint, waits for the Actor to finish, and reads its output using the [Get dataset items](/api/v2/#/reference/datasets/item-collection/get-items) API endpoint.
5 changes: 3 additions & 2 deletions sources/platform/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ import Card from "@site/src/components/Card";
import CardGrid from "@site/src/components/CardGrid";
import homepageContent from "./homepage_content.json";

> **Apify** is a cloud platform that helps you build reliable web scrapers, fast, and automate anything you can do manually in a web browser.

> **Apify** is a cloud platform and marketplace of tools for web data extraction and automation.
>
> **Actors** are serverless cloud programs running on the Apify platform that can easily crawl websites with millions of pages, but also perform arbitrary computing jobs such as sending emails or data transformations. They can be started manually, using our API or scheduler, and they can be easily integrated with other apps.
> **Actors** are serverless programs that run in the cloud. They can perform anything from simple actions such as filling out a web form or sending an email, to complex operations such as crawling a website with a million pages, or removing duplicates from a large dataset. Actors can persist their state and be restarted, and thus they can run as short or as long as necessary, from seconds to hours, even infinitely.

## Getting started

Expand Down
3 changes: 2 additions & 1 deletion sources/platform/integrations/ai/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ toc_max_heading_level: 4
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

The _Apify Model Context Protocol (MCP) Server_ enables AI applications to connect to Apify's extensive library of Actors. Tools allowing your AI agents to perform web scraping, data extraction, and automation tasks in real time.
The Apify's [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server allows AI applications and agents to search and run Actors from [Apify Store](https://apify.com/store) as tools for web scraping, data extraction, or automation,
as well as access Apify documentation and tutorials from your AI coding environments.

![Apify MCP Server](../../images/apify_mcp_server.png)

Expand Down
44 changes: 17 additions & 27 deletions sources/platform/quick-start/build_with_ai.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: Build Actors with AI
sidebar_position: 3
description: Use pre-built prompts, refer to Apify docs via llms.txt, and follow best practices for effective vibe coding.
sidebar_label: Build with AI
description: Learn how to build new Actors or improving existing ones using AI code generation and vibe coding tools.
slug: /actors/development/quick-start/build-with-ai
toc_max_heading_level: 4
---

**Use pre-built prompts, reference Apify documentation through `/llms.txt`, and follow best practices to build Actors efficiently with AI coding assistants.**
**Learn how to develop new Actors or improve existing ones using AI code generation and vibe coding tools.**

---

Expand All @@ -15,7 +16,9 @@ import PromptButton from "@site/src/components/PromptButton";
import InstallMCPButton from "@site/src/components/InstallMCPButton";
import copyForAI from "./images/copy-for-ai.png";

You will learn several approaches to building Apify Actors with the help of AI coding assistants. This guide includes independent instructions, tools, and best practices that you can use individually or combine together. Each section focuses on a specific part of the process such as prompt usage, Actor templates, Apify MCP server tools, or documentation integration, so you can follow only the parts that fit your development style.
This guide provides best practices for building new Actors or improving existing ones using AI code generation
and vibe coding tools such as Cursor, Claude Code, or Visual Studio Code,
by providing the AI agents with the right instructions and context.

## AI coding assistant instructions

Expand Down Expand Up @@ -66,30 +69,17 @@ Every page in the Apify documentation has a **Copy for LLM** button. You can use

<img src={copyForAI} alt="Copy for LLM" width="250" />

## Use `llms.txt` and `llms-full.txt`

Search engines weren't built for Large Language Models (LLMs), but LLMs need context. That's why we've created [`llms.txt`](https://docs.apify.com/llms.txt) and [`llms-full.txt`](https://docs.apify.com/llms-full.txt) for our documentation. These files can provide additional context if you link them.

<table>
<thead>
<tr>
<th>File</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>llms.txt</code></td>
<td>Contains index of the docs page in Markdown, with links to all subpages in Markdown.</td>
</tr>
<tr>
<td>
<code style={{ whiteSpace: 'nowrap' }}>llms-full.txt</code>
</td>
<td>Contains a full dump of documentation in Markdown.</td>
</tr>
</tbody>
</table>
## Use `/llms.txt` files

The entire Apify documentation is available in Markdown format to make it easy to
digest by LLMs and AI coding tools. There are two special files:

- **https://docs.apify.com/llms.txt**: A Markdown file with an index to all documentation pages in Markdown format. This is based on the [llmstxt.org](https://llmstxt.org/) standard.
- **https://docs.apify.com/llms-full.txt**: A single Markdown file with a complete dump of the entire Apify documentation.

Note that for each Apify documentation page, you can get the Markdown version by adding `.md` to the URL. For example:

https://docs.apify.com/platform/actors => https://docs.apify.com/platform/actors.md

:::note Provide link to AI assistants

Expand Down
3 changes: 2 additions & 1 deletion sources/platform/quick-start/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Quick start
title: Actor development quick start
sidebar_label: Quick start
sidebar_position: 0.5
description: Create your first Actor using the Apify Web IDE or locally in your IDE.
slug: /actors/development/quick-start
Expand Down
3 changes: 2 additions & 1 deletion sources/platform/quick-start/start_locally.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Local development
title: Local Actor development
sidebar_label: Local development
sidebar_position: 1
description: Create your first Actor locally on your machine, deploy it to the Apify platform, and run it in the cloud.
slug: /actors/development/quick-start/locally
Expand Down
4 changes: 2 additions & 2 deletions src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,8 @@ export default function Home() {
</div>
</Section>
<Section
heading="Web scraping Academy"
description='Free practical courses on web scraping and browser automation. Go from beginner to expert, all in one place.'
heading="Apify Academy"
description='Free practical courses on web scraping and the Apify platform. Go from beginner to expert, all in one place.'
>
<div className={styles.sectionLayoutWrapper}>
<div className={styles.cards}>
Expand Down
Loading