abacusai.api_key
================

.. py:module:: abacusai.api_key


Classes
-------

.. autoapisummary::

   abacusai.api_key.ApiKey


Module Contents
---------------

.. py:class:: ApiKey(client, apiKeyId=None, apiKey=None, apiKeySuffix=None, tag=None, createdAt=None, expiresAt=None, isExpired=None)

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`


   An API Key to authenticate requests to the Abacus.AI API

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param apiKeyId: The unique ID for the API key
   :type apiKeyId: str
   :param apiKey: The unique API key scoped to a specific organization. Value will be partially obscured.
   :type apiKey: str
   :param apiKeySuffix: The last 4 characters of the API key.
   :type apiKeySuffix: str
   :param tag: A user-friendly tag for the API key.
   :type tag: str
   :param createdAt: The timestamp when the API key was created.
   :type createdAt: str
   :param expiresAt: The timestamp when the API key will expire.
   :type expiresAt: str
   :param isExpired: Whether the API key has expired.
   :type isExpired: bool


   .. py:attribute:: api_key_id


   .. py:attribute:: api_key


   .. py:attribute:: api_key_suffix


   .. py:attribute:: tag


   .. py:attribute:: created_at


   .. py:attribute:: expires_at


   .. py:attribute:: is_expired


   .. py:attribute:: deprecated_keys


   .. py:method:: __repr__()


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict



   .. py:method:: delete()

      Delete a specified API key.

      :param api_key_id: The ID of the API key to delete.
      :type api_key_id: str



