# odysee.search_videos

**stable** **Advanced**

Search Odysee videos by text.

`GET /v1/odysee/search_videos`

## What you get

A list of Odysee 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 |
| --- | --- | --- | --- | --- | --- |
| `q` | string | yes | (required) | Search text | max 100 chars; must match `[^\x00-\x1f]{1,100}`; trimmed, repeated spaces collapsed |

## Request

```bash
curl "https://api.onekey.dev/v1/odysee/search_videos?q=linux" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/odysee/search_videos",
    params={"q": "linux"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ q: "linux" });
const res = await fetch(`https://api.onekey.dev/v1/odysee/search_videos?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

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

```json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "e0df7055a525a7e504b1eee4e2afd6e01b7f848c",
        "title": "Void Linux | Belajar Linux Pemula | Linux Indonesia",
        "text": "Salam Indonesia Belajar!!!\n\nApa itu Llinux? Void Linux?\n\nVideo ini memberikan panduan instalasi serta ulasan Void Linux.\n\nVoid Linux termasuk distro linux independent, dalam artian tidak diturunkan dari distro lain. Void Linux mengadopsi model rolling release serta berfokus pada stabilitas ketimbang bleeding edge. Nama void sendiri mengadopsi istilah void yang dikenal dalam pemrograman C. Setidaknya terdapat 3 hal yang menjadikan Void Linux unik dan berbeda bila dibandingkan distro linux lainnya.\n\nYang pertama adalah, Void Linux menggunakan XBPS sebagai package manager. XBPS ini kependekan dari X Binary Package System. Selepas sesi instalasi, kami juga akan memberikan panduan terkait penggunaan xbps.\n\nPoint unik kedua adalah, Void Linux menawarkan dua pilihan c library, yaitu glibc dan musl. Lalu apa perbedaan keduanya? glibc atau GNU Lib C merupakan c library yang diusung oleh kebanyakan distro Linux pada umumnya. Sedangkan musl adalah c library yang lebih efisien dalam penggunaan resources bila dibandingkan glibc. Hanya saja terdapat beberapa keterbatasan dari musl, yang pertama adalah, musl tidak mendukung arsitektur 32 bits. Lalu yang kedua adalah, musl tidak mendukung aplikasi non-free. Jadi kalau kalian menggunakan driver nonfree atau aplikasi non-free, maka sebaiknya kalian tidak menggunakan musl. Untuk aplikasi nonfree seperti zoom, spotify, ataupun steam,\n- kalian tidak perlu khawatir karena kita masih bisa mendapatkannya dengan memanfaatkan flatpak.\n\nPoint unik ketiga adalah, Void Linux tidak menggunakan systemd, melainkan menunggunakan runit yang sebenarnya jauh simple dan efisien.\n\n00:00 - Intro\n00:50 - Persiapan Virtual Machine | Virt-Manager\n03:17 - Panduan instalasi Void Linux  \n14:06 - Informasi menari terkait Void Linux\n17:01 - Post Installation\n18:53 - Update repository & upgrade system\n22:00 - Instalasi lightdm & i3 window manager | i3WM\n24:59 - Enable service dengan runit | enable service dbus & lightdm\n30:10 - Panduan xbps-query\n32:34 - Panduan xbps-install\n33:48 - Panduan xbps-remove\n37:44 - Homepage Void Linux | Download ISO\n40:30 - Instalasi nonfree repository\n\nBagi teman-teman yang tertarik, silakan untuk bergabung juga dengan Discord server Indonesia Belajar: https://discord.com/invite/ybWmMHCfrQ\n\nPertanyaan terkait ulasan dalam video ini dapat disampaikan pada kolom komentar di bawah ini. Kami akan berusaha sebaik mungkin untuk merespon setiap pertanyaan yang diajukan.\n\nLinks terkait:\n- Homepage Void Linux: https://voidlinux.org/\n- Komunitas Void Linux Indonesia: https://t.me/voidlinux_id\n- Video Pengenalan FOSS: https://youtu.be/OwXZwIs0vAU\n- Distrowatch: https://distrowatch.com\n\nKeywords:\n- Linux Indonesia\n- Instalasi Linux Pemula\n- Review Linux\n- Ulasan Linux\n- Belajar Linux Pemula\n- Belajar Linux Dasar\n- Tutorial Linux \n...\nhttps://www.youtube.com/watch?v=QNlHWQxrQqk",
        "createdAt": "2021-07-24T13:01:08Z"
      },
      "ext": {
        "canonical": "lbry://@belajarIDN#6/void-linux-belajar-linux-pemula-linux#e"
      },
      "media": {
        "thumbnailUrl": "https://thumbnails.lbry.com/QNlHWQxrQqk",
        "durationSeconds": 2701
      },
      "author": {
        "id": "610d59fce77013ef6409ac21aa773090dc9bc240",
        "username": "@belajarIDN",
        "displayName": "Indonesia Belajar"
      },
      "engagement": {
        "shares": 0
      }
    },
    {
      "content": {
        "id": "f0c978eb7de847be3054d98fa30fd456ad4557e7",
        "title": "Kali Linux Wallpaper Grade C",
        "text": "Kali Linux Wallpaper Grade ",
        "createdAt": null
      },
      "ext": {
        "canonical": "lbry://linux-c#f"
      },
      "media": {
        "thumbnailUrl": null,
        "durationSeconds": null
      },
      "author": {
        "id": null,
        "username": null,
        "displayName": null
      },
      "engagement": {
        "shares": 0
      }
    }
  ],
  "metadata": {
    "platform": "odysee",
    "endpoint": "search_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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `claim_id` | `content.id` | - |
| `value.title` | `content.title` | - |
| `value.description` | `content.text` | - |
| `canonical_url` | `ext.canonical` | - |
| `value.release_time` | `content.createdAt` | `toIsoDate` |
| `value.thumbnail.url` | `media.thumbnailUrl` | `safeUrl` |
| `value.video.duration` | `media.durationSeconds` | `toNumber` |
| `signing_channel.claim_id` | `author.id` | - |
| `signing_channel.name` | `author.username` | - |
| `signing_channel.value.title` | `author.displayName` | - |
| `meta.reposted` | `engagement.shares` | `toNumber` |

## 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](https://onekey.dev/pricing); 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).
