Agents

Delete an agent chat attachment

Changed on

Deletes a previously uploaded attachment by proxying DELETE to the query service (/api/v1/chat/attachments/{recordId}). The Node handler always ends the response without a JSON body on success (empty body); the status code is the upstream status, or 204 if none is returned.

On validation failure in the gateway (invalid / blank path params), the response is 400 with a small JSON error object. Same fire-and-forget semantics as DELETE /conversations/attachments/{recordId} on the client.

delete/agents/{agentKey}/conversations/attachments/{recordId}

Request

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

Path parameters

agentKeystring required

Agent key path parameter. Must be non-empty.

recordIdstring required

Attachment record id (from the upload response). Must be non-blank after trim.

Response

Success with no content (typical when upstream returns 204).

Changes

    • breaking

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

    • warning

      for the path request parameter recordId, the maxLength was set to 256

    • 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 non-success 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 required property / to the response with the status

    • info

      added the required property / to the response with the status