Skip to content

Delete Run Schedule By Name

agents.schedules.delete_by_name(strname, ScheduleDeleteByNameParams**kwargs) -> DeleteResponse
DELETE/agents/{agent_id}/schedules/name/{name}

Delete a run schedule by its active name.

ParametersExpand Collapse
agent_id: str
name: str
ReturnsExpand Collapse
class DeleteResponse: …
id: str
message: str

Delete Run Schedule 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.schedules.delete_by_name(
    name="name",
    agent_id="agent_id",
)
print(delete_response.id)
{
  "id": "id",
  "message": "message"
}
Returns Examples
{
  "id": "id",
  "message": "message"
}