Agents

Soft-delete an agent (tombstone) in the graph database.

Overview: The Python query service marks the agent instance deleted inside a transaction. List and search endpoints exclude tombstoned agents. Toolsets, tools, and knowledge linked to the agent are not removed by this call.

Permissions: Only the agent owner may delete (can_delete on the permission check).

Warning: All conversations with this agent will become inaccessible.

Gateway not-found behavior: Unknown agentKey, deleting an already-deleted agent, deleting another user's agent that is not shared with the caller, and GET /agents/{agentKey} after delete return HTTP 404 with an ErrorResponse body.

The route reads neither a query nor a body; anything sent is ignored.

delete/agents/{agentKey}

Request

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

Unique agent identifier (gateway Zod requires non-empty string).

Response

Agent soft-deleted successfully

status'success' required
messagestring required

Example response

{
  "message": "Agent deleted successfully",
  "deleted": {
    "agents": 1
  }
}

Changes

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