> **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 Vimeo video (https://www.socialfetch.dev/docs/api/v1/vimeo/videos/videoid/get) ## Summary Get a Vimeo video: title, description, dates, tags, thumbnails, owner, embed permission and public counts. **Tags:** `Vimeo` ## HTTP - **Method:** GET - **Path:** `/v1/vimeo/videos/{videoId}` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.vimeo.getVideo({ videoId: "76979871" })` - **Accepted identifiers:** `videoId` (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 ### `videoId` (path) - **Required:** yes - **Constraints:** type `string`; pattern: `^[1-9]\d{0,18}$` - **Description:** Vimeo video id, e.g. `76979871`. ## Responses (status codes) - **200**: Vimeo video. - **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) Vimeo video. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the entity was found. A removed, private, password-protected or never-existing item is `not_found`; Vimeo does not distinguish them. - **video** (required) — type `object`; nullable. The video when found; otherwise null. - **id** (required) — type `integer`; minimum: 0. Video id. - **url** (required) — type `string`; nullable. Video page URL. - **title** (required) — type `string`; nullable. Title. - **description** (required) — type `string`; nullable. Description as plain text; null when empty. - **descriptionHtml** (required) — type `string`; nullable. Description as Vimeo formats it, line breaks included; null when it is empty. - **uploadedAt** (required) — type `string`; nullable. When the video was uploaded, converted to UTC from Vimeo's US Eastern time. - **modifiedAt** (required) — type `string`; nullable. When the record was last changed. - **releasedAt** (required) — type `string`; nullable. When the owner says the video was released. - **durationSeconds** (required) — type `integer`; minimum: 0; nullable. Length in whole seconds. - **width** (required) — type `integer`; minimum: 0; nullable. Source width in pixels. - **height** (required) — type `integer`; minimum: 0; nullable. Source height in pixels. - **orientation** (required) — type `string`; enum: landscape, portrait, square, null; nullable. Derived from width and height. - **tags** (required) — type `array`. Tags, without the leading separator. - _items:_ - type `string` - **categories** (required) — type `array`. Vimeo category names. - _items:_ - type `string` - **language** (required) — type `string`; nullable. Language code the owner set. - **license** (required) — type `string`; nullable. Licence the owner set. - **contentRating** (required) — type `array`; nullable. Vimeo content-rating labels. - _items:_ - type `string` - **privacy** (required) — type `object`; nullable. The video's privacy settings. - **view** (required) — type `string`; nullable. Who may watch: `anybody`, `ptv` and similar. - **embed** (required) — type `string`; nullable. Embedding permission: `public`, `private` or `whitelist`. - **comments** (required) — type `string`; nullable. Who may comment: `anybody` and similar. - **embedPermission** (required) — type `string`; enum: anywhere, approved, nowhere, null; nullable. Where the video may be embedded. - **thumbnails** (required) — type `object`. Thumbnails in the sizes Vimeo offers. - **small** (required) — type `string`; nullable. Thumbnail, 100x75. - **medium** (required) — type `string`; nullable. Thumbnail, 200x150. - **large** (required) — type `string`; nullable. Thumbnail, 640 pixels wide. - **base** (required) — type `string`; nullable. Thumbnail without a size suffix. - **owner** (required) — type `object`; nullable. The user a record belongs to. - **id** (required) — type `integer`; minimum: 0; nullable. Vimeo user id. - **name** (required) — type `string`; nullable. Display name. - **handle** (required) — type `string`; nullable. Vanity handle, or the `user` form. - **url** (required) — type `string`; nullable. Profile page URL. - **avatar** (required) — type `object`; nullable. Avatars when the row carries them; null when the list row does not. - **stats** (required) — type `object`. Counts. Hidden counts are null, not zero. - **plays** (required) — type `integer`; minimum: 0; nullable. Plays, or null when the uploader hides stats. - **likes** (required) — type `integer`; minimum: 0; nullable. Likes, or null when the uploader hides stats. - **comments** (required) — type `integer`; minimum: 0; nullable. Comments, or null when the uploader hides stats. - **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", "video": { "id": 76979871, "url": "https://vimeo.com/staff/player", "title": "The New Vimeo Player (You Know, For Videos)", "description": "It may look (mostly) the same on the surface, but under the hood we totally rebuilt our player. Here’s a quick rundown of some of the coolest new features:\n\n• Lightning fast playback\n• Redesigned Share screen\n• Closed caption and subtitle compatible\n• HTML5 by default\n• Purchase-from-player functionality for embedded …", "descriptionHtml": "It may look (mostly) the same on the surface, but under the hood we totally rebuilt our player. Here’s a quick rundown of some of the coolest new features:\n\n• Lightning fast playback\n• Redesigned Share screen\n• Closed caption and subtitle compatible\n• HTML5 by default\n• Purchase-from-player functionality for embedded …", "uploadedAt": "2013-10-15T18:08:29.000Z", "modifiedAt": "2026-11-07T04:29:51.000Z", "releasedAt": "2013-10-15T18:08:29.000Z", "durationSeconds": 62, "width": 1280, "height": 720, "orientation": "landscape", "tags": [], "categories": [], "language": "en", "license": null, "contentRating": [ "safe" ], "privacy": { "view": "anybody", "embed": "public", "comments": "nobody" }, "embedPermission": "anywhere", "thumbnails": { "small": "https://i.vimeocdn.com/video/452001751-8216e0571c251a09d7a8387550942d89f7f86f6398f8ed886e639b0dd50d3c90-d_100x75?&r=pad®ion=us", "medium": "https://i.vimeocdn.com/video/452001751-8216e0571c251a09d7a8387550942d89f7f86f6398f8ed886e639b0dd50d3c90-d_200x150?&r=pad®ion=us", "large": "https://i.vimeocdn.com/video/452001751-8216e0571c251a09d7a8387550942d89f7f86f6398f8ed886e639b0dd50d3c90-d_640x360?&r=pad®ion=us", "base": "https://i.vimeocdn.com/video/452001751-8216e0571c251a09d7a8387550942d89f7f86f6398f8ed886e639b0dd50d3c90-d?region=us" }, "owner": { "id": 152184, "name": "Vimeo", "handle": "staff", "url": "https://vimeo.com/staff", "avatar": { "small": "https://i.vimeocdn.com/portrait/121863746_30x30?subrect=0%2C0%2C344%2C344&r=cover&sig=54c2fef7b23ff87b9fbff04008bce0bee1125865ef62aa056299edb1cce3e0c4&v=1®ion=us", "medium": "https://i.vimeocdn.com/portrait/121863746_75x75?subrect=0%2C0%2C344%2C344&r=cover&sig=54c2fef7b23ff87b9fbff04008bce0bee1125865ef62aa056299edb1cce3e0c4&v=1®ion=us", "large": "https://i.vimeocdn.com/portrait/121863746_100x100?subrect=0%2C0%2C344%2C344&r=cover&sig=54c2fef7b23ff87b9fbff04008bce0bee1125865ef62aa056299edb1cce3e0c4&v=1®ion=us", "huge": "https://i.vimeocdn.com/portrait/121863746_300x300?subrect=0%2C0%2C344%2C344&r=cover&sig=54c2fef7b23ff87b9fbff04008bce0bee1125865ef62aa056299edb1cce3e0c4&v=1®ion=us", "base": "https://i.vimeocdn.com/portrait/121863746?subrect=0%2C0%2C344%2C344&r=cover&sig=54c2fef7b23ff87b9fbff04008bce0bee1125865ef62aa056299edb1cce3e0c4&v=1®ion=us", "portrait360": null } }, "stats": { "plays": null, "likes": 2369, "comments": 60 } } }, "meta": { "requestId": "req_d427686e-a975-44f6-8333-51e7a035884b", "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.vimeo.getVideo({ videoId: "76979871", }); 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/vimeo/videos/76979871", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/vimeo/videos/76979871" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/vimeo/videos/76979871", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```