Docs
View as Markdown

commons.file_info

stable Standard

Wikimedia Commons file: URL, size, license and description.

GET /v1/commons/file_info

What you get#

One Commons 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#

NameTypeRequiredDefaultWhat it isConstraints
namestringyes(required)File name without File: prefixmax 200 chars; must match [^\x00-\x1f\x7f|/:]{1,200}; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/commons/file_info?name=Alan%20turing%20header.jpg" \
  -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 Commons response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "content": {
      "id": "158923803",
      "title": "File:Alan turing header.jpg",
      "text": "Photograph portrait of Alan Turing, taken on 29 March 1951."
    },
    "media": {
      "url": "https://upload.wikimedia.org/wikipedia/commons/c/ce/Alan_turing_header.jpg?utm_source=commons.wikimedia.org&utm_campaign=imageinfo&utm_content=original",
      "thumbnailUrl": "https://thumb.wikimedia.org/wikipedia/commons/thumb/c/ce/Alan_turing_header.jpg/330px-Alan_turing_header.jpg?utm_source=commons.wikimedia.org&utm_campaign=imageinfo&utm_content=thumbnail",
      "width": 752,
      "height": 1002,
      "mimeType": "image/jpeg",
      "sizeBytes": 143128
    },
    "package": {
      "license": "Public domain"
    },
    "author": {
      "displayName": "Elliott & Fry"
    }
  },
  "metadata": {
    "platform": "commons",
    "endpoint": "file_info",
    "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 pathOnekey fieldTransform
pageidcontent.idtoString
titlecontent.title-
imageinfo.0.urlmedia.urlsafeUrl
imageinfo.0.thumburlmedia.thumbnailUrlsafeUrl
imageinfo.0.widthmedia.widthtoNumber
imageinfo.0.heightmedia.heighttoNumber
imageinfo.0.mimemedia.mimeType-
imageinfo.0.sizemedia.sizeBytestoNumber
imageinfo.0.extmetadata.ImageDescription.valuecontent.textstripHtml
imageinfo.0.extmetadata.LicenseShortName.valuepackage.license-
imageinfo.0.extmetadata.Artist.valueauthor.displayNamestripHtml

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#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).