Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hugging Face Transformers jobs API

The following endpoints manage jobs.

Hugging Face Transformers jobs API is one of 27 APIs that Hugging Face Transformers publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 20 operations across 17 paths. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://huggingface.co.

20 operations 17 paths 0 schemas 1 DELETE9 GET8 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api-inference.huggingface.co
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Hugging Face Transformers jobs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 20

Across 17 paths, the API surfaces 20 operations — 1 DELETE, 9 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

jobs 20

The following endpoints manage jobs.

GET
/api/jobs/hardware
Get job hardware
→ 200
GET
/api/jobs/{namespace}
List jobs
2 params → 200
POST
/api/jobs/{namespace}
Start a job
1 param body → 200
GET
/api/jobs/{namespace}/count
Count jobs
2 params → 200
GET
/api/jobs/{namespace}/{jobId}
Get a job
2 params → 200
GET
/api/jobs/{namespace}/{jobId}/logs
Stream job logs
3 params
GET
/api/jobs/{namespace}/{jobId}/metrics
Stream job metrics
2 params
GET
/api/jobs/{namespace}/{jobId}/events
Stream job events
2 params
POST
/api/jobs/{namespace}/{jobId}/cancel
Cancel a job
2 params → 200
POST
/api/jobs/{namespace}/{jobId}/duplicate
Duplicate a job
2 params → 200
PUT
/api/jobs/{namespace}/{jobId}/labels
Update job labels
2 params body → 200
POST
/api/scheduled-jobs/{namespace}
Create a scheduled job
1 param body → 200
GET
/api/scheduled-jobs/{namespace}
List scheduled jobs
2 params → 200
GET
/api/scheduled-jobs/{namespace}/{jobId}
Get a scheduled job
2 params → 200
DELETE
/api/scheduled-jobs/{namespace}/{jobId}
Delete a scheduled job
2 params
POST
/api/scheduled-jobs/{namespace}/{jobId}/suspend
Suspend a scheduled job
2 params
POST
/api/scheduled-jobs/{namespace}/{jobId}/resume
Resume a scheduled job
2 params
POST
/api/scheduled-jobs/{namespace}/{jobId}/run
Run job
2 params → 200409
POST
/api/scheduled-jobs/{namespace}/{jobId}/schedule
Update a scheduled job schedule
2 params body → 200
PUT
/api/scheduled-jobs/{namespace}/{jobId}/labels
Update scheduled job labels
2 params body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hugging-face-transformers-jobs-api-openapi.yml Raw ↑

Other APIs Hugging Face Transformers publishes across the network.

Hugging Face Transformers Library
Hugging Face Inference API
Hugging Face Spaces API
Text Generation Inference (TGI)
Hugging Face Transformers agentic-provisioning API
Hugging Face Transformers auth API
Hugging Face Transformers buckets API
Hugging Face Transformers collections API
Hugging Face Transformers datasets API
Hugging Face Transformers discussions API
Hugging Face Transformers docs API
Hugging Face Transformers inference-endpoints API