List stored chat completions | Swagger Petstore

5 parameters

modelstringoptional

Filter results to chat completions generated by this specific model.

metadataobjectoptional

Filter by metadata key-value pairs. Pass as `metadata[key1]=value1&metadata[key2]=value2`.

afterstringoptional

Pagination cursor. Pass the ID of the last chat completion from the previous response to fetch the next page.

limitintegeroptional

Number of chat completions to retrieve per page. Defaults to 20 when omitted.

Default:20

orderstringoptional

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

Allowed:ascdescDefault:asc

1 status code

200Returns a paginated list of chat completion objects with metadata, along with pagination cursors and a flag indicating whether more results exist.

objectstringrequired

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

Allowed:listDefault:list

dataarray<object>required

An array of chat completion objects.

first_idstringrequired

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

last_idstringrequired

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

has_morebooleanrequired

Indicates whether there are more Chat Completions available.

Error handling

limit must be a positive integer — zero or negative values are rejected. order must be asc or desc if provided. after must be a valid chat completion ID from a previous response if provided.

import { Client } from "acme-sdk";

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

const result = await client.completions.list({ model: "example", metadata: "example", after: "example", limit: 20, order: "example" });

{
  "object": "list",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "choices": [
        {
          "finish_reason": "stop",
          "index": 1,
          "message": {
            "content": null,
            "refusal": null,
            "tool_calls": [
              null
            ],
            "annotations": [
              null
            ],
            "role": "assistant",
            "function_call": {
              "arguments": null,
              "name": null
            },
            "audio": null
          },
          "logprobs": {
            "content": null,
            "refusal": null
          }
        }
      ],
      "created": 1,
      "model": "example_value",
      "service_tier": "auto",
      "system_fingerprint": "example_value",
      "object": "chat.completion",
      "usage": {
        "completion_tokens": 0,
        "prompt_tokens": 0,
        "total_tokens": 0,
        "completion_tokens_details": {
          "accepted_prediction_tokens": 0,
          "audio_tokens": 0,
          "reasoning_tokens": 0,
          "text_tokens": "example_key_abc123",
          "rejected_prediction_tokens": 0
        },
        "prompt_tokens_details": {
          "audio_tokens": 0,
          "cached_tokens": 0,
          "text_tokens": "example_key_abc123",
          "image_tokens": "example_key_abc123",
          "cache_write_tokens": 0
        }
      },
      "moderation": {
        "input": {
          "type": null,
          "model": null,
          "results": null
        },
        "output": {
          "type": null,
          "model": null,
          "results": null
        }
      }
    }
  ],
  "first_id": "550e8400-e29b-41d4-a716-446655440000",
  "last_id": "550e8400-e29b-41d4-a716-446655440000",
  "has_more": true
}

Request

Response

Errors