Retrieve a stored chat completion | Swagger Petstore

1 parameter

completion_idstringrequired

The unique identifier of the chat completion to retrieve.

1 status code

200Returns the chat completion object with its unique identifier, choices, creation timestamp, model name, and token usage.

idstringrequired

A unique identifier for the chat completion.

choicesarray<object>required

A list of chat completion choices. Can be more than one if `n` is greater than 1.

createdintegerrequired

The Unix timestamp (in seconds) of when the chat completion was created.

modelstringrequired

The model used for the chat completion.

metadataobjectoptional

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

service_tierstringoptional

Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

Allowed:autodefaultflexscalepriorityfastDefault:auto

system_fingerprintstringdeprecatedoptional

This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.

objectstringrequired

The object type, which is always `chat.completion`.

Allowed:chat.completion

usageobjectoptional

Usage statistics for the completion request.

moderationobjectoptional

Moderation results for the request input and generated output, if moderated completions were requested.

Error handling

completion_id must identify an existing chat completion that was created with store set to true.

import { Client } from "acme-sdk";

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

const result = await client.completions.get({ completionId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "choices": [
    {
      "finish_reason": "stop",
      "index": 1,
      "message": {
        "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"
        }
      },
      "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": "moderation_results",
      "model": "example_value",
      "results": [
        {
          "type": null,
          "model": null,
          "flagged": null,
          "categories": null,
          "category_scores": null,
          "category_applied_input_types": null
        }
      ]
    },
    "output": {
      "type": "moderation_results",
      "model": "example_value",
      "results": [
        {
          "type": null,
          "model": null,
          "flagged": null,
          "categories": null,
          "category_scores": null,
          "category_applied_input_types": null
        }
      ]
    }
  }
}

Request

Response

Errors