Hugging Face Search
GET
Search the public Hugging Face models API by keyword and follow pagination.next to the next cursor page.
Credit cost: 1 credit per call
ApiKeyAuthheader
x-api-key<token>Your API key. Include it in the x-api-key header for every request.
query*stringRequired. A model keyword, a huggingface.co/models URL, or the full pagination.next cursor URL from a previous page.
Example:
bertNext-page example: pass the pagination.next value unchanged as query.
fields?stringComma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).
is_async?booleanRun the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.
Default
falsesoft_fail?booleanReturn HTTP 200 even when the request fails; the error is in the error field of the body.
Default
falseSuccessful response
application/json- response
results?array<>pagination?curl -X GET 'https://api.piloterr.com/v2/huggingface/search?query=string'Example Response
{ "results": [ { "id": "google-bert/bert-base-uncased", "url": "https://huggingface.co/google-bert/bert-base-uncased", "tags": [ "transformers", "pytorch", "tf", "jax", "rust", "coreml", "onnx", "safetensors", "bert", "fill-mask", "exbert", "en", "dataset:bookcorpus", "dataset:wikipedia", "arxiv:1810.04805", "license:apache-2.0", "endpoints_compatible", "deploy:sagemaker", "deploy:azure", "region:us" ], "likes": 3060, "private": false, "downloads": 29160167, "created_at": "2022-03-02T23:29:04.000Z", "library_name": "transformers", "pipeline_tag": "fill-mask", "trending_score": 6 } ], "pagination": { "next": "https://huggingface.co/api/models?search=bert&limit=20&cursor=eyIkb3IiOlt7InRyZW5kaW5nU2NvcmUiOjEsIl9pZCI6eyIkZ3QiOiI2MjFmZmRjMDM2NDY4ZDcwOWYxNzQ1MDAifX0seyJ0cmVuZGluZ1Njb3JlIjp7IiRsdCI6MX19LHsidHJlbmRpbmdTY29yZSI6bnVsbH1dLCJzZWFyY2hTZXF1ZW5jZVRva2VuIjoiQ05DSy93RWFDU0VBQUFBQUFBRHdQeG9PV2d4aUgvM0FOa2FOY0o4WFJRQWlEbG9NWWgvOXdEWkdqWENmRjBVQSJ9", "page": 1, "per_page": 20, "total_pages": null, "total_results": null }}