Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Shashank-H/gaiter-gaurd/llms.txt

Use this file to discover all available pages before exploring further.

GaiterGuard provides two distinct authentication methods designed for different use cases:

Authentication Methods

Agent-Key Authentication

For AI agents making API calls to protected services. Use the Agent-Key header with keys prefixed by agt_.
  • Scoped to specific services
  • Long-lived credentials
  • Managed via dashboard
  • Used for runtime agent operations
Learn more about Agent-Key authentication →

JWT Authentication

For dashboard users accessing management APIs. Uses access tokens (15 minutes) and refresh tokens (7 days).
  • Short-lived access tokens
  • Refresh token rotation
  • Email/password login
  • Used for user dashboard operations
Learn more about JWT authentication →

Quick Comparison

FeatureAgent-KeyJWT
Primary UseAI agents calling protected servicesDashboard user management
HeaderAgent-Key: agt_...Authorization: Bearer ...
ExpiryNone (revocable)Access: 15m, Refresh: 7d
ScopingPer-service access controlUser-level access
CreationVia dashboard APIVia login endpoint

Choosing the Right Method

Use Agent-Key When

Your AI agent needs to make API calls to services protected by GaiterGuard. Each agent can be scoped to specific services for granular access control.

Use JWT When

Building dashboard features or user-facing interfaces that need to manage agents, services, and approval workflows.

Error Responses

Both authentication methods return standard error responses:
{
  "error": "Missing authorization header",
  "statusCode": 401
}
Common status codes:
  • 401 Unauthorized - Invalid or missing credentials
  • 403 Forbidden - Valid credentials but insufficient permissions
  • 404 Not Found - Resource doesn’t exist or user lacks access

Build docs developers (and LLMs) love