API & SDK

OpenAPI Reference

The full ShieldAgent REST API is described in an OpenAPI 3.1 spec. Use it to generate client code, import into Postman/Insomnia, or explore endpoints interactively.

Spec URLs

JSONhttps://api.shieldagent.io/openapi.json

YAMLhttps://api.shieldagent.io/openapi.yaml

Self-hosted deployments expose the spec at http://localhost:<api-port>/openapi.json.

Generate a client

oapi-codegen -generate types,client -package shieldagent openapi.json

Java

openapi-generator generate -i openapi.json -g java -o ./client

Rust

progenitor-cli generate --input openapi.json --output src/client

For TypeScript and Python, prefer the official SDKs — they include retry logic, error types, and streaming support.

Browse endpoints

The browsable REST API catalog with request/response examples is available in the docs:

Browse REST API Reference