Model Description
The Model Description section defines the standardized structure of API responses. It includes essential attributes that encapsulate core data, summaries, metadata, and error handling. This ensures consistency and clarity when integrating with the API.
Field
Type
Description
data
Data object
Represents the core response payload
summary
Map<string, object>
Contains a summary of the core response data
metadata
Metadata object
Provides additional context about the response, such as pagination details, versioning, and extra metadata.
error
Error object, nullable
Detailed information if the request encounters an error, including error codes and descriptive messages.
Last updated