> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Use RapidAPI in Deepline

> Prefer the typed listing tools (rapidapi_google_web_search, rapidapi_google_image_search). Includes inputs, outputs, SDK V2 examples, and Deepline cost.

[Human guide: work with your agent →](https://deepline.com/docs/human/providers/rapidapi/guide.md)
Inspect one RapidAPI action before starting provider-backed work. Your first result is a verified input and output contract.

## Provider-specific requirements

Use RapidAPI when a registered listing covers the required data. Deepline uses a managed key for its subscribed listings. Each listing has separate plan limits. Only listings registered in Deepline are available.

* Prefer the typed listing tools first: `rapidapi_google_web_search` for Google organic results and `rapidapi_google_image_search` for Google Images. They validate inputs, unwrap the listing's response envelope, and publish an exact per-page price.
* Use `rapidapi_list_listings` (free) when you do not know which listings or endpoints exist. It returns each listing's host, documented endpoints, required inputs, and the typed tool for each endpoint.
* Use `rapidapi_request` only for an endpoint on a registered listing that has no typed tool yet. Pass the listing `host` (or slug), the `path`, and `query` or `body`. Hosts that are not registered are rejected before any call because Deepline cannot price them. ask the Deepline team to register a listing you need.
* Each page incurs request usage. Start with `pages: 1`. Increase it only when the workflow requires more results. A larger `pages` value retrieves and bills earlier pages again.
* An empty result set from a search listing is a completed search, not an error, and it is still billed. Do not retry it automatically.
* `billed_requests` in every result is the count the listing reported in its `X-RapidAPI-Billing` header. Deepline settles the call from that count. when the header is absent it charges the requested count.
* Upstream 401 means the RapidAPI key is not subscribed to that listing. 404 and 410 come back as `ok: false` with the upstream body so you can inspect them. 429 and 5xx stay loud so the shared retry policy applies.
* Deepline paces calls to the smallest paid plan's per-second limit across the provider (5 requests per second today). bursts wait briefly for a slot instead of receiving a synthetic 429.

### Examples

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
# See which listings and endpoints are registered
deepline tools execute rapidapi_list_listings --payload '{}'
```

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
# Typed Google web search, one page (about 20 results)
deepline tools execute rapidapi_google_web_search --payload '{"query":"best laptop 2026","pages":1,"country":"us"}'
```

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
# Generic call to a registered listing endpoint
deepline tools execute rapidapi_request --payload '{"host":"real-time-google-search-api","path":"/api/v1/google-search/image","query":{"q":"best laptop 2026"}}'
```

## Find an applicable action

Confirm your effective workspace, then search the live catalog:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline auth status --json
deepline search "RapidAPI" --type tools --json
```

Search returns candidates. Check the returned provider and operation rather than selecting a similar title automatically.

## Inspect the selected contract

Replace `<returned-tool-id>` with the identifier returned by discovery:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline describe <returned-tool-id> --json
```

These commands do not execute the selected provider action. Read its required inputs, supported access mode, pricing unit, outputs, and limits.

A connection does not establish that every action supports BYOK. Follow the provider-specific requirements above and the live action contract.

## Prepare one reviewed input

Use one authorized record that matches the inspected schema. Preserve its source identity and define the result you will accept.

Open the action reference for its payload and response shape. Provider-backed execution can incur usage or external effects.

For reusable logic, follow [Write Plays](https://deepline.com/docs/sdk-v2/plays.md). For direct-call recovery, use [Tool execution recovery](https://deepline.com/docs/sdk-v2/tool-execution-recovery.md).

> [!TIP]
>
> Continue only when the workspace, provider, required fields, acceptance rule, and applicable price are understood. Keep unavailable access separate from no-result evidence.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.