{ "opencollection": "1.0.0", "info": { "name": "Hub API Endpoints agentic-provisioning jobs API", "version": "0.0.1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "jobs", "type": "folder" }, "items": [ { "info": { "name": "Get job hardware", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/hardware" }, "docs": "Get available job hardware" }, { "info": { "name": "List jobs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "label", "value": "", "type": "query" } ] }, "docs": "List of jobs for an entity" }, { "info": { "name": "Start a job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/jobs/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start a job" }, { "info": { "name": "Count jobs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace/count", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "stage", "value": "", "type": "query" } ] }, "docs": "Count the number of jobs for an entity with optional status stage filter" }, { "info": { "name": "Get a job", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace/:jobId", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Get a job" }, { "info": { "name": "Stream job logs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/logs", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" }, { "name": "tail", "value": "", "type": "query" } ] }, "docs": "Stream the logs of a job, using SSE" }, { "info": { "name": "Stream job metrics", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/metrics", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Stream the metrics of a job, using SSE" }, { "info": { "name": "Stream job events", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/events", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Stream the events of a job, using SSE" }, { "info": { "name": "Cancel a job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/cancel", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Cancel a job" }, { "info": { "name": "Duplicate a job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/duplicate", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Duplicate an existing job, re-using its spec" }, { "info": { "name": "Update job labels", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/labels", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace user-provided labels on a job" }, { "info": { "name": "List scheduled jobs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/scheduled-jobs/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "label", "value": "", "type": "query" } ] }, "docs": "List scheduled jobs for an entity" }, { "info": { "name": "Create a scheduled job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/scheduled-jobs/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a scheduled job" }, { "info": { "name": "Get a scheduled job", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Get a scheduled job" }, { "info": { "name": "Delete a scheduled job", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Delete a scheduled job" }, { "info": { "name": "Suspend a scheduled job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId/suspend", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Suspend a scheduled job" }, { "info": { "name": "Resume a scheduled job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId/resume", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Resume a scheduled job" }, { "info": { "name": "Run job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId/run", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Trigger a scheduled job run. Trigger a scheduled job to run immediately. Throws an error if an instance is already running and job spec does not allow concurrent runs." }, { "info": { "name": "Update a scheduled job schedule", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId/schedule", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a scheduled job schedule" }, { "info": { "name": "Update scheduled job labels", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId/labels", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace user-provided labels on a scheduled job" } ] } ], "bundled": true }