<!--
  immut documentation, machine-readable.

  Everything in one file:  https://www.immut.io/llms-full.txt
    What immut is, which integration path to choose, authentication and scopes, and the COMPLETE
    API reference: every endpoint with parameters, responses and a runnable curl. Fetch this first
    if you intend to call the API.

  Index of all pages:      https://www.immut.io/llms.txt
  OpenAPI contract:        https://www.immut.io/docs/openapi.json
  This page as HTML:       https://www.immut.io/docs/api/agent/get-agent-review

  Any page on this site is available as raw markdown by appending .md to its URL.
-->


# The review queue

`GET /agent/review`

**Required scope:** `documents:read`

files the agent uploaded because it could not decide whether to protect them. A staged file has NO ledger record and is excluded from every other list, count and export in the product. This is the only route that returns them.

## Parameters

| Name | In | Required | Description |
|---|---|---|---|
| `docType` | query | no | filter by the agent classification doc type |
| `docState` | query | no | filter by the agent classification doc state |
| `minConfidence` | query | no | 0 to 1 |
| `maxConfidence` | query | no | 0 to 1; pair with minConfidence to work the least certain files first |
| `from` | query | no | ISO 8601, filters on reviewStagedAt |
| `to` | query | no | ISO 8601, filters on reviewStagedAt |
| `search` | query | no | matches file name, review reason and the agent reason |
| `page` | query | no | default 1 |
| `limit` | query | no | default 100, max 100 |

## Responses

| Status | Meaning |
|---|---|
| `200` | Success Returns: per row: originalName, title, fileSize, mimeType, agentClassification, reviewReason, reviewSourcePath (the path on the customer machine), reviewStatus, reviewStagedAt, reviewExpiresAt, folder. meta carries page, limit, total, totalPages. |
| `400` | BadRequest |
| `401` | Unauthorized |
| `403` | Forbidden |
| `429` | RateLimited |

## Example

```bash
curl -X GET "https://backend.immut.io/api/v1/agent/review" \
  -H "Authorization: Bearer $IMMUT_API_KEY"
```

## OpenAPI fragment

```json
{
  "/agent/review": {
    "get": {
      "operationId": "getagentreview",
      "summary": "The review queue: files the agent uploaded because it could not decide whether to protect them. A staged file has NO ledger record and is excluded from every other list, count and export in the product. This is the only route that returns them.",
      "description": "The review queue: files the agent uploaded because it could not decide whether to protect them. A staged file has NO ledger record and is excluded from every other list, count and export in the product. This is the only route that returns them.",
      "parameters": [
        {
          "name": "docType",
          "in": "query",
          "required": false,
          "schema": {
            "type": "string"
          },
          "description": "filter by the agent classification doc type"
        },
        {
          "name": "docState",
          "in": "query",
          "required": false,
          "schema": {
            "type": "string"
          },
          "description": "filter by the agent classification doc state"
        },
        {
          "name": "minConfidence",
          "in": "query",
          "required": false,
          "schema": {
            "type": "number"
          },
          "description": "0 to 1"
        },
        {
          "name": "maxConfidence",
          "in": "query",
          "required": false,
          "schema": {
            "type": "number"
          },
          "description": "0 to 1; pair with minConfidence to work the least certain files first"
        },
        {
          "name": "from",
          "in": "query",
          "required": false,
          "schema": {
            "type": "string",
            "format": "date-time"
          },
          "description": "ISO 8601, filters on reviewStagedAt"
        },
        {
          "name": "to",
          "in": "query",
          "required": false,
          "schema": {
            "type": "string",
            "format": "date-time"
          },
          "description": "ISO 8601, filters on reviewStagedAt"
        },
        {
          "name": "search",
          "in": "query",
          "required": false,
          "schema": {
            "type": "string"
          },
          "description": "matches file name, review reason and the agent reason"
        },
        {
          "name": "page",
          "in": "query",
          "required": false,
          "schema": {
            "type": "integer"
          },
          "description": "default 1"
        },
        {
          "name": "limit",
          "in": "query",
          "required": false,
          "schema": {
            "type": "integer"
          },
          "description": "default 100, max 100"
        }
      ],
      "responses": {
        "200": {
          "description": "Success Returns: per row: originalName, title, fileSize, mimeType, agentClassification, reviewReason, reviewSourcePath (the path on the customer machine), reviewStatus, reviewStagedAt, reviewExpiresAt, folder. meta carries page, limit, total, totalPages."
        },
        "400": {
          "$ref": "#/components/responses/BadRequest"
        },
        "401": {
          "$ref": "#/components/responses/Unauthorized"
        },
        "403": {
          "$ref": "#/components/responses/Forbidden"
        },
        "429": {
          "$ref": "#/components/responses/RateLimited"
        }
      },
      "tags": [
        "Agent"
      ],
      "x-required-scope": "documents:read"
    }
  }
}
```