Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

Eliza + Olostep gives your agents reliable web search, letting them look up current information, answer open-ended questions with live results, and return deduplicated links with titles and descriptions.

​
Features

Web Search Action

Adds the OLOSTEP_SEARCH action to Eliza agents for live web search.

Deduplicated Results

Removes duplicate links and keeps the most relevant results at the top.

Simple Setup

Configure one API key in your Eliza agent settings and start searching.

Natural-Language Triggers

Works when users ask the agent to search the web, look something up, or find online sources.

Structured Results

Returns titles, descriptions, and URLs that are easy for agents to summarize or cite.

No SDK Required

Calls Olostep directly through the /searches endpoint with standard fetch.

​
Installation

npm install @olostep/plugin-elizaos-olostep
This package is published on npm as @olostep/plugin-elizaos-olostep.

​
Setup

  1. Create an Olostep API key in your Olostep dashboard.
  2. Add the key to your Eliza agent settings as OLOSTEP_API_KEY.
  3. Include the plugin in your character config.
{
  "name": "MyAgent",
  "settings": {
    "secrets": {
      "OLOSTEP_API_KEY": "your-olostep-api-key-here"
    }
  }
}

import type { Character } from '@elizaos/core';

export const character: Character = {
  name: 'MyAgent',
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
};

​
Available Tools

Searches the web with Olostep and returns a list of relevant links with titles and descriptions. Use it when the user asks the agent to search for information, look up a topic, or find current web sources.
​
OLOSTEP_API_KEY
string
required
The Olostep API key stored in the agent runtime secrets.
​
message.content.text
string
required
The search query. Eliza uses the incoming user message text as the query.
// Register the plugin and let Eliza route search requests
import type { Character } from '@elizaos/core';

export const character: Character = {
  name: 'ResearchAgent',
  plugins: ['@olostep/plugin-elizaos-olostep'],
};
The action returns structured search results in data.links, and the agent response includes a readable summary with up to five top links.

​
Full Agent Examples

​
Research Assistant

A general-purpose research agent that fetches recent facts before answering: 
import type { Character } from '@elizaos/core';

export const character: Character = {
  name: 'ResearchAssistant',
  bio: [
    'Answers questions using current web sources.',
    'Summarizes links into concise, cited responses.',
  ],
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
  settings: {
    secrets: {
      OLOSTEP_API_KEY: process.env.OLOSTEP_API_KEY!,
    },
  },
};

​
News Monitor

An agent that tracks timely topics and reports notable updates: 
import type { Character } from '@elizaos/core';

export const character: Character = {
  name: 'NewsMonitor',
  bio: ['Tracks timely topics and reports notable updates from the web.'],
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
  style: {
    all: ['Prefer current sources and include direct URLs when possible.'],
  },
};
Use this for alerts, market watch tasks, trend research, and other time-sensitive workflows.

​
Support Agent with Search Fallback

Perfect for answering customer questions with product documentation lookup: 
import type { Character } from '@elizaos/core';

export const character: Character = {
  name: 'SupportAgent',
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
  topics: [
    'product support',
    'documentation lookup',
    'release notes search',
  ],
};
This pattern works well when your agent should search docs or product pages before answering a customer question.

​
Configuration

​
Enable the plugin

Add @olostep/plugin-elizaos-olostep to the plugins array in your character config. Remove the plugin from the character config if you want an Eliza agent that does not have Olostep search access.

​
Use only some capabilities

This plugin exposes a single action, so there is no per-tool toggle. Control behavior through:
  • Which plugins you load in the character config
  • The agent instructions and style
  • When your runtime injects OLOSTEP_API_KEY

​
Specialized Features

  • Direct /searches endpoint access — the plugin calls Olostep directly with fetch.
  • Result deduplication — duplicate URLs are removed before the response is returned.
  • Friendly fallbacks — the action returns clear errors when the API key is missing or the query is empty.
  • Top-result limiting — responses are trimmed to the five most relevant links.

​
Pricing

Pricing for search usage depends on your Olostep plan and dashboard settings.
  • Check your Olostep dashboard for current usage and billing details.
  • Review your account limits before deploying high-volume agents.

​
Support

Search API

Learn how the search endpoint returns web results

Batches API

Queue searches and other jobs for larger workflows

Answers API

Generate answer-style outputs from retrieved web sources

Crawls API

Explore deeper site collection and crawling workflows

Python SDK

Use the Python SDK for custom automation around Olostep

Node.js SDK

Build JavaScript integrations and agent workflows