{"openapi":"3.1.0","info":{"title":"Hugging Face Spaces runtime, hardware, Zero GPU quota and Jobs (your token) API","version":"0.1.0","description":"Hugging Face Spaces runtime, hardware, Zero GPU quota and Jobs (your token) lets an AI assistant read your own Hugging Face Compute data through the Hugging Face Compute API with a key you supply (Hugging Face access token). Read-only: 8 tools (get_space_runtime, search_spaces_semantic, list_space_hardware, get_zero_gpu_quota, list_space_templates, list_jobs, get_job, list_job_hardware). The BYOK...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-huggingface-compute.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-huggingface-compute/docs"},"termsOfService":"https://connectorbay.com/byok-huggingface-compute/terms"},"servers":[{"url":"https://byok-huggingface-compute.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-huggingface-compute/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_space_runtime":{"post":{"operationId":"get_space_runtime","summary":"Get the runtime of a Space: stage (for example RUNNING, BUILDING, PAUSED), current and requested hardware, sleep timeout","description":"Get the runtime of a Space: stage (for example RUNNING, BUILDING, PAUSED), current and requested hardware, sleep timeout and storage. Reads metadata only: it starts, stops and changes nothing. Use for \"Is the Hugging Face Space gradio/hello_world running and on what hardware\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"namespace":{"description":"Owner of the Space (user or organization).","maxLength":100,"title":"Namespace","type":"string"},"repo":{"description":"Space name without the owner.","maxLength":100,"title":"Repo","type":"string"}},"required":["namespace","repo"],"title":"get_space_runtimeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_spaces_semantic":{"post":{"operationId":"search_spaces_semantic","summary":"Search Spaces by meaning (semantic search) and return id, title, SDK, likes, tags, short description and trending score.","description":"Search Spaces by meaning (semantic search) and return id, title, SDK, likes, tags, short description and trending score. Returns the best matches only. Use for \"Find Hugging Face Spaces that remove image backgrounds\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"q":{"description":"Natural language description of the wanted Space, for example 'remove image background'.","maxLength":300,"title":"Q","type":"string"},"sdk":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only Spaces using this SDK, for example gradio, streamlit, docker or static.","title":"Sdk"},"filter":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only Spaces with this tag.","title":"Filter"},"include_non_running":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to also return Spaces that are not currently running.","title":"Include Non Running"}},"required":["q"],"title":"search_spaces_semanticArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_space_hardware":{"post":{"operationId":"list_space_hardware","summary":"List the hardware options for Spaces with CPU, RAM, accelerator and price per unit. Reads metadata only: it starts, stop","description":"List the hardware options for Spaces with CPU, RAM, accelerator and price per unit. Reads metadata only: it starts, stops and changes nothing. Use for \"What hardware can I choose for a Hugging Face Space and what does it cost\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_space_hardwareArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_zero_gpu_quota":{"post":{"operationId":"get_zero_gpu_quota","summary":"Show your ZeroGPU quota: base quota, remaining seconds, reset time and over-quota use. Needs a token. Reads metadata onl","description":"Show your ZeroGPU quota: base quota, remaining seconds, reset time and over-quota use. Needs a token. Reads metadata only: it starts, stops and changes nothing. Use for \"How much ZeroGPU quota do I have left on Hugging Face\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_zero_gpu_quotaArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_space_templates":{"post":{"operationId":"list_space_templates","summary":"List the starter templates offered for new Spaces with name, source repository and SDK. Reads metadata only: it starts, ","description":"List the starter templates offered for new Spaces with name, source repository and SDK. Reads metadata only: it starts, stops and changes nothing. Use for \"Which Space templates does Hugging Face offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_space_templatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_jobs":{"post":{"operationId":"list_jobs","summary":"List Hugging Face Jobs of a user or organization with status stage, hardware flavor, Docker image, labels and times; env","description":"List Hugging Face Jobs of a user or organization with status stage, hardware flavor, Docker image, labels and times; environment and secrets are not returned. Reads metadata only: it starts, stops and changes nothing. Use for \"Which of my Hugging Face Jobs are still running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"namespace":{"description":"User or organization that owns the Jobs.","maxLength":100,"title":"Namespace","type":"string"},"stage":{"anyOf":[{"enum":["COMPLETED","CANCELED","ERROR","DELETED","SCHEDULING","RUNNING"],"type":"string"},{"type":"null"}],"default":null,"description":"Only Jobs in this stage: COMPLETED, CANCELED, ERROR, DELETED, SCHEDULING or RUNNING.","title":"Stage"}},"required":["namespace"],"title":"list_jobsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_job":{"post":{"operationId":"get_job","summary":"Get one Hugging Face Job: status stage and message, flavor, Docker image, labels and times; environment and secrets are ","description":"Get one Hugging Face Job: status stage and message, flavor, Docker image, labels and times; environment and secrets are not returned. Reads metadata only: it starts, stops and changes nothing. Use for \"What happened to Hugging Face Job 665f0a1b2c3d4e5f6a7b8c9d\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"namespace":{"description":"User or organization that owns the Job.","maxLength":100,"title":"Namespace","type":"string"},"job_id":{"description":"Job id as returned by list_jobs.","maxLength":100,"title":"Job Id","type":"string"}},"required":["namespace","job_id"],"title":"get_jobArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_job_hardware":{"post":{"operationId":"list_job_hardware","summary":"List the hardware flavors available for Jobs with CPU, RAM, accelerator and price per unit. Reads metadata only: it star","description":"List the hardware flavors available for Jobs with CPU, RAM, accelerator and price per unit. Reads metadata only: it starts, stops and changes nothing. Use for \"What does it cost to run a Hugging Face Job on a GPU\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_job_hardwareArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}