> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Execute a hosted web search for a standalone runtime

POST https://api.runtype.com/v1/runtime/search
Content-Type: application/json

Hosted fulfillment of the runtime's WebSearcher capability seam. Executes the same search-API provider call the search flow step uses internally (Exa), resolving the search credential api-side (customer key or platform fallback). The credential never appears in the response. Requires an Enterprise plan: ineligible accounts receive 403 (code `BYOC_PLAN_REQUIRED`).

Reference: https://docs.runtype.com/api-reference/runtype-api/self-hosting/execute-a-hosted-web-search-for-a-standalone-runtime

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Body (application/json)

This endpoint expects an object.

- `provider` (string, required) — Search-API provider id. Supported: 'exa'.
- `query` (string, required)
- `maxResults` (integer, optional)
- `options` (V1RuntimeSearchPostRequestBodyContentApplicationJsonSchemaOptions, optional)

## Response

### 200

Provider-mapped search results (results + citations + metadata)

- `results` (list of V1RuntimeSearchPostResponsesContentApplicationJsonSchemaResultsItems, required)
- `citations` (list of V1RuntimeSearchPostResponsesContentApplicationJsonSchemaCitationsItems, optional)
- `metadata` (map from string to any, optional)

## Errors

### 400 Bad Request Error

Invalid request, unsupported provider, or no Exa key available

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 402 Payment Required Error

Monthly spend limit exceeded

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions, or the account is not on an Enterprise plan (code `BYOC_PLAN_REQUIRED`)

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 429 Too Many Requests Error

Daily execution limit or rate limit exceeded

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 502 Bad Gateway Error

The search provider call failed

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

## Types

### V1RuntimeSearchPostRequestBodyContentApplicationJsonSchemaOptions

- `category` (string, optional)
- `contents` (V1RuntimeSearchPostRequestBodyContentApplicationJsonSchemaOptionsContents, optional)
- `endCrawlDate` (string, optional)
- `endPublishedDate` (string, optional)
- `excludeDomains` (list of string, optional)
- `includeDomains` (list of string, optional)
- `numResults` (integer, optional)
- `searchType` (enum, optional)
  - Allowed values: `auto`, `neural`, `keyword`
- `startCrawlDate` (string, optional)
- `startPublishedDate` (string, optional)

### V1RuntimeSearchPostResponsesContentApplicationJsonSchemaResultsItems

- `author` (string, optional)
- `content` (string, optional)
- `highlights` (list of string, optional)
- `id` (string, optional)
- `publishedDate` (string, optional)
- `score` (double, optional)
- `source` (string, optional)
- `summary` (string, optional)
- `text` (string, optional)
- `timestamp` (string, optional)
- `title` (string, optional)
- `url` (string, optional)

### V1RuntimeSearchPostResponsesContentApplicationJsonSchemaCitationsItems

- `id` (double, required)
- `source` (string, required)
- `title` (string, required)
- `url` (string, required)
- `author` (string, optional)
- `publishedDate` (string, optional)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### V1RuntimeSearchPostRequestBodyContentApplicationJsonSchemaOptionsContents

- `highlights` (boolean, optional)
- `summary` (boolean, optional)
- `text` (boolean, optional)

## Examples

**Request**

```json
{
  "provider": "string",
  "query": "string"
}
```

**Response**

```json
{
  "results": [
    {
      "author": "string",
      "content": "string",
      "highlights": [
        "string"
      ],
      "id": "string",
      "publishedDate": "string",
      "score": 1.1,
      "source": "string",
      "summary": "string",
      "text": "string",
      "timestamp": "string",
      "title": "string",
      "url": "string"
    }
  ],
  "citations": [
    {
      "id": 1.1,
      "source": "string",
      "title": "string",
      "url": "string",
      "author": "string",
      "publishedDate": "string"
    }
  ],
  "metadata": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/runtime/search"

payload = {
    "provider": "string",
    "query": "string"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/runtime/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"provider":"string","query":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/runtime/search"

	payload := strings.NewReader("{\n  \"provider\": \"string\",\n  \"query\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/runtime/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"string\",\n  \"query\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/runtime/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"string\",\n  \"query\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/runtime/search', [
  'body' => '{
  "provider": "string",
  "query": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/runtime/search");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"provider\": \"string\",\n  \"query\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "provider": "string",
  "query": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/runtime/search")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```