vimeo.album_videos

stable Advanced

Videos in a Vimeo album/showcase by numeric id.

GET /v1/vimeo/album_videos

What you get#

A list of Vimeo results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits 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
`album`	string	yes	(required)	Vimeo album id	max 12 chars; must match `[0-9]{1,12}`; trimmed

Request#

curl "https://api.onekey.dev/v1/vimeo/album_videos?album=1" \
  -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": "317655",
        "title": "Working Hard",
        "text": "Behind the scenes of a \"CollegeHumor's Hardly Working.\" See the actual video here: http://www.collegehumor.com/video:1776540",
        "url": "https://vimeo.com/317655",
        "createdAt": "2007-09-24T07:36:40Z"
      },
      "author": {
        "id": "76850",
        "displayName": "Amir",
        "url": "https://vimeo.com/amir"
      },
      "media": {
        "durationSeconds": 56,
        "thumbnailUrl": "https://i.vimeocdn.com/video/49020764-adaacbcc14f2bbf225143626faad6f3b30ce939f066741e48d44bed9ccae6150-d_640?region=us"
      }
    }
  ],
  "metadata": {
    "platform": "vimeo",
    "endpoint": "album_videos",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "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 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes 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 1 hour more (marked stale).
A "not found" is remembered for 1 minute 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`	Unknown endpoint path.
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).