> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/hugging-face/models/owner/name/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/hugging-face/models/owner/name/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Get Hugging Face model (https://www.socialfetch.dev/docs/api/v1/hugging-face/models/owner/name/get)

## Summary

Get a Hugging Face model with its downloads, tags, card, weights, base models and evaluation results.

Pass the full repository id as `owner/name`, for…

**Tags:** `Hugging Face`

## HTTP

- **Method:** GET
- **Path:** `/v1/hugging-face/models/{owner}/{name}`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.huggingFace.getModel({ owner: "openai-community", name: "gpt2" })`
- **Accepted identifiers:** `owner` (path), `name` (path)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Failed requests (`lookup_failed`, `503`):** not charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `owner` (path)

- **Required:** yes
- **Constraints:** type `string`; pattern: `^[A-Za-z0-9][A-Za-z0-9._-]{0,95}$`
- **Description:** Owner of the repository: a user or organization name.

### `name` (path)

- **Required:** yes
- **Constraints:** type `string`; pattern: `^[A-Za-z0-9][A-Za-z0-9._-]{0,95}$`
- **Description:** Repository name, without the owner.

### `revision` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 200; pattern: `^[A-Za-z0-9][A-Za-z0-9._/-]*$`
- **Description:** Branch, tag or commit. Default: the default branch (`main`).

### `include` (query)

- **Required:** no
- **Constraints:** type `string`
- **Description:** Extra blocks, comma-separated: `config` (config.json), `spaces` (Spaces that use the model) and `security` (scan result).

## Responses (status codes)

- **200**: Model details.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Model details.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the item was found.
  - **model** (required) — type `object`; nullable. The model when lookupStatus is `found`; otherwise null.
    - **id** (required) — type `string`. Repository id, `owner/name`.
    - **type** (required) — type `string`; enum: model, dataset, space. Repository type.
    - **uid** (required) — type `string`; nullable. Stable repository id; survives renames.
    - **url** (required) — type `string`. Repository page URL.
    - **author** (required) — type `string`; nullable. Owner account name.
    - **createdAt** (required) — type `string`; nullable. When the repository was created (ISO-8601).
    - **lastModified** (required) — type `string`; nullable. When the repository last changed (ISO-8601).
    - **sha** (required) — type `string`; nullable. Latest commit on the default branch.
    - **likes** (required) — type `integer`; nullable. Likes.
    - **downloads** (required) — type `integer`; nullable. Downloads in the last 30 days.
    - **downloadsAllTime** (required) — type `integer`; nullable. Downloads since the repository was created.
    - **trendingScore** (required) — type `number`; nullable. Trending score.
    - **gated** (required). Whether access needs approval: `false`, `auto` (accepted on request) or `manual` (reviewed by the owner).
    - **disabled** (required) — type `boolean`; nullable. Whether the repository has been disabled.
    - **tags** (required) — type `array`. Tags: task, library, languages, licence and more.
      - _items:_
        - type `string`
    - **pipelineTag** (required) — type `string`; nullable. Main task of a model, e.g. `text-generation`; null in dataset and Space results.
    - **library** (required) — type `string`; nullable. Library a model is made for, e.g. `transformers`; null in dataset and Space results.
    - **license** (required) — type `string`; nullable. Licence id taken from the tags, e.g. `mit`.
    - **sdk** (required) — type `string`; nullable. SDK of a Space, e.g. `gradio`; null in model and dataset results.
    - **parameters** (required) — type `integer`; nullable. Parameter count of a model, when known; null in dataset and Space results.
    - **spaceStage** (required) — type `string`; nullable. Run state of a Space, e.g. `RUNNING` or `SLEEPING`; null in model and dataset results.
    - **languages** (required) — type `array`. Language codes from the card.
      - _items:_
        - type `string`
    - **datasets** (required) — type `array`. Dataset ids the card names.
      - _items:_
        - type `string`
    - **baseModels** (required) — type `object`; nullable. The models this one was built from.
      - **relation** (required) — type `string`; nullable. How this model relates to its base models: `finetune`, `adapter`, `merge` or `quantized`.
      - **models** (required) — type `array`. Base model ids.
        - _items:_
          - type `string`
    - **derivedModelCounts** (required) — type `object`; nullable. How many models are built on this one.
      - **adapter** (required) — type `integer`. Adapters built on this model.
      - **finetune** (required) — type `integer`. Finetunes of this model.
      - **merge** (required) — type `integer`. Merges that use this model.
      - **quantized** (required) — type `integer`. Quantized versions of this model.
    - **safetensors** (required) — type `object`; nullable. Weight sizes from the safetensors files.
      - **total** (required) — type `integer`; nullable. Total parameters.
      - **parameters** (required) — type `object`. Parameters per data type, e.g. `{ "F32": 137022720 }`.
    - **gguf** (required) — type `object`; nullable. GGUF file facts, for models that ship GGUF files.
      - **architecture** (required) — type `string`; nullable. Model architecture.
      - **contextLength** (required) — type `integer`; nullable. Context length in tokens.
      - **total** (required) — type `integer`; nullable. Total parameters.
      - **totalFileSize** (required) — type `integer`; nullable. Total size of the GGUF files in bytes.
      - **bosToken** (required) — type `string`; nullable. Beginning-of-sequence token.
      - **eosToken** (required) — type `string`; nullable. End-of-sequence token.
    - **transformers** (required) — type `object`; nullable. How the Transformers library loads the model.
      - **autoModel** (required) — type `string`; nullable. Auto class that loads the model.
      - **pipelineTag** (required) — type `string`; nullable. Pipeline task.
      - **processor** (required) — type `string`; nullable. Processor class.
    - **inferenceProviders** (required) — type `array`. Hosted inference providers that serve the model.
      - _items:_
    - **evalResults** (required) — type `array`. Evaluation results published in the repository.
      - _items:_
    - **usedStorageBytes** (required) — type `integer`; nullable. Storage the repository uses, in bytes.
    - **maskToken** (required) — type `string`; nullable. Mask token of a fill-mask model.
    - **widgetExamples** (required) — type `array`. Example inputs shown on the model page.
      - _items:_
        - type `object`
    - **card** (required) — type `object`; nullable. The repository's card header (YAML front matter) as the author wrote it: licence, languages, datasets, base model, metrics and more.
    - **config** (required) — type `object`; nullable. The model's config.json. Only with `include=config`; otherwise null.
    - **spaces** (required) — type `array`; nullable. Ids of Spaces that use the model. Only with `include=spaces`; otherwise null.
      - _items:_
        - type `string`
    - **security** (required) — type `object`; nullable. Security scan result. Only with `include=security`; otherwise null.
      - **scansDone** (required) — type `boolean`; nullable. Whether the security scans have finished.
      - **filesWithIssues** (required) — type `array`. Files the scans flagged.
        - _items:_
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "model": {
      "id": "openai-community/gpt2",
      "type": "model",
      "uid": "621ffdc036468d709f17434d",
      "url": "https://huggingface.co/openai-community/gpt2",
      "author": "openai-community",
      "createdAt": "2022-03-02T23:29:04.000Z",
      "lastModified": "2024-02-19T10:57:45.000Z",
      "sha": "607a30d783dfa663caf39e06633721c8d4cfcd7e",
      "likes": 3919,
      "downloads": 30819442,
      "downloadsAllTime": 966443213,
      "trendingScore": 12,
      "gated": false,
      "disabled": false,
      "tags": [
        "transformers"
      ],
      "pipelineTag": "text-generation",
      "library": "transformers",
      "license": "mit",
      "sdk": null,
      "parameters": 137022720,
      "spaceStage": null,
      "languages": [
        "en"
      ],
      "datasets": [],
      "baseModels": null,
      "derivedModelCounts": {
        "adapter": 1738,
        "finetune": 2351,
        "merge": 11,
        "quantized": 99
      },
      "safetensors": {
        "total": 137022720,
        "parameters": {
          "F32": 137022720
        }
      },
      "gguf": null,
      "transformers": {
        "autoModel": "AutoModelForCausalLM",
        "pipelineTag": "text-generation",
        "processor": "AutoTokenizer"
      },
      "inferenceProviders": [],
      "evalResults": [],
      "usedStorageBytes": 11977009063,
      "maskToken": null,
      "widgetExamples": [
        {
          "text": "Hi, what can you help me with?"
        }
      ],
      "card": {
        "language": "en",
        "tags": [
          "exbert"
        ],
        "license": "mit"
      },
      "config": null,
      "spaces": null,
      "security": null
    }
  },
  "meta": {
    "requestId": "req_eb5d01d9-0909-4121-a464-b46e45662120",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.huggingFace.getModel({
  owner: "openai-community",
  name: "gpt2",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/hugging-face/models/openai-community/gpt2",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/hugging-face/models/openai-community/gpt2" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/hugging-face/models/openai-community/gpt2",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```