Get chat messages | Sample

4 parameters

completion_idstringrequired

The ID of the chat completion to retrieve messages from.

afterstringoptional

Identifier for the last message from the previous pagination request.

limitintegeroptional

Number of messages to retrieve.

Default:20

orderstringoptional

Sort order for messages by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.

Allowed:ascdescDefault:asc

1 status code

200A list of messages

objectstringrequired

The type of this object. It is always set to "list".

Allowed:listDefault:list

dataarray<object>required

An array of chat completion message objects.

first_idstringrequired

The identifier of the first chat message in the data array.

last_idstringrequired

The identifier of the last chat message in the data array.

has_morebooleanrequired

Indicates whether there are more chat messages available.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.messages.list({
  completionId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  after: "example",
  limit: 20,
  order: "example",
});

{
  "object": "list",
  "data": [
    {
      "content": "example_value",
      "refusal": "example_value",
      "tool_calls": [
        {
          "id": null,
          "type": null,
          "function": null
        }
      ],
      "annotations": [
        {
          "type": "url_citation",
          "url_citation": {
            "end_index": null,
            "start_index": null,
            "url": null,
            "title": null
          }
        }
      ],
      "role": "assistant",
      "function_call": {
        "arguments": "example_value",
        "name": "Example Name"
      },
      "audio": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "expires_at": 1,
        "data": "example_value",
        "transcript": "example_value"
      },
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "content_parts": [
        null
      ]
    }
  ],
  "first_id": "550e8400-e29b-41d4-a716-446655440000",
  "last_id": "550e8400-e29b-41d4-a716-446655440000",
  "has_more": true
}

Request

Response