Conversations

Update a conversation

Changed on

Update a conversation

post/conversations/{conversation_id}

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/conversations/{conversation_id}
  • Auth
    HTTP bearer

Path parameters

conversation_idstring required
Example:conv_123

The ID of the conversation to update.

Request body

metadataMetadata nullable required

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.

Response

Success

idstring required

The unique ID of the conversation.

object'conversation' required

The object type, which is always conversation.

metadataobject required

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.

created_atinteger required

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

Changes

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • be3eca83a454Revision changes
    • breaking

      the response's property type changed from no type to object for status