For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Reference

Protege exposes an external API for tenant-scoped document review workflows, reference data discovery, scanner job management, and scanner reports.

API access is typically enabled as part of an enterprise integration. For packaging guidance, support expectations, and how an optional agent skill fits into a broader rollout, see the enterprise Integrations & API guide.

This GitBook space includes an API reference generated from the Protege OpenAPI specification. The reference is organized into four groups:

  1. Reference Data for brands, policies, policy groups, and document evaluation types

  2. Document Reviews for creating and retrieving reviews

  3. Scanner Jobs for managing monitoring jobs and run history

  4. Reports for scanner report summaries and detail views

Authentication

All endpoints use bearer authentication with an external Protege API key.

Send requests with:

Authorization: Bearer <your-api-key>

Base URL

The documented sandbox server for the API is:

https://sandbox.tryprotege.com

Formats

The Create a document review endpoint supports both:

  1. application/json for direct text review requests

  2. multipart/form-data for file upload review requests

Need Access?

If you need an API key, help choosing the right documentEvaluationTypeId, or sample requests for your integration, contact the Protege team through your shared support channel or email founders@tryprotege.com.

Last updated

Was this helpful?