Health check endpoint

GET

/v1/health

const url = 'https://api.neuramancer.dev/v1/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.neuramancer.dev/v1/health

Returns the health status of the API

Responses

200

API is healthy

application/json

object

status

Health status

string

uptime

Server process uptime in seconds

number

Example

{
  "status": "OK",
  "uptime": 3600.5
}

400

Bad request

application/json

Standardized error response following the APIResponse schema.

object

success

required

boolean

message

required

string

Example

{
  "success": false,
  "message": "Bad request"
}