GiGi Developer Portal

Build with the GiGi public API. v0 — partner-traffic gated until your account is flipped to live mode.

← Back to GiGi

What is the GiGi API?

The GiGi public API exposes the data partners need to embed real estate intelligence into their own products: the agent profile, recent coaching insights, sentinel firings, and outbound webhooks for events as they happen. It is the same data your /today sees — read-only on a partner endpoint.

v0 is intentionally narrow. Auth is Bearer-token via API keys you mint on the Keys page; rate limit is 100 requests/minute per key; outbound webhook delivery is silenced until your account is flipped to live mode — the rest of the API still works, so you can build and test against it today.

See Versioning for the v2 namespace + deprecation policy. Browse the Events page to see every webhook event type with sample payloads.

Sample requests

1. Get the agent profile

Returns the API key owner + their account.

curl https://app.gigiguides.ai/api/v2/public/agents/me \
  -H "Authorization: Bearer gg_live_<your-key>"

2. Read recent coaching insights

Pull GiGi's latest coaching insights. Until your account has real coaching history, sample data is returned so you can wire integrations end-to-end.

curl "https://app.gigiguides.ai/api/v2/public/coaching/insights?limit=5" \
  -H "Authorization: Bearer gg_live_<your-key>"

3. Read recent sentinel firings

Cursor-paginated. Use the returned next_cursor to walk back further in time.

curl "https://app.gigiguides.ai/api/v2/public/sentinels/firings?limit=10" \
  -H "Authorization: Bearer gg_live_<your-key>"

4. Subscribe to webhook events

Register your endpoint and we'll POST signed payloads when matching events fire. The signing secret is returned exactly once — store it on your end.

curl -X POST https://app.gigiguides.ai/api/v2/public/webhooks/subscribe \
  -H "Authorization: Bearer gg_live_<your-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "target_url": "https://example.com/hooks/gigi",
    "events": ["agent.coaching_insight_created", "sentinel.fired"],
    "description": "Production listener"
  }'

5. Unregister a webhook

Sets revoked_at on the subscription. Past delivery rows are kept for debugging.

curl -X DELETE https://app.gigiguides.ai/api/v2/public/webhooks/<id> \
  -H "Authorization: Bearer gg_live_<your-key>"