Delete an agent by external id

async AsyncCogniteClient.agents.delete(
external_ids: str | SequenceNotStr[str],
ignore_unknown_ids: bool = False,
) → None

Delete one or more agents.

Parameters:

  • external_ids (str | SequenceNotStr[str]) – External ID of the agent or a list of external ids.

  • ignore_unknown_ids (bool) – If True, the call will ignore unknown external IDs. Defaults to False.

Examples

Delete an agent by external id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> client.agents.delete(external_ids="my_agent")