Skip to content

docs: add Apify for AI agents onboarding page#2532

Merged
TC-MO merged 6 commits into
masterfrom
agent-onboarding
May 14, 2026
Merged

docs: add Apify for AI agents onboarding page#2532
TC-MO merged 6 commits into
masterfrom
agent-onboarding

Conversation

@TC-MO
Copy link
Copy Markdown
Contributor

@TC-MO TC-MO commented May 13, 2026

Consolidates PRs #2367 and #2369 into one entry point for developers integrating AI agents with Apify. Covers MCP, Agent Skills, client libraries, CLI, and REST API.

Wires the page into discovery surfaces: homepage card, AI integrations section card, and a disambiguation tip on the build-with-AI page.
Bumps MCP to sidebar position 0 so it remains the top item in AI integrations with onboarding sitting right below.

TC-MO added 4 commits May 13, 2026 23:33
Consolidates PRs #2367 and #2369 into one entry point for developers
integrating AI agents with Apify. Covers MCP, Agent Skills, client
libraries, CLI, and REST API.

Wires the page into discovery surfaces: homepage card, AI integrations
section card, and a disambiguation tip on the build-with-AI page.
Bumps MCP to sidebar position 0 so it remains the top item in AI
integrations with onboarding sitting right below.
…hooks pointer

Adds three pieces an agent developer needs but the initial merge missed:
- Run-your-first-Actor walkthrough with MCP, JavaScript, and Python
  tabs - shows the shape of an integration before the comparison table
- Cost controls callout naming the four run-limit query parameters
  (memory, timeout, maxItems, maxTotalChargeUsd) - the most common
  surprise-bill footgun for autonomous agents
- Webhooks pointer for long-running Actors - avoids polling when the
  sync endpoint times out

Also links named endpoints and MCP tools where they were previously
bare code spans.
- Bold reserved for UI elements; non-UI emphasis uses italic
- "Sign up to Apify Console" instead of URL or specific OAuth providers
- Sample agent prompt as a text code block, not a blockquote
- Promote bold/italic-paragraph leads to real headings, with MCP setup
  rewritten as numbered procedures
- Move Agent Skills out of the integration-method comparison into its
  own section; reframe as a layer on top of MCP or coding assistants
- Link each endpoint in the REST quick-reference table to its API doc
- Remove maxItems from cost controls (pay-per-result is deprecated)
- Dissolve the FAQ - each entry now covered inline or by structure
@TC-MO TC-MO requested a review from lukas-bekr May 13, 2026 22:34
@TC-MO TC-MO self-assigned this May 13, 2026
@TC-MO TC-MO requested a review from marcel-rbro as a code owner May 13, 2026 22:34
@TC-MO TC-MO added documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team. labels May 13, 2026
@apify-service-account
Copy link
Copy Markdown

apify-service-account commented May 13, 2026

🗑️ Preview for this PR was deleted.

Vocab listed `serverless` as lowercase-only, blocking canonical
phrasing at sentence starts. Match the [Ss]torages / [Aa]utoscaling
pattern so both cases pass Vale. Restore "Serverless cloud programs"
in the agent onboarding bullet.
@TC-MO TC-MO requested a review from patrikbraborec May 14, 2026 06:29
@patrikbraborec
Copy link
Copy Markdown
Contributor

I think the the page is good, only few points below:

The page is quite buried in /platform/integrations/agent-onboarding, although it might be improved based on the restructuring.

In the section Run your first Actor

I miss Apify CLI.

In the section Choose your integration method -> CLI:

npm install -g apify-cli                        # or: brew install apify-cli

The recommended version is curl.

You can show https://docs.apify.com/cli/docs/reference#apify-actors-search as Discover Actors flow.


Side note -> it looks that we have three similar things:

There are some differences, but it's somehow related, and I have feeling that we are duplicating content. I would rather have one GOOD thing / section than multiple of these resources across the docs. That being said, it might get solved by restructuring.

@TC-MO
Copy link
Copy Markdown
Contributor Author

TC-MO commented May 14, 2026

Yes this is prime candidate for Get started section after restructuring, right now I surface it by itemcard on homepage

@TC-MO
Copy link
Copy Markdown
Contributor Author

TC-MO commented May 14, 2026

re: duplicated content

There's real overlap between this page, build-with-ai, and develop-ai-agents, especially around MCP setup, Agent Skills, and llms.txt / .md docs access.

I want to handle the dedup in a follow-up rather than expand this PR's scope. Long-term, this page should be the canonical reference for "Apify + AI agents", absorbing develop-ai-agents (which covers the same territory from the hosted-agent angle).

- Add CLI tab to the walkthrough alongside MCP/JS/Python
- Lead the install command with curl per CLI README ordering;
  link to the full install docs for Homebrew/Windows/npm alternatives
- Add `apify actors search` to the discovery flow
@TC-MO TC-MO merged commit 61ec925 into master May 14, 2026
15 checks passed
@TC-MO TC-MO deleted the agent-onboarding branch May 14, 2026 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants