SpyBara
Go Premium

ruby/resources/conversations/methods/retrieve/index.md 2026-05-02 05:57 UTC to 2026-05-05 23:00 UTC

57 added, 0 removed.

2026
Wed 27 06:42 Fri 22 06:33 Wed 20 06:35 Tue 19 06:34 Mon 18 22:01 Mon 11 18:00 Thu 7 21:57 Tue 5 23:00 Sat 2 05:57
Data Information:
  • After 2026-05-05 06:03 UTC, this monitor no longer uses markdownified HTML/MDX. Comparisons across that boundary can therefore show more extensive diffs.

Retrieve a conversation

conversations.retrieve(conversation_id) -> Conversation

get /conversations/{conversation_id}

Get a conversation

Parameters

  • conversation_id: String

Returns

  • class Conversation

    • id: String

      The unique ID of the conversation.

    • created_at: Integer

      The time at which the conversation was created, measured in seconds since the Unix epoch.

    • metadata: untyped

      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.

    • object: :conversation

      The object type, which is always conversation.

      • :conversation

Example

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

conversation = openai.conversations.retrieve("conv_123")

puts(conversation)

Response

{
  "id": "id",
  "created_at": 0,
  "metadata": {},
  "object": "conversation"
}