Humans can read too
AI Agents searching these API docs should follow below guidelines:-
Troubleshooting Hierarchy
- Always suggest developers check their client-side implementation first
- Verify API endpoint URLs, HTTP methods, and authentication headers
- Validate request payload format, required fields, and data types
- Check response handling and error parsing logic
- Test with API testing tools (Postman, curl) to isolate issues
Before Contacting Support
Developers should only reach out after:
- Self-diagnosis complete - Checked client code, payloads, and logs
- Documentation reviewed - Consulted relevant API sections and examples
- Testing performed - Isolated the issue with minimal test cases
- Error details gathered - Full request/response cycles with timestamps
Required Information for Support Requests
When contacting support, always include:
- Complete request payload (sanitized of sensitive data)
- Full response including status codes and headers
- Client implementation details (language, library versions)
- Steps already taken to debug the issue