# Olostep Docs

## Docs

- [Create Answer](https://docs.olostep.com/api-reference/answers/create.md): The AI will perform actions like searching and browsing web pages to find the answer to the provided task. Execution time is 3-30s depending upon complexity.
- [Get Answer](https://docs.olostep.com/api-reference/answers/get.md): This endpoint retrieves a previously completed answer by its ID.
- [Create Batch](https://docs.olostep.com/api-reference/batches/create.md): Starts a new batch. You receive an `id` that you can use to track the progress of the batch as shown [here](/api-reference/batches/info). Note: Processing time is constant regardless of batch size
- [Batch Info](https://docs.olostep.com/api-reference/batches/info.md): Retrieves the status and progress information about a batch. To retrieve the content for a batch, see [here](/api-reference/batches/items)
- [Batch Items](https://docs.olostep.com/api-reference/batches/items.md): Retrieves the list of items processed for a batch. You can then use the `retrieve_id` to get the content with the Retrieve Endpoint
- [Update Batch](https://docs.olostep.com/api-reference/batches/update.md): Updates the metadata for a specific batch. Only metadata can be updated after batch creation.
- [Metadata](https://docs.olostep.com/api-reference/common/metadata.md): Attach custom key-value pairs to API resources
- [Object-Oriented API](https://docs.olostep.com/api-reference/common/object-oriented.md): Understanding how Olostep API objects work together
- [Webhooks](https://docs.olostep.com/api-reference/common/webhooks.md): Receive real-time notifications when async operations complete
- [Create Crawl](https://docs.olostep.com/api-reference/crawls/create.md): Starts a new crawl. You receive a `id` to track the progress. The operation may take 1-10 mins depending upon the site and depth and pages parameters.
- [Crawl Info](https://docs.olostep.com/api-reference/crawls/info.md): Fetches information about a specific crawl.
- [Crawl Pages](https://docs.olostep.com/api-reference/crawls/pages.md): Fetches the list of pages for a specific crawl.
- [Complete File Upload](https://docs.olostep.com/api-reference/files/complete.md): Complete the file upload process and validate the uploaded JSON file. This endpoint verifies the file exists, validates its JSON format, and updates the file status to completed.
- [Get File Content](https://docs.olostep.com/api-reference/files/content.md): Download the content of a completed file. Returns the JSON file content.
- [Create File Upload](https://docs.olostep.com/api-reference/files/create.md): Generate a pre-signed URL for uploading a JSON file. After uploading, you must call the [complete endpoint](/api-reference/files/complete) to finalize the upload.
- [Delete File](https://docs.olostep.com/api-reference/files/delete.md): Delete a file and its associated data from storage.
- [Get File](https://docs.olostep.com/api-reference/files/get.md): Retrieve metadata for a file by its ID.
- [List Files](https://docs.olostep.com/api-reference/files/list.md): List all completed files for your team. Optionally filter by purpose.
- [Create Map](https://docs.olostep.com/api-reference/maps/create.md): This endpoint allows users to get all the urls on a certain website.  It can take up to 120 seconds for complex websites. For large websites, results are paginated using cursor-based pagination
- [Get Map](https://docs.olostep.com/api-reference/maps/get.md): Retrieve a previously completed map by its ID.
- [Retrieve Content](https://docs.olostep.com/api-reference/retrieve.md): Retrieve content of processed batches and crawls urls.
- [Create Schedule](https://docs.olostep.com/api-reference/schedules/create.md): Creates a new schedule to execute API calls at specified times. Supports both one-time executions and recurring schedules using cron expressions. You can also use natural language text to generate cron expressions automatically.
- [Delete Schedule](https://docs.olostep.com/api-reference/schedules/delete.md): Deletes a schedule by its ID. This will stop any future executions and remove the schedule from EventBridge.
- [Get Schedule](https://docs.olostep.com/api-reference/schedules/get.md): Retrieves a single schedule by its ID.
- [List Schedules](https://docs.olostep.com/api-reference/schedules/list.md): Retrieves all schedules for your team. Returns a list of schedules with their configuration, status, and metadata.
- [Create Scrape](https://docs.olostep.com/api-reference/scrapes/create.md): [Scrape](https://docs.olostep.com/features/scrapes) a url with provided configuration and get content.
- [Get Scrape](https://docs.olostep.com/api-reference/scrapes/get.md): Can be used to retrieve response for a scrape.
- [Create Search](https://docs.olostep.com/api-reference/searches/create.md): Search the web with a natural language query and get back a deduplicated list of relevant links with titles and descriptions.
- [Get Search](https://docs.olostep.com/api-reference/searches/get.md): Retrieve a previously completed search by its ID.
- [Get the content of multiple websites in one go](https://docs.olostep.com/examples/batch.md): Start a batch scrape to extract content from up to 100k URLs in 5-7 mins
- [Crawl and Extract Content from Stripe's Blog Pages](https://docs.olostep.com/examples/crawl-matching-pages.md): Learn how to crawl and extract content from Stripe's blog posts.
- [Extract Blog URLs from Stripe's Website](https://docs.olostep.com/examples/extract-specific-paths.md): Filter and extract only the blog URLs from Stripe's website for targeted content analysis.
- [Fetch data from popular AI search tools](https://docs.olostep.com/examples/geo.md): Extract structured data from AI-powered search engines using batch requests
- [Get the Markdown of a Website](https://docs.olostep.com/examples/get-markdown-from-website.md): Learn how to extract content as LLM-friendly markdown from any web page.
- [Extract All URLs from Stripe's Website](https://docs.olostep.com/examples/get-website-structure.md): Get a complete map of Stripe's website structure to understand its organization and discover available content.
- [Get Google Maps Results](https://docs.olostep.com/examples/google-maps.md): SERP API to scrape Google Maps location data using Olostep and a Python code snippet.
- [Get Google Search Results (JS)](https://docs.olostep.com/examples/google-search-js.md): SERP API to scrape Google search results using Olostep and a Javascript code snippet.
- [Price Tracking with Olostep](https://docs.olostep.com/examples/price-monitoring.md): Learn how to use Olostep to track product prices at scale on an e-commerce.
- [Get Google Search Results (python)](https://docs.olostep.com/examples/serp.md): SERP API to scrape Google search results using Olostep and a Python code snippet.
- [Agents API](https://docs.olostep.com/features/agents.md)
- [Answers API](https://docs.olostep.com/features/answers.md)
- [Batch Endpoint](https://docs.olostep.com/features/batches.md)
- [Crawl](https://docs.olostep.com/features/crawls.md): Crawl a URL and get the content from all subpages
- [Files](https://docs.olostep.com/features/files.md): Upload and manage JSON files for use as context in API requests
- [Maps](https://docs.olostep.com/features/maps.md): Get all the URLs on a website.
- [Schedules](https://docs.olostep.com/features/schedules.md): Schedule API calls to run automatically at specified times
- [Scrape](https://docs.olostep.com/features/scrapes.md): Turn any url into clean data
- [Search API](https://docs.olostep.com/features/search.md)
- [Skills](https://docs.olostep.com/features/skills.md): Install and manage Olostep skills in your AI coding agents
- [Introduction](https://docs.olostep.com/features/structured-content/intro.md)
- [Using LLM Extraction](https://docs.olostep.com/features/structured-content/llm-extraction.md)
- [Using Parsers](https://docs.olostep.com/features/structured-content/parsers.md)
- [Authentication](https://docs.olostep.com/get-started/authentication.md)
- [Welcome to Olostep](https://docs.olostep.com/get-started/welcome.md): Olostep is the Web Data API for AI and Research Agents.
- [Olostep + Apify Integration](https://docs.olostep.com/integrations/apify.md): Automate web search, scraping and crawling with Apify Actors using Olostep — the API to search, extract and structure web data.
- [Olostep + OpenClaw Integration](https://docs.olostep.com/integrations/clawhub.md): Give your OpenClaw agent live web access with 13 skills and a 9-tool MCP server
- [Olostep + Kilo Integration](https://docs.olostep.com/integrations/kilo.md): Use Olostep MCP Server as an external tool in Kilo for web search, scraping, and content extraction
- [Olostep + LangChain Integration](https://docs.olostep.com/integrations/langchain.md): Build intelligent AI agents with web scraping and search capabilities using LangChain
- [Olostep + Mastra Integration](https://docs.olostep.com/integrations/mastra.md): Build AI agents with web search, scraping and crawling capabilities using Mastra.ai's agent framework
- [MCP Server](https://docs.olostep.com/integrations/mcp-server.md): Use Olostep through the Model Context Protocol for fast, efficient web data
- [Olostep + n8n](https://docs.olostep.com/integrations/n8n.md): Add web scraping, search, batch jobs, crawls, and site maps to any n8n workflow, no code required.
- [Olostep + Relay](https://docs.olostep.com/integrations/relay.md): Add web scraping, AI-powered research, batch jobs, crawls, and site maps to any Relay workflow, no code required.
- [Olostep + ViaSocket](https://docs.olostep.com/integrations/viasocket.md): Connect Olostep to any AI client — Claude, Cursor, ChatGPT, and more — using ViaSocket Mushrooms as an MCP gateway.
- [Olostep + Zapier](https://docs.olostep.com/integrations/zapier.md): Add web scraping, AI-powered research, batch jobs, crawls, and site maps to any Zap, no code required.
- [Olostep CLI](https://docs.olostep.com/sdks/cli.md): Command-line interface for map, scrape, crawl, batches, and answers: JSON output for scripts, CI, and agents
- [Olostep NodeJS SDK](https://docs.olostep.com/sdks/node-js.md): Official NodeJS SDK to search, extract and structure data from the Web
- [Overview](https://docs.olostep.com/sdks/overview.md)
- [Olostep Python SDK](https://docs.olostep.com/sdks/python.md): Official Python SDK to search, extract and structure data from the Web
- [Pay-per-use (x402)](https://docs.olostep.com/x402.md): Pay-per-use API endpoints with stablecoins

## OpenAPI Specs

- [utility](https://docs.olostep.com/openapi/utility.json)
- [search](https://docs.olostep.com/openapi/search.json)
- [scrapes](https://docs.olostep.com/openapi/scrapes.json)
- [schedules](https://docs.olostep.com/openapi/schedules.json)
- [partnerships](https://docs.olostep.com/openapi/partnerships.json)
- [maps](https://docs.olostep.com/openapi/maps.json)
- [files](https://docs.olostep.com/openapi/files.json)
- [crawls](https://docs.olostep.com/openapi/crawls.json)
- [builder](https://docs.olostep.com/openapi/builder.json)
- [batches](https://docs.olostep.com/openapi/batches.json)
- [answers](https://docs.olostep.com/openapi/answers.json)
- [airops-batches](https://docs.olostep.com/openapi/airops-batches.json)

## Optional

- [Playground](https://www.olostep.com/playground)
- [Join Community](https://olostep-users.slack.com/join/shared_invite/zt-2bfddyi8h-JzfjOgavg~98DJ1om1B5Lg#/shared-invite/email)