vimeo.video

stable Standard

Vimeo video details: title, owner, plays, likes, comments, duration.

GET /v1/vimeo/video

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/video?id=76979871" \
  -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": "76979871",
      "title": "The New Vimeo Player (You Know, For Videos)",
      "text": "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: • Lightning fast playback • Redesigned Share screen • Closed caption and subtitle compatible • HTML5 by default • Purchase-from-player functionality for embedded Vimeo On Demand trailers • More responsive than ever (go ahead, resize it, we dare you!!!) We’re really proud of these updates. So proud that we made a spiffy new page to showcase all the reasons why we have the best video player in the galaxy. Check it out here: http://vimeo.com/player In short, this is a player that even haters can love.",
      "url": "https://vimeo.com/76979871",
      "createdAt": "2013-10-15T14:08:29Z"
    },
    "author": {
      "id": "152184",
      "displayName": "Vimeo",
      "url": "https://vimeo.com/staff"
    },
    "media": {
      "durationSeconds": 62,
      "thumbnailUrl": "https://i.vimeocdn.com/video/452001751-8216e0571c251a09d7a8387550942d89f7f86f6398f8ed886e639b0dd50d3c90-d_640?region=us"
    }
  },
  "metadata": {
    "platform": "vimeo",
    "endpoint": "video",
    "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
`id`	`content.id`	`toString`
`title`	`content.title`	-
`description`	`content.text`	`stripHtml`
`url`	`content.url`	`safeUrl`
`upload_date`	`content.createdAt`	`toIsoDate`
`user_id`	`author.id`	`toString`
`user_name`	`author.displayName`	-
`user_url`	`author.url`	`safeUrl`
`duration`	`media.durationSeconds`	`toNumber`
`thumbnail_large`	`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).