<!--
  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-instructions

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


# Decisions the human made in immut that this agent must apply

`GET /agent/instructions`

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

CALL THIS AT THE START OF EVERY SWEEP. Defaults to status=pending and excludes expired rows. `protect` means upload that path on this sweep; `reject` means leave it and record decision `declined_by_human`. Mark each one applied with PATCH once you have actually acted.

## Parameters

| Name | In | Required | Description |
|---|---|---|---|
| `status` | query | no | pending \| applied \| cancelled (default pending, which also excludes expired rows) |

## Responses

| Status | Meaning |
|---|---|
| `200` | Success Returns: per row: path, action, status, requestedAt, appliedAt, expiresAt, workspace. Newest first, capped at 500. meta carries count and status. |
| `400` | BadRequest |
| `401` | Unauthorized |
| `403` | Forbidden |
| `429` | RateLimited |

## Example

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

## OpenAPI fragment

```json
{
  "/agent/instructions": {
    "get": {
      "operationId": "getagentinstructions",
      "summary": "Decisions the human made in immut that this agent must apply. CALL THIS AT THE START OF EVERY SWEEP. Defaults to status=pending and excludes expired rows. `protect` means upload that path on this sweep; `reject` means leave it and record decision `declined_by_human`. Mark each one applied with PATCH once you have actually acted.",
      "description": "Decisions the human made in immut that this agent must apply. CALL THIS AT THE START OF EVERY SWEEP. Defaults to status=pending and excludes expired rows. `protect` means upload that path on this sweep; `reject` means leave it and record decision `declined_by_human`. Mark each one applied with PATCH once you have actually acted.",
      "parameters": [
        {
          "name": "status",
          "in": "query",
          "required": false,
          "schema": {
            "type": "string"
          },
          "description": "pending | applied | cancelled (default pending, which also excludes expired rows)"
        }
      ],
      "responses": {
        "200": {
          "description": "Success Returns: per row: path, action, status, requestedAt, appliedAt, expiresAt, workspace. Newest first, capped at 500. meta carries count and status."
        },
        "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"
    }
  }
}
```