API & SDK

Referencia OpenAPI

La API REST completa de ShieldAgent está descrita en una especificación OpenAPI 3.1. Úsala para generar código de cliente, importarla en Postman/Insomnia o explorar los endpoints de forma interactiva.

URLs de la especificación

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

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

Los despliegues auto-alojados exponen la especificación en http://localhost:<api-port>/openapi.json.

Generar un cliente

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

Para TypeScript y Python, usa los SDKs oficiales — incluyen lógica de reintentos, tipos de error y soporte de streaming.

Explorar endpoints

El catálogo navegable de la API REST con ejemplos de solicitud/respuesta está disponible en los docs:

Explorar referencia de la API REST