This endpoint is used to check that your API key works. Generally API keys are only disabled in the event of billing issues. Requests to the /auth endpoint have no cost.
| Name | Required | Type | Description |
|---|---|---|---|
| api_key | Yes | UUID v4 | Your API key for authorization |
Type declarations are available at the bottom of this page.
| Name | Type | Description |
|---|---|---|
| api_key_authorized | Boolean | Indicates if the API key is authorized. |
| error | String | Details about the error. Empty if no error. |
| time_ms | Number | Time taken for the request to complete in milliseconds. |
Select the programming language you want to display the code examples in.
curl -X GET "https://api.houski.ca/auth?api_key=YOUR_API_KEY"
const houski_validate_api_key = async (): Promise<AuthResponse> => {
// You must copy the AuthResponse type declarations from the
// Houski API documentation to strongly type the response
const url = new URL('https://api.houski.ca/auth');
url.searchParams.set('api_key', 'YOUR_API_KEY');
const response = await fetch(url);
const data = await response.json();
return data;
}
(async () => {
let data: AuthResponse = await houski_validate_api_key();
// Log the response
console.log(data);
})();
{
"api_key_authorized": true,
"error": "",
"time_ms": 0
}
interface AuthResponse {
api_key_authorized: boolean;
error: string;
time_ms: number;
}