Skip to main content
POST
Search screens with natural language

Authorizations

Authorization
string
header
required

Your Mobbin API key

Body

application/json
query
string
required

Describe one screen in plain language — the UI elements you'd see and how they relate. Be specific; detail helps. Good: "login screen with biometric authentication", "checkout page with promo code field and Apple Pay button". Avoid: combining multiple screens/intents (search separately), negations ("without ads"), vague style words ("modern", "clean"), disconnected keyword lists. Name a specific app to filter results to it (e.g. "Spotify now-playing screen"). Do not include platform (ios/web) — use the dedicated parameter.

Required string length: 1 - 500
Example:

"login screen with biometric authentication"

platform
enum<string>
required

Platform to search

Available options:
ios,
web
mode
enum<string>
default:deep

Search mode. "standard" returns results with low latency. "deep" uses an AI-powered pipeline that interprets intent and scores each candidate for relevance, keeping the strong matches — ideal for nuanced queries. "fast" is a deprecated alias for "standard" and will be removed in a future version — use "standard" instead.

Available options:
deep,
standard,
fast
limit
integer
default:20

Maximum number of screens to return

Required range: 1 <= x <= 100
image_quality
enum<string>
default:optimized

"optimized" returns images sized for AI agents and most programmatic inspection. "high" returns larger images for detailed visual inspection.

Available options:
optimized,
high
exclude_screen_ids
string<uuid>[]

Screen IDs to exclude from results

Maximum array length: 100

Response

Search results

screens
object[]
required