RapidAPI: Request

Call any endpoint of a supported RapidAPI listing, with your own method, path, query and body, when no dedicated tool covers it.

Tool ID: rapidapi_request

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'rapidapi_request',
  {
    "host": "api.example.com",
    "path": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute rapidapi_request --input '{
  "host": "api.example.com",
  "path": "example"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "listing": {
    "slug": "example",
    "host": "api.example.com",
    "label": "example"
  },
  "method": "example",
  "path": "example",
  "status_code": 123,
  "ok": true,
  "billed_requests": 1,
  "data": {}
}

Use deepline describe rapidapi_request --json for the latest machine-readable contract.

Input reference

Call one endpoint on a RapidAPI listing that Deepline has registered and priced.

Name	Type	Required	Default	Details
`payload.host`	`string`	Yes	—	RapidAPI listing host such as real-time-google-search-api.p.rapidapi.com, or just its slug. Only listings Deepline has registered and priced can be called. run rapidapi_list_listings to see them. Minimum length: 1.
`payload.method`	`"GET" \| "POST"`	No	—	HTTP method. Defaults to GET. Allowed: `GET`, `POST`.
`payload.path`	`string`	Yes	—	Endpoint path on the listing host, for example /api/v1/google-search/web. Put query-string values in query, not in the path. Minimum length: 1.
`payload.query`	`record`	No	—	Query-string parameters.
`payload.body`	`unknown`	No	—	JSON request body. Only valid with method POST.
`payload.timeout_ms`	`integer`	No	—	Per-request timeout in milliseconds. Defaults to 30000. Minimum: 1000. Maximum: 120000.

Output reference

Name	Type	Required	Default	Details
`result.listing`	`object`	Yes	—	—
`result.listing.slug`	`string`	Yes	—	—
`result.listing.host`	`string`	Yes	—	—
`result.listing.label`	`string`	Yes	—	—
`result.method`	`string`	Yes	—	—
`result.path`	`string`	Yes	—	—
`result.status_code`	`integer`	Yes	—	—
`result.ok`	`boolean`	Yes	—	True for a 2xx upstream response. 404 and 410 are returned with ok=false instead of failing the call.
`result.billed_requests`	`integer`	Yes	—	Requests the listing reported in its X-RapidAPI-Billing header, or null when the header was absent.
`result.data`	`unknown`	Yes	—	Upstream response body as returned.

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 0 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation