# halo-guard

> Structured guard classifier for Halo0.8B-guard-v1

This file is intended for AI coding agents wiring an application to this specific Chutes model.

## Important URLs

- Model page: https://chutes.ai/app/chute/astroboi-halo-guard
- Model llms.txt: https://chutes.ai/app/chute/astroboi-halo-guard/llms.txt
- Global Chutes llms.txt: https://chutes.ai/llms.txt
- Full Chutes docs export: https://chutes.ai/llms-full.txt
- OpenAPI schema: https://api.chutes.ai/openapi.json

## Model Identifiers

- Name: `halo-guard`
- Chute ID: `f12d5c10-c6a9-58f3-bf6a-b344b330e139`
- Slug: `astroboi-halo-guard`
- Owner: `astroboi`

## Authentication

- Use `Authorization: Bearer $CHUTES_API_KEY` for inference calls.
- Send JSON request bodies with `Content-Type: application/json` unless the endpoint documentation says otherwise.
- The request body is FLAT — send the request fields at the top level (no `input_args`/`args` wrapper).
- This model is served on its own host (`https://astroboi-halo-guard.chutes.ai`). Call the endpoint paths listed below directly.
- For base64 media fields, send raw base64 strings in API requests. The web playground may use temporary Blob upload references internally for large files before proxying to Chutes.

## Endpoints

### 1. POST /v1/classify

- Base URL: `https://astroboi-halo-guard.chutes.ai`
- Output content type: `application/json`

Request fields:

- `model` (string, optional) Default: null.
- `query` (string, optional) Default: null.
- `messages` (array, optional) Default: null.

Example call:

```bash
curl -X POST "https://astroboi-halo-guard.chutes.ai/v1/classify" \
  -H "Authorization: Bearer $CHUTES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "halo-guard",
  "query": "Your text here",
  "messages": [
    {
      "role": "user",
      "content": "Hello!"
    }
  ]
}'
```

### 2. POST /v1/chat/completions

- Base URL: `https://astroboi-halo-guard.chutes.ai`
- Output content type: `application/json`

Request fields:

- `model` (string, optional) Default: null.
- `query` (string, optional) Default: null.
- `messages` (array, optional) Default: null.

Example call:

```bash
curl -X POST "https://astroboi-halo-guard.chutes.ai/v1/chat/completions" \
  -H "Authorization: Bearer $CHUTES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "halo-guard",
  "query": "Your text here",
  "messages": [
    {
      "role": "user",
      "content": "Hello!"
    }
  ]
}'
```

### 3. POST /health

- Base URL: `https://astroboi-halo-guard.chutes.ai`
- Output content type: `application/json`

Request fields:


Example call:

```bash
curl -X POST "https://astroboi-halo-guard.chutes.ai/health" \
  -H "Authorization: Bearer $CHUTES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

## Agent Integration Checklist

- Pick the endpoint path that matches the desired task.
- Set `CHUTES_API_KEY` in the server-side environment only.
- Validate required fields before sending requests.
- For media models, keep file upload, base64 conversion, and output preview/download handling explicit in the app UI.