Interactive API

Interactive API Documentation

Explore our GuardSavant API endpoints with our interactive Redoc-style documentation interface.

<RedocStyleApiDocs />

Features

  • Interactive API Explorer: Navigate and explore all endpoints in a three-panel interface
  • Request/Response Schemas: View detailed schema information for all requests and responses
  • Code Examples: See working code examples in Python, cURL, and JavaScript
  • Authentication: All endpoints require API key authentication
  • Schema Details: View field-level documentation with types, descriptions, and examples

Getting Started

  1. Get Your API Key: Create an API key in your account settings
  2. Explore Endpoints: Browse endpoints in the left sidebar
  3. View Details: Click any endpoint to see detailed documentation
  4. Check Code Examples: View working examples in the right panel

Available Endpoints

The API is organized into the following sections:

GuardSavant

  • POST /guard/prompt-input - Scan input prompts for security threats
  • POST /guard/prompt-output - Scan LLM outputs for issues

Scanners

  • GET /scanners - List all available scanners for your plan

Authentication

All API requests require an API key passed in the X-API-Key header:

X-API-Key: your-api-key-here

Base URL

All API requests should be made to:

https://api.testsavant.ai

Troubleshooting

Common Issues

401 Unauthorized

  • Check that your API key is correct
  • Ensure you're using the X-API-Key header
  • Verify the key hasn't expired

422 Validation Error

  • Review the request schema and required fields
  • Check field types and constraints

429 Too Many Requests

  • You've exceeded the rate limit
  • Wait for the reset time or upgrade your plan

Getting Help

  • Documentation: Browse this documentation
  • Support: Email support@testsavant.ai
  • Status: Check status.testsavant.ai