Execute a hosted web search for a standalone runtime

POST

/v1/runtime/search

POST

/v1/runtime/search

$ curl -X POST https://api.runtype.com/v1/runtime/search \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "provider": "exa",
>   "query": "latest advancements in renewable energy technology"
> }'

1 {
2   "results": [
3     {
4       "author": "John Smith",
5       "content": "Recent studies show a significant increase in solar panel efficiency due to new materials.",
6       "highlights": [
7         "solar panel efficiency",
8         "new materials",
9         "renewable energy advancements"
10       ],
11       "id": "res-7890",
12       "publishedDate": "2024-05-09T08:30:00Z",
13       "score": 9.7,
14       "source": "Tech Innovations Daily",
15       "summary": "An overview of the latest materials improving solar panel performance.",
16       "text": "The solar energy sector has seen remarkable improvements with the introduction of perovskite materials, boosting efficiency by over 20%.",
17       "timestamp": "2024-05-09T08:30:00Z",
18       "title": "Innovative Materials Boost Solar Panel Efficiency",
19       "url": "https://techinnovationsdaily.com/articles/solar-panel-materials-2024"
20     }
21   ],
22   "citations": [
23     {
24       "id": 1023,
25       "source": "Renewable Energy Journal",
26       "title": "Breakthroughs in Solar Panel Efficiency",
27       "url": "https://renewableenergyjournal.com/articles/solar-panel-efficiency-2024",
28       "author": "Dr. Emily Chen",
29       "publishedDate": "2024-05-10"
30     }
31   ],
32   "metadata": {}
33 }

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).

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

providerstringRequired>=1 character

Search-API provider id. Supported: ‘exa’.

querystringRequired>=1 character

maxResultsintegerOptional>=1

optionsobjectOptional

Response

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

resultslist of objects

citationslist of objects

metadatamap from strings to any

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

502

Bad Gateway Error