> **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 paper (https://www.socialfetch.dev/docs/api/v1/hugging-face/papers/arxivid/get) ## Summary Get a Hugging Face paper with its authors, abstract and upvotes. **Tags:** `Hugging Face` ## HTTP - **Method:** GET - **Path:** `/v1/hugging-face/papers/{arxivId}` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.huggingFace.getPaper({ arxivId: "1706.03762" })` - **Accepted identifiers:** `arxivId` (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 ### `arxivId` (path) - **Required:** yes - **Constraints:** type `string`; pattern: `^\d{4}\.\d{4,5}(?:v\d+)?$` - **Description:** arXiv id of the paper, e.g. `1706.03762`. A version suffix (`v2`) is ignored: Hugging Face keeps one page per paper. ### `include` (query) - **Required:** no - **Constraints:** type `string` - **Description:** Extra blocks, comma-separated: `comments` and `upvoters`. Both are null without it. ## Responses (status codes) - **200**: Paper 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) Paper details. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the item was found. - **paper** (required) — type `object`; nullable. The paper when lookupStatus is `found`; otherwise null. - **id** (required) — type `string`. arXiv id. - **title** (required) — type `string`; nullable. Paper title. - **url** (required) — type `string`. Paper page URL. - **summary** (required) — type `string`; nullable. Abstract. - **publishedAt** (required) — type `string`; nullable. When the paper was published (ISO-8601). - **upvotes** (required) — type `integer`; nullable. Upvotes. - **numComments** (required) — type `integer`; nullable. Comments on the paper page; null in paper search results. - **thumbnailUrl** (required) — type `string`; nullable. Thumbnail image URL. - **githubRepo** (required) — type `string`; nullable. Linked GitHub repository. - **githubStars** (required) — type `integer`; nullable. Stars on the linked GitHub repository; null in paper search results. - **organization** (required) — type `string`; nullable. Name of the organization the paper is listed under. - **submittedBy** (required) — type `object`; nullable. Who put the paper on the daily list; null in paper search results. - **username** (required) — type `string`. Account name, the part of the profile URL after the domain. - **uid** (required) — type `string`; nullable. Stable account id. - **displayName** (required) — type `string`; nullable. Display name. - **avatarUrl** (required) — type `string`; nullable. Avatar image URL. - **url** (required) — type `string`. Profile page URL. - **type** (required) — type `string`; enum: user, org, null; nullable. Whether the account is a user or an organization. - **isPro** (required) — type `boolean`; nullable. Whether the account has a Pro subscription. - **isStaff** (required) — type `boolean`; nullable. Whether the account belongs to the platform's staff, when the response includes it. - **followerCount** (required) — type `integer`; nullable. Followers, when the response includes it. - **submittedOnDailyAt** (required) — type `string`; nullable. When the paper was added to the daily list (ISO-8601); null in paper search results. - **aiSummary** (required) — type `string`; nullable. Short summary generated by Hugging Face. - **aiKeywords** (required) — type `array`. Keywords generated by Hugging Face. - _items:_ - type `string` - **authors** (required) — type `array`. Authors in paper order. - _items:_ - **projectUrl** (required) — type `string`; nullable. Project page. - **aiSummaryModel** (required) — type `string`; nullable. Model Hugging Face used to write the summary. - **mediaUrls** (required) — type `array`. Media attached to the paper. - _items:_ - type `string` - **discussionId** (required) — type `string`; nullable. Id of the paper's comment thread. - **linked** (required) — type `object`. Repositories that cite the paper. - **models** (required) — type `array`. Models that cite the paper (first page). - _items:_ - **datasets** (required) — type `array`. Datasets that cite the paper (first page). - _items:_ - **spaces** (required) — type `array`. Spaces that cite the paper (first page). - _items:_ - **totalModels** (required) — type `integer`; nullable. All models that cite the paper. - **totalDatasets** (required) — type `integer`; nullable. All datasets that cite the paper. - **totalSpaces** (required) — type `integer`; nullable. All Spaces that cite the paper. - **comments** (required) — type `array`; nullable. Comments with replies. Only with `include=comments`; otherwise null. - _items:_ - **upvoters** (required) — type `array`; nullable. Accounts that upvoted. Only with `include=upvoters`; otherwise null. - _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", "paper": { "id": "1706.03762", "title": "Attention Is All You Need", "url": "https://huggingface.co/papers/1706.03762", "summary": "The dominant sequence transduction models are based on complex recurrent or\nconvolutional neural networks in an encoder-decoder configuration. The best\nperform…", "publishedAt": "2017-06-12T17:57:34.000Z", "upvotes": 147, "numComments": null, "thumbnailUrl": null, "githubRepo": null, "githubStars": null, "organization": null, "submittedBy": null, "submittedOnDailyAt": null, "aiSummary": "The Transformer architecture, based purely on attention mechanisms, achieves superior performance on machine translation and parsing tasks with improved parall…", "aiKeywords": [ "recurrent neural networks" ], "authors": [ { "name": "Ashish Vaswani", "account": { "username": "ashishvaswanigoogle", "uid": "60fe1b231a3e6f5129776bf9", "displayName": "Ashish Vaswani", "avatarUrl": "https://huggingface.co/avatars/4f5ba1df4118139a2a00d67a89c7b772.svg", "url": "https://huggingface.co/ashishvaswanigoogle", "type": "user", "isPro": false, "isStaff": null, "followerCount": null }, "claimStatus": "extracted_pending", "hidden": false } ], "projectUrl": null, "aiSummaryModel": "Qwen/Qwen2.5-Coder-32B-Instruct", "mediaUrls": [], "discussionId": "641192343ea54b1aa7e2f084", "linked": { "models": [ { "id": "google/paligemma-3b-pt-224", "type": "model", "uid": null, "url": "https://huggingface.co/google/paligemma-3b-pt-224", "author": "google", "createdAt": null, "lastModified": "2024-09-21T10:14:25.000Z", "sha": null, "likes": 707, "downloads": 292516, "downloadsAllTime": null, "trendingScore": null, "gated": "manual", "disabled": null, "tags": [], "pipelineTag": "image-text-to-text", "library": null, "license": null, "sdk": null, "parameters": 2923466480, "spaceStage": null } ], "datasets": [ { "id": "alpha-one-index/awesome-ai-index", "type": "dataset", "uid": null, "url": "https://huggingface.co/datasets/alpha-one-index/awesome-ai-index", "author": "alpha-one-index", "createdAt": null, "lastModified": "2026-03-25T05:18:24.000Z", "sha": null, "likes": 2, "downloads": 5104, "downloadsAllTime": null, "trendingScore": null, "gated": false, "disabled": null, "tags": [], "pipelineTag": null, "library": null, "license": null, "sdk": null, "parameters": null, "spaceStage": null } ], "spaces": [ { "id": "nielsr/MiniCPM-OCR-vs-Unlimited-OCR-2", "type": "space", "uid": null, "url": "https://huggingface.co/spaces/nielsr/MiniCPM-OCR-vs-Unlimited-OCR-2", "author": "nielsr", "createdAt": null, "lastModified": null, "sha": null, "likes": null, "downloads": null, "downloadsAllTime": null, "trendingScore": null, "gated": null, "disabled": null, "tags": [], "pipelineTag": null, "library": null, "license": null, "sdk": null, "parameters": null, "spaceStage": null } ], "totalModels": 317, "totalDatasets": 9, "totalSpaces": 391 }, "comments": null, "upvoters": null } }, "meta": { "requestId": "req_7d2a765e-2b9f-4de8-a67a-5e22e0e6ef45", "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.getPaper({ arxivId: "1706.03762", }); 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/papers/1706.03762", { 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/papers/1706.03762" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/hugging-face/papers/1706.03762", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```