Sample - OpenAI API
POST/conversations/{conversation_id}

Update a conversation

Updates the metadata associated with an existing conversation. Supply the complete metadata value to replace the conversation's current metadata, or null when supported by the schema. The response returns the updated conversation resource.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
conversation_idstringrequired
The identifier of the conversation to update.

Conversation metadata replacement data. metadata is required.

metadataobjectrequired
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.

2 status codes
200Returns the updated conversation with its identifier, `conversation` object type, metadata, and Unix creation timestamp.
idstringrequired
The unique ID of the conversation.
objectstringrequired
The object type, which is always `conversation`.
Allowed:conversationDefault:conversation
metadataunknownrequired
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_atintegerrequired
The time at which the conversation was created, measured in seconds since the Unix epoch.
429Returned when the request was rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

metadata is required and must contain no more than 16 key-value pairs or be null. conversation_id must identify the conversation to update. A 429 is returned when the request exceeds the rate limit.