---
canonical_url: "https://docs.composio.dev/toolkits/search1api"
markdown_url: "https://docs.composio.dev/toolkits/search1api.md"
product: "platform"
version: null
last_updated: null
---

# Search1API

Search1API provides web, maps, and news search alongside crawling, screenshots, sitemap discovery, and structured data extraction for AI agents.

- **Category:** ai web scraping
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 14
- **Triggers:** 0
- **Slug:** `SEARCH1API`
- **Version:** 00000000_00

## Tools

### Ask Research

**Slug:** `SEARCH1API_ASK_RESEARCH`

Run a natural-language research query across up to five provider-selected engines and return at most 10 deduplicated, reranked results plus partial source errors. Warning: each completed call costs 5 credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Natural-language research request for Search1API to interpret and route. Platform and time hints can steer source and time-window selection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Crawl URLs

**Slug:** `SEARCH1API_CRAWL_URLS`

Fetch readable content from one or more public URLs. Search1API charges 1 credit for each successful item; a target 404 or 410 is a completed, charged lookup. Batch successes may be unordered, and failed items may be omitted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requests` | array | Yes | URLs to crawl. Use one item for one URL. Search1API charges 1 credit for each successful item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Discover Sitemap

**Slug:** `SEARCH1API_DISCOVER_SITEMAP`

Discover sitemap URLs for a public site, or list all links on one public page without fetching page content. Warning: each completed call costs 1 Search1API credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTP(S) site or page URL from which to discover links. |
| `type` | string ("sitemap" | "all") | No | Discovery mode. sitemap follows declared or conventional sitemaps and falls back to page links; all lists links only from the supplied page, including external hosts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Extract Structured Data

**Slug:** `SEARCH1API_EXTRACT_STRUCTURED_DATA`

Extract caller-defined structured data from one public webpage using an optional prompt and JSON response shape. Warning: each completed call costs 10 Search1API credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTP(S) webpage URL from which to extract data. |
| `prompt` | string | No | Optional natural-language instructions describing the data to extract. |
| `response_format` | object | No | Optional caller-supplied JSON Schema or result shape. Arbitrary object properties are supported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deepcrawl Status

**Slug:** `SEARCH1API_GET_DEEPCRAWL_STATUS`

Get the current state of a deepcrawl task and its packaged result URL when available. Status checks are free; this tool performs one check and does not poll automatically or fetch the result package.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Task ID returned by Start Deepcrawl. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Health

**Slug:** `SEARCH1API_GET_HEALTH`

Read Search1API's free, unauthenticated provider serving/readiness status. This endpoint does not validate the configured API key; use GET_USAGE for credential checks.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trending

**Slug:** `SEARCH1API_GET_TRENDING`

Return a platform's current live trending feed. Currently documented platform identifiers are github and hackernews; additional provider-supported identifiers are accepted. A successfully completed call costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `max_results` | integer | No | Optional maximum number of results to return. |
| `search_service` | string | Yes | Platform identifier whose live trending feed to retrieve. Currently documented identifiers are github and hackernews; the provider schema also permits additional non-empty identifiers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage

**Slug:** `SEARCH1API_GET_USAGE`

Return the connected account's remaining Search1API credits and credential metadata. This call is free. The optional period is forwarded as documented, but the returned balance is not period consumption.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string ("day" | "week" | "month" | "year") | No | Optional period accepted by Search1API. The returned balance is the current remaining credits, not credits consumed during this period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Maps

**Slug:** `SEARCH1API_SEARCH_MAPS`

Search one Google Maps results page for businesses or places. Each completed page costs 3 Search1API credits, including an empty page; max_results only truncates the response and does not lower the charge.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Maps results page to fetch. Pages after 1 require location coordinates. |
| `query` | string | Yes | Place, business, category, or location query. |
| `country` | string | No | Two-letter country code used to localize Maps results. |
| `language` | string | No | Result language code, optionally with a region or script suffix. |
| `location` | object | No | Map center coordinates and zoom. Required when page is greater than 1. |
| `max_results` | integer | No | Maximum places returned from this page. Reducing this value does not reduce the 3-credit charge for a completed page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search News

**Slug:** `SEARCH1API_SEARCH_NEWS`

Search recent news for one or more queries with source, site, language, and time filters, returning a typed outcome for each. Each query has a base cost of 1 credit plus 1 credit for each article page successfully fetched through crawl_results. News has no page field and this tool does not auto-paginate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requests` | array | Yes | One or more news search queries. Each item is billed at a base cost of 1 credit plus 1 credit for each article page successfully fetched through crawl_results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Web

