# List messages

URL: https://docs.hanzo.ai/docs/openapi/ai/get-ai-messages

> List the caller's messages.

`GET /v1/ai/messages`

> [AI →](https://docs.hanzo.ai/docs/openapi/ai) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                        |
| ------------- | -------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/ai/messages`  |
| **Method**    | `GET`                                  |
| **Operation** | `get_ai_messages`                      |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY` |

List the caller's messages.

## Request

`GET /v1/ai/messages` takes no parameters and no body — the credential is the whole request.

## Response

| Status | Body | Meaning                                             |
| ------ | ---- | --------------------------------------------------- |
| `200`  |      | Envelope.                                           |
| `401`  | —    | No credential, or one this service does not accept. |
| `403`  | —    | A valid credential that may not do this.            |

`200` body — 51 fields.

| Field                              | In   | Type                  | Always | Description                                             |
| ---------------------------------- | ---- | --------------------- | ------ | ------------------------------------------------------- |
| `data`                             | body | any                   | —      | The operation's own result.                             |
| `data2`                            | body | any                   | —      | A second result the operation defines, when it has one. |
| `msg`                              | body | string                | yes    | Empty on success, the reason on failure.                |
| `status`                           | body | string                | yes    | One of `ok`, `error`.                                   |
| `data[].answeredTime`              | body | string                | —      |                                                         |
| `data[].author`                    | body | string                | —      |                                                         |
| `data[].chat`                      | body | string                | —      |                                                         |
| `data[].claimedTime`               | body | string                | —      |                                                         |
| `data[].comment`                   | body | string                | —      |                                                         |
| `data[].createdTime`               | body | string                | —      |                                                         |
| `data[].currency`                  | body | string                | —      |                                                         |
| `data[].dislikeUsers`              | body | string\[]             | —      |                                                         |
| `data[].embeddingProvider`         | body | string                | —      |                                                         |
| `data[].errorText`                 | body | string                | —      |                                                         |
| `data[].fileName`                  | body | string                | —      |                                                         |
| `data[].isAlerted`                 | body | boolean               | —      |                                                         |
| `data[].isDeleted`                 | body | boolean               | —      |                                                         |
| `data[].isHidden`                  | body | boolean               | —      |                                                         |
| `data[].isRegenerated`             | body | boolean               | —      |                                                         |
| `data[].likeUsers`                 | body | string\[]             | —      |                                                         |
| `data[].modelProvider`             | body | string                | —      |                                                         |
| `data[].name`                      | body | string                | —      |                                                         |
| `data[].needNotify`                | body | boolean               | —      |                                                         |
| `data[].organization`              | body | string                | —      |                                                         |
| `data[].owner`                     | body | string                | —      |                                                         |
| `data[].price`                     | body | number                | —      |                                                         |
| `data[].reasonText`                | body | string                | —      |                                                         |
| `data[].replyTo`                   | body | string                | —      |                                                         |
| `data[].searchResults`             | body | model.SearchResult\[] | —      |                                                         |
| `data[].searchResults[].icon`      | body | string                | —      |                                                         |
| `data[].searchResults[].index`     | body | integer               | —      |                                                         |
| `data[].searchResults[].site_name` | body | string                | —      |                                                         |
| `data[].searchResults[].title`     | body | string                | —      |                                                         |
| `data[].searchResults[].url`       | body | string                | —      |                                                         |
| `data[].store`                     | body | string                | —      |                                                         |
| `data[].suggestions`               | body | Candidate\[]          | —      |                                                         |
| `data[].suggestions[].isHit`       | body | boolean               | —      |                                                         |
| `data[].suggestions[].text`        | body | string                | —      |                                                         |
| `data[].text`                      | body | string                | —      |                                                         |
| `data[].textTokenCount`            | body | integer               | —      |                                                         |
| `data[].tokenCount`                | body | integer               | —      |                                                         |
| `data[].toolCalls`                 | body | model.ToolCall\[]     | —      |                                                         |
| `data[].toolCalls[].arguments`     | body | string                | —      |                                                         |
| `data[].toolCalls[].content`       | body | string                | —      |                                                         |
| `data[].toolCalls[].name`          | body | string                | —      |                                                         |
| `data[].transactionId`             | body | string                | —      |                                                         |
| `data[].user`                      | body | string                | —      |                                                         |
| `data[].vectorScores`              | body | VectorScore\[]        | —      |                                                         |
| `data[].vectorScores[].score`      | body | number                | —      |                                                         |
| `data[].vectorScores[].vector`     | body | string                | —      |                                                         |
| `data[].webSearchEnabled`          | body | boolean               | —      |                                                         |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo ai messages list
```

**SDK**

**.ts**

```ts
import { Configuration, AiApi } from 'hanzoai';

const api = new AiApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAiMessages();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AiApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AiApi(client).get_ai_messages()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.AiAPI.GetAiMessages(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, ai_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = ai_api::get_ai_messages(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AiApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new AiApi(client).getAiMessages();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/ai/messages \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP declares no tool for **ai** — `tools/list` on `https://api.hanzo.ai/v1/mcp` names the products it does reach. Use HTTP or an SDK.

---

[AI API](https://docs.hanzo.ai/docs/openapi/ai) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)