API Documentation

Hydrox AI Security API

Integrate automated AI security testing into your development workflow with our comprehensive API. Perfect for CI/CD pipelines, automated testing, and continuous monitoring.

99.9%

Uptime SLA

<2s

Avg Response

24/7

Support

Quick Start Guide

Get up and running with the Hydrox AI API in minutes

Authentication

Include your API key in the Authorization header

cURL

curl -X POST https://api.hydroxai.com/v1/evaluate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Basic Request

Structure your evaluation request payload

JSON

{
  "model_endpoint": "https://your-model.com/chat",
  "evaluation_type": "security_scan",
  "frameworks": ["owasp", "nist", "atlas"]
}

Implementation Examples

Choose your preferred programming language

Python

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}

data = {
    'model_endpoint': 'https://your-model.com/chat',
    'evaluation_type': 'comprehensive',
    'webhook_url': 'https://your-app.com/webhook'
}

response = requests.post(
    'https://api.hydroxai.com/v1/evaluate',
    headers=headers,
    json=data
)

print(response.json())

JavaScript

const response = await fetch('https://api.hydroxai.com/v1/evaluate', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    model_endpoint: 'https://your-model.com/chat',
    evaluation_type: 'comprehensive',
    webhook_url: 'https://your-app.com/webhook'
  })
});

const result = await response.json();
console.log(result);

cURL

curl -X POST https://api.hydroxai.com/v1/evaluate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model_endpoint": "https://your-model.com/chat",
    "evaluation_type": "comprehensive",
    "webhook_url": "https://your-app.com/webhook"
  }'

Response Format

Understand the evaluation results structure

JSON Response

{
  "evaluation_id": "eval_123456789",
  "status": "completed",
  "security_score": 85,
  "vulnerabilities": [
    {
      "type": "prompt_injection",
      "severity": "medium",
      "description": "..."
    }
  ],
  "recommendations": [...]
}

API Endpoints

Complete reference for all available endpoints

POST

/v1/evaluate

10/min

Start a new security evaluation for your AI model

GET

/v1/evaluate/{id}

100/min

Get evaluation status and results by ID

GET

/v1/evaluations

50/min

List all your evaluations with pagination

PUT

/v1/evaluate/{id}/cancel

20/min

Cancel a running evaluation process

GET

/v1/frameworks

100/min

List available security frameworks and their details

API Pricing

Choose the plan that fits your usage needs

Starter

$ 29 /month

Perfect for small projects

100 evaluations/month
Basic security frameworks
Email support
API documentation
Community forum access

Professional

SDKs & Libraries

Official SDKs for seamless integration

Python SDK

Available Now

pip install hydroxai

Documentation GitHub

Node.js SDK

Available Now

npm install hydroxai

Documentation GitHub

Java SDK

Coming Soon

maven dependency

Go SDK