Skip to content

Commit 86b6782

Browse files
committed
update docs
1 parent 6544876 commit 86b6782

File tree

6 files changed

+165
-20
lines changed

6 files changed

+165
-20
lines changed

apps/docs/components/icons.tsx

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -548,6 +548,34 @@ export function GithubIcon(props: SVGProps<SVGSVGElement>) {
548548
)
549549
}
550550

551+
export function GithubOutlineIcon(props: SVGProps<SVGSVGElement>) {
552+
return (
553+
<svg
554+
{...props}
555+
width='24'
556+
height='24'
557+
viewBox='0 0 24 24'
558+
fill='none'
559+
xmlns='http://www.w3.org/2000/svg'
560+
>
561+
<path
562+
d='M15 21C15 21 15 18.73 15 18C15 17.37 15.15 16.04 14.5 15.5C15.89 15.37 16.98 14.92 18 14C19.02 13.08 19.5 11.69 19.5 9.5C19.5 8 19.25 7 18.5 6C18.79 5.22 18.84 4 18.5 3C16.94 3 15.53 4.07 15 4.5C14.61 4.4 13.67 4 12 4C10.33 4 9.39 4.4 9 4.5C8.47 4.07 7.06 3 5.5 3C5.16 4 5.21 5.22 5.5 6C4.75 7 4.5 8 4.5 9.5C4.5 11.69 4.98 13.08 6 14C7.02 14.92 8.11 15.37 9.5 15.5C8.85 16.04 9 17.37 9 18C9 18.73 9 21 9 21'
563+
stroke='currentColor'
564+
strokeWidth='2'
565+
strokeLinecap='round'
566+
strokeLinejoin='round'
567+
/>
568+
<path
569+
d='M9 19C7.59 19 6.16 18.44 5.31 17.81C4.47 17.18 4.22 16.15 3 15.5'
570+
stroke='currentColor'
571+
strokeWidth='2'
572+
strokeLinecap='round'
573+
strokeLinejoin='round'
574+
/>
575+
</svg>
576+
)
577+
}
578+
551579
export function GitLabIcon(props: SVGProps<SVGSVGElement>) {
552580
return (
553581
<svg {...props} width='24' height='24' viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'>
@@ -2050,7 +2078,7 @@ export function LangsmithIcon(props: SVGProps<SVGSVGElement>) {
20502078

20512079
export function LemlistIcon(props: SVGProps<SVGSVGElement>) {
20522080
return (
2053-
<svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='0 0 180 181' fill='none'>
2081+
<svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='24 24.92 132 132' fill='none'>
20542082
<path
20552083
fillRule='evenodd'
20562084
clipRule='evenodd'

apps/docs/content/docs/en/tools/airtable.mdx

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Integrates Airtable into the workflow. Can list bases, list tables (with schema)
3434

3535
### `airtable_list_bases`
3636

37-
List all Airtable bases the user has access to
37+
List all bases the authenticated user has access to
3838

3939
#### Input
4040

@@ -46,7 +46,7 @@ List all Airtable bases the user has access to
4646

4747
| Parameter | Type | Description |
4848
| --------- | ---- | ----------- |
49-
| `bases` | array | List of Airtable bases |
49+
| `bases` | array | Array of Airtable bases with id, name, and permissionLevel |
5050
|`id` | string | Base ID \(starts with "app"\) |
5151
|`name` | string | Base name |
5252
|`permissionLevel` | string | Permission level \(none, read, comment, edit, create\) |
@@ -204,22 +204,6 @@ Update multiple existing records in an Airtable table
204204
|`recordCount` | number | Number of records updated |
205205
|`updatedRecordIds` | array | List of updated record IDs |
206206

207-
### `airtable_list_bases`
208-
209-
List all bases the authenticated user has access to
210-
211-
#### Input
212-
213-
| Parameter | Type | Required | Description |
214-
| --------- | ---- | -------- | ----------- |
215-
216-
#### Output
217-
218-
| Parameter | Type | Description |
219-
| --------- | ---- | ----------- |
220-
| `bases` | json | Array of Airtable bases with id, name, and permissionLevel |
221-
| `metadata` | json | Operation metadata including total bases count |
222-
223207
### `airtable_get_base_schema`
224208

225209
Get the schema of all tables, fields, and views in an Airtable base

apps/docs/content/docs/en/tools/exa.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ Search the web using Exa AI. Returns relevant search results with titles, URLs,
5555
| `summary` | boolean | No | Include AI-generated summaries in results \(default: false\) |
5656
| `livecrawl` | string | No | Live crawling mode: never \(default\), fallback, always, or preferred \(always try livecrawl, fall back to cache if fails\) |
5757
| `apiKey` | string | Yes | Exa AI API Key |
58+
| `pricing` | custom | No | No description |
59+
| `metadata` | string | No | No description |
60+
| `rateLimit` | string | No | No description |
5861

5962
#### Output
6063

@@ -87,6 +90,9 @@ Retrieve the contents of webpages using Exa AI. Returns the title, text content,
8790
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
8891
| `livecrawl` | string | No | Live crawling mode: never \(default\), fallback, always, or preferred \(always try livecrawl, fall back to cache if fails\) |
8992
| `apiKey` | string | Yes | Exa AI API Key |
93+
| `pricing` | custom | No | No description |
94+
| `metadata` | string | No | No description |
95+
| `rateLimit` | string | No | No description |
9096

9197
#### Output
9298

@@ -116,6 +122,9 @@ Find webpages similar to a given URL using Exa AI. Returns a list of similar lin
116122
| `summary` | boolean | No | Include AI-generated summaries in results \(default: false\) |
117123
| `livecrawl` | string | No | Live crawling mode: never \(default\), fallback, always, or preferred \(always try livecrawl, fall back to cache if fails\) |
118124
| `apiKey` | string | Yes | Exa AI API Key |
125+
| `pricing` | custom | No | No description |
126+
| `metadata` | string | No | No description |
127+
| `rateLimit` | string | No | No description |
119128

120129
#### Output
121130

@@ -138,6 +147,9 @@ Get an AI-generated answer to a question with citations from the web using Exa A
138147
| `query` | string | Yes | The question to answer |
139148
| `text` | boolean | No | Whether to include the full text of the answer |
140149
| `apiKey` | string | Yes | Exa AI API Key |
150+
| `pricing` | custom | No | No description |
151+
| `metadata` | string | No | No description |
152+
| `rateLimit` | string | No | No description |
141153

142154
#### Output
143155

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

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,10 +176,45 @@ List documents in a knowledge base with optional filtering, search, and paginati
176176
|`tokenCount` | number | Total token count across chunks |
177177
|`uploadedAt` | string | Upload timestamp |
178178
|`updatedAt` | string | Last update timestamp |
179+
|`connectorId` | string | Connector ID if document was synced from an external source |
180+
|`connectorType` | string | Connector type \(e.g. notion, github, confluence\) if synced |
181+
|`sourceUrl` | string | Original URL in the source system if synced from a connector |
179182
| `totalDocuments` | number | Total number of documents matching the filter |
180183
| `limit` | number | Page size used |
181184
| `offset` | number | Offset used for pagination |
182185

186+
### `knowledge_get_document`
187+
188+
Get full details of a single document including tags, connector metadata, and processing status
189+
190+
#### Input
191+
192+
| Parameter | Type | Required | Description |
193+
| --------- | ---- | -------- | ----------- |
194+
| `knowledgeBaseId` | string | Yes | ID of the knowledge base the document belongs to |
195+
| `documentId` | string | Yes | ID of the document to retrieve |
196+
197+
#### Output
198+
199+
| Parameter | Type | Description |
200+
| --------- | ---- | ----------- |
201+
| `id` | string | Document ID |
202+
| `filename` | string | Document filename |
203+
| `fileSize` | number | File size in bytes |
204+
| `mimeType` | string | MIME type of the document |
205+
| `enabled` | boolean | Whether the document is enabled |
206+
| `processingStatus` | string | Processing status \(pending, processing, completed, failed\) |
207+
| `processingError` | string | Error message if processing failed |
208+
| `chunkCount` | number | Number of chunks in the document |
209+
| `tokenCount` | number | Total token count across chunks |
210+
| `characterCount` | number | Total character count |
211+
| `uploadedAt` | string | Upload timestamp |
212+
| `updatedAt` | string | Last update timestamp |
213+
| `connectorId` | string | Connector ID if document was synced from an external source |
214+
| `sourceUrl` | string | Original URL in the source system if synced from a connector |
215+
| `externalId` | string | External ID from the source system |
216+
| `tags` | object | Tag values keyed by tag slot \(tag1-7, number1-5, date1-2, boolean1-3\) |
217+
183218
### `knowledge_delete_document`
184219

185220
Delete a document from a knowledge base
@@ -279,4 +314,89 @@ Delete a chunk from a document in a knowledge base
279314
| `documentId` | string | ID of the parent document |
280315
| `message` | string | Confirmation message |
281316

317+
### `knowledge_list_connectors`
318+
319+
List all connectors for a knowledge base, showing sync status, type, and document counts
320+
321+
#### Input
322+
323+
| Parameter | Type | Required | Description |
324+
| --------- | ---- | -------- | ----------- |
325+
| `knowledgeBaseId` | string | Yes | ID of the knowledge base to list connectors for |
326+
327+
#### Output
328+
329+
| Parameter | Type | Description |
330+
| --------- | ---- | ----------- |
331+
| `knowledgeBaseId` | string | ID of the knowledge base |
332+
| `connectors` | array | Array of connectors for the knowledge base |
333+
|`id` | string | Connector ID |
334+
|`connectorType` | string | Type of connector \(e.g. notion, github, confluence\) |
335+
|`status` | string | Connector status \(active, paused, syncing\) |
336+
|`syncIntervalMinutes` | number | Sync interval in minutes \(0 = manual only\) |
337+
|`lastSyncAt` | string | Timestamp of last sync |
338+
|`lastSyncError` | string | Error from last sync if failed |
339+
|`lastSyncDocCount` | number | Number of documents synced in last sync |
340+
|`nextSyncAt` | string | Timestamp of next scheduled sync |
341+
|`consecutiveFailures` | number | Number of consecutive sync failures |
342+
|`createdAt` | string | Creation timestamp |
343+
|`updatedAt` | string | Last update timestamp |
344+
| `totalConnectors` | number | Total number of connectors |
345+
346+
### `knowledge_get_connector`
347+
348+
Get detailed connector information including recent sync logs for monitoring sync health
349+
350+
#### Input
351+
352+
| Parameter | Type | Required | Description |
353+
| --------- | ---- | -------- | ----------- |
354+
| `knowledgeBaseId` | string | Yes | ID of the knowledge base the connector belongs to |
355+
| `connectorId` | string | Yes | ID of the connector to retrieve |
356+
357+
#### Output
358+
359+
| Parameter | Type | Description |
360+
| --------- | ---- | ----------- |
361+
| `connector` | object | Connector details |
362+
|`id` | string | Connector ID |
363+
|`connectorType` | string | Type of connector |
364+
|`status` | string | Connector status \(active, paused, syncing\) |
365+
|`syncIntervalMinutes` | number | Sync interval in minutes |
366+
|`lastSyncAt` | string | Timestamp of last sync |
367+
|`lastSyncError` | string | Error from last sync if failed |
368+
|`lastSyncDocCount` | number | Docs synced in last sync |
369+
|`nextSyncAt` | string | Next scheduled sync timestamp |
370+
|`consecutiveFailures` | number | Consecutive sync failures |
371+
|`createdAt` | string | Creation timestamp |
372+
|`updatedAt` | string | Last update timestamp |
373+
| `syncLogs` | array | Recent sync log entries |
374+
|`id` | string | Sync log ID |
375+
|`status` | string | Sync status |
376+
|`startedAt` | string | Sync start time |
377+
|`completedAt` | string | Sync completion time |
378+
|`docsAdded` | number | Documents added |
379+
|`docsUpdated` | number | Documents updated |
380+
|`docsDeleted` | number | Documents deleted |
381+
|`docsUnchanged` | number | Documents unchanged |
382+
|`errorMessage` | string | Error message if sync failed |
383+
384+
### `knowledge_trigger_sync`
385+
386+
Trigger a manual sync for a knowledge base connector
387+
388+
#### Input
389+
390+
| Parameter | Type | Required | Description |
391+
| --------- | ---- | -------- | ----------- |
392+
| `knowledgeBaseId` | string | Yes | ID of the knowledge base the connector belongs to |
393+
| `connectorId` | string | Yes | ID of the connector to trigger sync for |
394+
395+
#### Output
396+
397+
| Parameter | Type | Description |
398+
| --------- | ---- | ----------- |
399+
| `connectorId` | string | ID of the connector that was synced |
400+
| `message` | string | Status message from the sync trigger |
401+
282402

apps/sim/components/icons.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2078,7 +2078,7 @@ export function LangsmithIcon(props: SVGProps<SVGSVGElement>) {
20782078

20792079
export function LemlistIcon(props: SVGProps<SVGSVGElement>) {
20802080
return (
2081-
<svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='0 0 180 181' fill='none'>
2081+
<svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='24 24.92 132 132' fill='none'>
20822082
<path
20832083
fillRule='evenodd'
20842084
clipRule='evenodd'

bun.lock

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)