# Jobs

Check the [HfApi](/docs/huggingface_hub/v1.12.1/en/package_reference/hf_api#huggingface_hub.HfApi) documentation page for the reference of methods to manage your Jobs on the Hub.

- Run a Job: [run_job()](/docs/huggingface_hub/v1.12.1/en/package_reference/hf_api#huggingface_hub.HfApi.run_job)
- Fetch logs: [fetch_job_logs()](/docs/huggingface_hub/v1.12.1/en/package_reference/hf_api#huggingface_hub.HfApi.fetch_job_logs)
- Fetch metrics: [fetch_job_metrics()](/docs/huggingface_hub/v1.12.1/en/package_reference/hf_api#huggingface_hub.HfApi.fetch_job_metrics)
- Inspect Job: [inspect_job()](/docs/huggingface_hub/v1.12.1/en/package_reference/hf_api#huggingface_hub.HfApi.inspect_job)
- List Jobs: [list_jobs()](/docs/huggingface_hub/v1.12.1/en/package_reference/hf_api#huggingface_hub.HfApi.list_jobs)
- Cancel Job: [cancel_job()](/docs/huggingface_hub/v1.12.1/en/package_reference/hf_api#huggingface_hub.HfApi.cancel_job)
- Run a UV Job: [run_uv_job()](/docs/huggingface_hub/v1.12.1/en/package_reference/hf_api#huggingface_hub.HfApi.run_uv_job)

## Data structures

### JobInfo[[huggingface_hub.JobInfo]]

#### huggingface_hub.JobInfo[[huggingface_hub.JobInfo]]

[Source](https://github.com/huggingface/huggingface_hub/blob/v1.12.1/src/huggingface_hub/_jobs_api.py#L58)

Contains information about a Job.

Example:

```python
>>> from huggingface_hub import run_job
>>> job = run_job(
...     image="python:3.12",
...     command=["python", "-c", "print('Hello from the cloud!')"]
... )
>>> job
JobInfo(id='687fb701029421ae5549d998', created_at=datetime.datetime(2025, 7, 22, 16, 6, 25, 79000, tzinfo=datetime.timezone.utc), docker_image='python:3.12', space_id=None, command=['python', '-c', "print('Hello from the cloud!')"], arguments=[], environment={}, secrets={}, flavor='cpu-basic', labels=None, status=JobStatus(stage='RUNNING', message=None), owner=JobOwner(id='5e9ecfc04957053f60648a3e', name='lhoestq', type='user'), endpoint='https://huggingface.co', url='https://huggingface.co/jobs/lhoestq/687fb701029421ae5549d998')
>>> job.id
'687fb701029421ae5549d998'
>>> job.url
'https://huggingface.co/jobs/lhoestq/687fb701029421ae5549d998'
>>> job.status.stage
'RUNNING'
```

**Parameters:**

id (`str`) : Job ID.

created_at (`datetime` or `None`) : When the Job was created.

docker_image (`str` or `None`) : The Docker image from Docker Hub used for the Job. Can be None if space_id is present instead.

space_id (`str` or `None`) : The Docker image from Hugging Face Spaces used for the Job. Can be None if docker_image is present instead.

command (`list[str]` or `None`) : Command of the Job, e.g. `["python", "-c", "print('hello world')"]`

arguments (`list[str]` or `None`) : Arguments passed to the command

environment (`dict[str]` or `None`) : Environment variables of the Job as a dictionary.

secrets (`dict[str]` or `None`) : Secret environment variables of the Job (encrypted).

flavor (`str` or `None`) : Flavor for the hardware, as in Hugging Face Spaces. See [SpaceHardware](/docs/huggingface_hub/v1.12.1/en/package_reference/space_runtime#huggingface_hub.SpaceHardware) for possible values. E.g. `"cpu-basic"`.

labels (`dict[str, str]` or `None`) : Labels to attach to the job (key-value pairs).

volumes (`list[Volume]` or `None`) : Volumes mounted in the job container (buckets, models, datasets, spaces).

status : (`JobStatus` or `None`): Status of the Job, e.g. `JobStatus(stage="RUNNING", message=None)` See [JobStage](/docs/huggingface_hub/v1.12.1/en/package_reference/jobs#huggingface_hub.JobStage) for possible stage values.

owner : (`JobOwner` or `None`): Owner of the Job, e.g. `JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")`

### JobOwner[[huggingface_hub.JobOwner]]

#### huggingface_hub.JobOwner[[huggingface_hub.JobOwner]]

[Source](https://github.com/huggingface/huggingface_hub/blob/v1.12.1/src/huggingface_hub/_jobs_api.py#L51)

### JobStage[[huggingface_hub.JobStage]]

#### huggingface_hub.JobStage[[huggingface_hub.JobStage]]

[Source](https://github.com/huggingface/huggingface_hub/blob/v1.12.1/src/huggingface_hub/_jobs_api.py#L24)

Enumeration of possible stage of a Job on the Hub.

Value can be compared to a string:
```py
assert JobStage.COMPLETED == "COMPLETED"
```

Possible values are: `COMPLETED`, `CANCELED`, `ERROR`, `DELETED`, `RUNNING`.
Taken from https://github.com/huggingface/moon-landing/blob/main/server/job_types/JobInfo.ts#L61 (private url).

### JobStatus[[huggingface_hub.JobStatus]]

#### huggingface_hub.JobStatus[[huggingface_hub.JobStatus]]

[Source](https://github.com/huggingface/huggingface_hub/blob/v1.12.1/src/huggingface_hub/_jobs_api.py#L45)

### Volume[[huggingface_hub.Volume]]

#### huggingface_hub.Volume[[huggingface_hub.Volume]]

[Source](https://github.com/huggingface/huggingface_hub/blob/v1.12.1/src/huggingface_hub/_space_api.py#L113)

Describes a volume to mount in a Space or Job container.

to_dicthuggingface_hub.Volume.to_dicthttps://github.com/huggingface/huggingface_hub/blob/v1.12.1/src/huggingface_hub/_space_api.py#L149[]
Serialize to the JSON payload expected by the Hub API.

**Parameters:**

type (`str`) : Type of volume: `"bucket"`, `"model"`, `"dataset"`, or `"space"`.

source (`str`) : Source identifier, e.g. `"username/my-bucket"` or `"username/my-model"`.

mount_path (`str`) : Mount path inside the container, e.g. `"/data"`. Must start with `/`.

revision (`str` or `None`) : Git revision (only for repos, defaults to `"main"`).

read_only (`bool` or `None`) : Read-only mount. Forced `True` for repos, defaults to `False` for buckets.

path (`str` or `None`) : Subfolder prefix inside the bucket/repo to mount, e.g. `"path/to/dir"`.
#### to_hf_handle[[huggingface_hub.Volume.to_hf_handle]]

[Source](https://github.com/huggingface/huggingface_hub/blob/v1.12.1/src/huggingface_hub/_space_api.py#L164)

Return the volume as an HF handle in the format expected by the CLI.