Retrieve

async AsyncCogniteClient.limits.retrieve(

id: str,

) → Limit | None

Retrieve a limit value by its id.

Retrieves a limit value by its limitId.

Parameters:

id (str) – Limit ID to retrieve. Limits are identified by an id containing the service name and a service-scoped limit name. For instance atlas.monthly_ai_tokens is the id of the atlas service limit monthly_ai_tokens. Service and limit names are always in lower_snake_case.

Returns:

The requested limit, or None if not found.

Return type:

Limit | None

Examples

Retrieve a single limit by id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.limits.retrieve(id="atlas.monthly_ai_tokens")