Delete a conversation
Deletes one of the caller's conversations and its messages. Cannot be undone. An API key's conversation disappears from the workspace's logs too, and its thumbs from the figures: nobody can read it afterwards. To honour a user's request to erase their data, delete each of their conversations (list them with end_user).
DELETE/v1/conversations/{conversation_id}
Requires query.
Deleting removes the conversation and all its messages for good. It is gated by the query scope, like renaming. It costs no credits.
A person deletes their own chats. An API key deletes the conversations it started, and can send end_user as a query parameter to be sure it is that person’s. An API key’s conversation also disappears from the workspace’s logs and from their figures: nobody can read it afterwards. To honour a user’s request to erase their data, list their conversations with end_user and delete each one.
This only deletes your own conversations. The conversations that anonymous visitors had through a widget are kept 90 days and removed with the widget: see Delete a widget.
Authorizations
Authorizationbearerin headerrequiredPath parameters
conversation_idstringrequiredpattern: ^cnv_[abcdefghjkmnpqrstuvwxyz23456789]{12}$Query parameters
end_userstringpattern: ^[\w.@:+\-]{1,200}$API keys only: the end_user of the conversation. When given, a conversation of another end user answers not found.
Response
Delete a conversation
dataobjectrequiredrequest_idstringrequiredPossible codes: invalid_request, unknown_field, invalid_parameter, invalid_cursor
errorobjectrequiredrequest_idstringrequiredPossible codes: authentication_required, invalid_api_key, api_key_expired, api_key_revoked, invalid_access_key
errorobjectrequiredrequest_idstringrequiredPossible codes: insufficient_scope, feature_not_available, admin_required, permission_denied
errorobjectrequiredrequest_idstringrequiredPossible codes: resource_not_found
errorobjectrequiredrequest_idstringrequiredPossible codes: rate_limited
errorobjectrequiredrequest_idstringrequiredPossible codes: internal_error
errorobjectrequiredrequest_idstringrequired