generateText of streamText en het model beslist wanneer te zoeken, scrapen of crawlen.
Installeer van npm →
Functies
Het pakket biedt 6 tools:Scrape
Scrape elke URL en retourneer schone markdown, met JavaScript-rendering
Search
Doorzoek het live web en retourneer titels, URL’s en beschrijvingen
Answer
Beantwoord een vraag van het live web, met bron-URL’s
Map
Lijst de URL’s op een website, optioneel gerangschikt op een query
Crawl
Crawl een site vanaf een start-URL en retourneer de markdown van elke pagina
Batch
Scrape een lijst van URL’s in één batch en retourneer de markdown van elk
Installatie
Setup
Stel je Olostep API-sleutel in als een omgevingsvariabele:.env bestand:
Snelle Start
Geef alle Olostep-tools door aan het model metolostepTools():
stopWhen laat het model tools over meerdere stappen aanroepen, bijvoorbeeld eerst zoeken en dan het beste resultaat scrapen. De modelstring gebruikt de Vercel AI Gateway. Je kunt ook elk AI SDK-provider model doorgeven, zoals openai('gpt-5-mini') van @ai-sdk/openai.
Kies Individuele Tools
Geef het model alleen de tools die het nodig heeft:Beschikbare Tools
De toolnamen hieronder zijn de sleutels die worden gebruikt doorolostepTools().
scrape
olostepScrape(). Scrape een enkele URL en retourneer de inhoud als markdown.
Input:
string
vereist
De URL van de pagina om te scrapen
number
Milliseconden wachten voor JavaScript-zware pagina’s om te renderen (0 tot 10000)
{ url, markdown }
search
olostepSearch(). Doorzoek het live web.
Input:
string
vereist
De zoekopdracht
number
standaard:"10"
Maximum aantal resultaten (1 tot 20)
{ query, results: [{ title, url, description }] }
answer
olostepAnswer(). Zoek en lees het live web om een vraag te beantwoorden, met bronnen.
Input:
string
vereist
De vraag of onderzoekstaak
{ answer, sources }
map
olostepMap(). Ontdek de URL’s op een website.
Input:
string
vereist
De website om in kaart te brengen
string
Rangschik URL’s op relevantie voor deze query
number
Maximum aantal URL’s om te retourneren (1 tot 500)
{ url, urls }
crawl
olostepCrawl(). Crawl een website vanaf een start-URL en retourneer de markdown van elke pagina. De tool wacht tot de crawl is voltooid voordat hij retourneert.
Input:
string
vereist
De URL om mee te beginnen met crawlen
number
standaard:"5"
Maximum aantal pagina’s om te crawlen (1 tot 25)
array
Alleen URL’s crawlen die overeenkomen met deze glob-patronen, bijv.
["/docs/**"]{ url, pages: [{ url, markdown }] }
batch
olostepBatch(). Scrape een lijst van URL’s in één batch en retourneer de markdown van elke pagina. De tool wacht tot de batch is voltooid voordat hij retourneert.
Input:
array
vereist
De URL’s om te scrapen (1 tot 20)
{ pages: [{ url, markdown }] }
De crawl- en batchtools zijn beperkt tot 25 pagina’s en 20 URL’s per oproep om de toolresultaten klein genoeg te houden voor het model. Voor grotere taken, roep de Crawls en Batches API’s direct aan met de Node.js SDK.
Opties
Elke tool, enolostepTools(), accepteert dezelfde opties:
string
Olostep API-sleutel. Standaard ingesteld op de
OLOSTEP_API_KEY omgevingsvariabele.number
standaard:"20000"
Maximum aantal tekens van pagina-inhoud geretourneerd aan het model per pagina. Langere pagina’s worden ingekort.
number
standaard:"300"
Hoe lang de crawl- en batchtools wachten tot de taak is voltooid, in seconden.
Streaming Voorbeeld
Gebruik dezelfde tools metstreamText, bijvoorbeeld in een Next.js route handler:
app/api/chat/route.ts
Populaire Gebruiksscenario’s
Onderzoeksassistent
Onderzoeksassistent
- Het model gebruikt
searchofanswerom bronnen te vinden - Het gebruikt
scrapeom de meest relevante pagina’s te lezen - Het retourneert een samenvatting met bron-URL’s
Docs-bewuste Codeeragent
Docs-bewuste Codeeragent
- Het model gebruikt
mapmet eensearchQueryom de juiste documentatiepagina’s te vinden - Het gebruikt
batchofcrawlom ze te lezen - Het schrijft code tegen de huidige API in plaats van te gokken
Concurrentie- en Prijsbewaking
Concurrentie- en Prijsbewaking
- Een geplande taak roept
generateTextaan metscrapeenbatch - Het model extraheert prijzen of wijzigingen van elke pagina
- Je code vergelijkt ze met de laatste run en stuurt waarschuwingen
Beste Praktijken
Geef Alleen de Nodige Tools Door
Geef Alleen de Nodige Tools Door
De beschrijving van elke tool wordt naar het model gestuurd. Minder tools betekent minder tokens en minder verkeerde toolkeuzes. Voor een chat die alleen pagina’s leest, zijn
scrape en search vaak voldoende.Stel een Stappenlimiet In
Stel een Stappenlimiet In
Stel altijd
stopWhen in (bijvoorbeeld stepCountIs(5)) zodat het model tooloproepen kan ketenen maar niet eindeloos kan blijven herhalen.Verlaag maxCharacters voor Lange Pagina's
Verlaag maxCharacters voor Lange Pagina's
Paginainhoud is het grootste deel van de tokenrekening. Als je veel pagina’s crawlt of batcht, verlaag
maxCharacters zodat alle resultaten in het contextvenster van het model passen.Verhoog timeoutSeconds voor Grote Crawls
Verhoog timeoutSeconds voor Grote Crawls
Crawl- en batchtools wachten tot de taak is voltooid. Als je time-outs tegenkomt, verhoog
timeoutSeconds, of verlaag maxPages.Problemen Oplossen
Authenticatie Mislukt
Authenticatie Mislukt
Fout: “Ongeldige API-sleutel”Oplossingen:
- Controleer je API-sleutel in het dashboard
- Zorg ervoor dat
OLOSTEP_API_KEYis ingesteld waar je code draait (bijvoorbeeld in de omgevingsvariabelen van je Vercel-project) - Of geef de sleutel direct door met
olostepTools({ apiKey })
Het Model Roept de Tools Niet Aan
Het Model Roept de Tools Niet Aan
Oplossingen:
- Stel
stopWhenin, anders stopt de generatie na de eerste stap - Gebruik een model dat toolaanroepen ondersteunt
- Noem het web in je prompt of systeembericht, bijvoorbeeld “gebruik de webtools en citeer je bronnen”
Crawl of Batch Loopt Vast
Crawl of Batch Loopt Vast
Oplossingen:
- Verhoog
timeoutSeconds - Verlaag
maxPagesof geef minder URL’s door - Zorg ervoor dat de eigen tijdslimiet van de serverloze functie langer is dan
timeoutSeconds
Contextlengte Overschreden
Contextlengte Overschreden
Oplossingen:
- Verlaag
maxCharacters - Gebruik
mapmetsearchQueryom minder, relevantere pagina’s te kiezen voordat je ze leest
Prijzen
Olostep rekent kosten op basis van API-gebruik, onafhankelijk van de AI SDK:- Scrapes: Betaal per scrape
- Zoeken en Antwoorden: Betaal per verzoek
- Batches: Betaal per URL in batch
- Crawls: Betaal per gecrawlde pagina
- Maps: Betaal per kaartoperatie
Ondersteuning
GitHub
Broncode en problemen
Ondersteuning Email
Email: info@olostep.com
AI SDK Docs
Leer over de Vercel AI SDK
Documentatie
Blader door de volledige API-documentatie
Gerelateerde Bronnen
Scrapes API
Leer over het Scrapes eindpunt
Crawls API
Leer over het Crawls eindpunt
Mastra Integratie
Bouw agenten met Mastra
LangChain Integratie
Bouw AI-agenten met LangChain