Index of every page on this site: llms.txt
All skills
Run it yourself

Run your first Apify Actor and retrieve results via apify-client. Use when starting a new Apify integration, testing connectivity, or learning the Actor call/dataset retrieval pattern. Trigger with "apify hello world", "apify example", "run an apify actor", "apify quick start", "first apify scrape".

Use this Skill: https://skilld.dev/gh/jeremylongshore/tons-of-skills-marketplace/apify-hello-world

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈80 tokens for metadata: the name and description. ≈1.2k when used: this file. ≈1.2k more on demand in 2 files.

Description uses 4.0% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈320 characters, or 4.0%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Apify Hello World

Overview

Run a public Actor from the Apify Store, wait for it to finish, and retrieve the scraped data. This demonstrates the fundamental call-wait-collect pattern used in every Apify integration.

Prerequisites

  • npm install apify-client completed
  • APIFY_TOKEN environment variable set
  • See apify-install-auth if not ready

Authentication

Every call authenticates with a personal API token passed to the client constructor: new ApifyClient({ token: process.env.APIFY_TOKEN }). Keep the token in the APIFY_TOKEN environment variable — never hard-code it in the script. Full setup (where to generate the token, how to export it) lives in the apify-install-auth skill.

Core Pattern: Call Actor, Get Data

import { ApifyClient } from 'apify-client';

const client = new ApifyClient({ token: process.env.APIFY_TOKEN });

// 1. Run an Actor and wait for it to finish
const run = await client.actor('apify/website-content-crawler').call({
  startUrls: [{ url: 'https://docs.apify.com/academy' }],
  maxCrawlPages: 5,
});

// 2. Retrieve results from the default dataset
const { items } = await client.dataset(run.defaultDatasetId).listItems();

console.log(`Crawled ${items.length} pages:`);
items.forEach(item => {
  console.log(`  - ${item.url}: ${item.text?.substring(0, 80)}...`);
});

This is the whole workflow at a high level: authenticate, .call() an Actor, then read its default dataset. For sync-vs-async execution, pagination, downloads, key-value store retrieval, run-configuration options, and a table of popular starter Actors, see run & retrieval patterns.

Instructions

Step 1: Create the Script

Use Write (or Edit an existing file) to create hello-apify.ts (or .js) with the Core Pattern code above. Use Read to confirm the file contents before running.

Step 2: Run It

# With tsx (recommended)
npx tsx hello-apify.ts

# Or with Node.js (plain JS)
node hello-apify.js

Step 3: Understand the Output

The Actor runs on Apify's cloud infrastructure. See the Output section below for the run-object fields returned when it finishes.

Output

A successful run returns a run object plus a populated dataset. The fields you read most:

Field Meaning
run.id Unique run identifier
run.status SUCCEEDED, FAILED, TIMED-OUT, or ABORTED
run.defaultDatasetId ID of the dataset containing scrape results
run.defaultKeyValueStoreId ID of the KV store with metadata/artifacts
run.statusMessage Human-readable detail (essential when status is not SUCCEEDED)

client.dataset(run.defaultDatasetId).listItems() returns { items }, where each item is one scraped record (shape depends on the Actor). Always branch on run.status before reading the dataset — a FAILED run can leave an empty or partial dataset. See worked examples for the full run-object breakdown.

Error Handling

Error Cause Solution
Actor not found Wrong Actor ID Check ID at apify.com/store
run.status === 'FAILED' Actor crashed Check run.statusMessage for details
run.status === 'TIMED-OUT' Exceeded timeout Increase timeout or reduce workload
Dataset is empty Actor produced no output Verify input parameters; check Actor logs
402 Payment Required Insufficient compute units — Apify returns HTTP 402 when your account is out of prepaid units Top up at console.apify.com/billing

Examples

Minimal happy-path collection — call an Actor and count the results:

const run = await client.actor('apify/website-content-crawler').call({
  startUrls: [{ url: 'https://example.com' }],
  maxCrawlPages: 10,
});
const { items } = await client.dataset(run.defaultDatasetId).listItems();
console.log(`Scraped ${items.length} pages`);

For the complete status-guarded "scrape and save to JSON" script and a full breakdown of the run object, see worked examples.

Resources

Next Steps

Once your first Actor run succeeds, proceed to the apify-local-dev-loop skill to build and iterate on your own Actor locally, then deploy it back to the Apify platform. That skill covers the develop-run-debug cycle in depth.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2mo3 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill provides a standard integration for Apify, a well-known web scraping and automation platform. It demonstrates best practices for secret management by using environment variables for API tokens and uses official client libraries. The skill involves running scripts and processing data from external websites, which are expected activities for its stated purpose.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: MEDIUM · 1 issue

Signed by skilld at 820dfc8. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 20 hours ago.

Activeupdated 4 months ago
What it can do
Reads files Edits files Runs commands
version
1.5.0
author
Jeremy Longshore <jeremy@intentsolutions.io>
tags
[
  "saas",
  "scraping",
  "automation",
  "apify"
]
All 6 allowed tools
ReadWriteEditBash(npm:*)Bash(npx:*)Bash(node:*)
Other metadata
compatibility
Designed for Claude Code

README badge

README badge for jeremylongshore/tons-of-skills-marketplace/apify-hello-world