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.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
  • Getting Started
    • What is Runtype?
    • Creating your account
    • Platform Keys vs. BYOK
    • Understanding the Runtype UI
    • Quickstart: Social Media Post Generator
    • Quickstart: From Agent to Chat Widget
  • Dashboard
    • What is the Dashboard?
    • Daily Executions
  • Playground
    • What is the Playground?
  • Products & Surfaces
    • What are Products?
    • What are Surfaces?
    • Creating a Product
    • Setting up a Chat Surface
    • Setting up an API Surface
    • Setting up an MCP Surface
    • Setting up an A2A Surface
    • Setting up a Slack Surface
    • MCP authentication
    • Authenticating with product API keys
    • Embedding the chat widget (script tag)
    • Embedding the chat widget (React)
    • Surface orchestration modes
    • Product views
    • Adding Capabilities to a product
    • Connecting external agents
    • How A2A works
    • Connecting to Cursor / VS Code
    • Connecting to Claude Desktop
    • Scoping API keys to capabilities
    • Auto-generated OpenAPI spec
    • Calling your API endpoints
    • Client tokens and domain restrictions
    • AI-powered theme generation
    • Widget theming and customization
    • Product versioning and status
  • Flows
    • What are Flows?
    • Creating and Editing Flows
    • Flow step types overview
    • Agent and Flow Templates
    • Using prompt steps
    • Using transform-data steps
    • Using conditional steps
    • Using fetch-url and api-call steps
    • Using record steps (upsert/retrieve)
    • Flow variables and templates
    • Flow versioning and publishing
    • Running flows in batch
    • Handling batch failures
    • Debugging flows
  • Agents
    • What are Agents?
    • Creating and configuring Agents
    • Agent tools
  • Records
    • What are Records?
    • Creating and managing records
    • Using records in flows
    • Filtering and searching records
  • Tools
    • What are Tools?
    • Built-in Tools
    • Creating custom tools
    • Creating external tools
    • Runtime tools
  • Evals
    • What are Evals?
    • Running an Eval
    • Interpreting eval results
  • Schedules
    • What are Schedules?
    • Automating batch processing
  • Logs
    • What are Logs?
    • Working with Logs
  • Integrations
    • Connecting AI model providers
    • Slack integration
    • Google Workspace integration
    • GitHub integration
    • Linear integration
    • Weaviate (vector search)
    • Firecrawl (web scraping)
    • Exa (web search)
  • Settings
    • What's in Settings?
    • Available AI models
    • What are Organizations?
    • Managing AI models
    • Managing API keys
    • Billing and plans
    • Usage data
    • Team members and permissions
    • Appearance and preferences
    • Integrations (PostHog, Weaviate, Daytona)
  • Troubleshooting & FAQ
    • FAQ
    • Rate Limits and Usage
    • Managing Runtype with Claude
    • Flow execution failures
    • Common errors and solutions
    • Authentication issues
Dashboard
LogoLogo
On this page
  • Filter search
  • In the dashboard
  • Filter syntax in Flows
  • Semantic search
  • How it works
  • Example queries
  • In Flows
  • Combining filters and semantic search
  • Result ranking
  • Record type filtering
  • Field selection
  • Performance considerations
  • Search examples
  • Customer lookup
  • High-value customers
  • Knowledge base search
  • Product recommendations
  • Next steps
Records

Filtering and searching records

Was this page helpful?
Previous

What are Tools?

Next
Built with

Find Records using exact filters, semantic search, or combined queries to provide relevant context to Flows and Agents.

Filter search

Search by exact or partial matches on metadata fields.

In the dashboard

  1. Go to Records
  2. Filter by Record type using the type tabs
  3. Use the filter builder to add conditions on metadata fields with operators such as equals, contains, greater than, and more

Filter syntax in Flows

Use the Retrieve Record step in query mode with a record filter, or configure filters on a Vector Search step. Filters use a structured JSON DSL with conditions and groups:

1{
2 "op": "and",
3 "conditions": [
4 { "field": "tier", "op": "eq", "value": "premium" },
5 { "field": "orderCount", "op": "gt", "value": 10 }
6 ]
7}

Operators:

  • eq, neq — Equality
  • gt, gte, lt, lte — Comparison
  • contains, startsWith, endsWith — String matching
  • in, notIn — Set membership
  • isSet, isNotSet — Existence checks
  • isTrue, isFalse — Boolean checks
  • between — Range matching
  • withinLastDays, olderThanDays — Date-relative filters

Groups use "op": "and" or "op": "or" to combine conditions.

Semantic search

Find Records by meaning using natural language queries.

How it works

Runtype converts your query into a vector embedding and finds Records with similar embeddings. This matches conceptual similarity, not just keywords.

Example queries

  • “How do I reset my password?” → Finds password reset documentation
  • “Affordable laptops for students” → Finds budget laptop Products
  • “Shipping delays” → Finds policies and updates about shipping

In Flows

Use the Vector Search step with a query template:

{{input.userQuestion}}

The step returns Records ranked by similarity score.

Semantic search works best on text-heavy fields like descriptions, content, or article bodies. It’s less effective on structured data like IDs or numbers.

Combining filters and semantic search

The Vector Search step supports both a semantic query and metadata filters. Use the recordType field to scope results, and metadataFilters for additional constraints:

  1. Semantic query: “Technical issues with Widget Pro”
  2. Record type: support

This finds semantically relevant support articles within the support record type.

Result ranking

Search results are ranked by:

  • Filter search: No ranking, returns all matches
  • Semantic search: Similarity score (most relevant first)

Limit results to top N for performance:

limit: 5 // Return top 5 results

Record type filtering

Search within a specific Record type:

type: "documentation"
query: "API authentication"

Or search across all types (slower but comprehensive).

Field selection

When building Flows, you control which data is used for each search type:

  • Embedded fields: The Generate Embedding step determines which text is embedded for semantic search
  • Filterable fields: Any metadata field can be used in record filters for exact matching

Performance considerations

  • Small datasets (under 1k Records): All search types perform well
  • Large datasets (10k+ Records): Add filters to narrow semantic search scope
  • Very large datasets (100k+ Records): Use record type filtering and limit result counts

Search examples

Customer lookup

1{
2 "op": "and",
3 "conditions": [
4 { "field": "email", "op": "eq", "value": "jane@example.com" }
5 ]
6}

High-value customers

1{
2 "op": "and",
3 "conditions": [
4 { "field": "lifetime_value", "op": "gt", "value": 10000 },
5 { "field": "tier", "op": "eq", "value": "premium" }
6 ]
7}

Knowledge base search

Use the Vector Search step:

Record type: docs
Query: {{input.userQuestion}}
Limit: 3

Product recommendations

Combine a Vector Search with a record type filter:

Record type: products
Query: {{input.userPreferences}}
Limit: 5

Next steps

  • Creating and managing records
  • Using records in flows
  • What are Records?