⚡ Quick Start — 3 Steps
Get crash intelligence in your game in under 5 minutes.
Get Your API Key
Head to the Grip Protocol portal and generate a free key. The Indie tier gives you 50 reports/month — no credit card needed.
Send a Bug Report
POST to /Jaffa/report with your game title and error. jaffaAi analyses it, searches for fixes, and returns actionable intelligence.
Get Fixes Back
The response includes severity, category, AI-suggested fixes with confidence scores, and links to community solutions. Show them in-game or on your dashboard.
🔧 Your First API Call
curl -X POST https://jaffaai.cc/Jaffa/report \ -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ -d '{ "gameTitle": "Elden Ring", "errorText": "Crash to desktop during boss transition", "platform": "PC", "engine": "Unreal Engine" }'
const response = await fetch('https://jaffaai.cc/Jaffa/report', { method: 'POST', headers: { 'Content-Type': 'application/json', 'X-API-Key': 'YOUR_API_KEY' }, body: JSON.stringify({ gameTitle: 'Elden Ring', errorText: 'Crash to desktop during boss transition', platform: 'PC', engine: 'Unreal Engine' }) }); const data = await response.json(); console.log(data.incident); // severity, category, AI analysis console.log(data.fixes); // ranked fixes with confidence scores
using UnityEngine.Networking; using System.Text; var json = JsonUtility.ToJson(new BugReport { gameTitle = "My Game", errorText = "NullReferenceException in PlayerController", platform = "PC", engine = "Unity" }); var request = new UnityWebRequest("https://jaffaai.cc/Jaffa/report", "POST"); request.uploadHandler = new UploadHandlerRaw(Encoding.UTF8.GetBytes(json)); request.downloadHandler = new DownloadHandlerBuffer(); request.SetRequestHeader("Content-Type", "application/json"); request.SetRequestHeader("X-API-Key", "YOUR_API_KEY"); yield return request.SendWebRequest(); Debug.Log(request.downloadHandler.text);
📡 API Endpoints
Base URL: https://jaffaai.cc | Auth: X-API-Key header
| Method | Endpoint | Description |
|---|---|---|
| POST | /Jaffa/report | Submit a bug report — returns AI analysis + fixes synchronously |
| POST | /Jaffa/report/async | Fire-and-forget — queues for background processing |
| GET | /Jaffa/incidents | List incidents — filter by ?gameTitle=, ?status=, ?limit= |
| GET | /Jaffa/incident/:id | Full incident details including timeline and AI payload |
| GET | /Jaffa/fix/:incidentId | Get ranked fixes for an incident, sorted by confidence |
| GET | /Jaffa/hotspots | Aggregated issue patterns — see what's breaking the most |
| GET | /Jaffa/analytics/dashboard | Full dashboard stats: incidents, fixes, severity breakdown |
| POST | /Jaffa/webhooks/register | Register a webhook to receive incident alerts |
| POST | /Jaffa/search | Manual web search for game fixes |
| GET | /health | Service health check (no auth required) |
SDK Endpoints
Base URL: https://jaffaai.cc/api/sdk | Auth: X-SDK-Key header
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/sdk/logs | Send telemetry event batches from your game client |
| POST | /api/sdk/crash | Report a crash with stack trace — auto-creates incident |
| POST | /api/sdk/session | Start/end a play session for analytics |
| GET | /api/sdk/health | SDK service health (no auth required) |
❓ Frequently Asked Questions
- REST API — Call
/Jaffa/reportfrom any language. Send a bug report, get AI analysis + fixes back. Works with any engine, any platform. - Unity SDK — Drop the GameGrip C# SDK into your Unity project. It auto-captures crashes, logs, and session data — zero code needed for basic crash tracking.
- Auto-captures crashes and unhandled exceptions
- Logs performance events (FPS drops, memory spikes)
- Tracks play sessions for analytics
- Built-in privacy sanitisation — no player PII is sent
- Batches events to minimise network calls
gameTitle— your game's nameerrorText— description of the bug/crash
platform— PC, PS5, Xbox, Switch, Mobileengine— Unity, Unreal, Godot, etc.stackTrace— for crash reportsmetadata— any extra context (game version, OS, GPU)
/Jaffa/webhooks/register and you'll receive HMAC-signed POST requests whenever new incidents match your game. Great for hooking into Discord, Slack, or your own monitoring dashboard. Available on Studio and Enterprise tiers.
/Jaffa/report— Synchronous. Processes the report immediately and returns the full AI analysis + fixes in the response. Typical response time: 1-3 seconds. Best when you want to show fixes to the player right away./Jaffa/report/async— Fire-and-forget. Queues the report for background processing and returns immediately (202 Accepted). Best for bulk/automated reporting where you don't need instant results. Retrieve results later via/Jaffa/incident/:id.
/Jaffa/report response includes:
- incident — ID, severity (critical/high/medium/low), category (crash, performance, rendering, etc.), AI summary
- fixes — Array of suggested fixes, each with a confidence score (0-1), source, and step-by-step instructions
- related — Similar incidents found across other games
- metadata — Processing time, pipeline version
- Indie (free) — 50 reports/month, 1 API key
- Studio (£29/mo) — 500 reports/month, 5 API keys
- Enterprise (£149/mo) — Unlimited reports, unlimited keys, SLA
429 Too Many Requests if you exceed your limit. The response includes a Retry-After header.
- API Key — Pass your key in the
X-API-Keyheader. Best for server-to-server and backend calls. - Bearer Token (SSO) — Sign in via GameGrip Auth, then use the JWT token as
Authorization: Bearer <token>. Best for frontend dashboards and browser-based tools.
X-SDK-Key instead. The /health endpoint requires no auth.
- 50 reports / month
- Basic severity analysis
- 1 API key
- Community support
- 500 reports / month
- Advanced PSI analysis
- Hotspot clustering
- Webhooks
- 5 API keys
- Unlimited reports
- Grip Protocol bridge
- Team management
- Unlimited API keys
- SLA guarantee
- jaffaAi — The AI engine. Processes bug reports, runs intelligence pipelines, serves the API. This is what you integrate with.
- Grip Protocol — The data layer. Aggregates, indexes, and distributes intelligence across the ecosystem. Manages API keys and developer portal.
- GameGrip — The consumer-facing platform. Blog posts, game health guides, and community resources powered by the intelligence pipeline.
- Sandbox — Public intelligence feed. Browse crawl findings, fix guides, and trending issues across all tracked games.