Delete Agent by Name

agents.delete_by_name() -> DeleteResponse

DELETE/agents/name/{agent_name}

Delete an agent by its unique name.

ParametersExpand Collapse

agent_name: str

ReturnsExpand Collapse

class DeleteResponse: …

id: str

message: str

Delete Agent by Name

import os
from agentex import Agentex

client = Agentex(
    api_key=os.environ.get("AGENTEX_SDK_API_KEY"),  # This is the default and can be omitted
)
delete_response = client.agents.delete_by_name(
    "agent_name",
)
print(delete_response.id)

{
  "id": "id",
  "message": "message"
}

Returns Examples

{
  "id": "id",
  "message": "message"
}