---
title: "overlane assistant audit"
description: "Show the assistant's audit trail for the team"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane assistant audit

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

Lists one row per assistant tool call, refusals included, newest last: when, who, which tool and the result. Arguments are kept only as a digest. Needs the right to manage team policy; the service refuses an agent token.

## Usage

```sh
overlane assistant audit [--service URL] [--team TENANT_ID]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--service` | string | no |  | The service address (default: OVERLANE_SERVICE_URL, then the project's binding, then the hosted service) |
| `--team` | string | no |  | The team (tenant) to act on (default: the one your token belongs to) |

## Examples

```sh
overlane assistant audit
overlane assistant audit --json
```

## Behavior

- Effect: `read` (changes nothing).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: no. Accepts `--force`: no.
- Machine-readable description: `overlane schema assistant audit`.

## Result

With `--json` (the default when stdout is not a terminal) the command prints this JSON Schema's shape on stdout.

```json
{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
      "description": "tenant identifier"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "tenant identifier"
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "at": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "actor": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128,
                "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
                "description": "user identifier"
              },
              "role": {
                "type": "string",
                "enum": [
                  "owner",
                  "admin",
                  "member",
                  "viewer",
                  "agent"
                ]
              }
            },
            "required": [
              "userId",
              "role"
            ],
            "additionalProperties": false
          },
          "conversationId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "tool": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "argumentsDigest": {
            "type": "string",
            "pattern": "^sha256:[0-9a-f]{64}$"
          },
          "result": {
            "type": "string",
            "enum": [
              "ok",
              "refused",
              "error",
              "approval_proposed",
              "approval_decided"
            ]
          },
          "detail": {
            "type": "string",
            "maxLength": 300
          },
          "approvalId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          }
        },
        "required": [
          "tenantId",
          "id",
          "at",
          "actor",
          "conversationId",
          "tool",
          "argumentsDigest",
          "result"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "events"
  ],
  "additionalProperties": false
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/assistant-audit/index.mdx