vimeo.oembed

stable Standard

Vimeo oEmbed for a public video: title, author, thumbnail, duration, description.

GET /v1/vimeo/oembed

What you get#

One Vimeo record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`id`	string	yes	(required)	Vimeo video id	max 12 chars; must match `[0-9]{1,12}`; trimmed

Request#

curl "https://api.onekey.dev/v1/vimeo/oembed?id=22439234" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Vimeo response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "content": {
      "id": "22439234",
      "title": "The Mountain",
      "text": "Follow on: https://facebook.com/TSOphotography for more photos, videos and updates. This was filmed between 4th and 11th April 2011. I had the pleasure of visiting El Teide. Spain´s highest mountain @(3718m) is one of the best places in the world to photograph the stars and is also the location of Teide Observatories, considered to be one of the world´s best observatories. The goal was to capture the beautiful Milky Way galaxy along with one of the most amazing mountains I know El Teide. I have to say this was one of the most exhausting trips I have done. There was a lot of hiking at high altitudes and probably less than 10 hours of sleep in total for the whole week. Having been here 10-11 times before I had a long list of must-see locations I wanted to capture for this movie, but I am still not 100% used to carrying around so much gear required for time-lapse movies. A large sandstorm hit the Sahara Desert on the 9th April (http://bit.ly/g3tsDW) and at approx 3am in the night the sandstorm hit me, making it nearly impossible to see the sky with my own eyes. Interestingly enough my camera was set for a 5 hour sequence of the milky way during this time and I was sure my whole scene was ruined. To my surprise, my camera had managed to capture the sandstorm which was backlit by Grand Canary Island making it look like golden clouds. The Milky Way was shining through the clouds, making the stars sparkle in an interesting way. So if you ever wondered how the Milky Way would look through a Sahara sandstorm, look at 00:32. Available in Digital Cinema 4k. Follow Facebook: http://www.facebook.com/TSOPhotography Follow Twitter: http://twitter.com/TSOPhotography Follow Google+: https://plus.google.com/107543460658107759808 Press/licensing/projects contact: tsophotography@gmail.com",
      "createdAt": "2011-04-15T08:35:35Z"
    },
    "author": {
      "displayName": "TSO Photography",
      "url": "https://vimeo.com/terjes"
    },
    "media": {
      "durationSeconds": 185,
      "thumbnailUrl": "https://i.vimeocdn.com/video/145027281-cf3e3e047a52e2210b26bbcf42fcde909a80a7dd023a757b95af01936d065ec0-d_295x166?region=us"
    }
  },
  "metadata": {
    "platform": "vimeo",
    "endpoint": "oembed",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`video_id`	`content.id`	`toString`
`title`	`content.title`	-
`description`	`content.text`	`stripHtml`
`upload_date`	`content.createdAt`	`toIsoDate`
`author_name`	`author.displayName`	-
`author_url`	`author.url`	`safeUrl`
`duration`	`media.durationSeconds`	`toNumber`
`thumbnail_url`	`media.thumbnailUrl`	`safeUrl`

Caching and freshness#

Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).