flashdata-dev commited on
Commit
a6e0409
·
verified ·
1 Parent(s): a64c514

Clarify capability names and simplify documentation

Browse files
Files changed (4) hide show
  1. README.md +31 -34
  2. index.html +5 -5
  3. task.json +6 -5
  4. tool.py +1 -1
README.md CHANGED
@@ -1,12 +1,13 @@
1
  ---
2
- title: "YouTube channel research snapshot"
3
- emoji: 🔎
4
- colorFrom: blue
5
- colorTo: indigo
6
- sdk: static
7
- app_file: index.html
 
8
  pinned: false
9
- license: mit
10
  tags:
11
  - smolagents
12
  - tool
@@ -14,25 +15,27 @@ tags:
14
  - youtube-channel
15
  ---
16
 
17
- # YouTube channel research snapshot — FlashData
18
 
19
- Prepare a channel research brief from its profile and recent uploads. Keep a dated snapshot of the channel description and available statistics, plus recent video IDs for follow-up review.
20
 
21
- **Try this task:** Review a channel's recent uploads before selecting videos for a topic brief.
22
 
23
- [FlashData youtube channel documentation](https://flashdata.dev/docs/sources/youtube_channel?utm_source=hugging-face&utm_medium=integration&utm_campaign=intent_gtm_2026q4&utm_content=youtube-channel-research-flashdata) · [Create a FlashData account](https://flashdata.dev/signup)
24
 
25
- ## Run it
26
 
27
- Open the Space to edit a request and inspect a documentation response sample. The interactive page runs locally in your browser; it does not send a FlashData query or collect an API key. The Python tool runs in your own process.
28
 
29
- Use Python 3.10 or newer. Install the pinned dependencies:
 
 
30
 
31
  ```sh
32
  python -m pip install "smolagents==1.26.0" "langchain-flashdata==0.2.1"
33
  ```
34
 
35
- Create an API key in the FlashData console, fund the required credits, and supply the key in your local environment. Review `tool.py` before enabling remote code execution.
36
 
37
  ```python
38
  import getpass
@@ -45,33 +48,27 @@ result = tool(**{'handle': '@Apple', 'video_limit': 20})
45
  print(result)
46
  ```
47
 
48
- This is a native smolagents Tool with typed task inputs. Add the loaded tool to your own agent; model choice, prompts and model fees remain under your control. Direct calls above do not need a model.
49
 
50
  ## Inputs
51
 
52
- | Parameter | Type | Required / default | Details |
53
- | --- | --- | --- | --- |
54
- | `handle` | string | Required | YouTube channel handle, for example @jawed. |
55
- | `video_limit` | integer | 20 | video limit minimum=1, maximum=100 |
56
-
57
- Optional `None` values are omitted; the documented adapter defaults apply.
58
-
59
- Full validation rules are in `input-schema.json`.
60
-
61
- ## Output and next step
62
 
63
- The useful data is at `results.0.videos`. Relevant fields: `videoId`, `title`, `duration`, `viewCount`, `uploadDate`.
64
 
65
- Use channelId as a stable reference and video IDs for later metadata checks. Compare separately saved snapshots only when you intentionally schedule collection.
66
 
67
- The Space includes a recorded documentation example and its original request. It is not a fresh result for the task prompt above. Optional fields may be absent.
68
 
69
- ## Costs, limits and failures
70
 
71
- Requests 1–100 recent videos, default 20. Statistics can be null; the videos array is not the entire channel archive. No ongoing monitor is created.
72
 
73
- The tool is MIT licensed. It is free to install. **FlashData API calls are paid**; installation does not include free data queries. Check current [FlashData pricing](https://flashdata.dev/pricing) and your console balance. Platform, model and customer storage charges are separate. Each search/page is a separate request; Extended Search has its own rate. Downloads are charged by delivered data volume.
74
 
75
- An uncertain timeout can still represent a charged request. Check Jobs in the FlashData console before trying again; this integration does not automatically retry paid submissions. A 401 means the key was rejected, 402 means insufficient credits, and 429 means a rate or quota limit.
76
 
77
- [Get started with this FlashData capability](https://flashdata.dev/docs/sources/youtube_channel?utm_source=hugging-face&utm_medium=integration&utm_campaign=intent_gtm_2026q4&utm_content=youtube-channel-research-flashdata)
 
1
  ---
2
+ title: "YouTube Channel Data"
3
+ short_description: "Channel profiles and recent uploads from a handle."
4
+ emoji: "🔎"
5
+ colorFrom: "blue"
6
+ colorTo: "indigo"
7
+ sdk: "static"
8
+ app_file: "index.html"
9
  pinned: false
10
+ license: "mit"
11
  tags:
12
  - smolagents
13
  - tool
 
15
  - youtube-channel
16
  ---
17
 
18
+ # YouTube Channel Data
19
 
20
+ Get a YouTube channel profile and recent videos from its handle. Retrieve channel details and a bounded list of recent uploads.
21
 
22
+ [API documentation](https://flashdata.dev/docs/sources/youtube_channel?utm_source=hugging-face&utm_medium=integration&utm_campaign=intent_gtm_2026q4&utm_content=youtube-channel-research-flashdata) · [Get an API key](https://flashdata.dev/app/api-keys) · [Pricing](https://flashdata.dev/pricing)
23
 
24
+ Requires your own FlashData API key and paid Credits. The Python tool is free to install.
25
 
26
+ ## Try the inputs
27
 
28
+ Edit the JSON in this Space, generate a Python call, and inspect the included sample response or paste your own JSON. This page runs locally in your browser; it does not run a data query or collect your API key.
29
 
30
+ ## Run with Python
31
+
32
+ Use Python 3.10 or newer:
33
 
34
  ```sh
35
  python -m pip install "smolagents==1.26.0" "langchain-flashdata==0.2.1"
36
  ```
37
 
38
+ Review [tool.py](tool.py) before enabling `trust_remote_code`. Run locally with your key:
39
 
40
  ```python
41
  import getpass
 
48
  print(result)
49
  ```
50
 
51
+ The same loaded tool can be used with smolagents. A direct Python call does not require a model.
52
 
53
  ## Inputs
54
 
55
+ | Parameter | Required / default | Details |
56
+ | --- | --- | --- |
57
+ | `handle` | Required | YouTube channel handle, for example @jawed. |
58
+ | `video_limit` | 20 | video limit minimum=1, maximum=100 |
 
 
 
 
 
 
59
 
60
+ See [input-schema.json](input-schema.json) for full validation rules. Optional `None` values are omitted; adapter defaults apply.
61
 
62
+ ## Output
63
 
64
+ Read `results.0.videos`. Fields: `videoId`, `title`, `duration`, `viewCount`, `uploadDate`. Optional fields may be absent.
65
 
66
+ [example.json](example.json) contains a recorded response and its original request, not a new result for the input shown in the Space.
67
 
68
+ ## Limits and cost
69
 
70
+ Request 1–100 recent videos. This is not a complete channel archive; statistics and other fields may be unavailable.
71
 
72
+ Each data request uses FlashData Credits. Check [current pricing](https://flashdata.dev/pricing) before running. Any model or hosting charges are separate.
73
 
74
+ For an uncertain timeout, check your FlashData Jobs before retrying; this tool does not automatically retry paid submissions.
index.html CHANGED
@@ -3,18 +3,18 @@
3
  <head>
4
  <meta charset="UTF-8">
5
  <meta name="viewport" content="width=device-width,initial-scale=1">
6
- <title>FlashData research tool</title>
7
  <link rel="stylesheet" href="style.css">
8
  </head>
9
  <body>
10
  <main>
11
- <header><a href="https://flashdata.dev" class="brand" target="_blank" rel="noopener">FLASHDATA</a><span>Research tools for AI agents</span></header>
12
- <section class="intro"><p class="eyebrow">SMOLAGENTS TOOL · PYTHON</p><h1 id="title">Loading tool…</h1><p id="scenario"></p><a id="docs" class="cta" target="_blank" rel="noopener">Get an API key and read the docs ↗</a></section>
13
  <div class="grid">
14
  <section class="panel"><h2>Build a request</h2><p id="task"></p><label for="parameters">Tool inputs (JSON)</label><textarea id="parameters" spellcheck="false"></textarea><button id="generate" type="button">Generate Python call</button><p id="input-status" role="status"></p><pre><code id="python"></code></pre><p class="hint">Run this code in your Python environment. Your API key is entered there, not on this page.</p></section>
15
- <section class="panel"><h2>Inspect the response</h2><p class="hint">This is a recorded documentation sample, not a live response to the request on the left. You can paste your own response JSON to explore its fields.</p><details><summary>Original sample request</summary><pre id="sample-request"></pre></details><label for="response">Response JSON</label><textarea id="response" spellcheck="false"></textarea><button id="inspect" type="button">Inspect results</button><p id="response-status" role="status"></p><div id="results"></div></section>
16
  </div>
17
- <section class="panel next"><h2>Use the result</h2><p id="next"></p><h3>Limits and costs</h3><p id="limit"></p><p>The tool is free to install. <strong>FlashData API calls are paid.</strong> Platform, model and customer storage costs are separate. No API or model call is made by this page. <a href="https://flashdata.dev/pricing" target="_blank" rel="noopener">Check pricing ↗</a></p><p>For an uncertain timeout, check Jobs before retrying a paid submission. Download jobs must be read with their saved ID; do not submit again while pending.</p></section>
18
  <footer><a id="source" target="_blank" rel="noopener">Review tool.py</a><a id="readme" target="_blank" rel="noopener">Installation and input reference</a><span>MIT licensed integration · FlashData API terms apply separately</span></footer>
19
  </main>
20
  <script type="module" src="app.js"></script>
 
3
  <head>
4
  <meta charset="UTF-8">
5
  <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <title>Search and video data tools</title>
7
  <link rel="stylesheet" href="style.css">
8
  </head>
9
  <body>
10
  <main>
11
+ <header><a href="https://flashdata.dev" class="brand" target="_blank" rel="noopener">FLASHDATA</a><span>Search &amp; video data</span></header>
12
+ <section class="intro"><p class="eyebrow">PYTHON TOOL · REQUEST EXAMPLES</p><h1 id="title">Loading tool…</h1><p id="scenario"></p><a id="docs" class="cta" target="_blank" rel="noopener">API documentation &amp; setup ↗</a></section>
13
  <div class="grid">
14
  <section class="panel"><h2>Build a request</h2><p id="task"></p><label for="parameters">Tool inputs (JSON)</label><textarea id="parameters" spellcheck="false"></textarea><button id="generate" type="button">Generate Python call</button><p id="input-status" role="status"></p><pre><code id="python"></code></pre><p class="hint">Run this code in your Python environment. Your API key is entered there, not on this page.</p></section>
15
+ <section class="panel"><h2>Inspect the response</h2><p class="hint">View the included sample or paste your own response JSON. Editing the request does not run a query.</p><details><summary>Original sample request</summary><pre id="sample-request"></pre></details><label for="response">Response JSON</label><textarea id="response" spellcheck="false"></textarea><button id="inspect" type="button">Inspect results</button><p id="response-status" role="status"></p><div id="results"></div></section>
16
  </div>
17
+ <section class="panel next"><h2>Use the result</h2><p id="next"></p><h3>Limits and costs</h3><p id="limit"></p><p>Requires your FlashData API key. <strong>Data calls use paid Credits.</strong> This page only prepares code and displays JSON. <a href="https://flashdata.dev/pricing" target="_blank" rel="noopener">Check pricing ↗</a></p><p>Check FlashData Jobs before retrying a request that timed out.</p></section>
18
  <footer><a id="source" target="_blank" rel="noopener">Review tool.py</a><a id="readme" target="_blank" rel="noopener">Installation and input reference</a><span>MIT licensed integration · FlashData API terms apply separately</span></footer>
19
  </main>
20
  <script type="module" src="app.js"></script>
task.json CHANGED
@@ -1,8 +1,8 @@
1
  {
2
  "slug": "youtube-channel-research-flashdata",
3
- "title": "YouTube channel research snapshot \u2014 FlashData",
4
- "scenario": "Prepare a channel research brief from its profile and recent uploads. Keep a dated snapshot of the channel description and available statistics, plus recent video IDs for follow-up review.",
5
- "task": "Review a channel's recent uploads before selecting videos for a topic brief.",
6
  "input": {
7
  "handle": "@Apple",
8
  "video_limit": 20
@@ -15,8 +15,9 @@
15
  "viewCount",
16
  "uploadDate"
17
  ],
18
- "next": "Use channelId as a stable reference and video IDs for later metadata checks. Compare separately saved snapshots only when you intentionally schedule collection.",
19
- "limit": "Requests 1\u2013100 recent videos, default 20. Statistics can be null; the videos array is not the entire channel archive. No ongoing monitor is created.",
 
20
  "source": "youtube_channel",
21
  "repo_id": "flashdata-dev/youtube-channel-research-flashdata"
22
  }
 
1
  {
2
  "slug": "youtube-channel-research-flashdata",
3
+ "title": "YouTube Channel Data",
4
+ "scenario": "Get a YouTube channel profile and recent videos from its handle. Retrieve channel details and a bounded list of recent uploads.",
5
+ "task": "Look up a channel handle and its recent videos.",
6
  "input": {
7
  "handle": "@Apple",
8
  "video_limit": 20
 
15
  "viewCount",
16
  "uploadDate"
17
  ],
18
+ "next": "Read results.0 for the channel profile and available recent videos.",
19
+ "limit": "Request 1\u2013100 recent videos. This is not a complete channel archive; statistics and other fields may be unavailable.",
20
+ "short_description": "Channel profiles and recent uploads from a handle.",
21
  "source": "youtube_channel",
22
  "repo_id": "flashdata-dev/youtube-channel-research-flashdata"
23
  }
tool.py CHANGED
@@ -3,7 +3,7 @@ from smolagents import Tool
3
 
4
  class FlashDataTool(Tool):
5
  name = 'youtube_channel'
6
- description = 'Prepare a channel research brief from its profile and recent uploads. Keep a dated snapshot of the channel description and available statistics, plus recent video IDs for follow-up review. Requests 1–100 recent videos, default 20. Statistics can be null; the videos array is not the entire channel archive. No ongoing monitor is created. Uses paid FlashData API credits. Never automatically retry an uncertain submission; check Jobs first.'
7
  inputs = {'handle': {'description': 'YouTube channel handle, for example @jawed.', 'type': 'string'},
8
  'video_limit': {'description': 'Video limit. minimum: 1. maximum: 100. Default: 20.',
9
  'nullable': True,
 
3
 
4
  class FlashDataTool(Tool):
5
  name = 'youtube_channel'
6
+ description = 'Get a YouTube channel profile and recent videos from its handle. Retrieve channel details and a bounded list of recent uploads. Request 1–100 recent videos. This is not a complete channel archive; statistics and other fields may be unavailable. Uses paid FlashData API credits. Never automatically retry an uncertain submission; check Jobs first.'
7
  inputs = {'handle': {'description': 'YouTube channel handle, for example @jawed.', 'type': 'string'},
8
  'video_limit': {'description': 'Video limit. minimum: 1. maximum: 100. Default: 20.',
9
  'nullable': True,