`GET /user/hello`

A health-check endpoint for verifying that your API key works. Returns a plain-text greeting with your account’s email if the key is valid.

Basic information

method: GET
url: https://api.remoet.dev/user/hello
returns: string

cURL


curl --location 'https://api.remoet.dev/user/hello' --header 'Authorization: Bearer <Your key>'

HTTP


GET /user/hello HTTP/1.1
Host: api.remoet.dev
Authorization: Bearer <Your key>

JavaScript Fetch


const myHeaders = new Headers();
myHeaders.append("Authorization", `Bearer ${key}`);
 
const requestOptions = {
  method: "GET",
  headers: myHeaders
};
 
fetch("https://api.remoet.dev/user/hello", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Result


Hello from the public API! <Your email>

Non authenticated response


{
    "statusCode": 401,
    "message": "Invalid API Key",
    "error": "Unauthorized"
}

The exact body depends on whether the header is missing, the key is unknown, or the key has expired — see Errors.

GET /user/hello