> For the complete documentation index, see [llms.txt](https://docs.tryprotege.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tryprotege.com/review/review-tool-concepts/document-review/api-reference.md).

# 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](/review/enterprise-features/integrations-and-api.md) 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:

```http
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 <support@tryprotege.com>.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.tryprotege.com/review/review-tool-concepts/document-review/api-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
