# ❜embed - The AI Recommendation System for Web3 Documentation

> ❜embed's documentation is your one-stop resource for quickly learning and integrating our AI-powered tools. You’ll find: 	•	Quickstart Guides: Step-by-step tutorials for rendering feeds with the Embed SDK and building Farcaster mini-apps in React. 	•	API Reference: Complete OpenAPI specs for content discovery, moderation, labeling, and semantic search endpoints, with request & response examples. 	•	Deep-Dive Tutorials: Hands-on walkthroughs for RAG implementations, custom AI-agent development, and best practices for training on your own label taxonomies. 	•	Recipes & Code Samples: Ready-to-use snippets in JavaScript, Python, and more—perfect for prototyping and production. 	•	Community & Support: Links to FAQ pages, our Developer Slack, Farcaster, and X channels for real-time help and discussion.

## Guides: Getting Started
- [guide-api-overview](https://docs.getembed.ai/docs/guide-api-overview.md)
- [guide-authentication](https://docs.getembed.ai/docs/guide-authentication.md)
- [quickstart-studio-sdk](https://docs.getembed.ai/docs/quickstart-studio-sdk.md)
- [glossary](https://docs.getembed.ai/docs/glossary.md)
- [vibecoding-with-embed](https://docs.getembed.ai/docs/vibecoding-with-embed.md)
- [Essentials - What Makes a Good Feed?](https://docs.getembed.ai/docs/what-makes-a-good-feed.md): Learn how to build a useful feed in Console with source selection, search, filtering, hydration, preview, and feed deployment.

## Guides: Platform Coverage
- [platform-coverage](https://docs.getembed.ai/docs/platform-coverage.md): How Embed organizes wallet, market, trade, and signal data, including current free-demo coverage.

## Guides: Datasources
- [data-sources](https://docs.getembed.ai/docs/data-sources.md)

## Guides: Algorithm
- [Supported Indices](https://docs.getembed.ai/docs/supported-indices.md): Search indices available in the Console algorithm Search tab.
- [Building Algorithms](https://docs.getembed.ai/docs/guide-building-algorithms.md): Build feed and notification algorithms in Console with Search, Hydration, and DSL.
- [algorithm-dsl-functions](https://docs.getembed.ai/docs/algorithm-dsl-functions.md)
- [search](https://docs.getembed.ai/docs/search.md)
- [algo-filter-cookbook](https://docs.getembed.ai/docs/algo-filter-cookbook.md)
- [Validate & Test](https://docs.getembed.ai/docs/validate-and-test.md)

## Guides: Feeds
- [Feed Management](https://docs.getembed.ai/docs/guide-feed-management.md): Manage production feeds in Console with saved algorithms, feed configs, fallbacks, cache settings, and test runs.
- [feeds-dsl-functions](https://docs.getembed.ai/docs/feeds-dsl-functions.md)
- [Deploy Feed Configs](https://docs.getembed.ai/docs/deploy-feed-configs.md): Deploy saved algorithms as production feed configs in Console.
- [Serving Feeds in Production](https://docs.getembed.ai/docs/deploy-serving.md)
- [Feed deployment status](https://docs.getembed.ai/docs/deploy-status.md)

## Guides: Notifications
- [Notifications](https://docs.getembed.ai/docs/guide-notifications.md): Build notification products in Console with algorithms, notification configs, webhooks, cooldowns, and budgets.
- [notifications-dsl-functions](https://docs.getembed.ai/docs/notifications-dsl-functions.md)
- [Building Notification Streams](https://docs.getembed.ai/docs/building-notification-streams.md): Build notification streams from saved algorithms and notification configs.

## API: Datasources
- [Data Ingestion](https://docs.getembed.ai/reference/data-ingestion.md)
- [Create a new datasource](https://docs.getembed.ai/reference/createdatasource.md): Creates a new datasource with automatic Embed stream provisioning
- [Ingest item data](https://docs.getembed.ai/reference/ingestitems.md): Ingest content items (posts, articles, videos, etc.) from various protocols
- [Ingest user data](https://docs.getembed.ai/reference/ingestusers.md): Ingest user profile data from various protocols
- [Track item interactions](https://docs.getembed.ai/reference/trackiteminteractions.md): Track user interactions with content items
- [Track user interactions](https://docs.getembed.ai/reference/trackuserinteractions.md): Track user interactions (uses same schema as item interactions but routes to different stream)

## API: Algorithm
- [Compose algorithm from prompt](https://docs.getembed.ai/reference/algocompose.md): Generate a feed algorithm from a natural language prompt using an AI agent. The agent has access to DS services (search, stories, features, scoring, ranking) to explore data and compose the…
- [Get help from AI assistant](https://docs.getembed.ai/reference/algohelp.md): Get contextual help from an AI assistant for the embed feed builder. Pass a conversation (single string or array of messages) and optional context (e.g. product, page, source).
- [Validate algorithm](https://docs.getembed.ai/reference/algovalidate.md): Validate a feed algorithm without executing it. Runs two checks:  - **Syntax**: Validates algorithm code against the algo-dsl spec (version can be specified via `version` field, defaults to `V1`). -…
- [Create algorithm](https://docs.getembed.ai/reference/createfeedalgo.md): Create a new algorithm. The `account_id` in the payload must match the authenticated account. The `signature` field is obtained from `/algo/validate` after passing both syntax and security checks.
- [Delete algorithm](https://docs.getembed.ai/reference/deletefeedalgo.md): Soft-delete a algorithm (sets `deleted_at`). Only allowed if the algo belongs to your account.
- [Get algorithm by ID](https://docs.getembed.ai/reference/getfeedalgo.md): Retrieve a algorithm by its ID. Allowed if the algo belongs to your account or is public.
- [List algorithms](https://docs.getembed.ai/reference/listfeedalgos.md): List algorithms accessible to the account (owned + public from others). Returns own algos and public algos from other accounts (read-only access to public).
- [Update algorithm](https://docs.getembed.ai/reference/updatefeedalgo.md): Update a algorithm. Only allowed if the algo belongs to your account. All fields are optional — only provided fields are updated.
- [Run a signed algorithm](https://docs.getembed.ai/reference/feedbuilderrun.md): Execute a signed feed algorithm in a sandbox with a 10-second timeout. Requires the algorithm code and a signature from /algo/validate.

## API: Feeds
- [Create config](https://docs.getembed.ai/reference/createfeedconfig.md): Create a new deployment configuration. The `account_id` in the payload must match the authenticated account. The `feed_config` object defines which algorithms to use, fallback chains, cache settings,…
- [Delete config](https://docs.getembed.ai/reference/deletefeedconfig.md): Soft-delete a config (sets `deleted_at`). Only allowed if the config belongs to your account.
- [Get config by ID](https://docs.getembed.ai/reference/getfeedconfig.md): Retrieve a config by its ID. Allowed if the config belongs to your account or is public.
- [List configs](https://docs.getembed.ai/reference/listfeedconfigs.md): List configs accessible to the account (owned + public from others).
- [Update config](https://docs.getembed.ai/reference/updatefeedconfig.md): Update a config. Only allowed if the config belongs to your account. All fields are optional — only provided fields are updated.
- [Serve feed by config ID](https://docs.getembed.ai/reference/deployserve.md): Serves a merged feed using a saved config from the database by ID. Returns the first page of feed items and a `served_id` for pagination via `/deploy/serve/page` and new-items detection via…
- [Get feed page](https://docs.getembed.ai/reference/deployservepage.md): Get a paginated page of feed items. Use the `served_id` returned from `POST /deploy/serve` or `POST /deploy/preview`.  Pages are 1-based. The total number of pages is returned in the initial serve…
- [Get new items since last view](https://docs.getembed.ai/reference/deployservenewitems.md): Returns items that are new since the previous feed version. Use the `served_id` from `POST /deploy/serve` or `POST /deploy/preview`.  This is useful for showing a "new items available" indicator in…
- [Preview feed with inline config](https://docs.getembed.ai/reference/deploypreview.md): Serves a merged feed from main feeds and fallbacks per the provided deployment config. Use this to test a config before saving it.  Returns the first page of feed items and a `served_id` for…
- [Clear feed cache](https://docs.getembed.ai/reference/deploycacheclear.md): Clears cached version entries for feed algos the user can access (owned or public). Use when you've updated an algorithm and need to force a fresh build.  Pass an array of algorithm IDs to clear.…

## API: Content
- [List Frequent Values](https://docs.getembed.ai/reference/listfrequentvalues.md): Retrieve the most frequently occurring values for a specific field in an index.  This endpoint is useful for discovering popular values in a field before building filters or queries. Common use cases…
- [Boost](https://docs.getembed.ai/reference/searchboost.md): Execute a search query with filtering, exclusion, and result boosting against Elasticsearch indices.  This endpoint extends filter-and-sort by adding a `boost` array for soft relevance tuning. Boost…
- [Filter and Sort](https://docs.getembed.ai/reference/searchfilterandsort.md): Execute a search query with filtering and sorting capabilities against Elasticsearch indices.  This endpoint is the primary structured search method. Use it when you need exact-match filters, range…
- [Semantic Search](https://docs.getembed.ai/reference/searchsemantic.md): Execute a semantic similarity search using dense vector embeddings.  This endpoint retrieves items by meaning rather than exact keyword matching. It supports two modes:  **Text Mode**: - Provide a…
- [Generate](https://docs.getembed.ai/reference/generatestories.md): Generate personalized onchain stories about market activity, significant bets, and price movements.  This endpoint creates narrative-driven content about Polymarket activity tailored to a specific…

## Recipes
- [Alert on Large Followed-Wallet Trades](https://docs.getembed.ai/recipes/alert-on-large-followed-wallet-trades.md)
- [Boost Polymarket Markets with a Fixed Wallet Profile](https://docs.getembed.ai/recipes/boost-polymarket-markets-with-a-fixed-wallet-profile.md)
- [Browse Hyperliquid Market Prices](https://docs.getembed.ai/recipes/browse-hyperliquid-market-prices.md)
- [Browse Zora Creator Coins](https://docs.getembed.ai/recipes/browse-zora-creator-coins.md)
- [Build a Diversified Following Digest](https://docs.getembed.ai/recipes/build-a-diversified-following-digest.md)
- [Build a Polymarket Following Feed](https://docs.getembed.ai/recipes/build-a-polymarket-following-feed.md)
- [Build a Polymarket Trader Leaderboard](https://docs.getembed.ai/recipes/build-a-polymarket-trader-leaderboard.md)
- [Create a Recent Whale-Trades Fallback](https://docs.getembed.ai/recipes/create-a-recent-whale-trades-fallback.md)
- [Create a Trending Polymarket-Markets Fallback](https://docs.getembed.ai/recipes/create-a-trending-polymarket-markets-fallback.md)
- [Create an Any-P0 Signal Stream](https://docs.getembed.ai/recipes/create-an-any-p0-signal-stream.md)
- [Create P0 Whale Alerts from Follows](https://docs.getembed.ai/recipes/create-p0-whale-alerts-from-follows.md)
- [Exclude Muted Wallets from a Following Feed](https://docs.getembed.ai/recipes/exclude-muted-wallets-from-a-following-feed.md)
- [Exclude Muted Wallets from Follow Signals](https://docs.getembed.ai/recipes/exclude-muted-wallets-from-follow-signals.md)
- [Filter Signals to Leaderboard Wallets](https://docs.getembed.ai/recipes/filter-signals-to-leaderboard-wallets.md)
- [Find Top Markets Traded by Followed Wallets](https://docs.getembed.ai/recipes/find-top-markets-traded-by-followed-wallets.md)
- [Find Trending DEX Tokens](https://docs.getembed.ai/recipes/find-trending-dex-tokens.md)
- [Find Whale Trades on Base](https://docs.getembed.ai/recipes/find-whale-trades-on-base.md)
- [Find Whale Trades on Ethereum](https://docs.getembed.ai/recipes/find-whale-trades-on-ethereum.md)
- [Find Whale Trades on Solana](https://docs.getembed.ai/recipes/find-whale-trades-on-solana.md)
- [Notify on Followed-Wallet Signals](https://docs.getembed.ai/recipes/notify-on-followed-wallet-signals.md)
- [Notify on Large Followed-Wallet Buys](https://docs.getembed.ai/recipes/notify-on-large-followed-wallet-buys.md)
- [Notify on Large Followed-Wallet Sells](https://docs.getembed.ai/recipes/notify-on-large-followed-wallet-sells.md)
- [Personalize Kalshi Markets by Wallet Tags](https://docs.getembed.ai/recipes/personalize-kalshi-markets-by-wallet-tags.md)
- [Personalize Polymarket Markets by Traded Tags](https://docs.getembed.ai/recipes/personalize-polymarket-markets-by-traded-tags.md)
- [Personalize Polymarket Notifications by Wallet Tags](https://docs.getembed.ai/recipes/personalize-polymarket-notifications-by-wallet-tags.md)
- [Prioritize Whale Follow Signals](https://docs.getembed.ai/recipes/prioritize-whale-follow-signals.md)
- [Rank DEX Wallets by Portfolio Value](https://docs.getembed.ai/recipes/rank-dex-wallets-by-portfolio-value.md)
- [Rank Hyperliquid Traders by PnL](https://docs.getembed.ai/recipes/rank-hyperliquid-traders-by-pnl.md)
- [Rank Kalshi Traders by Volume](https://docs.getembed.ai/recipes/rank-kalshi-traders-by-volume.md)
- [Show a Wallet’s Recent Hyperliquid Trades](https://docs.getembed.ai/recipes/show-a-wallets-recent-hyperliquid-trades.md)
- [Show Fresh Buys from Followed Wallets](https://docs.getembed.ai/recipes/show-fresh-buys-from-followed-wallets.md)
- [Show Whale Trades from Followed Wallets](https://docs.getembed.ai/recipes/show-whale-trades-from-followed-wallets.md)