Skip to content

Commit 39d79a0

Browse files
waleedlatif1waleedlatif1
committed
update docs
1 parent 2da7a34 commit 39d79a0

File tree

16 files changed

+150
-33
lines changed

16 files changed

+150
-33
lines changed

‎apps/docs/components/icons.tsx‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4588,11 +4588,17 @@ export function ShopifyIcon(props: SVGProps<SVGSVGElement>) {
45884588

45894589
export function BoxCompanyIcon(props: SVGProps<SVGSVGElement>) {
45904590
return (
4591-
<svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='0 0 41 22'>
4592-
<path
4593-
d='M39.7 19.2c.5.7.4 1.6-.2 2.1-.7.5-1.7.4-2.2-.2l-3.5-4.5-3.4 4.4c-.5.7-1.5.7-2.2.2-.7-.5-.8-1.4-.3-2.1l4-5.2-4-5.2c-.5-.7-.3-1.7.3-2.2.7-.5 1.7-.3 2.2.3l3.4 4.5L37.3 7c.5-.7 1.4-.8 2.2-.3.7.5.7 1.5.2 2.2L35.8 14l3.9 5.2zm-18.2-.6c-2.6 0-4.7-2-4.7-4.6 0-2.5 2.1-4.6 4.7-4.6s4.7 2.1 4.7 4.6c-.1 2.6-2.2 4.6-4.7 4.6zm-13.8 0c-2.6 0-4.7-2-4.7-4.6 0-2.5 2.1-4.6 4.7-4.6s4.7 2.1 4.7 4.6c0 2.6-2.1 4.6-4.7 4.6zM21.5 6.4c-2.9 0-5.5 1.6-6.8 4-1.3-2.4-3.9-4-6.9-4-1.8 0-3.4.6-4.7 1.5V1.5C3.1.7 2.4 0 1.6 0 .7 0 0 .7 0 1.5v12.6c.1 4.2 3.5 7.5 7.7 7.5 3 0 5.6-1.7 6.9-4.1 1.3 2.4 3.9 4.1 6.8 4.1 4.3 0 7.8-3.4 7.8-7.7.1-4.1-3.4-7.5-7.7-7.5z'
4594-
fill='currentColor'
4595-
/>
4591+
<svg
4592+
{...props}
4593+
xmlns='http://www.w3.org/2000/svg'
4594+
width='2500'
4595+
height='1379'
4596+
viewBox='0 0 444.893 245.414'
4597+
>
4598+
<g fill='#0075C9'>
4599+
<path d='M239.038 72.43c-33.081 0-61.806 18.6-76.322 45.904-14.516-27.305-43.24-45.902-76.32-45.902-19.443 0-37.385 6.424-51.821 17.266V16.925h-.008C34.365 7.547 26.713 0 17.286 0 7.858 0 .208 7.547.008 16.925H0v143.333h.036c.768 47.051 39.125 84.967 86.359 84.967 33.08 0 61.805-18.603 76.32-45.908 14.517 27.307 43.241 45.906 76.321 45.906 47.715 0 86.396-38.684 86.396-86.396.001-47.718-38.682-86.397-86.394-86.397zM86.395 210.648c-28.621 0-51.821-23.201-51.821-51.82 0-28.623 23.201-51.823 51.821-51.823 28.621 0 51.822 23.2 51.822 51.823 0 28.619-23.201 51.82-51.822 51.82zm152.643 0c-28.622 0-51.821-23.201-51.821-51.822 0-28.623 23.2-51.821 51.821-51.821 28.619 0 51.822 23.198 51.822 51.821-.001 28.621-23.203 51.822-51.822 51.822z' />
4600+
<path d='M441.651 218.033l-44.246-59.143 44.246-59.144-.008-.007c5.473-7.62 3.887-18.249-3.652-23.913-7.537-5.658-18.187-4.221-23.98 3.157l-.004-.002-38.188 51.047-38.188-51.047-.006.009c-5.793-7.385-16.441-8.822-23.981-3.16-7.539 5.664-9.125 16.293-3.649 23.911l-.008.005 44.245 59.144-44.245 59.143.008.005c-5.477 7.62-3.89 18.247 3.649 23.909 7.54 5.664 18.188 4.225 23.981-3.155l.006.007 38.188-51.049 38.188 51.049.004-.002c5.794 7.377 16.443 8.814 23.98 3.154 7.539-5.662 9.125-16.291 3.652-23.91l.008-.008z' />
4601+
</g>
45964602
</svg>
45974603
)
45984604
}

‎apps/docs/content/docs/en/tools/firecrawl.mdx‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ Extract structured content from web pages with comprehensive metadata support. C
5353
| `url` | string | Yes | The URL to scrape content from \(e.g., "https://example.com/page"\) |
5454
| `scrapeOptions` | json | No | Options for content scraping |
5555
| `apiKey` | string | Yes | Firecrawl API key |
56+
| `pricing` | custom | No | No description |
57+
| `metadata` | string | No | No description |
58+
| `rateLimit` | string | No | No description |
5659

5760
#### Output
5861

@@ -86,6 +89,9 @@ Search for information on the web using Firecrawl
8689
| --------- | ---- | -------- | ----------- |
8790
| `query` | string | Yes | The search query to use |
8891
| `apiKey` | string | Yes | Firecrawl API key |
92+
| `pricing` | custom | No | No description |
93+
| `metadata` | string | No | No description |
94+
| `rateLimit` | string | No | No description |
8995

9096
#### Output
9197

@@ -123,6 +129,9 @@ Crawl entire websites and extract structured content from all accessible pages
123129
| `includePaths` | json | No | URL paths to include in crawling \(e.g., \["/docs/*", "/api/*"\]\). Only these paths will be crawled |
124130
| `onlyMainContent` | boolean | No | Extract only main content from pages |
125131
| `apiKey` | string | Yes | Firecrawl API Key |
132+
| `pricing` | custom | No | No description |
133+
| `metadata` | string | No | No description |
134+
| `rateLimit` | string | No | No description |
126135

127136
#### Output
128137

@@ -142,7 +151,6 @@ Crawl entire websites and extract structured content from all accessible pages
142151
| ↳ `statusCode` | number | HTTP status code |
143152
| ↳ `ogLocaleAlternate` | array | Alternate locale versions |
144153
| `total` | number | Total number of pages found during crawl |
145-
| `creditsUsed` | number | Number of credits consumed by the crawl operation |
146154

147155
### `firecrawl_map`
148156

@@ -161,6 +169,9 @@ Get a complete list of URLs from any website quickly and reliably. Useful for di
161169
| `timeout` | number | No | Request timeout in milliseconds |
162170
| `location` | json | No | Geographic context for proxying \(country, languages\) |
163171
| `apiKey` | string | Yes | Firecrawl API key |
172+
| `pricing` | custom | No | No description |
173+
| `metadata` | string | No | No description |
174+
| `rateLimit` | string | No | No description |
164175

165176
#### Output
166177

@@ -187,6 +198,9 @@ Extract structured data from entire webpages using natural language prompts and
187198
| `ignoreInvalidURLs` | boolean | No | Skip invalid URLs in the array \(default: true\) |
188199
| `scrapeOptions` | json | No | Advanced scraping configuration options |
189200
| `apiKey` | string | Yes | Firecrawl API key |
201+
| `pricing` | custom | No | No description |
202+
| `metadata` | string | No | No description |
203+
| `rateLimit` | string | No | No description |
190204

191205
#### Output
192206

@@ -217,7 +231,6 @@ Autonomous web data extraction agent. Searches and gathers information based on
217231
| `success` | boolean | Whether the agent operation was successful |
218232
| `status` | string | Current status of the agent job \(processing, completed, failed\) |
219233
| `data` | object | Extracted data from the agent |
220-
| `creditsUsed` | number | Number of credits consumed by this agent task |
221234
| `expiresAt` | string | Timestamp when the results expire \(24 hours\) |
222235
| `sources` | object | Array of source URLs used by the agent |
223236

‎apps/docs/content/docs/en/tools/google_books.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Search for books using the Google Books API
4646
| `startIndex` | number | No | Index of the first result to return \(for pagination\) |
4747
| `maxResults` | number | No | Maximum number of results to return \(1-40\) |
4848
| `langRestrict` | string | No | Restrict results to a specific language \(ISO 639-1 code\) |
49+
| `pricing` | per_request | No | No description |
50+
| `rateLimit` | string | No | No description |
4951

5052
#### Output
5153

@@ -82,6 +84,8 @@ Get detailed information about a specific book volume
8284
| `apiKey` | string | Yes | Google Books API key |
8385
| `volumeId` | string | Yes | The ID of the volume to retrieve |
8486
| `projection` | string | No | Projection level \(full, lite\) |
87+
| `pricing` | per_request | No | No description |
88+
| `rateLimit` | string | No | No description |
8589

8690
#### Output
8791

‎apps/docs/content/docs/en/tools/google_maps.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Get current air quality data for a location
5050
| `lat` | number | Yes | Latitude coordinate |
5151
| `lng` | number | Yes | Longitude coordinate |
5252
| `languageCode` | string | No | Language code for the response \(e.g., "en", "es"\) |
53+
| `pricing` | per_request | No | No description |
54+
| `rateLimit` | string | No | No description |
5355

5456
#### Output
5557

@@ -91,6 +93,8 @@ Get directions and route information between two locations
9193
| `waypoints` | json | No | Array of intermediate waypoints |
9294
| `units` | string | No | Unit system: metric or imperial |
9395
| `language` | string | No | Language code for results \(e.g., en, es, fr\) |
96+
| `pricing` | per_request | No | No description |
97+
| `rateLimit` | string | No | No description |
9498

9599
#### Output
96100

@@ -135,6 +139,8 @@ Calculate travel distance and time between multiple origins and destinations
135139
| `avoid` | string | No | Features to avoid: tolls, highways, or ferries |
136140
| `units` | string | No | Unit system: metric or imperial |
137141
| `language` | string | No | Language code for results \(e.g., en, es, fr\) |
142+
| `pricing` | per_request | No | No description |
143+
| `rateLimit` | string | No | No description |
138144

139145
#### Output
140146

@@ -163,6 +169,8 @@ Get elevation data for a location
163169
| `apiKey` | string | Yes | Google Maps API key |
164170
| `lat` | number | Yes | Latitude coordinate |
165171
| `lng` | number | Yes | Longitude coordinate |
172+
| `pricing` | per_request | No | No description |
173+
| `rateLimit` | string | No | No description |
166174

167175
#### Output
168176

@@ -185,6 +193,8 @@ Convert an address into geographic coordinates (latitude and longitude)
185193
| `address` | string | Yes | The address to geocode |
186194
| `language` | string | No | Language code for results \(e.g., en, es, fr\) |
187195
| `region` | string | No | Region bias as a ccTLD code \(e.g., us, uk\) |
196+
| `pricing` | per_request | No | No description |
197+
| `rateLimit` | string | No | No description |
188198

189199
#### Output
190200

@@ -217,6 +227,8 @@ Geolocate a device using WiFi access points, cell towers, or IP address
217227
| `considerIp` | boolean | No | Whether to use IP address for geolocation \(default: true\) |
218228
| `cellTowers` | array | No | Array of cell tower objects with cellId, locationAreaCode, mobileCountryCode, mobileNetworkCode |
219229
| `wifiAccessPoints` | array | No | Array of WiFi access point objects with macAddress \(required\), signalStrength, etc. |
230+
| `pricing` | per_request | No | No description |
231+
| `rateLimit` | string | No | No description |
220232

221233
#### Output
222234

@@ -238,6 +250,8 @@ Get detailed information about a specific place
238250
| `placeId` | string | Yes | Google Place ID |
239251
| `fields` | string | No | Comma-separated list of fields to return |
240252
| `language` | string | No | Language code for results \(e.g., en, es, fr\) |
253+
| `pricing` | per_request | No | No description |
254+
| `rateLimit` | string | No | No description |
241255

242256
#### Output
243257

@@ -290,6 +304,8 @@ Search for places using a text query
290304
| `type` | string | No | Place type filter \(e.g., restaurant, cafe, hotel\) |
291305
| `language` | string | No | Language code for results \(e.g., en, es, fr\) |
292306
| `region` | string | No | Region bias as a ccTLD code \(e.g., us, uk\) |
307+
| `pricing` | per_request | No | No description |
308+
| `rateLimit` | string | No | No description |
293309

294310
#### Output
295311

@@ -322,6 +338,8 @@ Convert geographic coordinates (latitude and longitude) into a human-readable ad
322338
| `lat` | number | Yes | Latitude coordinate |
323339
| `lng` | number | Yes | Longitude coordinate |
324340
| `language` | string | No | Language code for results \(e.g., en, es, fr\) |
341+
| `pricing` | per_request | No | No description |
342+
| `rateLimit` | string | No | No description |
325343

326344
#### Output
327345

@@ -346,6 +364,8 @@ Snap GPS coordinates to the nearest road segment
346364
| `apiKey` | string | Yes | Google Maps API key with Roads API enabled |
347365
| `path` | string | Yes | Pipe-separated list of lat,lng coordinates \(e.g., "60.170880,24.942795\|60.170879,24.942796"\) |
348366
| `interpolate` | boolean | No | Whether to interpolate additional points along the road |
367+
| `pricing` | per_request | No | No description |
368+
| `rateLimit` | string | No | No description |
349369

350370
#### Output
351371

@@ -399,6 +419,8 @@ Get timezone information for a location
399419
| `lng` | number | Yes | Longitude coordinate |
400420
| `timestamp` | number | No | Unix timestamp to determine DST offset \(defaults to current time\) |
401421
| `language` | string | No | Language code for timezone name \(e.g., en, es, fr\) |
422+
| `pricing` | per_request | No | No description |
423+
| `rateLimit` | string | No | No description |
402424

403425
#### Output
404426

@@ -424,6 +446,8 @@ Validate and standardize a postal address
424446
| `regionCode` | string | No | ISO 3166-1 alpha-2 country code \(e.g., "US", "CA"\) |
425447
| `locality` | string | No | City or locality name |
426448
| `enableUspsCass` | boolean | No | Enable USPS CASS validation for US addresses |
449+
| `pricing` | per_request | No | No description |
450+
| `rateLimit` | string | No | No description |
427451

428452
#### Output
429453

‎apps/docs/content/docs/en/tools/google_pagespeed.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ Analyze a webpage for performance, accessibility, SEO, and best practices using
5555
| `category` | string | No | Lighthouse categories to analyze \(comma-separated\): performance, accessibility, best-practices, seo |
5656
| `strategy` | string | No | Analysis strategy: desktop or mobile |
5757
| `locale` | string | No | Locale for results \(e.g., en, fr, de\) |
58+
| `pricing` | per_request | No | No description |
59+
| `rateLimit` | string | No | No description |
5860

5961
#### Output
6062

‎apps/docs/content/docs/en/tools/google_translate.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ Translate text between languages using the Google Cloud Translation API. Support
4343
| `target` | string | Yes | Target language code \(e.g., "es", "fr", "de", "ja"\) |
4444
| `source` | string | No | Source language code. If omitted, the API will auto-detect the source language. |
4545
| `format` | string | No | Format of the text: "text" for plain text, "html" for HTML content |
46+
| `pricing` | custom | No | No description |
47+
| `metadata` | string | No | No description |
48+
| `rateLimit` | string | No | No description |
4649

4750
#### Output
4851

@@ -61,6 +64,9 @@ Detect the language of text using the Google Cloud Translation API.
6164
| --------- | ---- | -------- | ----------- |
6265
| `apiKey` | string | Yes | Google Cloud API key with Cloud Translation API enabled |
6366
| `text` | string | Yes | The text to detect the language of |
67+
| `pricing` | custom | No | No description |
68+
| `metadata` | string | No | No description |
69+
| `rateLimit` | string | No | No description |
6470

6571
#### Output
6672

‎apps/docs/content/docs/en/tools/grain.mdx‎

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,26 @@ Get the full transcript of a recording
138138
| ↳ `end` | number | End timestamp in ms |
139139
| ↳ `text` | string | Transcript text |
140140

141+
### `grain_list_views`
142+
143+
List available Grain views for webhook subscriptions
144+
145+
#### Input
146+
147+
| Parameter | Type | Required | Description |
148+
| --------- | ---- | -------- | ----------- |
149+
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
150+
| `typeFilter` | string | No | Optional view type filter: recordings, highlights, or stories |
151+
152+
#### Output
153+
154+
| Parameter | Type | Description |
155+
| --------- | ---- | ----------- |
156+
| `views` | array | Array of Grain views |
157+
| ↳ `id` | string | View UUID |
158+
| ↳ `name` | string | View name |
159+
| ↳ `type` | string | View type: recordings, highlights, or stories |
160+
141161
### `grain_list_teams`
142162

143163
List all teams in the workspace
@@ -185,15 +205,9 @@ Create a webhook to receive recording events
185205
| --------- | ---- | -------- | ----------- |
186206
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
187207
| `hookUrl` | string | Yes | Webhook endpoint URL \(e.g., "https://example.com/webhooks/grain"\) |
188-
| `hookType` | string | Yes | Type of webhook: "recording_added" or "upload_status" |
189-
| `filterBeforeDatetime` | string | No | Filter: recordings before this ISO8601 date \(e.g., "2024-01-15T00:00:00Z"\) |
190-
| `filterAfterDatetime` | string | No | Filter: recordings after this ISO8601 date \(e.g., "2024-01-01T00:00:00Z"\) |
191-
| `filterParticipantScope` | string | No | Filter: "internal" or "external" |
192-
| `filterTeamId` | string | No | Filter: specific team UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
193-
| `filterMeetingTypeId` | string | No | Filter: specific meeting type UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
194-
| `includeHighlights` | boolean | No | Include highlights in webhook payload |
195-
| `includeParticipants` | boolean | No | Include participants in webhook payload |
196-
| `includeAiSummary` | boolean | No | Include AI summary in webhook payload |
208+
| `viewId` | string | Yes | Grain view ID from GET /_/public-api/views |
209+
| `actions` | array | No | Optional list of actions to subscribe to: added, updated, removed |
210+
| `items` | string | No | No description |
197211

198212
#### Output
199213

@@ -202,9 +216,8 @@ Create a webhook to receive recording events
202216
| `id` | string | Hook UUID |
203217
| `enabled` | boolean | Whether hook is active |
204218
| `hook_url` | string | The webhook URL |
205-
| `hook_type` | string | Type of hook: recording_added or upload_status |
206-
| `filter` | object | Applied filters |
207-
| `include` | object | Included fields |
219+
| `view_id` | string | Grain view ID for the webhook |
220+
| `actions` | array | Configured actions for the webhook |
208221
| `inserted_at` | string | ISO8601 creation timestamp |
209222

210223
### `grain_list_hooks`
@@ -225,9 +238,8 @@ List all webhooks for the account
225238
| ↳ `id` | string | Hook UUID |
226239
| ↳ `enabled` | boolean | Whether hook is active |
227240
| ↳ `hook_url` | string | Webhook URL |
228-
| ↳ `hook_type` | string | Type: recording_added or upload_status |
229-
| ↳ `filter` | object | Applied filters |
230-
| ↳ `include` | object | Included fields |
241+
| ↳ `view_id` | string | Grain view ID |
242+
| ↳ `actions` | array | Configured actions |
231243
| ↳ `inserted_at` | string | Creation timestamp |
232244

233245
### `grain_delete_hook`

‎apps/docs/content/docs/en/tools/jina.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ Extract and process web content into clean, LLM-friendly text using Jina AI Read
6464
| Parameter | Type | Description |
6565
| --------- | ---- | ----------- |
6666
| `content` | string | The extracted content from the URL, processed into clean, LLM-friendly text |
67+
| `tokensUsed` | number | Number of Jina tokens consumed by this request |
6768

6869
### `jina_search`
6970

@@ -97,5 +98,6 @@ Search the web and return top 5 results with LLM-friendly content. Each result i
9798
| ↳ `content` | string | LLM-friendly extracted content |
9899
| ↳ `usage` | object | Token usage information |
99100
| ↳ `tokens` | number | Number of tokens consumed by this request |
101+
| `tokensUsed` | number | Number of Jina tokens consumed by this request |
100102

101103

‎apps/docs/content/docs/en/tools/knowledge.mdx‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,37 @@ Create a new document in a knowledge base
122122
| `message` | string | Success or error message describing the operation result |
123123
| `documentId` | string | ID of the created document |
124124

125+
### `knowledge_upsert_document`
126+
127+
Create or update a document in a knowledge base. If a document with the given ID or filename already exists, it will be replaced with the new content.
128+
129+
#### Input
130+
131+
| Parameter | Type | Required | Description |
132+
| --------- | ---- | -------- | ----------- |
133+
| `knowledgeBaseId` | string | Yes | ID of the knowledge base containing the document |
134+
| `documentId` | string | No | Optional ID of an existing document to update. If not provided, lookup is done by filename. |
135+
| `name` | string | Yes | Name of the document |
136+
| `content` | string | Yes | Content of the document |
137+
| `documentTags` | json | No | Document tags |
138+
| `documentTags` | string | No | No description |
139+
140+
#### Output
141+
142+
| Parameter | Type | Description |
143+
| --------- | ---- | ----------- |
144+
| `data` | object | Information about the upserted document |
145+
| ↳ `documentId` | string | Document ID |
146+
| ↳ `documentName` | string | Document name |
147+
| ↳ `type` | string | Document type |
148+
| ↳ `enabled` | boolean | Whether the document is enabled |
149+
| ↳ `isUpdate` | boolean | Whether an existing document was replaced |
150+
| ↳ `previousDocumentId` | string | ID of the document that was replaced, if any |
151+
| ↳ `createdAt` | string | Creation timestamp |
152+
| ↳ `updatedAt` | string | Last update timestamp |
153+
| `message` | string | Success or error message describing the operation result |
154+
| `documentId` | string | ID of the upserted document |
155+
125156
### `knowledge_list_tags`
126157

127158
List all tag definitions for a knowledge base

‎apps/docs/content/docs/en/tools/linkup.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ Search the web for information using Linkup
5151
| `includeDomains` | string | No | Comma-separated list of domain names to restrict search results to |
5252
| `includeInlineCitations` | boolean | No | Add inline citations to answers \(only applies when outputType is "sourcedAnswer"\) |
5353
| `includeSources` | boolean | No | Include sources in response |
54+
| `pricing` | custom | No | No description |
55+
| `metadata` | string | No | No description |
56+
| `rateLimit` | string | No | No description |
5457

5558
#### Output
5659

0 commit comments

Comments
 (0)