Skip to content

Commit 1983744

Browse files
waleedlatif1waleedlatif1
committed
fix(youcom): use literal operation ids so docs and catalog pick up tools
1 parent 19abda3 commit 1983744

4 files changed

Lines changed: 309 additions & 67 deletions

File tree

‎.agents/skills/add-block/SKILL.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -562,6 +562,11 @@ Use `wandConfig` on fields that are hard to fill by hand — timestamps (`genera
562562

563563
## Tools Configuration
564564

565+
**Write operation ids and tool ids as string literals** in the `operation` dropdown `options` and
566+
`tools.access`, never through constants (`id: SEARCH`, `access: [SEARCH]`). `scripts/generate-docs.ts`
567+
reads them from source with regexes, so a constant parses as empty: the docs page loses its whole
568+
Actions section and the integration catalog ships blank operation descriptions, with no check failing.
569+
565570
**Preferred:** Use tool names directly as dropdown option IDs to avoid switch cases:
566571
```typescript
567572
// Dropdown options use tool IDs directly

‎apps/docs/content/docs/integrations/youcom.mdx‎

Lines changed: 242 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,246 @@ Integrate You.com into the workflow. Search the web and news with query-relevant
3333

3434

3535

36+
## Actions
37+
38+
### You.com Search
39+
40+
Search the web and news with You.com, returning LLM-ready results with optional query-relevant highlights or full page content.
41+
42+
#### Input
43+
44+
| Parameter | Type | Required | Description |
45+
| --------- | ---- | -------- | ----------- |
46+
| `query` | string | Yes | Search query. Supports search operators such as site: and filetype: |
47+
| `count` | number | No | Maximum results to return per section \(web and news\). Defaults to 10 |
48+
| `offset` | number | No | Page offset in multiples of count, from 0 to 9. Defaults to 0 |
49+
| `freshness` | string | No | Result recency: day, week, month, year, or a range like 2025-01-01to2025-12-31 |
50+
| `country` | string | No | Two-letter country code that sets the geographic focus \(e.g., US, GB, DE\) |
51+
| `language` | string | No | BCP 47 language code for results \(e.g., EN, FR, ZH-HANS\). Defaults to EN |
52+
| `safesearch` | string | No | Content moderation filter: off, moderate, or strict. Defaults to moderate |
53+
| `knowledge` | string | No | Set to core to also return knowledge results from licensed data providers |
54+
| `includeDomains` | string | No | Comma-separated domains to restrict results to \(up to 500\). Cannot be combined with exclude or boost domains |
55+
| `excludeDomains` | string | No | Comma-separated domains to remove from results \(up to 500\) |
56+
| `boostDomains` | string | No | Comma-separated domains to rank higher without filtering others \(up to 500\) |
57+
| `extractionMode` | string | No | Content to extract per result: highlights \(query-relevant passages\) or full_page. Omit for snippets only |
58+
| `extractionSource` | string | No | Where full_page content comes from: blend \(cache, then live crawl\), cache, or fetch. Defaults to blend |
59+
| `extractionFormats` | string | No | Comma-separated full_page formats: markdown, html, or both. Defaults to markdown |
60+
| `crawlTimeout` | number | No | Seconds to wait for page content when crawling, from 1 to 60. Defaults to 10 |
61+
| `apiKey` | string | Yes | You.com API key |
62+
63+
#### Output
64+
65+
| Parameter | Type | Description |
66+
| --------- | ---- | ----------- |
67+
| `web` | array | Web results |
68+
| ↳ `url` | string | URL of the result |
69+
| ↳ `title` | string | Title of the result |
70+
| ↳ `description` | string | Brief description of the result |
71+
| ↳ `snippets` | array | Short keyword-centered fragments \(omitted when highlights extraction is used\) |
72+
| ↳ `thumbnailUrl` | string | Thumbnail URL |
73+
| ↳ `faviconUrl` | string | Favicon URL of the result's domain |
74+
| ↳ `pageAge` | string | Age of the result |
75+
| ↳ `highlights` | array | Query-relevant passages \(highlights extraction only\) |
76+
| ↳ `html` | string | Full page HTML \(full_page only\) |
77+
| ↳ `markdown` | string | Full page Markdown \(full_page only\) |
78+
| `news` | array | News results |
79+
| ↳ `url` | string | URL of the article |
80+
| ↳ `title` | string | Title of the article |
81+
| ↳ `description` | string | Brief description of the article |
82+
| ↳ `thumbnailUrl` | string | Thumbnail URL |
83+
| ↳ `pageAge` | string | UTC publication timestamp |
84+
| ↳ `html` | string | Full page HTML \(full_page only\) |
85+
| ↳ `markdown` | string | Full page Markdown \(full_page only\) |
86+
| `knowledge` | array | Knowledge results from licensed data providers \(when knowledge is core\) |
87+
| ↳ `type` | string | Kind of knowledge result \(currently answer\) |
88+
| ↳ `title` | string | Title of the knowledge result |
89+
| ↳ `description` | string | Knowledge drawn from licensed data |
90+
| ↳ `asOf` | string | Date the data covers \(YYYY-MM-DD\) |
91+
| ↳ `attribution` | array | Data provider credits |
92+
| ↳ `name` | string | Data provider name |
93+
| ↳ `sourceDescription` | string | Description of the provider |
94+
| `searchUuid` | string | Unique ID of the search |
95+
| `query` | string | Query used to retrieve the results |
96+
| `latency` | number | Search latency in seconds |
97+
98+
### You.com Get Contents
99+
100+
Fetch the HTML, Markdown, and page metadata of one or more web pages with You.com.
101+
102+
#### Input
103+
104+
| Parameter | Type | Required | Description |
105+
| --------- | ---- | -------- | ----------- |
106+
| `urls` | string | Yes | Comma-separated URLs to fetch content from |
107+
| `formats` | string | No | Comma-separated formats to return: markdown, html, metadata \(JSON-LD and OpenGraph site info\) |
108+
| `crawlTimeout` | number | No | Seconds to wait for page content, from 1 to 60. Defaults to 10 |
109+
| `maxAge` | number | No | Maximum age in seconds of cached content before the page is re-fetched. Defaults to no limit |
110+
| `apiKey` | string | Yes | You.com API key |
111+
112+
#### Output
113+
114+
| Parameter | Type | Description |
115+
| --------- | ---- | ----------- |
116+
| `pages` | array | Content of each fetched page |
117+
| ↳ `url` | string | URL of the fetched page |
118+
| ↳ `title` | string | Title of the page |
119+
| ↳ `html` | string | Page HTML \(html format\) |
120+
| ↳ `markdown` | string | Page Markdown \(markdown format\) |
121+
| ↳ `siteName` | string | OpenGraph site name \(metadata format\) |
122+
| ↳ `faviconUrl` | string | Favicon URL of the page's domain \(metadata format\) |
123+
124+
### You.com Answer
125+
126+
Get a synthesized answer to a question with numbered citations and the web results used to write it.
127+
128+
#### Input
129+
130+
| Parameter | Type | Required | Description |
131+
| --------- | ---- | -------- | ----------- |
132+
| `query` | string | Yes | The question to answer |
133+
| `freshness` | string | No | Result recency: day, week, month, year, or a range like 2025-01-01to2025-12-31 |
134+
| `country` | string | No | Two-letter country code that sets the geographic focus \(e.g., US, GB, DE\) |
135+
| `language` | string | No | BCP 47 language code for results \(e.g., EN, FR, DE\) |
136+
| `safesearch` | string | No | Content moderation filter: off, moderate, or strict. Defaults to moderate |
137+
| `includeDomains` | string | No | Comma-separated domains to restrict results to \(up to 500\). Cannot be combined with exclude or boost domains |
138+
| `excludeDomains` | string | No | Comma-separated domains to remove from results \(up to 500\) |
139+
| `boostDomains` | string | No | Comma-separated domains to rank higher without filtering others \(up to 500\) |
140+
| `apiKey` | string | Yes | You.com API key |
141+
142+
#### Output
143+
144+
| Parameter | Type | Description |
145+
| --------- | ---- | ----------- |
146+
| `answer` | string | Synthesized answer with numbered inline citations referencing citations |
147+
| `citations` | array | Sources cited in the answer, in citation order |
148+
| ↳ `source` | string | URL of the cited source |
149+
| ↳ `excerpts` | array | Verbatim excerpts from the source that support the answer |
150+
| `results` | array | All web results considered while writing the answer, cited or not |
151+
| ↳ `url` | string | URL of the source webpage |
152+
| ↳ `title` | string | Title of the source webpage |
153+
| ↳ `snippets` | array | Text snippets previewing the content |
154+
| ↳ `description` | string | Brief description |
155+
| ↳ `thumbnailUrl` | string | Thumbnail URL |
156+
| ↳ `pageAge` | string | Age of the result |
157+
158+
### You.com Research
159+
160+
Run multi-step web research on a question and get a thorough, cited answer, or start it as a background task.
161+
162+
#### Input
163+
164+
| Parameter | Type | Required | Description |
165+
| --------- | ---- | -------- | ----------- |
166+
| `input` | string | Yes | Research question or complex query \(up to 40,000 characters\) |
167+
| `researchEffort` | string | No | Depth of research: lite \(<10s\), standard \(10-30s\), deep \(<120s\), exhaustive \(<300s\), or frontier \(always runs in the background and returns a task ID\). Defaults to standard |
168+
| `outputSchema` | json | No | JSON Schema for structured output in content. Every object needs additionalProperties: false and all properties required. Not supported with lite |
169+
| `background` | boolean | No | Run as a background task and return a task ID to poll with Get Research Task. Always on for frontier |
170+
| `includeDomains` | string | No | Comma-separated domains the research may use \(up to 500\). Cannot be combined with exclude or boost domains |
171+
| `excludeDomains` | string | No | Comma-separated domains the research must not search or visit \(up to 500\) |
172+
| `boostDomains` | string | No | Comma-separated domains to rank higher without filtering others \(up to 500\) |
173+
| `freshness` | string | No | Source recency: day, week, month, year, or a range like 2025-01-01to2025-12-31 |
174+
| `country` | string | No | Two-letter country code that focuses web results \(e.g., US, GB, DE\) |
175+
| `apiKey` | string | Yes | You.com API key |
176+
177+
#### Output
178+
179+
| Parameter | Type | Description |
180+
| --------- | ---- | ----------- |
181+
| `taskId` | string | Background task ID to pass to Get Research Task \(background only\) |
182+
| `status` | string | Background task status: queued, running, completed, failed, or cancelled \(background only\) |
183+
| `streamUrl` | string | URL path of the task progress event stream \(background only\) |
184+
| `createdAt` | string | When the background task was created, RFC 3339 \(background only\) |
185+
186+
### You.com Get Research Task
187+
188+
Get the status of a background research task and, once completed, its cited answer and sources.
189+
190+
#### Input
191+
192+
| Parameter | Type | Required | Description |
193+
| --------- | ---- | -------- | ----------- |
194+
| `taskId` | string | Yes | ID of the background research task |
195+
| `apiKey` | string | Yes | You.com API key |
196+
197+
#### Output
198+
199+
| Parameter | Type | Description |
200+
| --------- | ---- | ----------- |
201+
| `taskId` | string | ID of the background research task |
202+
| `taskType` | string | Task type \(research\) |
203+
| `status` | string | Task status: queued, running, completed, failed, or cancelled |
204+
| `createdAt` | string | When the task was created, RFC 3339 |
205+
| `updatedAt` | string | When the task was last updated, RFC 3339 |
206+
| `completedAt` | string | When the task reached a terminal status, RFC 3339 |
207+
| `error` | string | Diagnostic message when failed |
208+
| `taskInput` | json | Original request parameters submitted for the task |
209+
| ↳ `input` | string | Research question that was submitted |
210+
| ↳ `researchEffort` | string | Research effort level submitted |
211+
| ↳ `background` | boolean | Whether background mode was requested |
212+
| ↳ `outputSchema` | json | Structured output schema submitted |
213+
| ↳ `sourceControl` | json | Source control configuration submitted |
214+
| ↳ `type` | string | Task type \(research\) |
215+
216+
### You.com Finance Research
217+
218+
Research a financial question across earnings reports, SEC filings, analyst coverage, and market news, and get a cited answer.
219+
220+
#### Input
221+
222+
| Parameter | Type | Required | Description |
223+
| --------- | ---- | -------- | ----------- |
224+
| `input` | string | Yes | Financial research question \(up to 40,000 characters\) |
225+
| `researchEffort` | string | No | Depth of research: deep \(<120s\) or exhaustive \(<300s\). Defaults to deep |
226+
| `apiKey` | string | Yes | You.com API key |
227+
228+
#### Output
229+
230+
| Parameter | Type | Description |
231+
| --------- | ---- | ----------- |
232+
| `content` | string | Markdown answer with numbered inline citations referencing sources |
233+
| `contentType` | string | Format of content \(text\) |
234+
235+
### You.com Search Images
236+
237+
Find image URLs for a query with You.com. Beta, and limited to You.com early-access API keys.
238+
239+
#### Input
240+
241+
| Parameter | Type | Required | Description |
242+
| --------- | ---- | -------- | ----------- |
243+
| `query` | string | Yes | Image search query. Supports site:, filetype: \(e.g., filetype:png\), and OR |
244+
| `count` | number | No | Maximum number of images to return, from 1 to 100. Defaults to 10 |
245+
| `apiKey` | string | Yes | You.com API key |
246+
247+
#### Output
248+
249+
| Parameter | Type | Description |
250+
| --------- | ---- | ----------- |
251+
| `images` | array | Image results |
252+
| ↳ `title` | string | Title of the image result |
253+
| ↳ `pageUrl` | string | URL of the page containing the image |
254+
| ↳ `imageUrl` | string | Direct URL to the image |
255+
| ↳ `thumbnail` | string | Proxy-hosted thumbnail URL |
256+
| ↳ `largeThumbnail` | string | Larger resized image URL; fall back to thumbnail or imageUrl if it fails |
257+
| `query` | string | Query that was submitted |
258+
| `searchUuid` | string | Unique ID of the search |
259+
260+
### You.com Get Account Balance
261+
262+
Get the remaining You.com API credit balance for the account or organization that owns the API key.
263+
264+
#### Input
265+
266+
| Parameter | Type | Required | Description |
267+
| --------- | ---- | -------- | ----------- |
268+
| `apiKey` | string | Yes | You.com API key |
269+
270+
#### Output
271+
272+
| Parameter | Type | Description |
273+
| --------- | ---- | ----------- |
274+
| `accountId` | string | Stable hashed ID of the billing entity \(user or organization\) |
275+
| `accountType` | string | Billing entity type \(account\) |
276+
| `balance` | number | Remaining credit balance in cents \(divide by 100 for USD\) |
277+
36278

0 commit comments

Comments
 (0)