Retrieve a conversation
conversations.retrieve(strconversation_id) -> Conversation
get /conversations/{conversation_id}
Get a conversation
Parameters
conversation_id: str
Returns
-
class Conversation: …-
id: strThe unique ID of the conversation.
-
created_at: intThe time at which the conversation was created, measured in seconds since the Unix epoch.
-
metadata: objectSet 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.
-
object: Literal["conversation"]The object type, which is always
conversation."conversation"
-
Example
import os
from openai import OpenAI
client = OpenAI(
api_key=os.environ.get("OPENAI_API_KEY"), # This is the default and can be omitted
)
conversation = client.conversations.retrieve(
"conv_123",
)
print(conversation.id)
Response
{
"id": "id",
"created_at": 0,
"metadata": {},
"object": "conversation"
}
Example
from openai import OpenAI
client = OpenAI()
conversation = client.conversations.retrieve("conv_123")
print(conversation)
Response
{
"id": "conv_123",
"object": "conversation",
"created_at": 1741900000,
"metadata": {"topic": "demo"}
}