PIpipeshub-ai
Conversations

Delete conversation

Changed on

Delete a conversation by its ID.

Overview:

Performs a soft delete by setting isDeleted: true. The conversation is removed from listings but preserved in the database. All citations referenced by messages in the conversation are also soft-deleted.

Permissions:

Only the conversation's owner can delete it. The lookup also allows a user the conversation is shared with at write access, but it requires the caller to be the owner as well, so such a user is answered 404.

Artifacts: before the conversation is marked deleted, every artifact the caller created in it is deleted for good (every version and stored file), and so are older stored outputs of the conversation. If that cannot be done the conversation is left in place and the error is returned (for example 503); repeating the request finishes the cleanup.

delete/conversations/{conversationId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/conversations/{conversationId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: conversation:write

Path parameters

conversationIdstring objectId required

Unique conversation identifier

Response

Conversation deleted successfully

idstring objectId

Identifier of the conversation that was deleted

status'deleted'

Outcome of the operation

deletedAtstring date-time

Timestamp when the conversation was marked deleted

deletedBystring objectId

Identifier of the user who performed the delete

citationsDeletedinteger

Number of citations soft-deleted alongside the conversation

Changes

  • dbb5e203b445Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status