Agents

Delete an agent conversation

Changed on

Soft-deletes an agent conversation owned by the authenticated user.

The controller scopes the lookup by _id, orgId, userId, and agentKey. If no matching writable conversation is found, the route is intentionally a no-op and still returns HTTP 200 with conversation: null.

This makes the operation idempotent:

  • deleting a nonexistent conversation returns success with null
  • deleting through a different agentKey returns success with null
  • deleting an already deleted conversation returns success with null

Artifacts: before the conversation is marked deleted, every artifact the caller created in it is deleted for good (every version and stored file). Artifacts another participant created stay theirs. If the cleanup cannot be done the conversation is left in place and the error is returned (for example 503); repeating the request finishes it.

delete/agents/{agentKey}/conversations/{conversationId}

Request

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

Path parameters

agentKeystring required
conversationIdstring objectId required

Response

Conversation deleted or no-op delete completed successfully

message'Conversation deleted successfully' required

Changes

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • info

      added the non-success 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

    • info

      added to the ///////// response property anyOf list for the response status

    • info

      added to the ///////// response property anyOf list for the response status

    • info

      added to the ///////// response property anyOf list for the response status

    • info

      added to the ///////// response property anyOf list for the response status

    • info

      added to the ///////// response property anyOf list for the response status

    • info

      added to the //////// response property anyOf list for the response status

    • info

      added subschema #1 to the //////// response property anyOf list for the response 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

    • 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

    • 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