Documentation

Everything you need to integrate Nelix into your security workflow

Quick Start

Get up and running with Nelix in minutes

  1. Sign up for a free account
  2. Upload your first document via the web interface
  3. Review the security analysis results
  4. Generate an API key for programmatic access

Security Overview

Understanding PDF security signals

Hidden Text Attacks

Learn how malicious actors embed invisible instructions in PDFs to manipulate AI systems.

Layer Manipulation

Understand how PDF layers can be exploited to hide content from human reviewers.

Metadata Injection

Discover how document metadata can be used as an attack vector.

API Integration

Integrate Nelix into your pipeline

RESTful API

Simple REST endpoints for document analysis with comprehensive JSON responses.

API Reference

Complete API documentation with examples. Create a key on your API Keys page and send it as Authorization: Bearer YOUR_API_KEY. Deleting a key takes effect within 60 seconds, so a revoked key can keep working for up to a minute.

POST /v1/analyze

Submit a document for security analysis. The body is the raw PDF, up to 10 MB; a larger PDF is rejected with 413.

curl -X POST https://api.nelix.ai/v1/analyze \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/pdf" \
  -H "X-File-Name: document.pdf" \
  --data-binary @document.pdf

GET /v1/jobs/{jobId}

Poll a job for its status and findings. Use the jobId returned by /analyze.

curl https://api.nelix.ai/v1/jobs/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response codes worth handling

  • 413 Payload Too Large — the PDF is larger than 10 MB.
  • 503 Database service unavailable — retry after a short delay.

The full list, including the 202 returned while an analysis is still running, is on the API documentation page.

View Full API Documentation

Resources

Additional guides and best practices

Best Practices

  • • Document Preprocessing Tips
  • • Handling Large Files
  • • Security Recommendations
  • • Rate Limiting Guidelines

Open Source

Nelix (a.k.a. Doc Sherlock) is built in the open. Contribute to the project, report issues, or deploy your own instance.

View on GitHub