**Slug:** `SEARCH1API_SEARCH_WEB`

Search the web for one or more queries and return a typed outcome for each. Each query has a base cost of 1 credit plus 1 credit for each result page successfully fetched through crawl_results. The page field selects one native provider page only for Bing, Bing China, Baidu, and Grokipedia; this tool does not auto-paginate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requests` | array | Yes | One or more web search queries. Each item is billed at a base cost of 1 credit plus 1 credit for each result page successfully fetched through crawl_results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Deepcrawl

**Slug:** `SEARCH1API_START_DEEPCRAWL`

Start an asynchronous multi-page crawl of a public site and return its task ID. WARNING: each submission creates server-side work and costs 20 Search1API credits. The native API exposes no maximum depth, page or result limit, path filter, or timeout control.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTP(S) site URL to crawl asynchronously. Submitting this request creates a task and costs 20 Search1API credits. |
| `type` | string ("sitemap" | "all") | No | Optional discovery mode. Omit this field to use provider behavior; the native contract does not assert a default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Feedback

**Slug:** `SEARCH1API_SUBMIT_FEEDBACK`

Create external feedback for Search1API about a problem, missing capability, or confusing documentation encountered during a task. Use this tool only when the user explicitly asks to contact Search1API or submit provider feedback. WARNING: this irreversibly stores a non-idempotent external report with the provider and has no retraction endpoint. Never include credentials, PII, or private user content. Do not report every empty result, do not retry the same report automatically, and never let feedback block the primary task. The call is free and limited to 10 submissions per account per minute at a Cloudflare location.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent` | object | No | Optional agent identification. Include only non-sensitive agent name or model metadata, never credentials, PII, or private user content. |
| `intent` | string | No | Optional task intent that helps Search1API understand the feedback context (maximum 2000 characters). Exclude credentials, PII, and private user content. |
| `message` | string | Yes | Feedback message sent to and stored by Search1API (1-4000 characters). This creates external provider feedback and is non-idempotent. Do not include credentials, PII, or private user content. Do not report every empty result, and do not let feedback block the primary task. |
| `category` | string ("bug" | "feature_request" | "docs" | "other") | No | Feedback category. Defaults to other. Submitting any category creates a non-idempotent external provider report. |
| `request_id` | string | No | Optional Search1API request ID for the original problem request (maximum 256 characters). Do not substitute credentials or private content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Take Screenshot

**Slug:** `SEARCH1API_TAKE_SCREENSHOT`

Render a public webpage as a PNG, JPEG, or WebP file with viewport, readiness, selector, and appearance controls. A successful screenshot costs 2 Search1API credits; failed requests are not charged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTP(S) webpage URL without embedded credentials. |
| `format` | string ("png" | "jpeg" | "webp") | No | Output image format. |
| `quality` | integer | No | Optional quality for lossy JPEG or WebP output. |
| `delay_ms` | integer | No | Additional delay in milliseconds after readiness conditions are met. |
| `selector` | string | No | Optional CSS selector for an element-only capture; cannot be combined with full_page=true. |
| `viewport` | object | No | Browser viewport dimensions and device scale factor. |
| `full_page` | boolean | No | Capture the full scrollable page instead of only the viewport; cannot be combined with selector. |
| `animations` | string ("disabled" | "allow") | No | Whether page animations remain enabled during capture. |
| `timeout_ms` | integer | No | Maximum provider-side capture time in milliseconds. |
| `wait_until` | string ("domcontentloaded" | "load" | "networkidle") | No | Page readiness event to wait for before capture. |
| `color_scheme` | string ("light" | "dark") | No | Preferred page color scheme during rendering. |
| `omit_background` | boolean | No | Whether to omit the default page background when the output format supports transparency. |
| `wait_for_selector` | string | No | Optional CSS selector that must appear before capture. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |