civis.utils.run_job

civis.utils.run_job(job_id: int, client: APIClient | None = None, polling_interval: int | float | None = None) CivisFuture[source]

Run a job.

Parameters:
job_id: int

The ID of the job.

client: :class:`civis.APIClient`, optional

If not provided, an civis.APIClient object will be created from the CIVIS_API_KEY.

polling_intervalint or float, optional

The number of seconds between API requests to check whether a result is ready.

Returns:
results: CivisFuture

A CivisFuture object.