PIpipeshub-ai
Agents

Archive an agent conversation

Changed on

Marks the conversation as archived for the authenticated owner. The route reads no query parameter and no body; anything sent is ignored.

post/agents/{agentKey}/conversations/{conversationId}/archive

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/agents/{agentKey}/conversations/{conversationId}/archive
  • 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 archived

idstring objectId required
status'archived' required
archivedBystring objectId required
archivedAtstring date-time required

Changes

  • dbb5e203b445Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • bb0c59adf026Revision changes
    • 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