Each error response includes the following structure:
{ "code": "F-RES-401",
"title": "Unauthorized",
"detail": "Authentication is required to access this resource."
}Response Fields:
code: Unique identifier for the error type (e.g., F-RES-401).
title: Short title describing the error (e.g., "Unauthorized").
detail: Detailed message explaining the error (e.g., "Authentication is required to access this resource.").
HTTP Status Codes
200 (OK)
Request succeeded, and the API returned the expected data.
304 (F-RES-304) - Not Modified
The requested resource has not been modified since the last request.
Causes: Resource unchanged; no updates available.
Actions: No action needed.
308 (F-RES-308) - Permanent Redirect
The resource has been permanently moved to a new URL. Check the Location header for the new endpoint.
Causes: Endpoint has moved permanently.
Actions: Update the URL as specified in the Location header.
400 (F-RES-400) - Bad Request
The request was invalid. Check the parameters and try again.
Causes: Missing or malformed parameters.
Actions: Verify all required parameters and their formats.
401 (F-RES-401) - Unauthorized
Authentication is required and has failed or has not yet been provided.
Causes: Missing or invalid API key.
Actions: Ensure ApiKey is included in the header and is correct.
403 (F-RES-403) - Forbidden
The server understood the request but refuses to authorize it.
Causes: Lack of access rights or invalid permissions.
Actions: Confirm that your API key has the necessary permissions.
404 (F-RES-404) - Not Found
The requested resource could not be found.
Causes: Incorrect endpoint or resource ID.
Actions: Verify the endpoint URL and parameters.
405 (F-RES-405) - Method Not Allowed
The HTTP method used is not allowed for this resource.
Causes: Invalid HTTP method (e.g., POST instead of GET).
Actions: Check the API documentation for allowed methods.
429 (F-RES-429) - Too Many Requests
You have exceeded the number of allowed requests.
Causes: Rate limit exceeded.
Actions: Wait and retry after the rate limit window has passed.
500 (F-RES-500) - Internal Server Error
The server encountered an unexpected condition that prevented it from fulfilling the request.
Causes: Server-side issue.
Actions: Retry the request later or contact support if it persists.
503 (F-RES-503) - Service Unavailable
The server is currently unable to handle the request due to temporary overload or maintenance.
Causes: Server maintenance or temporary overload.
Actions: Retry after a few minutes.
504 (F-RES-504) - Gateway Timeout
The server timed out while waiting for an upstream server.
Causes: Delayed response from an upstream server.
Actions: Retry the request; if it persists, report it to support.