Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: LLM Guard System API
description: Self-hostable REST API for LLM Guard, Protect AI's open-source (Apache 2.0) security toolkit for LLM interactions.
termsOfService: https://protectai.com/terms
contact:
name: Protect AI / LLM Guard
url: https://llm-guard.com/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '1.0'
servers:
- url: http://localhost:8000
description: Default local llm-guard-api deployment (FastAPI/Uvicorn).
security:
- bearerAuth: []
- {}
tags:
- name: System
paths:
/:
get:
operationId: getRoot
tags:
- System
summary: Service metadata
description: Returns basic service and version information for the running LLM Guard API.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: true
/healthz:
get:
operationId: getHealthz
tags:
- System
summary: Liveness probe
description: Returns the liveness status of the API process.
responses:
'200':
description: Service is alive.
content:
application/json:
schema:
$ref: '#/components/schemas/HealthStatus'
/readyz:
get:
operationId: getReadyz
tags:
- System
summary: Readiness probe
description: Returns readiness once scanners are loaded and the API can serve scan requests.
responses:
'200':
description: Service is ready.
content:
application/json:
schema:
$ref: '#/components/schemas/HealthStatus'
/metrics:
get:
operationId: getMetrics
tags:
- System
summary: Prometheus metrics
description: Exposes Prometheus-format metrics for the API when metrics are enabled.
responses:
'200':
description: Metrics in Prometheus text exposition format.
content:
text/plain:
schema:
type: string
components:
schemas:
HealthStatus:
type: object
properties:
status:
type: string
example: ok
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Optional bearer token authentication, enabled per deployment via the llm-guard-api configuration. Deployments may also run without auth.