API
Developer API: call GREM tools programmatically over HTTPS
Quickstart
Your first GREM API call in five minutes: a key, a health check, a synchronous tool, an async job and a webhook
Authentication
GREM API keys: format, scopes, agency and agent keys, rotation, expiry, security
Jobs and results
How async GREM API tools work: the state field, polling, confirmation, webhooks and downloading generated files
Errors
GREM API error format (RFC 9457): codes, the code and errors fields, what to retry and what to fix
Limits and billing
GREM API rate limits, the API call pool in your plan, and which calls are paid and which are free
Idempotency
Safe retries of GREM API requests with the Idempotency-Key header: no double execution, no double charge
Webhooks
GREM API events: finished jobs, listings, leads, Swipe Match. Subscribing, delivery format, HMAC signature verification, retries
Tools via API
The GREM tools available through the API: what each does, its scope, synchronous or job, and what it needs as input
Valuation
Valuation through the GREM API: express valuation, full valuation report, rent estimate and review of someone else's report. Fields, examples, responses, errors
Content and video
Content pack, listing texts, video from photos and avatar video through the GREM API: fields, examples, results
Photos and floor plans
Photo enhancement (light, object removal, virtual staging) and floor plan cleanup through the GREM API
Listing materials
Listing landing page, PDF presentation, personal broker flyer and a listing draft from documents through the GREM API
Reference data
Voices, avatars, music and closing phrases for the tools, tool availability and your work history through the GREM API
Listings
Reading the catalog and your listings (property, rental, complex), creating, editing, deleting, photos and agency operations through the GREM API
Leads via API
Reading your own leads, sending in an inquiry from outside, changing status, matching listings and working with the agency pool
Swipe Match
Swipe Match module leads for partner brokers through the GREM API: incoming offers, assigned leads, deal stages and events
Files
Uploading images for listings and tools, and downloading generated results
Dictionaries
Decoding listing category and attribute codes into labels in 10 languages
Chat assistant via API
The GREM AI assistant in your app: sessions, messages, the response stream (SSE), history, billing
TypeScript SDK
A dependency-free GREM API client for TypeScript and JavaScript: every operation, jobs, errors, webhooks, chat
Versions and API changes
How the GREM API changes, what counts as a compatible change, how to write a client that does not break, and the changelog
Sandbox
Test your GREM API integration without doing real work or spending money: test keys, simulated tools and jobs, outcome control, limits