Search Public Endpoints | Orbit by Postman

Describe your goal in q. Search returns matching public endpoints and evaluates what each one does, when to use it, and its limitations so the agent can select the best fit.

Request

POST /v1/search

1 { "q": "Get Current Weather" }

q is required and capped at 512 characters. No other body field is accepted; unknown fields return 400.

Query parameters

limit — results per page (default 10, max 25)
cursor — pass meta.nextCursor from the previous response

Pagination stops at 40 results total; a cursor past 40 is rejected.

Response

Each result carries id, resourceType, name, description, method, url, and evaluateGuide;.

resourceType — the kind of entity, for example endpoint. Pass it to /v1/integrate as the resource’s type.
evaluateGuide — an evaluation of the endpoint in three parts: a brief summary, recommended use cases, and unsupported use cases or limitations.

meta carries q, total, and nextCursor (absent on the last page).

Errors

400 invalid input, 429 rate limited, 500 server error.

# Search Public Endpoints Describe your goal in `q`. Search returns matching public endpoints and evaluates what each one does, when to use it, and its limitations so the agent can select the best fit. ## Request `POST /v1/search` ```json { "q": "Get Current Weather" } ``` `q` is required and capped at 512 characters. No other body field is accepted; unknown fields return `400`. **Query parameters** - `limit` — results per page (default 10, max 25) - `cursor` — pass `meta.nextCursor` from the previous response Pagination stops at 40 results total; a cursor past 40 is rejected. ## Response Each result carries `id`, `resourceType`, `name`, `description`, `method`, `url`, and `evaluateGuide`;. - `resourceType` — the kind of entity, for example `endpoint`. Pass it to `/v1/integrate` as the resource's `type`. - `evaluateGuide` — an evaluation of the endpoint in three parts: a brief summary, recommended use cases, and unsupported use cases or limitations. `meta` carries `q`, `total`, and `nextCursor` (absent on the last page). ## Errors `400` invalid input, `429` rate limited, `500` server error.

Query parameters

limitintegerOptional1-25Defaults to 10

Results per page. Default 10, maximum 25.

cursorstringOptional

Pagination cursor. Pass the meta.nextCursor value from the previous response. Omit for the first page.

Request

This endpoint expects an object.

qstringRequired1-512 characters

Response

Successful Response

datalist of objectsOptional

metaobjectOptional

Errors

400

Bad Request Error

429

Too Many Requests Error

500

Internal Server Error

Describe your goal in q. Search returns matching public endpoints and evaluates what each one does, when to use it, and its limitations so the agent can select the best fit.

Request

POST /v1/search

1 { "q": "Get Current Weather" }

q is required and capped at 512 characters. No other body field is accepted; unknown fields return 400.

Query parameters

limit — results per page (default 10, max 25)
cursor — pass meta.nextCursor from the previous response

Pagination stops at 40 results total; a cursor past 40 is rejected.

Response

Each result carries id, resourceType, name, description, method, url, and evaluateGuide;.

resourceType — the kind of entity, for example endpoint. Pass it to /v1/integrate as the resource’s type.
evaluateGuide — an evaluation of the endpoint in three parts: a brief summary, recommended use cases, and unsupported use cases or limitations.

meta carries q, total, and nextCursor (absent on the last page).

Errors

400 invalid input, 429 rate limited, 500 server error.

$	curl -X POST https://api.buildwithorbit.ai/v1/search \
>	-H "Content-Type: application/json" \
>	-d '{
>	"q": "Get Current Weather"
>	}'

1	{
2	"data": [
3	{
4	"id": "1446534-36e04f24-1a4e-4546-83c4-59049ae23f1b",
5	"resourceType": "endpoint",
6	"name": "Get Current Weather - OpenWeatherMap",
7	"description": "OpenWeatherMap API provides weather data. This request gets current weather for a city. Replace YOURAPIKEY with your actual API key from openweathermap.org",
8	"method": "GET",
9	"url": "https://api.openweathermap.org/data/2.5/weather?q=London&appid=YOUR_API_KEY",
10	"evaluateGuide": "Retrieves current weather data for a specified city from OpenWeatherMap. An agent can obtain conditions such as temperature and other weather details using the city and API key parameters. Use for: current weather in London, city weather lookup, temperature retrieval Not supported: forecasts, historical weather, weather alerts"
11	}
12	],
13	"meta": {
14	"q": "Get Current Weather",
15	"total": 1
16	}
17	}