Helpers

gretel_client.helpers.do_api_call(method: str, path: str, query_params: dict | None = None, body: dict | None = None, headers: dict | None = None, *, session: ClientConfig | None = None) → dict

Make a direct API call to Gretel Cloud.

Parameters:

  • method – “get”, “post”, etc

  • path – The full path to make the request to, any path params must be already included. Example: “/users/me”

  • query_params – Optional URL based query parameters

  • body – An optional JSON payload to send

  • headers – Any custom headers that need to bet set.

  • session – the session to use, or None to use the default session.

Note

This function will automatically inject the appropriate API hostname and authentication from the Gretel configuration.

gretel_client.helpers.poll(job: Job, wait: int = -1, verbose: bool = True) → None

Polls a Model or RecordHandler.

Parameters:

  • job – The job to poll.

  • wait – The time to wait for the job to complete.

  • verbose – False uses new quiet polling, defaults to True.