AgentsResource

Agent API methods.

Functions

func__init__(self, client) -> None

Initialize the resource.

paramself

paramclientKitaruAPIClient

API client used to send requests.

Returns

None

funccreate(self, request, idempotency_key=None) -> AgentResponse

Create an agent.

paramself

paramrequestAgentCreateRequest

Agent create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.agent.AgentResponse

Created agent.

funcget(self, agent_id) -> AgentResponse

Get an agent by id.

paramself

paramagent_iduuid.UUID

Id of the agent.

Returns

kitaru.api_models.v1.agent.AgentResponse

Stored agent.

funclist(self, params=None) -> Page[AgentResponse]

List agents.

paramself

paramparamsAgentListParams | None

= None

Agent list params.

Returns

kitaru.api_models.v1.base.Page

Page of agents.

funciter(self, params=None) -> AsyncIterator[AgentResponse]

Iterate over all agents.

paramself

paramparamsAgentListParams | None

= None

Agent list params.

Returns

collections.abc.AsyncIterator

Async iterator over every agent.

funcupdate(self, agent_id, request) -> AgentResponse

Update an agent.

paramself

paramagent_iduuid.UUID

Id of the agent.

paramrequestAgentUpdateRequest

Agent update request, unset fields stay unchanged.

Returns

kitaru.api_models.v1.agent.AgentResponse

Updated agent.

funcdelete(self, agent_id) -> None

Delete an agent, hiding the agent and retaining its subtree.

The agent's stored sessions, versions, cohorts, experiments, and investigations are retained and stay readable through their own resources. Creating new ones for the agent fails.

paramself

paramagent_iduuid.UUID

Id of the agent.

Returns

None

funccreate_version(self, agent_id, request, idempotency_key=None) -> AgentVersionResponse

Create a new version of an agent.

paramself

paramagent_iduuid.UUID

Id of the agent.

paramrequestAgentVersionCreateRequest

Agent version create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.agent_version.AgentVersionResponse

Created agent version.

funclist_versions(self, agent_id, params=None) -> Page[AgentVersionResponse]

List the versions of an agent.

paramself

paramagent_iduuid.UUID

Id of the agent.

paramparamsAgentVersionListParams | None

= None

Agent version list params.

Returns

kitaru.api_models.v1.base.Page

Page of agent versions.

funciter_versions(self, agent_id, params=None) -> AsyncIterator[AgentVersionResponse]

Iterate over every version of an agent.

paramself

paramagent_iduuid.UUID

Id of the agent.

paramparamsAgentVersionListParams | None

= None

Agent version list params.

Returns

collections.abc.AsyncIterator

Async iterator over every version of the agent.

Functions

On this page