Skip to main content
The AI API provides endpoints for AI-powered features and health checks.

health

Check the health status of the AI service.
await client.ai.health()

Parameters

No parameters required.

Response

Returns the health status of the AI service.
status
string
Health status of the AI service
message
string
Optional status message

Usage Notes

This endpoint is public and does not require authentication.
The AI service is used for features like automatic transaction categorization. Additional AI endpoints may be added in future releases.

Example Response

{
  "status": "healthy",
  "message": "AI service is operational"
}

Build docs developers (and LLMs) love