API Reference
Search
Hybrid keyword + semantic search across apps, screens, and flows.
Gummble's search is hybrid — keyword matching for exact phrases and vector-space ANN for semantic similarity. You can target apps, screens, or both.
Universal search
GET /api/v1/search?q=onboarding&type=screen&limit=10| Name | Type | Description |
|---|---|---|
q | string | Query string (required) |
type | app | screen | flow | all | Result type filter |
limit | number | Max results (default 10, max 50) |
semantic | boolean | Force semantic-only mode (default: hybrid) |
Visual search
POST /api/v1/search/visual
Content-Type: multipart/form-dataUpload an image and get back the top-K visually similar screens by embedding cosine similarity.
curl -X POST https://api.gummble.com/api/v1/search/visual \
-H "Authorization: Bearer $TOKEN" \
-F "image=@screenshot.png" \
-F "limit=10"Uploads are validated by magic-byte sniffing (not just MIME). Only JPEG, PNG, and WebP under 8 MiB are accepted.
Response shape
{
"data": [
{
"type": "screen",
"score": 0.87,
"item": { ... full Screen object ... }
}
]
}score ranges 0-1. The hybrid scorer blends BM25 + cosine; tune via the
semantic flag if you want pure semantic ranking.