Skip to main content

ClientRequest

Base class for client requests with validation and JSON:API support. This base class provides common functionality for all API request models, including validation, serialization, and JSON:API format conversion. Methods: to_dict(): Convert to dictionary for API requests to_jsonapi(): Convert to JSON:API format for requests

Fields​

Usage Example​

from credoai.models import ClientRequest

# Create a new instance
model = ClientRequest()

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

# Create from dictionary
model_from_dict = ClientRequest()

JSON Schema​

{
  "type": "object",
  "title": "ClientRequest",
  "description": "Base class for client requests with validation and JSON:API support.
This base class provides common functionality for all API request models,
including validation, serialization, and JSON:API format conversion.
Methods:
to_dict(): Convert to dictionary for API requests
to_jsonapi(): Convert to JSON:API format for requests",
  "properties": {
  }
}