List messages from a stored chat completion | Swagger Petstore

4 parameters

completion_idstringrequired

The unique identifier of the chat completion to retrieve messages from.

afterstringoptional

Pagination cursor. Pass the identifier of the last message from the previous request to fetch the next page.

limitintegeroptional

Number of messages to retrieve per page. Defaults to 20 when omitted.

Default:20

orderstringoptional

Sort order for messages by timestamp: `asc` for ascending or `desc` for descending. Defaults to `asc` when omitted.

Allowed:ascdescDefault:asc

1 status code

200Returns a paginated list of message objects with metadata including the first and last message identifiers and a flag indicating whether more messages are available.

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.

Error handling

completion_id must identify an existing chat completion that was created with store set to true. limit must be a positive integer, and order must be either asc or desc.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

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": "Jane Doe"
      },
      "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

Errors