Class ApiClient

codecarbon/core/api_client.py:33–358

This class call the Code Carbon API

class ApiClient:  # (AsyncClient)
    """
    This class call the Code Carbon API
    """

    run_id = None

    def __init__(
        self,
        endpoint_url="https://api.codecarbon.io",
        experiment_id=None,
        api_key=None,
        access_token=None,
        conf=None,
        create_run_automatically=True,
    ):
        """
        :endpoint_url: URL of the API endpoint
        :experiment_id: ID of the experiment
        :api_key: Code Carbon API_KEY
        :access_token: Code Carbon API access token
        :conf: Metadata of the experiment
        :create_run_automatically: If False, do not create a run. To use API in read only mode.
        """
        # super().__init__(base_url=endpoint_url) # (AsyncClient)
        self.url = endpoint_url
        self.experiment_id = experiment_id
        self.api_key = api_key
        self.conf = conf
        self.access_token = access_token
        if self.experiment_id is not None and create_run_automatically:
            self._create_run(self.experiment_id)

    def _get_headers(self):
        headers = {"Content-Type": "application/json"}
        if self.api_key:
            # set the x-api-token header
            headers["x-api-token"] = self.api_key
        elif self.access_token:
            headers["Authorization"] = f"Bearer {self.access_token}"
        return headers

    def set_access_token(self, token: str):
        """This method sets the access token to be used for the API.
        Args:
            token (str): access token to be used for the API
        """
        self.access_token = token

    def check_auth(self):
        """
        Check API access to user account
        """
        url = self.url + "/auth/check"
        headers = self._get_headers()
        r = requests.get(url=url, timeout=2, headers=headers)
        if r.status_code != 200:
            self._log_error(url, {}, r)