The G-Tateth API supports two authentication methods: API keys (recommended for server-to-server) and JWT tokens (for user-authenticated requests).Documentation Index
Fetch the complete documentation index at: https://docs.g-tateth.com/llms.txt
Use this file to discover all available pages before exploring further.
API Key Authentication
API keys are the recommended method for server-to-server communication. They provide secure, long-lived access to the API.Creating an API Key
- Log in to your G-Tateth account
- Navigate to Settings → Developer Console
- Click “Create API Key”
- Choose your environment (Production or Staging)
- Select permissions for the key
- Copy your API key (it’s only shown once!)
Using Your API Key
Include your API key in theAuthorization header:
X-API-Key header:
API Key Types
- Production keys (
sk_live_...) - Use in production environments - Test keys (
sk_test_...) - Use for development and testing
API Key Permissions
When creating an API key, you can specify which permissions it has:read:conversations- Read conversationswrite:conversations- Create/update/delete conversationsread:customers- Read customerswrite:customers- Create/update/delete customersread:webhooks- Read webhookswrite:webhooks- Create/update/delete webhooksread:analytics- Read analytics data
JWT Authentication
JWT tokens can be used for user-authenticated requests. Obtain a JWT token through the authentication endpoints.Security Best Practices
- Never commit API keys to version control - Use environment variables
- Rotate keys regularly - Set up automatic rotation if possible
- Use test keys for development - Keep production keys secure
- Limit permissions - Only grant the minimum permissions needed
- Use IP whitelisting - Restrict API key access to specific IPs
- Monitor usage - Regularly check API key usage logs
Error Responses
If authentication fails, you’ll receive a401 Unauthorized response:
API_KEY_INVALID- Invalid API keyAPI_KEY_EXPIRED- API key has expiredAPI_KEY_INACTIVE- API key is inactiveTENANT_SUSPENDED- Tenant account is suspended