Service status
GET https://api.visualpdf.com/v1/status
Retrieves the service status. Also allows you to test your authentication.
Example
Request (NodeJS)
const statusResponse = await fetch(
'https://api.visualpdf.com/v1/status',
{
method: 'GET',
headers: { Authorization: `Bearer ${my_API_key}` },
},
);
Response
{
message: 'You are correctly authenticated!',
status: 'available',
}
Status values
- available: the service is available
- unavailable: the service is not accessible, we cannot process your requests at the moment
Errors
HTTP code | Description |
---|---|
401 - Unauthorized | No valid API key provided. |
429 - Too Many Requests | Too many requests hit the API too quickly. |
5xx - Server Errors | Something went wrong on our end. |