API Reference
Screens
Individual UI references — the smallest unit in Gummble.
A Screen is one rendered UI surface from one app. Every screen has
an image (stored on Cloudflare R2 at storage.gummble.com) and metadata
extracted at ingest time.
List screens
GET /api/v1/screens| Name | Type | Description |
|---|---|---|
appId | string | Filter by app |
pattern | string | UI pattern (onboarding, paywall, empty-state, …) |
colors | string[] | Dominant color filter |
q | string | Free-text on extracted OCR + caption |
Get a screen
GET /api/v1/screens/:idDownload
GET /api/v1/screens/:id/downloadRequires pro or team plan. Returns a short-lived signed URL.
Screen object
type Screen = {
id: string
appId: string
pattern: string[] // ['onboarding', 'paywall']
platform: 'IOS' | 'ANDROID' | 'WEB'
imageUrl: string // https://storage.gummble.com/...
thumbUrl: string
width: number
height: number
dominantColors: string[] // ['#1A1A1A', '#FF6B35']
captionText?: string // OCR'd
pHash?: string // perceptual hash for dedupe
embeddingId?: string // for semantic search
capturedAt: string // ISO timestamp
}