Skip to main content

API Contracts

All endpoints follow the following general type:

type Result<T> =
| {
data: T;
error?: never;
}
| {
data?: never;
error: string;
};

Which corresponds to either returning:

{
"data": /* ... some data */
}

or

{
error: "error message",
}