Delete Task State

states.delete() -> State

DELETE/states/{state_id}

Delete Task State

ParametersExpand Collapse

state_id: str

ReturnsExpand Collapse

class State: …

Represents a state in the agent system. A state is associated uniquely with a task and an agent.

This entity is used to store states in MongoDB, with each state associated with a specific task and agent. The combination of task_id and agent_id is globally unique.

The state is a dictionary of arbitrary data.

id: str

The task state’s unique id

agent_id: str

created_at: datetime

The timestamp when the state was created

formatdate-time

state: Dict[str, object]

task_id: str

updated_at: Optional[datetime]

The timestamp when the state was last updated

formatdate-time

Delete Task State

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
)
state = client.states.delete(
    "state_id",
)
print(state.id)

{
  "id": "id",
  "agent_id": "agent_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "state": {
    "foo": "bar"
  },
  "task_id": "task_id",
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "id",
  "agent_id": "agent_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "state": {
    "foo": "bar"
  },
  "task_id": "task_id",
  "updated_at": "2019-12-27T18:11:19.117Z"
}