> ## 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.

# GET /health

> Check if the API is operational.

# 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

```bash theme={null}
curl https://www.pixcraft.es/api/v1/health
```

## Example response

```json theme={null}
{
  "status": "ok",
  "version": "1.0",
  "timestamp": "2025-03-01T08:00:00.000Z"
}
```

## Response fields

| Field       | Type   | Description                         |
| ----------- | ------ | ----------------------------------- |
| `status`    | string | `"ok"` when the API is operational  |
| `version`   | string | Current API version                 |
| `timestamp` | string | Server timestamp in ISO 8601 format |

## Using in monitoring

```javascript theme={null}
// 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;
  }
}
```