SpyBara
Go Premium

cli/resources/conversations/methods/update/index.md 2026-05-05 23:00 UTC to 2026-05-07 21:57 UTC

63 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

Update a conversation

$ openai conversations update

post /conversations/{conversation_id}

Update a conversation

Parameters

  • --conversation-id: string

    The ID of the conversation to update.

  • --metadata: map[string]

    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.

Returns

  • conversation: object { id, created_at, metadata, object }

    • id: string

      The unique ID of the conversation.

    • created_at: number

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

    • metadata: unknown

      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.

Example

openai conversations update \
  --api-key 'My API Key' \
  --conversation-id conv_123 \
  --metadata '{foo: string}'

Response

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