Overview
The Cometly API uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the2xx range indicate success, and codes in the 4xx range indicate an error with the request.
HTTP Status Code Summary
| Status Code | Description |
|---|---|
| 200 | OK - The request was successful |
| 201 | Created - The resource was successfully created |
| 202 | Accepted - The request has been queued for processing successfully |
| 401 | Unauthenticated - Authentication failed or wasn’t provided |
| 403 | Forbidden - The request is understood but refused |
| 404 | Not Found - The requested resource does not exist |
| 422 | Unprocessable Entity - Request validation failed or missing required parameters |
Error Response Structure
All error responses follow a consistent structure:| Field | Type | Description |
|---|---|---|
message | string | Human-readable error description |