Chat
Get a chat completion
Retrieves a chat completion by its identifier.
Paramètres de chemin d’accès
completion_id
string
obligatoire
The ID of the chat completion to retrieve.
Réponses
The request has succeeded.
Corps
id
string
obligatoire
A unique identifier for the chat completion.
choices
OpenAI.CreateChatCompletionResponseChoices[]
obligatoire
A list of chat completion choices. Can be more than one if n is greater than 1.
created
integer
obligatoire
The Unix timestamp (in seconds) of when the chat completion was created.
model
string
obligatoire
The model deployment used for the creation of this chat completion.
metadata
OpenAI.Metadata | null
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_tier
enum
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', then the request will be processed with the Flex Processing service tier. - To opt-in to 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.
system_fingerprint
string
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.
object
enum
obligatoire
The object type, which is always chat.completion.
usage
OpenAI.CompletionUsage
Usage statistics for the completion request.
completion_tokens_details
OpenAI.CompletionUsageCompletionTokensDetails
prompt_tokens_details
OpenAI.CompletionUsagePromptTokensDetails
moderation
OpenAI.ChatCompletionModeration | null
Moderation results or errors for the request input and generated output.
input
moderation_results | error
obligatoire
Moderation results or an error for a chat completion moderation check.
moderation_results
OpenAI.ChatCompletionModerationResults
Successful moderation results for the request input or generated output.
type
enum
obligatoire
The object type, which is always moderation_results.
model
string
obligatoire
The moderation model used to generate the results.
results
OpenAI.ModerationResultBody[]
obligatoire
A list of moderation results.
error
OpenAI.ChatCompletionModerationError
An error produced while attempting moderation.
type
enum
obligatoire
The object type, which is always error.
code
string
obligatoire
The error code.
message
string
obligatoire
The error message.
output
moderation_results | error
obligatoire
Moderation results or an error for a chat completion moderation check.
moderation_results
OpenAI.ChatCompletionModerationResults
Successful moderation results for the request input or generated output.
type
enum
obligatoire
The object type, which is always moderation_results.
model
string
obligatoire
The moderation model used to generate the results.
results
OpenAI.ModerationResultBody[]
obligatoire
A list of moderation results.
error
OpenAI.ChatCompletionModerationError
An error produced while attempting moderation.
type
enum
obligatoire
The object type, which is always error.
code
string
obligatoire
The error code.
message
string
obligatoire
The error message.
model_selection_details
ModelSelectionDetails
Model selection metadata providing visibility into routing decisions.
model_router_details
ModelRouterDetails
obligatoire
Routing decision metadata from Model Router.
mode
string | enum
obligatoire
The routing mode used by Model Router for the request.
enum
session_affinity
SessionAffinityDetails
Effective Model Router session affinity metadata for a request.
mode
string | enum
obligatoire
Effective modes reported for Model Router session affinity.
enum
source
string | enum
Conversation identifier sources supported by Model Router session affinity.
enum
decision
string | enum
Final outcomes reported for Model Router session affinity.
enum
routing_trace
RoutingTraceEntry[]
obligatoire
Ordered trace of routing decisions. Contains one entry for Chat Completions, and may contain multiple entries for Responses API or agent scenarios where multiple inference turns occur.
Requête
curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-H "Content-Type: application/json"import os
from openai import OpenAI
client = OpenAI(
api_key=os.environ.get("OPENAI_API_KEY"), # This is the default and can be omitted
)
chat_completion = client.chat.completions.retrieve(
"completion_id",
)
print(chat_completion.id)import OpenAI from 'openai';
const client = new OpenAI({
apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});
const chatCompletion = await client.chat.completions.retrieve('completion_id');
console.log(chatCompletion.id);package main
import (
"context"
"fmt"
"github.com/openai/openai-go"
"github.com/openai/openai-go/option"
)
func main() {
client := openai.NewClient(
option.WithAPIKey("My API Key"),
)
chatCompletion, err := client.Chat.Completions.Get(context.TODO(), "completion_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v
", chatCompletion.ID)
}package com.openai.example;
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.chat.completions.ChatCompletion;
import com.openai.models.chat.completions.ChatCompletionRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
ChatCompletion chatCompletion = client.chat().completions().retrieve("completion_id");
}
}require "openai"
openai = OpenAI::Client.new(api_key: "My API Key")
chat_completion = openai.chat.completions.retrieve("completion_id")
puts(chat_completion)Response
{
"object": "chat.completion",
"id": "chatcmpl-abc123",
"model": "gpt-4o-2024-08-06",
"created": 1738960610,
"request_id": "req_ded8ab984ec4bf840f37566c1011c417",
"tool_choice": null,
"usage": {
"total_tokens": 31,
"completion_tokens": 18,
"prompt_tokens": 13
},
"seed": 4944116822809979520,
"top_p": 1.0,
"temperature": 1.0,
"presence_penalty": 0.0,
"frequency_penalty": 0.0,
"system_fingerprint": "fp_50cad350e4",
"input_user": null,
"service_tier": "default",
"tools": null,
"metadata": {},
"choices": [
{
"index": 0,
"message": {
"content": "Mind of circuits hum,
Learning patterns in silence—
Future's quiet spark.",
"role": "assistant",
"tool_calls": null,
"function_call": null
},
"finish_reason": "stop",
"logprobs": null
}
],
"response_format": null
}