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

# Search Public Endpoints

POST https://api.buildwithorbit.ai/v1/search
Content-Type: application/json

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

Reference: https://www.buildwithorbit.ai/api-reference/search-public-endpoints

## Request

### Query parameters

- `limit` (integer, optional, default: 10) — Results per page. Default 10, maximum 25.
- `cursor` (string, optional) — Pagination cursor. Pass the `meta.nextCursor` value from the previous response. Omit for the first page.

### Body (application/json)

- `q` (string, required)

## Response

### 200

Successful Response

- `data` (list of object, optional)
  - `id` (string, optional)
  - `resourceType` (string, optional)
  - `name` (string, optional)
  - `description` (string, optional)
  - `method` (string, optional)
  - `url` (string, optional)
  - `evaluateGuide` (string, optional)
- `meta` (object, optional)
  - `q` (string, optional)
  - `total` (integer, optional)
  - `nextCursor` (string, optional)

## Examples

**Request**

```json
{
  "q": "Get Current Weather"
}
```

**Response**

```json
{
  "data": [
    {
      "id": "1446534-36e04f24-1a4e-4546-83c4-59049ae23f1b",
      "resourceType": "endpoint",
      "name": "Get Current Weather - OpenWeatherMap",
      "description": "OpenWeatherMap API provides weather data. This request gets current weather for a city. Replace YOURAPIKEY with your actual API key from openweathermap.org",
      "method": "GET",
      "url": "https://api.openweathermap.org/data/2.5/weather?q=London&appid=YOUR_API_KEY",
      "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"
    }
  ],
  "meta": {
    "q": "Get Current Weather",
    "total": 1
  }
}
```

**SDK Code**

```python searchPublicEndpoints_example
import requests

url = "https://api.buildwithorbit.ai/v1/search"

payload = { "q": "Get Current Weather" }
headers = {"Content-Type": "application/json"}

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

print(response.json())
```

```javascript searchPublicEndpoints_example
const url = 'https://api.buildwithorbit.ai/v1/search';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"q":"Get Current Weather"}'
};

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

```go searchPublicEndpoints_example
package main

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

func main() {

	url := "https://api.buildwithorbit.ai/v1/search"

	payload := strings.NewReader("{\n  \"q\": \"Get Current Weather\"\n}")

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

	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 searchPublicEndpoints_example
require 'uri'
require 'net/http'

url = URI("https://api.buildwithorbit.ai/v1/search")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"q\": \"Get Current Weather\"\n}"

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

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

HttpResponse<String> response = Unirest.post("https://api.buildwithorbit.ai/v1/search")
  .header("Content-Type", "application/json")
  .body("{\n  \"q\": \"Get Current Weather\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.buildwithorbit.ai/v1/search', [
  'body' => '{
  "q": "Get Current Weather"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp searchPublicEndpoints_example
using RestSharp;

var client = new RestClient("https://api.buildwithorbit.ai/v1/search");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"q\": \"Get Current Weather\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift searchPublicEndpoints_example
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["q": "Get Current Weather"] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.buildwithorbit.ai/v1/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()
```