> **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 embed (https://www.socialfetch.dev/docs/api/v1/vimeo/videos/videoid/embed/get) ## Summary Get a Vimeo embed: iframe markup, size, thumbnail and the owner's account type; restricted when embedding is off. **Tags:** `Vimeo` ## HTTP - **Method:** GET - **Path:** `/v1/vimeo/videos/{videoId}/embed` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.vimeo.getVideoEmbed({ videoId: "76979871" })` - **Accepted identifiers:** `videoId` (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 ### `videoId` (path) - **Required:** yes - **Constraints:** type `string`; pattern: `^[1-9]\d{0,18}$` - **Description:** Vimeo video id, e.g. `76979871`. ### `maxWidth` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 4096 - **Description:** Maximum width of the embed, in pixels. ### `maxHeight` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 4096 - **Description:** Maximum height of the embed, in pixels. ### `width` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 4096 - **Description:** Fixed width of the embed, in pixels. ### `hash` (query) - **Required:** no - **Constraints:** type `string`; pattern: `^[A-Za-z0-9]{4,64}$` - **Description:** Unlisted-video hash, when the video was shared with one. ### `responsive` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Ask for responsive iframe markup. ### `autoplay` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Ask for autoplay. ### `dnt` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Do-not-track, as the embed parameter spells it. ### `byline` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Show the uploader byline in the player. ### `portrait` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Show the uploader portrait in the player. ### `title` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Show the title in the player. ### `color` (query) - **Required:** no - **Constraints:** type `string`; pattern: `^[0-9a-fA-F]{6}$` - **Description:** Player colour as six hex digits, e.g. `00adef`. ## Responses (status codes) - **200**: Vimeo embed. - **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 embed. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found, restricted. `found` when an embed is available; `restricted` when the owner has embedding switched off; `not_found` when the video is gone. - **videoId** (required) — type `integer`; minimum: 0. Video id. - **embed** (required) — type `object`; nullable. Embed data; null when the video is not found. - **html** (required) — type `string`; nullable. Ready-made iframe markup, when embedding is allowed. - **width** (required) — type `integer`; minimum: 0; nullable. Iframe width. - **height** (required) — type `integer`; minimum: 0; nullable. Iframe height. - **thumbnail** (required) — type `string`; nullable. Embed thumbnail URL. - **thumbnailWithPlayButton** (required) — type `string`; nullable. Embed thumbnail with a play overlay. - **domainStatusCode** (required) — type `integer`; nullable. Set to 403 when the video is restricted to other domains. - **owner** (required) — type `object`; nullable. The author, as the embed record names them. - **name** (required) — type `string`; nullable. Author name. - **url** (required) — type `string`; nullable. Author profile URL. - **accountType** (required) — type `string`; nullable. `free`, `plus`, `pro`, `business` or `enterprise`. - **title** (required) — type `string`; nullable. Title the embed record carries. - **description** (required) — type `string`; nullable. Description the embed record carries. - **uploadedAt** (required) — type `string`; nullable. Upload time the embed record carries. - **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", "videoId": 22439234, "embed": { "html": "", "width": 426, "height": 240, "thumbnail": "https://i.vimeocdn.com/video/145027281-cf3e3e047a52e2210b26bbcf42fcde909a80a7dd023a757b95af01936d065ec0-d_295x166?region=us", "thumbnailWithPlayButton": "https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F145027281-cf3e3e047a52e2210b26bbcf42fcde909a80a7dd023a757b95af01936d065ec0-d_295x166%3Fregion%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png", "domainStatusCode": null }, "owner": { "name": "TSO Photography", "url": "https://vimeo.com/terjes", "accountType": "basic" }, "title": "The Mountain", "description": "Follow on:\nhttps://facebook.com/TSOphotography for more photos, videos and updates. \n\nThis was filmed between 4th and 11th April 2011. I had the pleasure of visiting El Teide.\nSpain´s highest mountain @(3718m) is one of the best places in the world to photograph the stars and is also the location of Teide Observatori…", "uploadedAt": "2011-04-15T12:35:35.000Z" }, "meta": { "requestId": "req_c0ba59df-c5b3-4632-8f39-d5a3c90a5f40", "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.getVideoEmbed({ 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/embed", { 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/embed" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/vimeo/videos/76979871/embed", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```