Skip to main content

HealthResponse

Response model for health check endpoints.

Attributes: message: Boolean indicating the health status (True = healthy).

Fields​

FieldTypeRequiredDefaultDescription
messagebool✓None-

Usage Example​

from credoai.models import HealthResponse

# Create a new instance
model = HealthResponse(
message=True, # Required field
)

# Convert to dictionary
model_dict = model.model_dump()
print(model_dict)

# Create from dictionary
data = {
"message": True,
}
model_from_dict = HealthResponse(**data)

JSON Schema​

{
"type": "object",
"title": "HealthResponse",
"description": "Response model for health check endpoints.

Attributes:
message: Boolean indicating the health status (True = healthy).",
"properties": {
"message": {
"type": "bool"
}
},
"required": ["message"]
}