Skip to main content
Olostep logo
  • Category: web scraping & browser
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: OLOSTEP
  • Version: 20261101_00

Tools

Slug: OLOSTEP_ANSWER_QUESTIONSynchronously research a bounded task by searching and browsing the web, then return the completed answer and sources when available. This usage-metered operation usually takes 3-30 seconds and has no documented fixed dashboard-key credit price; check the account balance before expensive use.

Input Parameters

string
required
Question or bounded research task to answer by searching and browsing the web.
string
Desired structured output. Provide either an example JSON object with empty values or a textual description of the required data shape.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_CREATE_MONITORCreate a scheduled page or web-query monitor for asynchronous provisioning, with optional alert channels and a separate webhook. The schedule defaults to every hour.

Input Parameters

string
required
Natural-language description of what to monitor.
object
Webhook delivery configuration, separate from notification channels.
object
User-controlled metadata object attached to the monitor.
string
Natural-language UTC schedule, up to 50 characters. Defaults to every hour; the minimum supported interval is every 10 minutes.
object
Events and email, Slack, or SMS channels used for notifications.
object
JSON Schema object for structured values extracted by each monitor run.
object
Optional URL and domain allow or deny lists for monitor sources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_GET_CREDIT_BALANCEReturn the connected team’s remaining Olostep credits, credit lots, active subscription, and whether usage is enabled without consuming web-processing credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_GET_OPERATION_RESULTRetrieve a stored scrape, search, map, answer, crawl, or batch by its operation ID without repeating or rebilling the original work. Crawl and batch results may still report in_progress.

Input Parameters

string
required
ID returned when the selected operation was created, such as scrape_…, search_…, map_…, an answer ID, a crawl ID, or a batch ID.
string ("scrape" | "search" | "map" | "answer" | "crawl" | "batch")
required
Kind of stored Olostep operation whose result should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_LIST_BATCH_ITEMSReturn one page of completed or failed items from an asynchronous batch, including retrieve IDs, URLs, metadata, and extracted links.

Input Parameters

integer
Maximum batch items to return in this page. Olostep recommends 10-50; smaller or larger positive values are accepted by the documented API.
string ("completed" | "failed")
Return only completed or failed batch items.
string
required
Batch ID returned by Start Batch.
string
Opaque continuation cursor from a previous response; omit on the first call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_LIST_CRAWL_PAGESReturn one page of URLs and retrieve IDs processed by an asynchronous crawl, with a continuation cursor for additional pages. Use Retrieve Content for page bodies.

Input Parameters

integer
Maximum crawl-page records to return in this response (1-50), subject to the provider’s 10 MB response cap.
string
required
Crawl ID returned by Start Crawl.
string
Opaque continuation cursor from a previous response; omit on the first call.
string
Optional query used to order returned pages by relevance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_LIST_MONITOR_EVENTSReturn one page of a monitor’s snapshot events, including change summaries and short-lived snapshot links.

Input Parameters

integer
Maximum monitor events to return in this page (1-100).
string
required
Monitor ID whose snapshot events should be listed.
string
Opaque continuation cursor from a previous response; omit on the first call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_LIST_MONITORSList the account’s page and web-query monitors, including their IDs, lifecycle status, schedules, tracked targets, and notification settings.

Input Parameters

boolean
Whether to include deleted monitors; omit to exclude deleted records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_MAP_WEBSITESynchronously discover and optionally rank URLs on a website, returning one response page and a continuation cursor. This usage-metered operation consumes Olostep credits.

Input Parameters

