> **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):** - **Markdown (.mdx) URL:** ## 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:** ## 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 dataset viewer (https://www.socialfetch.dev/docs/api/v1/hugging-face/datasets/owner/name/viewer/get) ## Summary Get what a Hugging Face dataset viewer can show. **Tags:** `Hugging Face` ## HTTP - **Method:** GET - **Path:** `/v1/hugging-face/datasets/{owner}/{name}/viewer` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.huggingFace.getDatasetViewer({ owner: "stanfordnlp", name: "imdb" })` - **Accepted identifiers:** `owner` (path), `name` (path) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`, `restricted` ## 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. ## Responses (status codes) - **200**: Dataset row viewer facts. - **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) Dataset row viewer facts. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found, restricted. Whether the item was found. `restricted` means it exists but its content is gated. - **viewer** (required) — type `object`; nullable. Row viewer facts when found; otherwise null. - **status** (required) — type `string`; enum: available, unavailable. `available` when Hugging Face can show the dataset's rows; `unavailable` when it cannot. - **reason** (required) — type `string`; enum: disabled, no_data_files, empty, unsupported_format, too_large, failed, split_not_found, null; nullable. Why no rows are shown: `disabled` (the owner switched it off), `no_data_files`, `empty`, `unsupported_format`, `too_large`, `failed`, or `split_not_found` when a default lookup finds no split in the dataset. Null when rows are available. A `config` or `split` you name that the dataset does not have is refused with a 400. - **isPartial** (required) — type `boolean`; nullable. Whether the figures cover only part of a very large dataset. - **supports** (required) — type `object`. Which row features the dataset supports. - **preview** (required) — type `boolean`; nullable. First rows can be previewed. - **viewer** (required) — type `boolean`; nullable. Rows can be paged through. - **search** (required) — type `boolean`; nullable. Rows can be searched. - **filter** (required) — type `boolean`; nullable. Rows can be filtered. - **statistics** (required) — type `boolean`; nullable. Column statistics are available. - **totalRows** (required) — type `integer`; nullable. Rows across every subset and split. - **parquetBytes** (required) — type `integer`; nullable. Size of the dataset's Parquet files in bytes. - **configs** (required) — type `array`. Subsets of the dataset. - _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", "viewer": { "status": "available", "reason": null, "isPartial": false, "supports": { "preview": true, "viewer": true, "search": true, "filter": true, "statistics": true }, "totalRows": 100000, "parquetBytes": 83446840, "configs": [ { "name": "plain_text", "numRows": 100000, "numColumns": 2, "license": null, "homepage": null, "features": [ { "name": "text", "type": "string", "classNames": null } ], "splits": [ { "name": "train", "numRows": 25000, "numBytes": 33290791 } ] } ] } }, "meta": { "requestId": "req_639ef5b8-563e-47f1-9e04-c87fb8d731a7", "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.getDatasetViewer({ owner: "stanfordnlp", name: "imdb", }); 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/datasets/stanfordnlp/imdb/viewer", { 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/datasets/stanfordnlp/imdb/viewer" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/hugging-face/datasets/stanfordnlp/imdb/viewer", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```