---
title: "overlane assistant conversation"
description: "Read one of your assistant conversations"
---

> 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 conversation

{/* 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`. */}

Prints the messages of a conversation you had with the assistant, in order, with who said each and the outcome. You can read only your own conversations.

## Usage

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

## Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `conversation` | yes | The conversation ID (shown in the app's assistant panel) |

## 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 conversation c1
overlane assistant conversation c1 --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 conversation`.

## 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"
    },
    "messages": {
      "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
          },
          "conversationId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "origin": {
            "type": "string",
            "enum": [
              "user",
              "assistant",
              "retrieved",
              "tool"
            ]
          },
          "content": {
            "type": "string",
            "maxLength": 8000
          },
          "citations": {
            "default": [],
            "maxItems": 10,
            "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"
                },
                "sourceId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "title": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "url": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 500
                },
                "snippet": {
                  "type": "string",
                  "maxLength": 600
                }
              },
              "required": [
                "tenantId",
                "sourceId",
                "title",
                "url"
              ],
              "additionalProperties": false
            }
          },
          "outcome": {
            "type": "string",
            "enum": [
              "answer",
              "not_found",
              "navigation",
              "tool_result",
              "approval",
              "refusal",
              "info"
            ]
          },
          "createdAt": {
            "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)))$"
          }
        },
        "required": [
          "tenantId",
          "id",
          "conversationId",
          "origin",
          "content",
          "citations",
          "createdAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "messages"
  ],
  "additionalProperties": false
}
```

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

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