InsightSocial
GET /v1/huggingface/repo/readmebeta

Hugging Face Repo Readme API

Get the README of a Hugging Face model, dataset or Space.

20 credits a call · single call · failed calls free · 10 free calls to start

curl "https://api.insightsocial.app/v1/huggingface/repo/readme?repo_type=models&owner=<owner>&name=<name>" \
-H "x-api-key: $INSIGHTSOCIAL_API_KEY"
200 OKJSON
{
"success": true,
"platform": "huggingface",
"endpoint": "/v1/huggingface/repo/readme",
"schema_version": "2",
"data": {
"<field>": "<value>"
},
"unavailable": [],
"credits_used": "<integer>"
}

Parameters

Query parameters for GET /v1/huggingface/repo/readme. Send your key in the x-api-key header.

NameRequiredDescription
repo_typeYesRepository type: models, datasets or spaces.
ownerYesOwner of the repository: a user or organization name.
nameYesRepository name, without the owner.
revisionNoBranch, tag or commit. Default: the default branch (main).

Response

This endpoint is beta: data holds the platform's own fields under our naming rules (snake_case keys, string ids, ISO times where the platform gives a timestamp) rather than a unified post or profile, and those fields may change.

Every field, error and example is in the Hugging Face Repo Readme API reference.

How much does the Hugging Face Repo Readme API cost?

20 credits per successful call.

  • Failed calls are free

    A call that errors or finds nothing costs 0 credits.

  • Know the price first

    Add dry_run=1 and the response quotes the call without making it. Nothing is charged.

  • One balance

    API calls and Chrome extension exports share the same credits, on the free plan too.

Hugging Face Repo Readme API: frequently asked questions

Send GET /v1/huggingface/repo/readme with the repo_type and owner and name parameters and your key in the x-api-key header. Get the README of a Hugging Face model, dataset or Space.