For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Fork this repoGet a demo
  • Docs
    • Welcome
    • Quickstart
    • Concepts
    • Search
    • MCP Server
    • CLI
    • Agent Skills
    • Connect
    • Add New Connector
    • Rate Limits
      • LlamaIndex
      • Vercel AI SDK
      • Google Antigravity
      • Pipedream
      • Sim
  • API Reference
LogoLogo
Fork this repoGet a demo
On this page
  • Prerequisites
  • Setup
  • Configuration
  • Output Format
  • Example Use Cases
  • Learn More
DocsFramework Integrations

Sim

Search your Airweave collections directly from Sim workflows using the native Airweave block.
Was this page helpful?
Edit this page
Previous

Authentication Providers

Reuse existing data source connections from third-party platforms instead of requiring users to authenticate again.

Next
Built with

The Sim Airweave block currently uses the legacy search API. It will be updated to support the new three-tier search API (instant, classic, agentic) in a future release.

Sim is an open-source platform for building and deploying AI agent workflows visually. The native Airweave block lets you search your synced data collections from any workflow, no code required.

Prerequisites

Before you start you’ll need:

  • A collection with data: at least one source connection must have completed its initial sync. See the Quickstart if you need to set this up.
  • An API key: Create one in the Airweave dashboard under API Keys.

Setup

1

Add the Airweave block

Open a workflow in Sim and drag the Airweave block from the tools palette onto the canvas.

2

Enter your Collection ID

Paste the readable ID of the Airweave collection you want to search. You can find this in the Airweave dashboard on the collection detail page.

3

Enter your API Key

Paste your Airweave API key into the API Key field. The value is stored securely and masked in the UI.

4

Write your Search Query

Type a natural-language query into the Search Query field. This field also accepts dynamic references from upstream blocks, so you can pass in user input or output from a previous step.

5

Configure search options (optional)

Adjust the retrieval strategy, max results, query expansion, reranking, and answer generation toggles to fine-tune your search.

6

Connect outputs to downstream blocks

Wire the block’s outputs, the results array and optional completion string, into downstream blocks such as an LLM agent, a Slack notification, or a condition filter.

Configuration

ParameterTypeDefaultDescription
collectionIdstring-The readable ID of the Airweave collection to search
querystring-Search query text
apiKeystring-Your Airweave API key
limitnumber25Maximum number of results to return (10, 25, 50, or 100)
retrievalStrategystringhybridRetrieval strategy: hybrid, neural, or keyword
expandQuerybooleanfalseGenerate query variations for better recall
rerankbooleanfalseRerank results using an LLM for improved relevance
generateAnswerbooleanfalseGenerate a natural-language answer from the search results

Output Format

The Airweave block returns:

results - an array of search result objects, each containing:

FieldTypeDescription
entity_idstringUnique identifier for the result entity
source_namestringName of the data source (e.g. “GitHub”, “Slack”)
md_contentstringMarkdown-formatted content of the result
scorenumberRelevance score
metadataobjectAdditional metadata associated with the result
breadcrumbsarrayNavigation path to the result within its source
urlstringURL to the original content

completion - an optional string containing an AI-generated answer to the query. Only returned when Generate Answer is enabled.

Example Use Cases

  • RAG-style question answering: Connect the Airweave block to an LLM agent block. Pass the results or completion output as context so the agent can answer questions grounded in your synced data.
  • Automated notifications: Route search results to a Slack or email block to alert your team when specific content is found in your collections.
  • Relevance filtering: Chain the Airweave block with a condition block to filter results by score, then pass only high-relevance results to the next step.

Learn More

  • Sim Website
  • Sim GitHub
  • Sim Documentation
  • Airweave GitHub