API Overview

Coming Soon

The Tokligence Guard API is currently in development. This page provides a preview of the planned endpoints.

What is the Guard API?

The Tokligence Guard API provides a REST interface for detecting and redacting sensitive data. It's designed for server-side applications, batch processing, and advanced integrations.

Planned Endpoints

Detection

POST /v1/detect
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "text": "My email is john@example.com and phone is 555-123-4567",
  "categories": ["pii", "api_keys"],
  "sensitivity": "medium"
}

Response:

{
  "findings": [
    {
      "type": "email",
      "value": "john@example.com",
      "start": 12,
      "end": 28,
      "confidence": 0.99
    },
    {
      "type": "phone",
      "value": "555-123-4567",
      "start": 43,
      "end": 55,
      "confidence": 0.95
    }
  ]
}

Redaction

POST /v1/redact
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "text": "My email is john@example.com",
  "style": "placeholder"
}

Response:

{
  "original": "My email is john@example.com",
  "redacted": "My email is [EMAIL_REDACTED]",
  "findings": [...]
}

Batch Processing

POST /v1/batch/redact
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "texts": [
    "Email: john@example.com",
    "Phone: 555-123-4567"
  ]
}

Authentication

All API requests require authentication via API key:

Authorization: Bearer YOUR_API_KEY

API keys can be generated from your Tokligence dashboard.

Rate Limits

Plan	Requests/min	Requests/day
Free	10	100
Pro	100	10,000
Enterprise	Custom	Custom

Getting Notified

Want to know when the API is available?

1. Sign up at guard.tokligence.ai
2. Join our waitlist for API access