Reference

async createApiKey(userId: string, keyDescription: string): Promise<CompleteApiKeyInfo>

Creates a new API key for the specified user.

• userId: string - The ID of the user
• keyDescription: string - A description for the new API key

Returns a CompleteApiKeyInfo object.

async loadApiKeyInfo(userId: string): Promise<ApiKeyInfo[]>

Retrieves information about all API keys for the specified user.

• userId: string - The ID of the user

Returns an array of ApiKeyInfo objects.

async revokeApiKey(userId: string, secretId: string): Promise<void>

Revokes the specified API key.

• userId: string - The ID of the user
• secretId: string - The ID of the API key to revoke

async getAllKeyMetadata(userId: string): Promise<ApiKeyMetadata[]>

Retrieves detailed metadata for all API keys associated with the specified user.

• userId: string - The ID of the user

Returns an array of ApiKeyMetadata objects.

async authenticate(request: Request): Promise<AuthResult>

Authenticates a request using the provided API key.

• request: Request - The incoming request object

Returns an AuthResult object.

interface Logger {
  info: (message: string) => void;
  warn: (message: string) => void;
  error: (message: string) => void;
  debug: (message: string) => void;
}

Interface for custom logger objects.

type ApiKeyResponse = {
  api_key: string;
}

Represents the response when creating a new API key.

type ApiKeyInfo = {
  id: string;
  description: string;
}

Basic information about an API key.

interface CompleteApiKeyInfo extends ApiKeyInfo {
  apiKey: string | null;
  status: "success" | "failed";
  error?: string;
}

Complete information about an API key, including its value and status.

type ApiKeyMetadata = {
  api_key_id: string;
  name: string;
  permission: string;
  last_used: string;
  created: string;
  revoked: string;
  total_uses: number;
  success_rate: number;
  total_cost: number;
}

Detailed metadata about an API key.

type AuthResult = {
  userId: string;
  supabase: SupabaseClient<any, "public", any>;
}

Result of authenticating a request with an API key.

Ensure that the API key is being correctly passed in the request headers and that it hasn’t been revoked.

Verify that the user has the necessary permissions in your Supabase project and that the KeyHippo extension is properly installed.

Check that the user ID being passed is correct and that the user has existing API keys.