Get the API health check
GET/healthcheck
Returns the API health check. This route is public and doesn't require authentication.
Cost: 0 credit per call.
Request
Header Parameters
Possible values: [v1]
The API version.
Responses
- 200
- 400
- 429
- 500
- 503
OK
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [UP, DOWN]
The health status of the API.
status objectrequired
Number of credits that were consumed for this request.
apiDeprecationNotice object
Deprecation notice of the API.
A message that tells when the API version will be shut down.
The date of removal of the API version, UTC date-time without timezone using RFC3339 format.
{
"apiStatus": "UP",
"status": {
"cost": 0,
"apiDeprecationNotice": {
"message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
"shutdownDate": "2022-02-02T00:00:00.000Z"
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The description of the error. It gives meaningful information about what happened.
Possible values: >= 100 and <= 600
The error code. Please use our documentation to get more information about it.
Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
The id of the user that made the request.
Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
The id of the request.
status objectrequired
Number of credits that were consumed for this request.
apiDeprecationNotice object
Deprecation notice of the API.
A message that tells when the API version will be shut down.
The date of removal of the API version, UTC date-time without timezone using RFC3339 format.
{
"error": {
"message": "An error occurred.",
"code": 0,
"userId": "123e4567-e89b-12d3-a456-426655440000",
"requestId": "123e4567-e89b-12d3-a456-426655440000"
},
"status": {
"cost": 0,
"apiDeprecationNotice": {
"message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
"shutdownDate": "2022-02-02T00:00:00.000Z"
}
}
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The description of the error. It gives meaningful information about what happened.
Possible values: >= 100 and <= 600
The error code. Please use our documentation to get more information about it.
Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
The id of the user that made the request.
Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
The id of the request.
status objectrequired
Number of credits that were consumed for this request.
apiDeprecationNotice object
Deprecation notice of the API.
A message that tells when the API version will be shut down.
The date of removal of the API version, UTC date-time without timezone using RFC3339 format.
{
"error": {
"message": "An error occurred.",
"code": 0,
"userId": "123e4567-e89b-12d3-a456-426655440000",
"requestId": "123e4567-e89b-12d3-a456-426655440000"
},
"status": {
"cost": 0,
"apiDeprecationNotice": {
"message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
"shutdownDate": "2022-02-02T00:00:00.000Z"
}
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
The id of the request.
{
"requestId": "123e4567-e89b-12d3-a456-426655440000"
}
Service Unavailable