string
required
Website URL whose links should be discovered.
integer
Maximum number of top-ranked links to return when search_query is provided.
string
Continuation cursor returned by a previous call; omit on the first call.
array
URL-path glob patterns to exclude; exclusions override inclusions.
array
URL-path glob patterns to include, such as /blog/**.
string
Optional query used to rank discovered links by relevance.
boolean
Whether to include URLs on subdomains of the supplied website.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_RETRIEVE_CONTENTRetrieve stored page content by retrieve ID in selected live-supported formats, including hosted URLs for oversized output.

Input Parameters

array
Stored formats to return. Supported values are markdown, html, and json. Omit to return all available stored formats, including any screenshot or network-call artifacts captured at scrape time.
string
required
Content ID returned by a scrape, batch item, or crawl page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_SCRAPE_PAGESynchronously scrape one web page and return requested content, links, metadata, a retrieve ID, and billing usage. This usage-metered operation can consume credits even when cached content is returned. Fresh scrapes, browser actions, extraction, and screenshots may cost more.

Input Parameters

string
required
Public URL of the single page to scrape.
array
Browser actions to perform in order before collecting content.
string ("US" | "CA" | "IT" | "IN" | "GB" | "JP" | "MX" | "AU" | "ID" | "UA" | "RU" | "RANDOM")
Residential country from which to load the page, or RANDOM.
array
Content formats to return for this scrape.
integer
Maximum acceptable cached-result age in seconds. Zero forces a fresh scrape; 604800 permits a result up to seven days old. Cached results can still consume credits.
string
Parser ID for structured JSON extraction; include json in formats when using it.
string ("postlight" | "none")
HTML cleanup transformer to apply.
Options for extracting and filtering links on the page.
object
Desired object schema for LLM-based structured extraction.
string
CSS removal setting: use default, none, or a JSON-stringified array of CSS selectors.
boolean
When screenshot format is requested, capture the full page after scrolling to the bottom.
integer
Milliseconds to wait after loading before collecting content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_SEARCH_WEBSynchronously search the web for relevant deduplicated links. This usage-metered operation costs 5 base credits per search; supplying scrape_formats also charges for scraping each returned page. The response reports credits_consumed when available.

Input Parameters

integer
Maximum number of deduplicated links to return, from 1 to 25.
string
required
Natural-language web search query.
boolean
Use the query verbatim for lower latency instead of the broader default search pass.
array
Scrape every returned link in these formats. Omit this field to avoid per-page scrape charges.
integer
Wall-clock seconds allowed for optional per-link scraping. Unfinished link content may be null.
array
Bare domains to exclude from results.
array
Bare domains to restrict results to. Olostep strips URL schemes and trailing slashes.
string
For optional link scraping, use ‘default’, ‘none’, or a JSON-stringified array of CSS selectors to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_SET_MONITOR_STATEPause future scheduled runs of an active monitor or resume scheduled runs of a paused monitor. Returns the updated monitor.

Input Parameters

string ("pause" | "resume")
required
Desired monitor schedule state: pause future runs or resume them.
string
required
ID of the Olostep monitor to pause or resume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_START_BATCHStart an asynchronous, usage-metered scrape of 1 to 10,000 URLs and return the batch ID and initial status. This action does not wait for completion; use Get Operation Result to monitor the batch and List Batch Items to consume results.

Input Parameters

array
required
Pages to scrape asynchronously, from 1 to 10,000 items.
object
Parser configuration applied to every item in the batch.
string
ISO 3166-1 alpha-2 country code used for batch execution.
string
Public HTTP(S) URL that receives a POST when the batch completes.
object
Batch-level metadata. Supports at most 50 keys; keys are at most 40 characters without square brackets, and values are stringified scalars of at most 500 characters.
Link extraction filters applied to every item in the batch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_START_CRAWLStart an asynchronous, usage-metered website crawl and immediately return its crawl ID and initial status. This action does not poll: use Get Operation Result to monitor status and List Crawl Pages to consume output. Work may continue for 1-10 minutes and can consume credits for up to max_pages pages.

Input Parameters

integer
With search_query, crawl only the top N relevant links found on each page.
string
Parser name placed in scrape_options.parser for every page. Olostep automatically adds json output when a parser is supplied.
array
Per-page output formats placed in scrape_options.formats. HTML is always included automatically; raw_pdf is not supported for crawls.
integer
Stop background work after this many seconds and retain completed pages. Olostep may take about 10 additional seconds to stop.
string
Public HTTP(S) URL that Olostep should notify when the crawl completes.
integer
Maximum link depth from start_url; 0 processes only the starting page.
integer
required
Maximum pages to process, from 1 to 100. This required integration bound limits usage-metered work; choose the smallest value that satisfies the task.
string
required
Public HTTP(S) website URL where the crawl begins.
array
URL-path glob patterns to exclude. Exclusions override include_urls.
array
URL-path glob patterns eligible for crawling.
string
Query used to find and rank relevant links during the crawl.
boolean
Also crawl first-degree links to external sites, which may increase usage.
boolean
Respect robots.txt restrictions. Disable only when authorized to do so.
boolean
Include pages on subdomains of start_url.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OLOSTEP_UPDATE_MONITORUpdate a monitor’s schedule, metadata, notification configuration, or webhook. Pass webhook as null to explicitly remove webhook delivery.

Input Parameters

object
Replacement webhook delivery configuration. Pass null explicitly to remove the existing webhook; omit this field to leave it unchanged.
object
Metadata keys to merge into the monitor. Use an empty string value to delete an existing key.
string
New natural-language UTC schedule. Changing it recreates the monitor’s underlying schedule.
string
required
Unique ID of the monitor to update.
object
Replacement notification events and email, Slack, or SMS channels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not