quivr/docs/developers/useQuivr/error_handling.mdx
Stan Girard 33eec50a09
docs: ✏️ mintlify (#1917)
moved to mintlify
2023-12-24 17:49:27 +01:00

56 lines
1.7 KiB
Plaintext

---
sidebar_position: 5
title: Error Handling
---
**URL**: https://api.quivr.app/chat
**Swagger**: https://api.quivr.app/docs
## Overview
This page provides information about common error codes, their descriptions, and examples of scenarios where these errors may occur.
| Error Code | Description |
| ---------- | --------------------------------------------------------------------------- |
| 401 | Unauthorized: The request lacks valid authentication credentials. |
| 403 | Forbidden: The requested operation is not allowed. |
| 422 | Unprocessable Entity: The request is well-formed but contains invalid data. |
| 500 | Internal Server Error: An unexpected error occurred on the server. |
## Error Code: 401
**Description**: The request lacks valid authentication credentials or the provided token/api key is invalid.
Example Scenarios:
- Missing or invalid authentication token/api key.
- Expired authentication token.
## Error Code: 403
**Description**: The requested operation is forbidden due to insufficient privileges or credentials missing.
Example Scenarios:
- Attempting to access a resource without proper authorization.
- Insufficient permissions to perform a specific action.
## Error Code: 422
**Description**: The request is well-formed, but contains invalid data or parameters.
Example Scenarios:
- Invalid input data format.
- Required fields are missing or have incorrect values.
## Error Code: 500
**Description**: An unexpected error occurred on the server.
Example Scenarios:
- Internal server error due to a server-side issue.
- Unhandled exceptions or errors during request processing.