On this page
Success response
{ "success": true, "data": {}, "meta": { "requestId": "...", "creditsUsed": 1 } }The common tool response envelope contains a success flag, returned data, and metadata such as the request ID and charge information when available.
Error response
{ "success": false, "error": { "code": "INVALID_IP", "message": "Invalid IP address" }, "requestId": "..." }HTTP codes
| HTTP | Meaning |
|---|---|
| 400 | Invalid request or input. |
| 401 | Missing or invalid authentication. |
| 402 | Insufficient API credits. |
| 403 | Missing scope or required paid entitlement. |
| 404 | Resource not found. |
| 409 | Credit or state conflict. |
| 429 | Rate limit exceeded. |
| 500 | Unexpected server-side failure. |
| 503 | Quota infrastructure unavailable. |
Request IDs
API requests are associated with request IDs that are returned in normal responses and errors when available. Keep the request ID when contacting GGX Labs support about a failed request.