API Reference

Hybrid search across app entities

GET /api/ai/search

Hybrid search across app entities

Operation IDsearchAiApp

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Query parameters

qstringrequired

typesstring

Comma-separated entity types to filter

limitinteger

Default: 10

Success response body

200Search results

Search results

Content typeapplication/json

responseobject

1 property

resultsarray<object>

Array items

itemobject

Error responses

400Validation error

Validation error

No response content schema is documented.

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/ai/search?q=YOUR_Q&types=YOUR_TYPES&limit=10' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/ai/search?q=YOUR_Q&types=YOUR_TYPES&limit=10", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);