Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pixcraft.es/llms.txt

Use this file to discover all available pages before exploring further.

​
Health Check

GET /api/v1/health
Public endpoint — no authentication required. Returns the current API status. Use this endpoint in your monitoring tools to check if the PixCraft API is operational before debugging your own code.

​
Example request

curl https://www.pixcraft.es/api/v1/health

​
Example response

{
  "status": "ok",
  "version": "1.0",
  "timestamp": "2025-03-01T08:00:00.000Z"
}

​
Response fields

FieldTypeDescription
statusstring"ok" when the API is operational
versionstringCurrent API version
timestampstringServer timestamp in ISO 8601 format

​
Using in monitoring

// Simple uptime check
async function checkPixCraftApi() {
  try {
    const res = await fetch('https://www.pixcraft.es/api/v1/health');
    const data = await res.json();
    return data.status === 'ok';
  } catch {
    return false;
  }
}