Documentation

curl -X POST https://your-gateway.onrender.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      { "role": "user", "content": "What is LLMShield?" }
    ]
  }'

# From the LLMShield project root, link the SDK globally
cd sdk
npm link

# Then, in your application directory
cd /path/to/your-app
npm link llmshield-sdk

const { createLLMClient } = require('llmshield-sdk');

const client = createLLMClient({
  baseURL: 'https://your-gateway.onrender.com'
});

// Simple: just pass a prompt string
const answer = await client.chat('What is machine learning?');
console.log(answer);

// Use chatRaw() for full control over the request body
const response = await client.chatRaw({
  messages: [
    { role: 'system', content: 'You are a helpful coding assistant.' },
    { role: 'user', content: 'Write a binary search in Python' }
  ]
});

console.log(response.choices[0].message.content);
console.log(response._llmshield);
// → { model: 'llama-3.3-70b-versatile', cost: 0.002, latency: 1200, cacheHit: false }

try {
  const answer = await client.chat('My email is john@test.com');
} catch (err) {
  if (err.status === 403) {
    console.log('Blocked by guardrail:', err.details.message);
    // → "Email address detected"
  }
}

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "model": "llama-3.1-8b-instant",
  "choices": [{
    "message": {
      "role": "assistant",
      "content": "Machine learning is a subset of AI..."
    },
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 43,
    "completion_tokens": 30,
    "total_tokens": 73
  },
  "_llmshield": {
    "model": "llama-3.1-8b-instant",
    "cost": 0.0000046,
    "latency": 407,
    "cacheHit": false
  }
}

{
  "id": "cache-1775267576857",
  "choices": [{
    "message": {
      "role": "assistant",
      "content": "Machine learning is a subset of AI..."
    }
  }],
  "usage": { "prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0 },
  "_llmshield": {
    "cacheHit": true,
    "latency": 1
  }
}

{
  "error": "Request blocked by guardrail",
  "details": {
    "blocked": true,
    "type": "email",
    "message": "Email address detected"
  }
}