Hygiara
Sign In
Documentation / API

API

Use The REST API

How to use the Hygiara REST API reference, OpenAPI document, and API key authentication.

Use the REST API for workflow automation against Hygiara.

Base path

https://your-hygiara-domain.example/api/v1

For local development:

http://app.hygiara.test:8000/api/v1

Authenticate

Create an organization API key in Settings > API Keys and send it with each request:

X-API-Key: hygiara_your_key_here
Accept: application/json

Example:

curl -H "X-API-Key: hygiara_your_key_here" \
  -H "Accept: application/json" \
  http://app.hygiara.test:8000/api/v1/projects

Use the generated reference

Use the generated reference for exact endpoints, request bodies, response shapes, and response codes.

Open the API reference

Use the OpenAPI document for import, tooling, or client generation.

Download the OpenAPI JSON

First workflow

Start with:

  1. list projects
  2. create or identify the project
  3. create a review
  4. check review status until it completes
  5. retrieve findings, recommendations, scores, or report metadata

Common failures

401 or 403

Check the X-API-Key header, key status, and organization automation settings.

404

Check the app domain, /api/v1 base path, and endpoint path.

Validation errors

Compare the request body with the generated API reference.

AI client integration

Use MCP instead of giving API keys to an AI client.