mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-31 01:37:58 -05:00
Compare commits
87 Commits
fix/ci-com
...
fix/condit
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
48baa41459 | ||
|
|
d0f1f32e8d | ||
|
|
2d799b3272 | ||
|
|
92403e0594 | ||
|
|
2c4eb9fecb | ||
|
|
aec0de046b | ||
|
|
51565a6e28 | ||
|
|
a280a53034 | ||
|
|
478a53521e | ||
|
|
6cf9841b99 | ||
|
|
656beb8383 | ||
|
|
f7c3de0591 | ||
|
|
2ec9b7f47e | ||
|
|
b0fbf3648d | ||
|
|
f718079593 | ||
|
|
dd2f0c6a6a | ||
|
|
f99518b837 | ||
|
|
2b026ded16 | ||
|
|
dca0758054 | ||
|
|
ae17c90bdf | ||
|
|
1256a15266 | ||
|
|
0b2b7ed9c8 | ||
|
|
0d8d9fb238 | ||
|
|
e0f1e66f4f | ||
|
|
20bb7cdec6 | ||
|
|
1469e9c66c | ||
|
|
06d7ce7667 | ||
|
|
1bc476f10b | ||
|
|
9e40342af8 | ||
|
|
0c0f19c717 | ||
|
|
12d529d045 | ||
|
|
57f0837da7 | ||
|
|
5c02d46d55 | ||
|
|
8b2404752b | ||
|
|
c00f05c346 | ||
|
|
78410eef84 | ||
|
|
655fe4f3b7 | ||
|
|
72a2f79701 | ||
|
|
2c2b485f81 | ||
|
|
01e0723a3a | ||
|
|
6814f33243 | ||
|
|
304cf717a4 | ||
|
|
0d0209a108 | ||
|
|
500dcd4734 | ||
|
|
8bdba373c6 | ||
|
|
c8ffda1616 | ||
|
|
b4a389a71f | ||
|
|
65bc21608c | ||
|
|
ef613ef035 | ||
|
|
20b76e67b3 | ||
|
|
7640fdf742 | ||
|
|
bca355c36d | ||
|
|
089427822e | ||
|
|
6b412c578d | ||
|
|
dddd0c8277 | ||
|
|
be7f3db059 | ||
|
|
416c08267a | ||
|
|
46ba315701 | ||
|
|
077e702dd8 | ||
|
|
d8df08d3d3 | ||
|
|
51891daf9a | ||
|
|
9ee5dfe185 | ||
|
|
9cba8eee48 | ||
|
|
cb650132c7 | ||
|
|
9dbf56f9cd | ||
|
|
5189473e06 | ||
|
|
37900988eb | ||
|
|
3cc9b1ae56 | ||
|
|
3ccbee187d | ||
|
|
36945deaa5 | ||
|
|
ebf2852733 | ||
|
|
12495ef89c | ||
|
|
d8d85fccf0 | ||
|
|
56bc809c6f | ||
|
|
c7bd48573a | ||
|
|
80f00479a3 | ||
|
|
c140e90559 | ||
|
|
d83c418111 | ||
|
|
be2a9ef0f8 | ||
|
|
1bf5ed4586 | ||
|
|
dc0ed842c4 | ||
|
|
1952b196a0 | ||
|
|
fa03d4d818 | ||
|
|
e14cebeec5 | ||
|
|
404d8c006e | ||
|
|
ac91d78834 | ||
|
|
6f0a093869 |
@@ -55,21 +55,21 @@ export const {serviceName}{Action}Tool: ToolConfig<
|
||||
},
|
||||
|
||||
params: {
|
||||
// Hidden params (system-injected)
|
||||
// Hidden params (system-injected, only use hidden for oauth accessToken)
|
||||
accessToken: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
visibility: 'hidden',
|
||||
description: 'OAuth access token',
|
||||
},
|
||||
// User-only params (credentials, IDs user must provide)
|
||||
// User-only params (credentials, api key, IDs user must provide)
|
||||
someId: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
visibility: 'user-only',
|
||||
description: 'The ID of the resource',
|
||||
},
|
||||
// User-or-LLM params (can be provided by user OR computed by LLM)
|
||||
// User-or-LLM params (everything else, can be provided by user OR computed by LLM)
|
||||
query: {
|
||||
type: 'string',
|
||||
required: false, // Use false for optional
|
||||
@@ -114,8 +114,8 @@ export const {serviceName}{Action}Tool: ToolConfig<
|
||||
|
||||
### Visibility Options
|
||||
- `'hidden'` - System-injected (OAuth tokens, internal params). User never sees.
|
||||
- `'user-only'` - User must provide (credentials, account-specific IDs)
|
||||
- `'user-or-llm'` - User provides OR LLM can compute (search queries, content, filters)
|
||||
- `'user-only'` - User must provide (credentials, api keys, account-specific IDs)
|
||||
- `'user-or-llm'` - User provides OR LLM can compute (search queries, content, filters, most fall into this category)
|
||||
|
||||
### Parameter Types
|
||||
- `'string'` - Text values
|
||||
|
||||
7
.cursor/commands/council.md
Normal file
7
.cursor/commands/council.md
Normal file
@@ -0,0 +1,7 @@
|
||||
Based on the given area of interest, please:
|
||||
|
||||
1. Dig around the codebase in terms of that given area of interest, gather general information such as keywords and architecture overview.
|
||||
2. Spawn off n=10 (unless specified otherwise) task agents to dig deeper into the codebase in terms of that given area of interest, some of them should be out of the box for variance.
|
||||
3. Once the task agents are done, use the information to do what the user wants.
|
||||
|
||||
If user is in plan mode, use the information to create the plan.
|
||||
@@ -44,7 +44,7 @@ services:
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
memory: 4G
|
||||
memory: 1G
|
||||
environment:
|
||||
- NODE_ENV=development
|
||||
- DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio
|
||||
|
||||
32
.github/workflows/ci.yml
vendored
32
.github/workflows/ci.yml
vendored
@@ -10,6 +10,9 @@ concurrency:
|
||||
group: ci-${{ github.ref }}
|
||||
cancel-in-progress: false
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
test-build:
|
||||
name: Test and Build
|
||||
@@ -31,7 +34,7 @@ jobs:
|
||||
COMMIT_MSG: ${{ github.event.head_commit.message }}
|
||||
run: |
|
||||
# Only tag versions on main branch
|
||||
if [ "${{ github.ref }}" = "refs/heads/main" ] && [[ "$COMMIT_MSG" =~ ^(v[0-9]+\.[0-9]+\.[0-9]+): ]]; then
|
||||
if [ "$GITHUB_REF" = "refs/heads/main" ] && [[ "$COMMIT_MSG" =~ ^(v[0-9]+\.[0-9]+\.[0-9]+): ]]; then
|
||||
VERSION="${BASH_REMATCH[1]}"
|
||||
echo "version=${VERSION}" >> $GITHUB_OUTPUT
|
||||
echo "is_release=true" >> $GITHUB_OUTPUT
|
||||
@@ -278,3 +281,30 @@ jobs:
|
||||
if: needs.check-docs-changes.outputs.docs_changed == 'true'
|
||||
uses: ./.github/workflows/docs-embeddings.yml
|
||||
secrets: inherit
|
||||
|
||||
# Create GitHub Release (only for version commits on main, after all builds complete)
|
||||
create-release:
|
||||
name: Create GitHub Release
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2404
|
||||
needs: [create-ghcr-manifests, detect-version]
|
||||
if: needs.detect-version.outputs.is_release == 'true'
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: latest
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun install --frozen-lockfile
|
||||
|
||||
- name: Create release
|
||||
env:
|
||||
GH_PAT: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: bun run scripts/create-single-release.ts ${{ needs.detect-version.outputs.version }}
|
||||
|
||||
3
.github/workflows/docs-embeddings.yml
vendored
3
.github/workflows/docs-embeddings.yml
vendored
@@ -4,6 +4,9 @@ on:
|
||||
workflow_call:
|
||||
workflow_dispatch: # Allow manual triggering
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
process-docs-embeddings:
|
||||
name: Process Documentation Embeddings
|
||||
|
||||
3
.github/workflows/migrations.yml
vendored
3
.github/workflows/migrations.yml
vendored
@@ -4,6 +4,9 @@ on:
|
||||
workflow_call:
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
migrate:
|
||||
name: Apply Database Migrations
|
||||
|
||||
3
.github/workflows/publish-cli.yml
vendored
3
.github/workflows/publish-cli.yml
vendored
@@ -6,6 +6,9 @@ on:
|
||||
paths:
|
||||
- 'packages/cli/**'
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
publish-npm:
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2404
|
||||
|
||||
3
.github/workflows/publish-python-sdk.yml
vendored
3
.github/workflows/publish-python-sdk.yml
vendored
@@ -6,6 +6,9 @@ on:
|
||||
paths:
|
||||
- 'packages/python-sdk/**'
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
publish-pypi:
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2404
|
||||
|
||||
3
.github/workflows/publish-ts-sdk.yml
vendored
3
.github/workflows/publish-ts-sdk.yml
vendored
@@ -6,6 +6,9 @@ on:
|
||||
paths:
|
||||
- 'packages/ts-sdk/**'
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
publish-npm:
|
||||
runs-on: blacksmith-4vcpu-ubuntu-2404
|
||||
|
||||
3
.github/workflows/test-build.yml
vendored
3
.github/workflows/test-build.yml
vendored
@@ -4,6 +4,9 @@ on:
|
||||
workflow_call:
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
test-build:
|
||||
name: Test and Build
|
||||
|
||||
25
README.md
25
README.md
@@ -172,31 +172,6 @@ Key environment variables for self-hosted deployments. See [`.env.example`](apps
|
||||
| `API_ENCRYPTION_KEY` | Yes | Encrypts API keys (`openssl rand -hex 32`) |
|
||||
| `COPILOT_API_KEY` | No | API key from sim.ai for Copilot features |
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Ollama models not showing in dropdown (Docker)
|
||||
|
||||
If you're running Ollama on your host machine and Sim in Docker, change `OLLAMA_URL` from `localhost` to `host.docker.internal`:
|
||||
|
||||
```bash
|
||||
OLLAMA_URL=http://host.docker.internal:11434 docker compose -f docker-compose.prod.yml up -d
|
||||
```
|
||||
|
||||
See [Using an External Ollama Instance](#using-an-external-ollama-instance) for details.
|
||||
|
||||
### Database connection issues
|
||||
|
||||
Ensure PostgreSQL has the pgvector extension installed. When using Docker, wait for the database to be healthy before running migrations.
|
||||
|
||||
### Port conflicts
|
||||
|
||||
If ports 3000, 3002, or 5432 are in use, configure alternatives:
|
||||
|
||||
```bash
|
||||
# Custom ports
|
||||
NEXT_PUBLIC_APP_URL=http://localhost:3100 POSTGRES_PORT=5433 docker compose up -d
|
||||
```
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Framework**: [Next.js](https://nextjs.org/) (App Router)
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import type React from 'react'
|
||||
import { findNeighbour } from 'fumadocs-core/page-tree'
|
||||
import { Pre } from 'fumadocs-ui/components/codeblock'
|
||||
import defaultMdxComponents from 'fumadocs-ui/mdx'
|
||||
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/page'
|
||||
import { ChevronLeft, ChevronRight } from 'lucide-react'
|
||||
@@ -21,6 +22,7 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
|
||||
const data = page.data as PageData
|
||||
const MDX = data.body
|
||||
const baseUrl = 'https://docs.sim.ai'
|
||||
const markdownContent = await data.getText('processed')
|
||||
|
||||
const pageTreeRecord = source.pageTree as Record<string, any>
|
||||
const pageTree =
|
||||
@@ -185,11 +187,6 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
|
||||
tableOfContent={{
|
||||
style: 'clerk',
|
||||
enabled: true,
|
||||
header: (
|
||||
<div key='toc-header' className='mb-2 font-medium text-sm'>
|
||||
On this page
|
||||
</div>
|
||||
),
|
||||
footer: <TOCFooter />,
|
||||
single: false,
|
||||
}}
|
||||
@@ -205,7 +202,7 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
|
||||
<div className='relative mt-6 sm:mt-0'>
|
||||
<div className='absolute top-1 right-0 flex items-center gap-2'>
|
||||
<div className='hidden sm:flex'>
|
||||
<LLMCopyButton markdownUrl={`${page.url}.mdx`} />
|
||||
<LLMCopyButton content={markdownContent} />
|
||||
</div>
|
||||
<PageNavigationArrows previous={neighbours?.previous} next={neighbours?.next} />
|
||||
</div>
|
||||
@@ -216,7 +213,11 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
|
||||
<MDX
|
||||
components={{
|
||||
...defaultMdxComponents,
|
||||
CodeBlock,
|
||||
pre: (props: React.HTMLAttributes<HTMLPreElement>) => (
|
||||
<CodeBlock {...props}>
|
||||
<Pre>{props.children}</Pre>
|
||||
</CodeBlock>
|
||||
),
|
||||
h1: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
|
||||
<Heading as='h1' {...props} />
|
||||
),
|
||||
|
||||
@@ -3,13 +3,14 @@ import { defineI18nUI } from 'fumadocs-ui/i18n'
|
||||
import { DocsLayout } from 'fumadocs-ui/layouts/docs'
|
||||
import { RootProvider } from 'fumadocs-ui/provider/next'
|
||||
import { Geist_Mono, Inter } from 'next/font/google'
|
||||
import Image from 'next/image'
|
||||
import Script from 'next/script'
|
||||
import {
|
||||
SidebarFolder,
|
||||
SidebarItem,
|
||||
SidebarSeparator,
|
||||
} from '@/components/docs-layout/sidebar-components'
|
||||
import { Navbar } from '@/components/navbar/navbar'
|
||||
import { SimLogoFull } from '@/components/ui/sim-logo'
|
||||
import { i18n } from '@/lib/i18n'
|
||||
import { source } from '@/lib/source'
|
||||
import '../global.css'
|
||||
@@ -17,11 +18,13 @@ import '../global.css'
|
||||
const inter = Inter({
|
||||
subsets: ['latin'],
|
||||
variable: '--font-geist-sans',
|
||||
display: 'swap',
|
||||
})
|
||||
|
||||
const geistMono = Geist_Mono({
|
||||
subsets: ['latin'],
|
||||
variable: '--font-geist-mono',
|
||||
display: 'swap',
|
||||
})
|
||||
|
||||
const { provider } = defineI18nUI(i18n, {
|
||||
@@ -93,25 +96,15 @@ export default async function Layout({ children, params }: LayoutProps) {
|
||||
type='application/ld+json'
|
||||
dangerouslySetInnerHTML={{ __html: JSON.stringify(structuredData) }}
|
||||
/>
|
||||
{/* OneDollarStats Analytics - CDN script handles everything automatically */}
|
||||
<script defer src='https://assets.onedollarstats.com/stonks.js' />
|
||||
</head>
|
||||
<body className='flex min-h-screen flex-col font-sans'>
|
||||
<Script src='https://assets.onedollarstats.com/stonks.js' strategy='lazyOnload' />
|
||||
<RootProvider i18n={provider(lang)}>
|
||||
<Navbar />
|
||||
<DocsLayout
|
||||
tree={source.pageTree[lang]}
|
||||
nav={{
|
||||
title: (
|
||||
<Image
|
||||
src='/static/logo.png'
|
||||
alt='Sim'
|
||||
width={72}
|
||||
height={28}
|
||||
className='h-7 w-auto'
|
||||
priority
|
||||
/>
|
||||
),
|
||||
title: <SimLogoFull className='h-7 w-auto' />,
|
||||
}}
|
||||
sidebar={{
|
||||
defaultOpenLevel: 0,
|
||||
|
||||
@@ -9,7 +9,7 @@ export default function NotFound() {
|
||||
<DocsPage>
|
||||
<DocsBody>
|
||||
<div className='flex min-h-[60vh] flex-col items-center justify-center text-center'>
|
||||
<h1 className='mb-4 bg-gradient-to-b from-[#8357FF] to-[#6F3DFA] bg-clip-text font-bold text-8xl text-transparent'>
|
||||
<h1 className='mb-4 bg-gradient-to-b from-[#47d991] to-[#33c482] bg-clip-text font-bold text-8xl text-transparent'>
|
||||
404
|
||||
</h1>
|
||||
<h2 className='mb-2 font-semibold text-2xl text-foreground'>Page Not Found</h2>
|
||||
|
||||
@@ -33,15 +33,41 @@ async function loadGoogleFont(font: string, weights: string, text: string): Prom
|
||||
throw new Error('Failed to load font data')
|
||||
}
|
||||
|
||||
/**
|
||||
* Sim logo with icon and "Sim" text for OG image.
|
||||
*/
|
||||
function SimLogoFull() {
|
||||
return (
|
||||
<svg height='28' viewBox='720 440 1020 320' fill='none'>
|
||||
{/* Green icon - top left shape with cutout */}
|
||||
<path
|
||||
fillRule='evenodd'
|
||||
clipRule='evenodd'
|
||||
d='M875.791 577.171C875.791 581.922 873.911 586.483 870.576 589.842L870.098 590.323C866.764 593.692 862.234 595.575 857.517 595.575H750.806C740.978 595.575 733 603.6 733 613.498V728.902C733 738.799 740.978 746.826 750.806 746.826H865.382C875.209 746.826 883.177 738.799 883.177 728.902V620.853C883.177 616.448 884.912 612.222 888.008 609.104C891.093 605.997 895.29 604.249 899.664 604.249H1008.16C1017.99 604.249 1025.96 596.224 1025.96 586.327V470.923C1025.96 461.025 1017.99 453 1008.16 453H893.586C883.759 453 875.791 461.025 875.791 470.923V577.171ZM910.562 477.566H991.178C996.922 477.566 1001.57 482.254 1001.57 488.029V569.22C1001.57 574.995 996.922 579.683 991.178 579.683H910.562C904.828 579.683 900.173 574.995 900.173 569.22V488.029C900.173 482.254 904.828 477.566 910.562 477.566Z'
|
||||
fill='#33C482'
|
||||
/>
|
||||
{/* Green icon - bottom right square */}
|
||||
<path
|
||||
d='M1008.3 624.59H923.113C912.786 624.59 904.414 633.022 904.414 643.423V728.171C904.414 738.572 912.786 747.004 923.113 747.004H1008.3C1018.63 747.004 1027 738.572 1027 728.171V643.423C1027 633.022 1018.63 624.59 1008.3 624.59Z'
|
||||
fill='#33C482'
|
||||
/>
|
||||
{/* "Sim" text - white for dark background */}
|
||||
<path
|
||||
d='M1210.54 515.657C1226.65 515.657 1240.59 518.51 1252.31 524.257H1252.31C1264.3 529.995 1273.63 538.014 1280.26 548.319H1280.26C1287.19 558.635 1290.78 570.899 1291.08 585.068L1291.1 586.089H1249.11L1249.09 585.115C1248.8 574.003 1245.18 565.493 1238.32 559.451C1231.45 553.399 1221.79 550.308 1209.21 550.308C1196.3 550.308 1186.48 553.113 1179.61 558.588C1172.76 564.046 1169.33 571.499 1169.33 581.063C1169.33 588.092 1171.88 593.978 1177.01 598.783C1182.17 603.618 1189.99 607.399 1200.56 610.061H1200.56L1238.77 619.451C1257.24 623.65 1271.21 630.571 1280.57 640.293L1281.01 640.739C1290.13 650.171 1294.64 662.97 1294.64 679.016C1294.64 692.923 1290.88 705.205 1283.34 715.822L1283.33 715.834C1275.81 726.134 1265.44 734.14 1252.26 739.866L1252.25 739.871C1239.36 745.302 1224.12 748 1206.54 748C1180.9 748 1160.36 741.696 1145.02 728.984C1129.67 716.258 1122 699.269 1122 678.121V677.121H1163.99V678.121C1163.99 688.869 1167.87 697.367 1175.61 703.722L1176.34 704.284C1184.04 709.997 1194.37 712.902 1207.43 712.902C1222.13 712.902 1233.3 710.087 1241.07 704.588C1248.8 698.812 1252.64 691.21 1252.64 681.699C1252.64 674.769 1250.5 669.057 1246.25 664.49L1246.23 664.478L1246.22 664.464C1242.28 659.929 1234.83 656.119 1223.64 653.152L1185.43 644.208L1185.42 644.204C1166.05 639.407 1151.49 632.035 1141.83 622.012L1141.83 622.006L1141.82 622C1132.43 611.94 1127.78 598.707 1127.78 582.405C1127.78 568.81 1131.23 556.976 1138.17 546.949L1138.18 546.941L1138.19 546.933C1145.41 536.936 1155.18 529.225 1167.48 523.793L1167.48 523.79C1180.07 518.36 1194.43 515.657 1210.54 515.657ZM1323.39 521.979C1331.68 525.008 1337.55 526.482 1343.51 526.482C1349.48 526.482 1355.64 525.005 1364.49 521.973L1365.82 521.52V742.633H1322.05V521.489L1323.39 521.979ZM1642.01 515.657C1667.11 515.657 1686.94 523.031 1701.39 537.876C1715.83 552.716 1723 572.968 1723 598.507V742.633H1680.12V608.794C1680.12 591.666 1675.72 578.681 1667.07 569.681L1667.06 569.669L1667.04 569.656C1658.67 560.359 1647.26 555.675 1632.68 555.675C1622.47 555.675 1613.47 558.022 1605.64 562.69L1605.63 562.696C1598.11 567.064 1592.17 573.475 1587.8 581.968C1583.44 590.448 1581.25 600.424 1581.25 611.925V742.633H1537.92V608.347C1537.92 591.208 1533.67 578.376 1525.31 569.68L1525.31 569.674L1525.3 569.668C1516.93 560.664 1505.52 556.122 1490.93 556.122C1480.72 556.122 1471.72 558.469 1463.89 563.138L1463.88 563.144C1456.36 567.511 1450.41 573.922 1446.05 582.415L1446.05 582.422L1446.04 582.428C1441.69 590.602 1439.5 600.423 1439.5 611.925V742.633H1395.72V521.919H1435.05V554.803C1439.92 544.379 1447.91 535.465 1458.37 528.356C1470.71 519.875 1485.58 515.657 1502.93 515.657C1522.37 515.657 1538.61 520.931 1551.55 531.538C1560.38 538.771 1567.1 547.628 1571.72 558.091C1576.05 547.619 1582.83 538.757 1592.07 531.524C1605.61 520.93 1622.28 515.657 1642.01 515.657ZM1343.49 452C1351.45 452 1358.23 454.786 1363.75 460.346C1369.27 465.905 1372.04 472.721 1372.04 480.73C1372.04 488.452 1369.27 495.254 1363.77 501.096L1363.76 501.105L1363.75 501.115C1358.23 506.675 1351.45 509.461 1343.49 509.461C1335.81 509.461 1329.05 506.669 1323.25 501.134L1323.23 501.115L1323.21 501.096C1317.71 495.254 1314.94 488.452 1314.94 480.73C1314.94 472.721 1317.7 465.905 1323.23 460.346L1323.24 460.337L1323.25 460.327C1329.05 454.792 1335.81 452 1343.49 452Z'
|
||||
fill='#fafafa'
|
||||
/>
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates dynamic Open Graph images for documentation pages.
|
||||
* Style matches Cursor docs: dark background, title at top, logo bottom-left, domain bottom-right.
|
||||
*/
|
||||
export async function GET(request: NextRequest) {
|
||||
const { searchParams } = new URL(request.url)
|
||||
const title = searchParams.get('title') || 'Documentation'
|
||||
|
||||
const baseUrl = new URL(request.url).origin
|
||||
|
||||
const allText = `${title}docs.sim.ai`
|
||||
const fontData = await loadGoogleFont('Geist', '400;500;600', allText)
|
||||
|
||||
@@ -52,84 +78,39 @@ export async function GET(request: NextRequest) {
|
||||
width: '100%',
|
||||
display: 'flex',
|
||||
flexDirection: 'column',
|
||||
background: '#0c0c0c',
|
||||
position: 'relative',
|
||||
justifyContent: 'space-between',
|
||||
padding: '56px 64px',
|
||||
background: '#121212', // Dark mode background matching docs (hsla 0, 0%, 7%)
|
||||
fontFamily: 'Geist',
|
||||
}}
|
||||
>
|
||||
{/* Base gradient layer - subtle purple tint across the entire image */}
|
||||
<div
|
||||
style={{
|
||||
position: 'absolute',
|
||||
top: 0,
|
||||
left: 0,
|
||||
width: '100%',
|
||||
height: '100%',
|
||||
background:
|
||||
'radial-gradient(ellipse 150% 100% at 50% 100%, rgba(88, 28, 135, 0.15) 0%, rgba(88, 28, 135, 0.08) 25%, rgba(88, 28, 135, 0.03) 50%, transparent 80%)',
|
||||
display: 'flex',
|
||||
}}
|
||||
/>
|
||||
|
||||
{/* Secondary glow - adds depth without harsh edges */}
|
||||
<div
|
||||
style={{
|
||||
position: 'absolute',
|
||||
top: 0,
|
||||
left: 0,
|
||||
width: '100%',
|
||||
height: '100%',
|
||||
background:
|
||||
'radial-gradient(ellipse 100% 80% at 80% 90%, rgba(112, 31, 252, 0.12) 0%, rgba(112, 31, 252, 0.04) 40%, transparent 70%)',
|
||||
display: 'flex',
|
||||
}}
|
||||
/>
|
||||
|
||||
{/* Top darkening - creates natural vignette */}
|
||||
<div
|
||||
style={{
|
||||
position: 'absolute',
|
||||
top: 0,
|
||||
left: 0,
|
||||
width: '100%',
|
||||
height: '100%',
|
||||
background:
|
||||
'linear-gradient(180deg, rgba(0, 0, 0, 0.3) 0%, transparent 40%, transparent 100%)',
|
||||
display: 'flex',
|
||||
}}
|
||||
/>
|
||||
|
||||
{/* Content */}
|
||||
<div
|
||||
style={{
|
||||
display: 'flex',
|
||||
flexDirection: 'column',
|
||||
padding: '56px 72px',
|
||||
height: '100%',
|
||||
justifyContent: 'space-between',
|
||||
}}
|
||||
>
|
||||
{/* Logo */}
|
||||
<img src={`${baseUrl}/static/logo.png`} alt='sim' height={32} />
|
||||
|
||||
{/* Title */}
|
||||
{/* Title at top */}
|
||||
<span
|
||||
style={{
|
||||
fontSize: getTitleFontSize(title),
|
||||
fontWeight: 600,
|
||||
color: '#ffffff',
|
||||
lineHeight: 1.1,
|
||||
fontWeight: 500,
|
||||
color: '#fafafa', // Light text matching docs
|
||||
lineHeight: 1.2,
|
||||
letterSpacing: '-0.02em',
|
||||
}}
|
||||
>
|
||||
{title}
|
||||
</span>
|
||||
|
||||
{/* Footer */}
|
||||
{/* Footer: icon left, domain right */}
|
||||
<div
|
||||
style={{
|
||||
display: 'flex',
|
||||
justifyContent: 'space-between',
|
||||
alignItems: 'center',
|
||||
width: '100%',
|
||||
}}
|
||||
>
|
||||
<SimLogoFull />
|
||||
<span
|
||||
style={{
|
||||
fontSize: 20,
|
||||
fontWeight: 500,
|
||||
fontWeight: 400,
|
||||
color: '#71717a',
|
||||
}}
|
||||
>
|
||||
|
||||
@@ -9,11 +9,20 @@ body {
|
||||
}
|
||||
|
||||
@theme {
|
||||
--color-fd-primary: #802fff; /* Purple from control-bar component */
|
||||
--color-fd-primary: #33c482; /* Green from Sim logo */
|
||||
--font-geist-sans: var(--font-geist-sans);
|
||||
--font-geist-mono: var(--font-geist-mono);
|
||||
}
|
||||
|
||||
/* Ensure primary color is set in both light and dark modes */
|
||||
:root {
|
||||
--color-fd-primary: #33c482;
|
||||
}
|
||||
|
||||
.dark {
|
||||
--color-fd-primary: #33c482;
|
||||
}
|
||||
|
||||
/* Font family utilities */
|
||||
.font-sans {
|
||||
font-family: var(--font-geist-sans), ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont,
|
||||
@@ -34,7 +43,7 @@ body {
|
||||
:root {
|
||||
--fd-border: transparent !important;
|
||||
--fd-border-sidebar: transparent !important;
|
||||
--fd-nav-height: 64px; /* Custom navbar height (h-16 = 4rem = 64px) */
|
||||
--fd-nav-height: 65px; /* Custom navbar height (h-16 = 64px + 1px border) */
|
||||
/* Content container width used to center main content */
|
||||
--spacing-fd-container: 1400px;
|
||||
/* Edge gutter = leftover space on each side of centered container */
|
||||
@@ -119,15 +128,28 @@ aside#nd-sidebar {
|
||||
}
|
||||
}
|
||||
|
||||
/* Hide TOC popover on tablet/medium screens (768px - 1279px) */
|
||||
/* Keeps it visible on mobile (<768px) for easy navigation */
|
||||
/* Desktop (>=1280px) already hides it via fumadocs xl:hidden */
|
||||
@media (min-width: 768px) and (max-width: 1279px) {
|
||||
#nd-docs-layout {
|
||||
--fd-toc-popover-height: 0px !important;
|
||||
}
|
||||
|
||||
[data-toc-popover] {
|
||||
display: none !important;
|
||||
}
|
||||
}
|
||||
|
||||
/* Desktop only: Apply custom navbar offset, sidebar width and margin offsets */
|
||||
/* On mobile, let fumadocs handle the layout natively */
|
||||
@media (min-width: 1024px) {
|
||||
:root {
|
||||
--fd-banner-height: 64px !important;
|
||||
--fd-banner-height: 65px !important; /* 64px navbar + 1px border */
|
||||
}
|
||||
|
||||
#nd-docs-layout {
|
||||
--fd-docs-height: calc(100dvh - 64px) !important;
|
||||
--fd-docs-height: calc(100dvh - 65px) !important; /* 64px navbar + 1px border */
|
||||
--fd-sidebar-width: 300px !important;
|
||||
margin-left: var(--sidebar-offset) !important;
|
||||
margin-right: var(--toc-offset) !important;
|
||||
@@ -214,19 +236,19 @@ html:not(.dark) #nd-sidebar button:not([aria-label*="ollapse"]):not([aria-label*
|
||||
letter-spacing: 0.05em !important;
|
||||
}
|
||||
|
||||
/* Override active state (NO PURPLE) */
|
||||
/* Override active state */
|
||||
#nd-sidebar a[data-active="true"],
|
||||
#nd-sidebar button[data-active="true"],
|
||||
#nd-sidebar a.bg-fd-primary\/10,
|
||||
#nd-sidebar a.text-fd-primary,
|
||||
#nd-sidebar a[class*="bg-fd-primary"],
|
||||
#nd-sidebar a[class*="text-fd-primary"],
|
||||
/* Override custom sidebar purple classes */
|
||||
/* Override custom sidebar green classes */
|
||||
#nd-sidebar
|
||||
a.bg-purple-50\/80,
|
||||
#nd-sidebar a.text-purple-600,
|
||||
#nd-sidebar a[class*="bg-purple"],
|
||||
#nd-sidebar a[class*="text-purple"] {
|
||||
a.bg-emerald-50\/80,
|
||||
#nd-sidebar a.text-emerald-600,
|
||||
#nd-sidebar a[class*="bg-emerald"],
|
||||
#nd-sidebar a[class*="text-emerald"] {
|
||||
background-image: none !important;
|
||||
}
|
||||
|
||||
@@ -237,10 +259,10 @@ html.dark #nd-sidebar a.bg-fd-primary\/10,
|
||||
html.dark #nd-sidebar a.text-fd-primary,
|
||||
html.dark #nd-sidebar a[class*="bg-fd-primary"],
|
||||
html.dark #nd-sidebar a[class*="text-fd-primary"],
|
||||
html.dark #nd-sidebar a.bg-purple-50\/80,
|
||||
html.dark #nd-sidebar a.text-purple-600,
|
||||
html.dark #nd-sidebar a[class*="bg-purple"],
|
||||
html.dark #nd-sidebar a[class*="text-purple"] {
|
||||
html.dark #nd-sidebar a.bg-emerald-50\/80,
|
||||
html.dark #nd-sidebar a.text-emerald-600,
|
||||
html.dark #nd-sidebar a[class*="bg-emerald"],
|
||||
html.dark #nd-sidebar a[class*="text-emerald"] {
|
||||
background-color: rgba(255, 255, 255, 0.15) !important;
|
||||
color: rgba(255, 255, 255, 1) !important;
|
||||
}
|
||||
@@ -252,10 +274,10 @@ html:not(.dark) #nd-sidebar a.bg-fd-primary\/10,
|
||||
html:not(.dark) #nd-sidebar a.text-fd-primary,
|
||||
html:not(.dark) #nd-sidebar a[class*="bg-fd-primary"],
|
||||
html:not(.dark) #nd-sidebar a[class*="text-fd-primary"],
|
||||
html:not(.dark) #nd-sidebar a.bg-purple-50\/80,
|
||||
html:not(.dark) #nd-sidebar a.text-purple-600,
|
||||
html:not(.dark) #nd-sidebar a[class*="bg-purple"],
|
||||
html:not(.dark) #nd-sidebar a[class*="text-purple"] {
|
||||
html:not(.dark) #nd-sidebar a.bg-emerald-50\/80,
|
||||
html:not(.dark) #nd-sidebar a.text-emerald-600,
|
||||
html:not(.dark) #nd-sidebar a[class*="bg-emerald"],
|
||||
html:not(.dark) #nd-sidebar a[class*="text-emerald"] {
|
||||
background-color: rgba(0, 0, 0, 0.07) !important;
|
||||
color: rgba(0, 0, 0, 0.9) !important;
|
||||
}
|
||||
@@ -273,8 +295,8 @@ html:not(.dark) #nd-sidebar button:hover:not([data-active="true"]) {
|
||||
}
|
||||
|
||||
/* Dark mode - ensure active/selected items don't change on hover */
|
||||
html.dark #nd-sidebar a.bg-purple-50\/80:hover,
|
||||
html.dark #nd-sidebar a[class*="bg-purple"]:hover,
|
||||
html.dark #nd-sidebar a.bg-emerald-50\/80:hover,
|
||||
html.dark #nd-sidebar a[class*="bg-emerald"]:hover,
|
||||
html.dark #nd-sidebar a[data-active="true"]:hover,
|
||||
html.dark #nd-sidebar button[data-active="true"]:hover {
|
||||
background-color: rgba(255, 255, 255, 0.15) !important;
|
||||
@@ -282,8 +304,8 @@ html.dark #nd-sidebar button[data-active="true"]:hover {
|
||||
}
|
||||
|
||||
/* Light mode - ensure active/selected items don't change on hover */
|
||||
html:not(.dark) #nd-sidebar a.bg-purple-50\/80:hover,
|
||||
html:not(.dark) #nd-sidebar a[class*="bg-purple"]:hover,
|
||||
html:not(.dark) #nd-sidebar a.bg-emerald-50\/80:hover,
|
||||
html:not(.dark) #nd-sidebar a[class*="bg-emerald"]:hover,
|
||||
html:not(.dark) #nd-sidebar a[data-active="true"]:hover,
|
||||
html:not(.dark) #nd-sidebar button[data-active="true"]:hover {
|
||||
background-color: rgba(0, 0, 0, 0.07) !important;
|
||||
@@ -355,16 +377,24 @@ aside[data-sidebar] > *:not([data-sidebar-viewport]) {
|
||||
button[aria-label="Toggle Sidebar"],
|
||||
button[aria-label="Collapse Sidebar"],
|
||||
/* Hide nav title/logo in sidebar on desktop - target all possible locations */
|
||||
/* Lower specificity selectors first (attribute selectors) */
|
||||
[data-sidebar-header],
|
||||
[data-sidebar] [data-title],
|
||||
aside[data-sidebar] a[href="/"],
|
||||
aside[data-sidebar] a[href="/"] img,
|
||||
aside[data-sidebar] > a:first-child,
|
||||
aside[data-sidebar] > div > a:first-child,
|
||||
aside[data-sidebar] img[alt="Sim"],
|
||||
[data-sidebar-header],
|
||||
[data-sidebar] [data-title],
|
||||
aside[data-sidebar] svg[aria-label="Sim"],
|
||||
/* Higher specificity selectors (ID selectors) */
|
||||
#nd-sidebar
|
||||
a[href="/"],
|
||||
#nd-sidebar a[href="/"] img,
|
||||
#nd-sidebar a[href="/"] svg,
|
||||
#nd-sidebar > a:first-child,
|
||||
#nd-sidebar > div:first-child > a:first-child,
|
||||
#nd-sidebar img[alt="Sim"],
|
||||
#nd-sidebar svg[aria-label="Sim"],
|
||||
/* Hide theme toggle at bottom of sidebar on desktop */
|
||||
#nd-sidebar
|
||||
> footer,
|
||||
@@ -502,6 +532,15 @@ pre code .line {
|
||||
color: var(--color-fd-primary);
|
||||
}
|
||||
|
||||
/* ============================================
|
||||
TOC (Table of Contents) Styling
|
||||
============================================ */
|
||||
|
||||
/* Remove the thin border-left on nested TOC items (keeps main indicator only) */
|
||||
#nd-toc a[style*="padding-inline-start"] {
|
||||
border-left: none !important;
|
||||
}
|
||||
|
||||
/* Add bottom spacing to prevent abrupt page endings */
|
||||
[data-content] {
|
||||
padding-top: 1.5rem !important;
|
||||
|
||||
@@ -44,7 +44,7 @@ export function SidebarItem({ item }: { item: Item }) {
|
||||
'lg:text-gray-600 lg:dark:text-gray-400',
|
||||
!active && 'lg:hover:bg-gray-100/60 lg:dark:hover:bg-gray-800/40',
|
||||
active &&
|
||||
'lg:bg-purple-50/80 lg:font-normal lg:text-purple-600 lg:dark:bg-purple-900/15 lg:dark:text-purple-400'
|
||||
'lg:bg-emerald-50/80 lg:font-normal lg:text-emerald-600 lg:dark:bg-emerald-900/15 lg:dark:text-emerald-400'
|
||||
)}
|
||||
>
|
||||
{item.name}
|
||||
@@ -79,7 +79,7 @@ export function SidebarFolder({ item, children }: { item: Folder; children: Reac
|
||||
'lg:text-gray-600 lg:dark:text-gray-400',
|
||||
!active && 'lg:hover:bg-gray-100/60 lg:dark:hover:bg-gray-800/40',
|
||||
active &&
|
||||
'lg:bg-purple-50/80 lg:font-normal lg:text-purple-600 lg:dark:bg-purple-900/15 lg:dark:text-purple-400'
|
||||
'lg:bg-emerald-50/80 lg:font-normal lg:text-emerald-600 lg:dark:bg-emerald-900/15 lg:dark:text-emerald-400'
|
||||
)}
|
||||
>
|
||||
{item.name}
|
||||
@@ -104,7 +104,7 @@ export function SidebarFolder({ item, children }: { item: Folder; children: Reac
|
||||
'lg:text-gray-800 lg:dark:text-gray-200',
|
||||
!active && 'lg:hover:bg-gray-100/60 lg:dark:hover:bg-gray-800/40',
|
||||
active &&
|
||||
'lg:bg-purple-50/80 lg:text-purple-600 lg:dark:bg-purple-900/15 lg:dark:text-purple-400'
|
||||
'lg:bg-emerald-50/80 lg:text-emerald-600 lg:dark:bg-emerald-900/15 lg:dark:text-emerald-400'
|
||||
)}
|
||||
>
|
||||
{item.name}
|
||||
|
||||
@@ -23,7 +23,7 @@ export function TOCFooter() {
|
||||
rel='noopener noreferrer'
|
||||
onMouseEnter={() => setIsHovered(true)}
|
||||
onMouseLeave={() => setIsHovered(false)}
|
||||
className='group mt-2 inline-flex h-8 w-fit items-center justify-center gap-1 whitespace-nowrap rounded-[10px] border border-[#6F3DFA] bg-gradient-to-b from-[#8357FF] to-[#6F3DFA] px-3 pr-[10px] pl-[12px] font-medium text-sm text-white shadow-[inset_0_2px_4px_0_#9B77FF] outline-none transition-all hover:shadow-lg focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50'
|
||||
className='group mt-2 inline-flex h-8 w-fit items-center justify-center gap-1 whitespace-nowrap rounded-[10px] border border-[#2AAD6C] bg-gradient-to-b from-[#3ED990] to-[#2AAD6C] px-3 pr-[10px] pl-[12px] font-medium text-sm text-white shadow-[inset_0_2px_4px_0_#5EE8A8] outline-none transition-all hover:shadow-lg focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50'
|
||||
aria-label='Get started with Sim - Sign up for free'
|
||||
>
|
||||
<span>Get started</span>
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import type { SVGProps } from 'react'
|
||||
import { useId } from 'react'
|
||||
|
||||
export function SearchIcon(props: SVGProps<SVGSVGElement>) {
|
||||
return (
|
||||
@@ -737,6 +738,9 @@ export function GmailIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function GrafanaIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const gradientId = `grafana_gradient_${id}`
|
||||
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
@@ -747,12 +751,12 @@ export function GrafanaIcon(props: SVGProps<SVGSVGElement>) {
|
||||
fill='none'
|
||||
>
|
||||
<path
|
||||
fill='url(#grafana-color-16__paint0_linear_2372_364)'
|
||||
fill={`url(#${gradientId})`}
|
||||
d='M13.985 7.175a4.408 4.408 0 00-.138-.802 5.035 5.035 0 00-1.054-1.998 2.96 2.96 0 00-.366-.393c.198-.787-.245-1.468-.245-1.468-.764-.046-1.237.227-1.42.363-.031-.015-.062-.03-.092-.03-.122-.046-.26-.106-.397-.137-.138-.045-.275-.075-.413-.12-.137-.031-.29-.061-.443-.092-.03 0-.046 0-.076-.015C9.005 1.44 8.058 1 8.058 1 7.004 1.666 6.79 2.604 6.79 2.604s0 .015-.016.06l-.183.046c-.076.03-.168.06-.244.076-.077.03-.168.06-.245.09-.153.076-.32.152-.473.228-.153.09-.306.181-.443.272-.016-.015-.03-.015-.03-.015-1.467-.545-2.766.136-2.766.136-.122 1.544.58 2.528.733 2.71-.03.09-.06.196-.091.287a8.104 8.104 0 00-.245 1.09c0 .06-.015.106-.015.166C1.397 8.386 1 9.748 1 9.748c1.13 1.287 2.46 1.377 2.46 1.377.167.303.366.575.58.848.092.106.183.212.29.318a3.014 3.014 0 00.061 2.149c1.268.045 2.093-.545 2.261-.681.122.045.26.076.382.106.382.106.78.151 1.176.181h.49c.595.848 1.634.954 1.634.954.748-.772.779-1.544.779-1.71v-.015-.03-.03c.153-.107.305-.228.443-.35a5.37 5.37 0 00.779-.892c.015-.03.046-.06.061-.09.84.045 1.436-.515 1.436-.515-.138-.863-.642-1.287-.749-1.378l-.015-.015h-.015s-.015 0-.015-.015c0-.045.015-.106.015-.151 0-.091.015-.182.015-.288V9.4v-.166-.076-.152l-.015-.075c-.015-.091-.03-.197-.061-.288a3.506 3.506 0 00-.428-1.044 3.856 3.856 0 00-.718-.848 3.784 3.784 0 00-.901-.575 3.347 3.347 0 00-.993-.272c-.168-.015-.336-.03-.504-.03H9.37 9.204c-.092.015-.169.015-.26.03-.336.06-.642.181-.932.348-.275.166-.52.363-.718.605a2.579 2.579 0 00-.459.757 2.63 2.63 0 00-.183.817v.393c.015.137.046.273.077.394.076.258.183.485.336.666.137.197.32.348.504.485.183.12.382.212.58.272.199.06.382.076.565.076h.244c.031 0 .047 0 .062-.015.015 0 .046-.015.061-.015.046-.016.076-.016.122-.03l.23-.092a.869.869 0 00.198-.12c.015-.016.03-.03.046-.03a.129.129 0 00.015-.198c-.046-.06-.122-.075-.183-.03-.015.015-.03.015-.046.03-.046.03-.107.046-.168.06l-.183.046c-.03 0-.061.015-.092.015H8.73a1.519 1.519 0 01-.825-.378 1.452 1.452 0 01-.306-.378 1.655 1.655 0 01-.168-.485c-.015-.09-.015-.166-.015-.257v-.106-.03c0-.046.015-.091.015-.136.061-.364.26-.727.55-1 .077-.075.153-.136.23-.181.076-.06.167-.106.259-.151.092-.046.183-.076.29-.106a.993.993 0 01.306-.046h.321c.107.015.229.03.336.046.214.045.427.12.626.242.397.212.733.56.947.969.107.211.183.423.214.65.015.06.015.121.015.167v.363c0 .06-.015.121-.015.182 0 .06-.015.12-.03.181l-.046.182c-.03.121-.077.242-.123.363a3.183 3.183 0 01-.366.666 3.002 3.002 0 01-1.91 1.18c-.122.016-.26.03-.382.046h-.198c-.061 0-.138 0-.199-.015a3.637 3.637 0 01-.81-.151 4.068 4.068 0 01-.748-.303 4.098 4.098 0 01-1.696-1.695 4.398 4.398 0 01-.29-.742c-.076-.257-.107-.514-.137-.772v-.302-.091c0-.136.015-.258.03-.394s.046-.272.061-.393c.03-.137.061-.258.092-.394a5.33 5.33 0 01.275-.741c.214-.47.504-.893.855-1.226.092-.091.184-.167.275-.243.092-.075.184-.136.29-.211a5.39 5.39 0 01.306-.182c.046-.03.107-.045.153-.076a.26.26 0 01.076-.03.26.26 0 01.077-.03c.107-.046.229-.091.336-.121.03-.015.06-.015.091-.03.03-.016.061-.016.092-.03.061-.016.122-.031.168-.046.03-.015.061-.015.092-.015.03 0 .06-.016.091-.016.03 0 .061-.015.092-.015l.046-.015h.046c.03 0 .06-.015.091-.015.03 0 .061-.015.107-.015.03 0 .077-.015.107-.015h.764c.23.015.443.03.657.075.428.076.84.212 1.207.394.366.182.702.393.977.636l.046.045.046.045c.03.03.061.061.107.091l.092.091.091.09c.123.122.23.258.336.394.199.258.367.515.49.772.014.015.014.03.03.046.015.015.015.03.015.045l.046.09.046.092.045.09c.046.122.092.228.123.333.06.167.107.318.137.455.015.045.061.09.122.075a.104.104 0 00.107-.106c.092-.227.092-.393.077-.575z'
|
||||
/>
|
||||
<defs>
|
||||
<linearGradient
|
||||
id='grafana-color-16__paint0_linear_2372_364'
|
||||
id={gradientId}
|
||||
x1='7.502'
|
||||
x2='7.502'
|
||||
y1='18.142'
|
||||
@@ -1236,6 +1240,10 @@ export function GoogleCalendarIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function SupabaseIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const gradient0 = `supabase_paint0_${id}`
|
||||
const gradient1 = `supabase_paint1_${id}`
|
||||
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
@@ -1247,11 +1255,11 @@ export function SupabaseIcon(props: SVGProps<SVGSVGElement>) {
|
||||
>
|
||||
<path
|
||||
d='M15.4057 26.2606C14.7241 27.1195 13.3394 26.649 13.3242 25.5519L13.083 9.50684H23.8724C25.8262 9.50684 26.9157 11.7636 25.7006 13.2933L15.4057 26.2606Z'
|
||||
fill='url(#supabase_paint0_linear)'
|
||||
fill={`url(#${gradient0})`}
|
||||
/>
|
||||
<path
|
||||
d='M15.4057 26.2606C14.7241 27.1195 13.3394 26.649 13.3242 25.5519L13.083 9.50684H23.8724C25.8262 9.50684 26.9157 11.7636 25.7006 13.2933L15.4057 26.2606Z'
|
||||
fill='url(#supabase_paint1_linear)'
|
||||
fill={`url(#${gradient1})`}
|
||||
fillOpacity='0.2'
|
||||
/>
|
||||
<path
|
||||
@@ -1260,7 +1268,7 @@ export function SupabaseIcon(props: SVGProps<SVGSVGElement>) {
|
||||
/>
|
||||
<defs>
|
||||
<linearGradient
|
||||
id='supabase_paint0_linear'
|
||||
id={gradient0}
|
||||
x1='13.084'
|
||||
y1='13.0655'
|
||||
x2='22.6727'
|
||||
@@ -1271,7 +1279,7 @@ export function SupabaseIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='1' stopColor='#3ECF8E' />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
id='supabase_paint1_linear'
|
||||
id={gradient1}
|
||||
x1='8.83277'
|
||||
y1='7.24485'
|
||||
x2='13.2057'
|
||||
@@ -1481,6 +1489,9 @@ export function DocumentIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function MistralIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const clipId = `mistral_clip_${id}`
|
||||
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
@@ -1491,7 +1502,7 @@ export function MistralIcon(props: SVGProps<SVGSVGElement>) {
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
preserveAspectRatio='xMidYMid meet'
|
||||
>
|
||||
<g clipPath='url(#clip0_1621_58)'>
|
||||
<g clipPath={`url(#${clipId})`}>
|
||||
<path d='M17.4541 0H21.8177V4.39481H17.4541V0Z' fill='black' />
|
||||
<path d='M19.6367 0H24.0003V4.39481H19.6367V0Z' fill='#F7D046' />
|
||||
<path
|
||||
@@ -1528,7 +1539,7 @@ export function MistralIcon(props: SVGProps<SVGSVGElement>) {
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id='clip0_1621_58'>
|
||||
<clipPath id={clipId}>
|
||||
<rect width='24' height='22' fill='white' />
|
||||
</clipPath>
|
||||
</defs>
|
||||
@@ -2096,6 +2107,23 @@ export function ClayIcon(props: SVGProps<SVGSVGElement>) {
|
||||
)
|
||||
}
|
||||
|
||||
export function ClerkIcon(props: SVGProps<SVGSVGElement>) {
|
||||
return (
|
||||
<svg {...props} viewBox='0 0 128 128' fill='none' xmlns='http://www.w3.org/2000/svg'>
|
||||
<circle cx='64' cy='64' r='20' fill='white' />
|
||||
<path
|
||||
d='M99.5716 10.788C101.571 12.1272 101.742 14.9444 100.04 16.646L85.4244 31.2618C84.1035 32.5828 82.0542 32.7914 80.3915 31.9397C75.4752 29.421 69.9035 28 64 28C44.1177 28 28 44.1177 28 64C28 69.9035 29.421 75.4752 31.9397 80.3915C32.7914 82.0542 32.5828 84.1035 31.2618 85.4244L16.646 100.04C14.9444 101.742 12.1272 101.571 10.788 99.5716C3.97411 89.3989 0 77.1635 0 64C0 28.6538 28.6538 0 64 0C77.1635 0 89.3989 3.97411 99.5716 10.788Z'
|
||||
fill='white'
|
||||
fillOpacity='0.4'
|
||||
/>
|
||||
<path
|
||||
d='M100.04 111.354C101.742 113.056 101.571 115.873 99.5717 117.212C89.3989 124.026 77.1636 128 64 128C50.8364 128 38.6011 124.026 28.4283 117.212C26.4289 115.873 26.2581 113.056 27.9597 111.354L42.5755 96.7382C43.8965 95.4172 45.9457 95.2085 47.6084 96.0603C52.5248 98.579 58.0964 100 64 100C69.9036 100 75.4753 98.579 80.3916 96.0603C82.0543 95.2085 84.1036 95.4172 85.4245 96.7382L100.04 111.354Z'
|
||||
fill='white'
|
||||
/>
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
|
||||
export function MicrosoftIcon(props: SVGProps<SVGSVGElement>) {
|
||||
return (
|
||||
<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 23 23' {...props}>
|
||||
@@ -2109,6 +2137,9 @@ export function MicrosoftIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function MicrosoftTeamsIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const gradientId = `msteams_gradient_${id}`
|
||||
|
||||
return (
|
||||
<svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='0 0 2228.833 2073.333'>
|
||||
<path
|
||||
@@ -2154,7 +2185,7 @@ export function MicrosoftTeamsIcon(props: SVGProps<SVGSVGElement>) {
|
||||
d='M1140.333,561.355v103.148c-104.963-24.857-191.679-98.469-233.25-198.003 h138.395C1097.783,466.699,1140.134,509.051,1140.333,561.355z'
|
||||
/>
|
||||
<linearGradient
|
||||
id='msteams_gradient_a'
|
||||
id={gradientId}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='198.099'
|
||||
y1='1683.0726'
|
||||
@@ -2170,7 +2201,7 @@ export function MicrosoftTeamsIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='1' stopColor='#3940ab' />
|
||||
</linearGradient>
|
||||
<path
|
||||
fill='url(#msteams_gradient_a)'
|
||||
fill={`url(#${gradientId})`}
|
||||
d='M95.01,466.5h950.312c52.473,0,95.01,42.538,95.01,95.01v950.312c0,52.473-42.538,95.01-95.01,95.01 H95.01c-52.473,0-95.01-42.538-95.01-95.01V561.51C0,509.038,42.538,466.5,95.01,466.5z'
|
||||
/>
|
||||
<path
|
||||
@@ -2182,6 +2213,10 @@ export function MicrosoftTeamsIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const gradient1 = `outlook_gradient1_${id}`
|
||||
const gradient2 = `outlook_gradient2_${id}`
|
||||
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
@@ -2211,7 +2246,7 @@ export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<path fill='#14447D' d='M520.453,1025.151h416.38v346.969h-416.38V1025.151z' />
|
||||
<path fill='#0078D4' d='M1362.667,1022h383.25v383.25h-383.25V1022z' />
|
||||
<linearGradient
|
||||
id='SVGID_1_'
|
||||
id={gradient1}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='1128.4584'
|
||||
y1='811.0833'
|
||||
@@ -2223,7 +2258,7 @@ export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='1' style={{ stopColor: '#28A8EA' }} />
|
||||
</linearGradient>
|
||||
<path
|
||||
fill='url(#SVGID_1_)'
|
||||
fill={`url(#${gradient1})`}
|
||||
d='M1811.58,927.593l-0.809,0.426l-634.492,356.848c-2.768,1.703-5.578,3.321-8.517,4.769 c-10.777,5.132-22.481,8.029-34.407,8.517l-34.663-20.27c-2.929-1.47-5.773-3.105-8.517-4.897L447.167,906.003h-0.298 l-21.036-11.753v722.384c0.328,48.196,39.653,87.006,87.849,86.7h1230.914c0.724,0,1.363-0.341,2.129-0.341 c10.18-0.651,20.216-2.745,29.808-6.217c4.145-1.756,8.146-3.835,11.966-6.217c2.853-1.618,7.75-5.152,7.75-5.152 c21.814-16.142,34.726-41.635,34.833-68.772V894.25C1831.068,908.067,1823.616,920.807,1811.58,927.593z'
|
||||
/>
|
||||
<path
|
||||
@@ -2271,7 +2306,7 @@ export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
|
||||
d='M936.833,461.305v823.136c-0.046,43.067-34.861,78.015-77.927,78.225H425.833 V383.25h433.072c43.062,0.023,77.951,34.951,77.927,78.013C936.833,461.277,936.833,461.291,936.833,461.305z'
|
||||
/>
|
||||
<linearGradient
|
||||
id='SVGID_2_'
|
||||
id={gradient2}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='162.7469'
|
||||
y1='1383.0741'
|
||||
@@ -2284,7 +2319,7 @@ export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='1' style={{ stopColor: '#0A63C9' }} />
|
||||
</linearGradient>
|
||||
<path
|
||||
fill='url(#SVGID_2_)'
|
||||
fill={`url(#${gradient2})`}
|
||||
d='M78.055,383.25h780.723c43.109,0,78.055,34.947,78.055,78.055v780.723 c0,43.109-34.946,78.055-78.055,78.055H78.055c-43.109,0-78.055-34.947-78.055-78.055V461.305 C0,418.197,34.947,383.25,78.055,383.25z'
|
||||
/>
|
||||
<path
|
||||
@@ -2297,6 +2332,9 @@ export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function MicrosoftExcelIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const gradientId = `excel_gradient_${id}`
|
||||
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
@@ -2338,7 +2376,7 @@ export function MicrosoftExcelIcon(props: SVGProps<SVGSVGElement>) {
|
||||
d='M1073.893,479.25H532.5V1704h541.393c53.834-0.175,97.432-43.773,97.607-97.607 V576.857C1171.325,523.023,1127.727,479.425,1073.893,479.25z'
|
||||
/>
|
||||
<linearGradient
|
||||
id='SVGID_1_'
|
||||
id={gradientId}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='203.5132'
|
||||
y1='1729.0183'
|
||||
@@ -2351,7 +2389,7 @@ export function MicrosoftExcelIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='1' style={{ stopColor: '#0B6631' }} />
|
||||
</linearGradient>
|
||||
<path
|
||||
fill='url(#SVGID_1_)'
|
||||
fill={`url(#${gradientId})`}
|
||||
d='M97.607,479.25h976.285c53.907,0,97.607,43.7,97.607,97.607v976.285 c0,53.907-43.7,97.607-97.607,97.607H97.607C43.7,1650.75,0,1607.05,0,1553.143V576.857C0,522.95,43.7,479.25,97.607,479.25z'
|
||||
/>
|
||||
<path
|
||||
@@ -2465,7 +2503,13 @@ export const AnthropicIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
</svg>
|
||||
)
|
||||
|
||||
export const AzureIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
export function AzureIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const gradient0 = `azure_paint0_${id}`
|
||||
const gradient1 = `azure_paint1_${id}`
|
||||
const gradient2 = `azure_paint2_${id}`
|
||||
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
width='18'
|
||||
@@ -2476,7 +2520,7 @@ export const AzureIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
>
|
||||
<path
|
||||
d='M5.33492 1.37491C5.44717 1.04229 5.75909 0.818359 6.11014 0.818359H11.25L5.91513 16.6255C5.80287 16.9581 5.49095 17.182 5.13991 17.182H1.13968C0.579936 17.182 0.185466 16.6325 0.364461 16.1022L5.33492 1.37491Z'
|
||||
fill='url(#paint0_linear_6102_134469)'
|
||||
fill={`url(#${gradient0})`}
|
||||
/>
|
||||
<path
|
||||
d='M13.5517 11.4546H5.45126C5.1109 11.4546 4.94657 11.8715 5.19539 12.1037L10.4005 16.9618C10.552 17.1032 10.7515 17.1819 10.9587 17.1819H15.5453L13.5517 11.4546Z'
|
||||
@@ -2484,15 +2528,15 @@ export const AzureIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
/>
|
||||
<path
|
||||
d='M6.11014 0.818359C5.75909 0.818359 5.44717 1.04229 5.33492 1.37491L0.364461 16.1022C0.185466 16.6325 0.579936 17.182 1.13968 17.182H5.13991C5.49095 17.182 5.80287 16.9581 5.91513 16.6255L6.90327 13.6976L10.4005 16.9617C10.552 17.1032 10.7515 17.1818 10.9588 17.1818H15.5454L13.5517 11.4545H7.66032L11.25 0.818359H6.11014Z'
|
||||
fill='url(#paint1_linear_6102_134469)'
|
||||
fill={`url(#${gradient1})`}
|
||||
/>
|
||||
<path
|
||||
d='M12.665 1.37478C12.5528 1.04217 12.2409 0.818237 11.8898 0.818237H6.13629H6.16254C6.51358 0.818237 6.82551 1.04217 6.93776 1.37478L11.9082 16.1021C12.0872 16.6324 11.6927 17.1819 11.133 17.1819H11.0454H16.8603C17.42 17.1819 17.8145 16.6324 17.6355 16.1021L12.665 1.37478Z'
|
||||
fill='url(#paint2_linear_6102_134469)'
|
||||
fill={`url(#${gradient2})`}
|
||||
/>
|
||||
<defs>
|
||||
<linearGradient
|
||||
id='paint0_linear_6102_134469'
|
||||
id={gradient0}
|
||||
x1='6.07512'
|
||||
y1='1.38476'
|
||||
x2='0.738178'
|
||||
@@ -2503,7 +2547,7 @@ export const AzureIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
<stop offset='1' stopColor='#0669BC' />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
id='paint1_linear_6102_134469'
|
||||
id={gradient1}
|
||||
x1='10.3402'
|
||||
y1='11.4564'
|
||||
x2='9.107'
|
||||
@@ -2517,7 +2561,7 @@ export const AzureIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
<stop offset='1' stopOpacity='0' />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
id='paint2_linear_6102_134469'
|
||||
id={gradient2}
|
||||
x1='9.45858'
|
||||
y1='1.38467'
|
||||
x2='15.3168'
|
||||
@@ -2529,7 +2573,8 @@ export const AzureIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
</linearGradient>
|
||||
</defs>
|
||||
</svg>
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
export const GroqIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
<svg
|
||||
@@ -2556,11 +2601,15 @@ export const DeepseekIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
</svg>
|
||||
)
|
||||
|
||||
export const GeminiIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
export function GeminiIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const gradientId = `gemini_gradient_${id}`
|
||||
|
||||
return (
|
||||
<svg {...props} height='1em' viewBox='0 0 24 24' width='1em' xmlns='http://www.w3.org/2000/svg'>
|
||||
<title>Gemini</title>
|
||||
<defs>
|
||||
<linearGradient id='lobe-icons-gemini-fill' x1='0%' x2='68.73%' y1='100%' y2='30.395%'>
|
||||
<linearGradient id={gradientId} x1='0%' x2='68.73%' y1='100%' y2='30.395%'>
|
||||
<stop offset='0%' stopColor='#1C7DFF' />
|
||||
<stop offset='52.021%' stopColor='#1C69FF' />
|
||||
<stop offset='100%' stopColor='#F0DCD6' />
|
||||
@@ -2568,11 +2617,12 @@ export const GeminiIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
</defs>
|
||||
<path
|
||||
d='M12 24A14.304 14.304 0 000 12 14.304 14.304 0 0012 0a14.305 14.305 0 0012 12 14.305 14.305 0 00-12 12'
|
||||
fill='url(#lobe-icons-gemini-fill)'
|
||||
fill={`url(#${gradientId})`}
|
||||
fillRule='nonzero'
|
||||
/>
|
||||
</svg>
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
export const VertexIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
<svg
|
||||
@@ -2735,9 +2785,13 @@ export function ScheduleIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function QdrantIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const gradientId = `qdrant_gradient_${id}`
|
||||
const clipPathId = `qdrant_clippath_${id}`
|
||||
|
||||
return (
|
||||
<svg {...props} fill='none' viewBox='0 0 49 56' xmlns='http://www.w3.org/2000/svg'>
|
||||
<g clipPath='url(#qdrant_clippath_b)'>
|
||||
<g clipPath={`url(#${clipPathId})`}>
|
||||
<path
|
||||
d='m38.489 51.477-1.1167-30.787-2.0223-8.1167 13.498 1.429v37.242l-8.2456 4.7589-2.1138-4.5259z'
|
||||
clipRule='evenodd'
|
||||
@@ -2788,12 +2842,12 @@ export function QdrantIcon(props: SVGProps<SVGSVGElement>) {
|
||||
/>
|
||||
<path
|
||||
d='m24.603 46.483v-9.5222l-7.7166-4.4411v9.5064l7.7166 4.4569z'
|
||||
fill='url(#qdrant_gradient_a)'
|
||||
fill={`url(#${gradientId})`}
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<linearGradient
|
||||
id='qdrant_gradient_a'
|
||||
id={gradientId}
|
||||
x1='23.18'
|
||||
x2='15.491'
|
||||
y1='38.781'
|
||||
@@ -2803,7 +2857,7 @@ export function QdrantIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop stopColor='#FF3364' offset='0' />
|
||||
<stop stopColor='#C91540' stopOpacity='0' offset='1' />
|
||||
</linearGradient>
|
||||
<clipPath id='qdrant_clippath_b'>
|
||||
<clipPath id={clipPathId}>
|
||||
<rect transform='translate(.34961)' width='48.3' height='56' fill='#fff' />
|
||||
</clipPath>
|
||||
</defs>
|
||||
@@ -3237,9 +3291,13 @@ export const SOC2BadgeIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
</svg>
|
||||
)
|
||||
|
||||
export const HIPAABadgeIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
export function HIPAABadgeIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const clipId = `hipaa_clip_${id}`
|
||||
|
||||
return (
|
||||
<svg {...props} viewBox='0 0 46 40' fill='none' xmlns='http://www.w3.org/2000/svg'>
|
||||
<g clipPath='url(#clip0_122_4972)'>
|
||||
<g clipPath={`url(#${clipId})`}>
|
||||
<path
|
||||
fillRule='evenodd'
|
||||
clipRule='evenodd'
|
||||
@@ -3253,12 +3311,13 @@ export const HIPAABadgeIcon = (props: SVGProps<SVGSVGElement>) => (
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id='clip0_122_4972'>
|
||||
<clipPath id={clipId}>
|
||||
<rect width='45.8537' height='40' fill='white' />
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
export function GoogleFormsIcon(props: SVGProps<SVGSVGElement>) {
|
||||
return (
|
||||
@@ -3275,19 +3334,6 @@ export function GoogleFormsIcon(props: SVGProps<SVGSVGElement>) {
|
||||
d='M19.229 50.292h16.271v-2.959H19.229v2.959Zm0-17.75v2.958h16.271v-2.958H19.229Zm-3.698 1.479c0 1.224-0.995 2.219-2.219 2.219s-2.219-0.995-2.219-2.219c0-1.224 0.995-2.219 2.219-2.219s2.219 0.995 2.219 2.219Zm0 7.396c0 1.224-0.995 2.219-2.219 2.219s-2.219-0.995-2.219-2.219c0-1.224 0.995-2.219 2.219-2.219s2.219 0.995 2.219 2.219Zm0 7.396c0 1.224-0.995 2.219-2.219 2.219s-2.219-0.995-2.219-2.219c0-1.224 0.995-2.219 2.219-2.219s2.219 0.995 2.219 2.219Zm3.698-5.917h16.271v-2.959H19.229v2.959Z'
|
||||
fill='#F1F1F1'
|
||||
/>
|
||||
<defs>
|
||||
<linearGradient
|
||||
id='gf-gradient'
|
||||
x1='30.881'
|
||||
y1='16.452'
|
||||
x2='47.333'
|
||||
y2='32.9'
|
||||
gradientUnits='userSpaceOnUse'
|
||||
>
|
||||
<stop stopColor='#9575CD' />
|
||||
<stop offset='1' stopColor='#7E57C2' />
|
||||
</linearGradient>
|
||||
</defs>
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
@@ -3736,6 +3782,9 @@ export function SentryIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function IncidentioIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const clipId = `incidentio_clip_${id}`
|
||||
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
@@ -3745,7 +3794,7 @@ export function IncidentioIcon(props: SVGProps<SVGSVGElement>) {
|
||||
fill='none'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
>
|
||||
<g clipPath='url(#clip0_1361_12561)'>
|
||||
<g clipPath={`url(#${clipId})`}>
|
||||
<path
|
||||
fillRule='evenodd'
|
||||
clipRule='evenodd'
|
||||
@@ -3754,7 +3803,7 @@ export function IncidentioIcon(props: SVGProps<SVGSVGElement>) {
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id='clip0_1361_12561'>
|
||||
<clipPath id={clipId}>
|
||||
<rect width='128' height='163' fill='white' />
|
||||
</clipPath>
|
||||
</defs>
|
||||
@@ -3978,6 +4027,9 @@ export function SftpIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function ApifyIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const clipId = `apify_clip_${id}`
|
||||
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
@@ -3987,7 +4039,7 @@ export function ApifyIcon(props: SVGProps<SVGSVGElement>) {
|
||||
fill='none'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
>
|
||||
<g clipPath='url(#clip0_267_4154)'>
|
||||
<g clipPath={`url(#${clipId})`}>
|
||||
<path
|
||||
d='M114.695 0H196.97C198.643 0 200 1.35671 200 3.03031V128.766C200 131.778 196.083 132.945 194.434 130.425L112.159 4.68953C110.841 2.67412 112.287 0 114.695 0Z'
|
||||
fill='#246DFF'
|
||||
@@ -4002,7 +4054,7 @@ export function ApifyIcon(props: SVGProps<SVGSVGElement>) {
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id='clip0_267_4154'>
|
||||
<clipPath id={clipId}>
|
||||
<rect width='200' height='200' fill='white' />
|
||||
</clipPath>
|
||||
</defs>
|
||||
@@ -4111,6 +4163,9 @@ export function TextractIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function McpIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const clipId = `mcp_clip_${id}`
|
||||
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
@@ -4120,7 +4175,7 @@ export function McpIcon(props: SVGProps<SVGSVGElement>) {
|
||||
fill='none'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
>
|
||||
<g clipPath='url(#mcp-clip)'>
|
||||
<g clipPath={`url(#${clipId})`}>
|
||||
<path
|
||||
fillRule='evenodd'
|
||||
clipRule='evenodd'
|
||||
@@ -4129,7 +4184,7 @@ export function McpIcon(props: SVGProps<SVGSVGElement>) {
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id='mcp-clip'>
|
||||
<clipPath id={clipId}>
|
||||
<rect width='16' height='16' fill='white' />
|
||||
</clipPath>
|
||||
</defs>
|
||||
@@ -4461,6 +4516,10 @@ export function GrainIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function CirclebackIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const patternId = `circleback_pattern_${id}`
|
||||
const imageId = `circleback_image_${id}`
|
||||
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
@@ -4471,13 +4530,13 @@ export function CirclebackIcon(props: SVGProps<SVGSVGElement>) {
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
xmlnsXlink='http://www.w3.org/1999/xlink'
|
||||
>
|
||||
<rect width='280' height='280' fill='url(#pattern0_5_2)' />
|
||||
<rect width='280' height='280' fill={`url(#${patternId})`} />
|
||||
<defs>
|
||||
<pattern id='pattern0_5_2' patternContentUnits='objectBoundingBox' width='1' height='1'>
|
||||
<use xlinkHref='#image0_5_2' transform='scale(0.00357143)' />
|
||||
<pattern id={patternId} patternContentUnits='objectBoundingBox' width='1' height='1'>
|
||||
<use xlinkHref={`#${imageId}`} transform='scale(0.00357143)' />
|
||||
</pattern>
|
||||
<image
|
||||
id='image0_5_2'
|
||||
id={imageId}
|
||||
width='280'
|
||||
height='280'
|
||||
preserveAspectRatio='none'
|
||||
@@ -4517,11 +4576,21 @@ export function JiraServiceManagementIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const g1 = `fireflies_g1_${id}`
|
||||
const g2 = `fireflies_g2_${id}`
|
||||
const g3 = `fireflies_g3_${id}`
|
||||
const g4 = `fireflies_g4_${id}`
|
||||
const g5 = `fireflies_g5_${id}`
|
||||
const g6 = `fireflies_g6_${id}`
|
||||
const g7 = `fireflies_g7_${id}`
|
||||
const g8 = `fireflies_g8_${id}`
|
||||
|
||||
return (
|
||||
<svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='-6 -6 68 68'>
|
||||
<defs>
|
||||
<linearGradient
|
||||
id='fireflies_g1'
|
||||
id={g1}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='144.6644'
|
||||
y1='-133.7781'
|
||||
@@ -4537,7 +4606,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='0.994' stopColor='#3B73FF' />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
id='fireflies_g2'
|
||||
id={g2}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='145.1664'
|
||||
y1='-133.3084'
|
||||
@@ -4553,7 +4622,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='0.994' stopColor='#3B73FF' />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
id='fireflies_g3'
|
||||
id={g3}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='144.7625'
|
||||
y1='-123.2011'
|
||||
@@ -4569,7 +4638,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='0.994' stopColor='#3B73FF' />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
id='fireflies_g4'
|
||||
id={g4}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='134.8237'
|
||||
y1='-132.3271'
|
||||
@@ -4585,7 +4654,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='0.994' stopColor='#3B73FF' />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
id='fireflies_g5'
|
||||
id={g5}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='82.2078'
|
||||
y1='-52.7908'
|
||||
@@ -4601,7 +4670,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='0.994' stopColor='#3D081E' />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
id='fireflies_g6'
|
||||
id={g6}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='107.6542'
|
||||
y1='-78.5296'
|
||||
@@ -4617,7 +4686,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='0.994' stopColor='#3D081E' />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
id='fireflies_g7'
|
||||
id={g7}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='70.8311'
|
||||
y1='-99.3209'
|
||||
@@ -4633,7 +4702,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
|
||||
<stop offset='0.994' stopColor='#3D081E' />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
id='fireflies_g8'
|
||||
id={g8}
|
||||
gradientUnits='userSpaceOnUse'
|
||||
x1='297.6904'
|
||||
y1='-1360.8851'
|
||||
@@ -4650,25 +4719,25 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<g>
|
||||
<path fill='url(#fireflies_g1)' d='M18.4,0H0v18.3h18.4V0z' />
|
||||
<path fill='url(#fireflies_g2)' d='M40.2,22.1H21.8v18.3h18.4V22.1z' />
|
||||
<path fill={`url(#${g1})`} d='M18.4,0H0v18.3h18.4V0z' />
|
||||
<path fill={`url(#${g2})`} d='M40.2,22.1H21.8v18.3h18.4V22.1z' />
|
||||
<path
|
||||
fill='url(#fireflies_g3)'
|
||||
fill={`url(#${g3})`}
|
||||
d='M40.2,0H21.8v18.3H56v-2.6c0-4.2-1.7-8.1-4.6-11.1C48.4,1.7,44.4,0,40.2,0L40.2,0z'
|
||||
/>
|
||||
<path
|
||||
fill='url(#fireflies_g4)'
|
||||
fill={`url(#${g4})`}
|
||||
d='M0,22.1v18.3c0,4.2,1.7,8.1,4.6,11.1c3,2.9,7,4.6,11.2,4.6h2.6V22.1H0z'
|
||||
/>
|
||||
<path fill='url(#fireflies_g5)' opacity='0.18' d='M0,0l18.4,18.3H0V0z' />
|
||||
<path fill='url(#fireflies_g6)' opacity='0.18' d='M21.8,22.1l18.4,18.3H21.8V22.1z' />
|
||||
<path fill={`url(#${g5})`} opacity='0.18' d='M0,0l18.4,18.3H0V0z' />
|
||||
<path fill={`url(#${g6})`} opacity='0.18' d='M21.8,22.1l18.4,18.3H21.8V22.1z' />
|
||||
<path
|
||||
fill='url(#fireflies_g7)'
|
||||
fill={`url(#${g7})`}
|
||||
opacity='0.18'
|
||||
d='M0,40.3c0,4.2,1.7,8.1,4.6,11.1c3,2.9,7,4.6,11.2,4.6h2.6V22.1L0,40.3z'
|
||||
/>
|
||||
<path
|
||||
fill='url(#fireflies_g8)'
|
||||
fill={`url(#${g8})`}
|
||||
opacity='0.18'
|
||||
d='M40.2,0c4.2,0,8.2,1.7,11.2,4.6c3,2.9,4.6,6.9,4.6,11.1v2.6H21.8L40.2,0z'
|
||||
/>
|
||||
@@ -4678,10 +4747,13 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
|
||||
}
|
||||
|
||||
export function BedrockIcon(props: SVGProps<SVGSVGElement>) {
|
||||
const id = useId()
|
||||
const gradientId = `bedrock_gradient_${id}`
|
||||
|
||||
return (
|
||||
<svg {...props} viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'>
|
||||
<defs>
|
||||
<linearGradient id='bedrock_gradient' x1='80%' x2='20%' y1='20%' y2='80%'>
|
||||
<linearGradient id={gradientId} x1='80%' x2='20%' y1='20%' y2='80%'>
|
||||
<stop offset='0%' stopColor='#6350FB' />
|
||||
<stop offset='50%' stopColor='#3D8FFF' />
|
||||
<stop offset='100%' stopColor='#9AD8F8' />
|
||||
@@ -4689,7 +4761,7 @@ export function BedrockIcon(props: SVGProps<SVGSVGElement>) {
|
||||
</defs>
|
||||
<path
|
||||
d='M13.05 15.513h3.08c.214 0 .389.177.389.394v1.82a1.704 1.704 0 011.296 1.661c0 .943-.755 1.708-1.685 1.708-.931 0-1.686-.765-1.686-1.708 0-.807.554-1.484 1.297-1.662v-1.425h-2.69v4.663a.395.395 0 01-.188.338l-2.69 1.641a.385.385 0 01-.405-.002l-4.926-3.086a.395.395 0 01-.185-.336V16.3L2.196 14.87A.395.395 0 012 14.555L2 14.528V9.406c0-.14.073-.27.192-.34l2.465-1.462V4.448c0-.129.062-.249.165-.322l.021-.014L9.77 1.058a.385.385 0 01.407 0l2.69 1.675a.395.395 0 01.185.336V7.6h3.856V5.683a1.704 1.704 0 01-1.296-1.662c0-.943.755-1.708 1.685-1.708.931 0 1.685.765 1.685 1.708 0 .807-.553 1.484-1.296 1.662v2.311a.391.391 0 01-.389.394h-4.245v1.806h6.624a1.69 1.69 0 011.64-1.313c.93 0 1.685.764 1.685 1.707 0 .943-.754 1.708-1.685 1.708a1.69 1.69 0 01-1.64-1.314H13.05v1.937h4.953l.915 1.18a1.66 1.66 0 01.84-.227c.931 0 1.685.764 1.685 1.707 0 .943-.754 1.708-1.685 1.708-.93 0-1.685-.765-1.685-1.708 0-.346.102-.668.276-.937l-.724-.935H13.05v1.806zM9.973 1.856L7.93 3.122V6.09h-.778V3.604L5.435 4.669v2.945l2.11 1.36L9.712 7.61V5.334h.778V7.83c0 .136-.07.263-.184.335L7.963 9.638v2.081l1.422 1.009-.446.646-1.406-.998-1.53 1.005-.423-.66 1.605-1.055v-1.99L5.038 8.29l-2.26 1.34v1.676l1.972-1.189.398.677-2.37 1.429V14.3l2.166 1.258 2.27-1.368.397.677-2.176 1.311V19.3l1.876 1.175 2.365-1.426.398.678-2.017 1.216 1.918 1.201 2.298-1.403v-5.78l-4.758 2.893-.4-.675 5.158-3.136V3.289L9.972 1.856zM16.13 18.47a.913.913 0 00-.908.92c0 .507.406.918.908.918a.913.913 0 00.907-.919.913.913 0 00-.907-.92zm3.63-3.81a.913.913 0 00-.908.92c0 .508.406.92.907.92a.913.913 0 00.908-.92.913.913 0 00-.908-.92zm1.555-4.99a.913.913 0 00-.908.92c0 .507.407.918.908.918a.913.913 0 00.907-.919.913.913 0 00-.907-.92zM17.296 3.1a.913.913 0 00-.907.92c0 .508.406.92.907.92a.913.913 0 00.908-.92.913.913 0 00-.908-.92z'
|
||||
fill='url(#bedrock_gradient)'
|
||||
fill={`url(#${gradientId})`}
|
||||
fillRule='nonzero'
|
||||
/>
|
||||
</svg>
|
||||
@@ -5041,3 +5113,60 @@ export function PulseIcon(props: SVGProps<SVGSVGElement>) {
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
|
||||
export function SimilarwebIcon(props: SVGProps<SVGSVGElement>) {
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
role='img'
|
||||
viewBox='0 0 24 24'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
height='24'
|
||||
width='24'
|
||||
>
|
||||
<path
|
||||
d='M22.099 5.781c-1.283 -2 -3.14 -3.67 -5.27 -4.52l-0.63 -0.213a7.433 7.433 0 0 0 -2.15 -0.331c-2.307 0.01 -4.175 1.92 -4.175 4.275a4.3 4.3 0 0 0 0.867 2.602l-0.26 -0.342c0.124 0.186 0.26 0.37 0.417 0.556 0.663 0.802 1.604 1.635 2.822 2.58 2.999 2.32 4.943 4.378 5.104 6.93 0.038 0.344 0.062 0.696 0.062 1.051 0 1.297 -0.283 2.67 -0.764 3.635h0.005s-0.207 0.377 -0.077 0.487c0.066 0.057 0.21 0.1 0.46 -0.053a12.104 12.104 0 0 0 3.4 -3.33 12.111 12.111 0 0 0 2.088 -6.635 12.098 12.098 0 0 0 -1.9 -6.692zm-9.096 8.718 -1.878 -1.55c-3.934 -2.87 -5.98 -5.966 -4.859 -9.783a8.73 8.73 0 0 1 0.37 -1.016v-0.004s0.278 -0.583 -0.327 -0.295a12.067 12.067 0 0 0 -6.292 9.975 12.11 12.11 0 0 0 2.053 7.421 9.394 9.394 0 0 0 2.154 2.168H4.22c4.148 3.053 7.706 1.446 7.706 1.446h0.003a4.847 4.847 0 0 0 2.962 -4.492 4.855 4.855 0 0 0 -1.889 -3.87z'
|
||||
fill='currentColor'
|
||||
/>
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
|
||||
export function CalComIcon(props: SVGProps<SVGSVGElement>) {
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
width='101'
|
||||
height='22'
|
||||
viewBox='0 0 101 22'
|
||||
fill='currentColor'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
>
|
||||
<path
|
||||
d='M10.0582 20.817C4.32115 20.817 0 16.2763 0 10.6704C0 5.04589 4.1005 0.467773 10.0582 0.467773C13.2209 0.467773 15.409 1.43945 17.1191 3.66311L14.3609 5.96151C13.2025 4.72822 11.805 4.11158 10.0582 4.11158C6.17833 4.11158 4.04533 7.08268 4.04533 10.6704C4.04533 14.2582 6.38059 17.1732 10.0582 17.1732C11.7866 17.1732 13.2577 16.5566 14.4161 15.3233L17.1375 17.7151C15.501 19.8453 13.2577 20.817 10.0582 20.817Z'
|
||||
fill='#292929'
|
||||
/>
|
||||
<path
|
||||
d='M29.0161 5.88601H32.7304V20.4612H29.0161V18.331C28.2438 19.8446 26.9566 20.8536 24.4927 20.8536C20.5577 20.8536 17.4133 17.4341 17.4133 13.2297C17.4133 9.02528 20.5577 5.60571 24.4927 5.60571C26.9383 5.60571 28.2438 6.61477 29.0161 8.12835V5.88601ZM29.1264 13.2297C29.1264 10.95 27.5634 9.06266 25.0995 9.06266C22.7274 9.06266 21.1828 10.9686 21.1828 13.2297C21.1828 15.4346 22.7274 17.3967 25.0995 17.3967C27.5451 17.3967 29.1264 15.4907 29.1264 13.2297Z'
|
||||
fill='#292929'
|
||||
/>
|
||||
<path d='M35.3599 0H39.0742V20.4427H35.3599V0Z' fill='#292929' />
|
||||
<path
|
||||
d='M40.7291 18.5182C40.7291 17.3223 41.6853 16.3132 42.9908 16.3132C44.2964 16.3132 45.2158 17.3223 45.2158 18.5182C45.2158 19.7515 44.278 20.7605 42.9908 20.7605C41.7037 20.7605 40.7291 19.7515 40.7291 18.5182Z'
|
||||
fill='#292929'
|
||||
/>
|
||||
<path
|
||||
d='M59.4296 18.1068C58.0505 19.7885 55.9543 20.8536 53.4719 20.8536C49.0404 20.8536 45.7858 17.4341 45.7858 13.2297C45.7858 9.02528 49.0404 5.60571 53.4719 5.60571C55.8623 5.60571 57.9402 6.61477 59.3193 8.20309L56.4508 10.6136C55.7336 9.71667 54.7958 9.04397 53.4719 9.04397C51.0999 9.04397 49.5553 10.95 49.5553 13.211C49.5553 15.472 51.0999 17.378 53.4719 17.378C54.9062 17.378 55.8991 16.6306 56.6346 15.6215L59.4296 18.1068Z'
|
||||
fill='#292929'
|
||||
/>
|
||||
<path
|
||||
d='M59.7422 13.2297C59.7422 9.02528 62.9968 5.60571 67.4283 5.60571C71.8598 5.60571 75.1144 9.02528 75.1144 13.2297C75.1144 17.4341 71.8598 20.8536 67.4283 20.8536C62.9968 20.8349 59.7422 17.4341 59.7422 13.2297ZM71.3449 13.2297C71.3449 10.95 69.8003 9.06266 67.4283 9.06266C65.0563 9.04397 63.5117 10.95 63.5117 13.2297C63.5117 15.4907 65.0563 17.3967 67.4283 17.3967C69.8003 17.3967 71.3449 15.4907 71.3449 13.2297Z'
|
||||
fill='#292929'
|
||||
/>
|
||||
<path
|
||||
d='M100.232 11.5482V20.4428H96.518V12.4638C96.518 9.94119 95.3412 8.85739 93.576 8.85739C91.921 8.85739 90.7442 9.67958 90.7442 12.4638V20.4428H87.0299V12.4638C87.0299 9.94119 85.8346 8.85739 84.0878 8.85739C82.4329 8.85739 80.9802 9.67958 80.9802 12.4638V20.4428H77.2659V5.8676H80.9802V7.88571C81.7525 6.31607 83.15 5.53125 85.3014 5.53125C87.3425 5.53125 89.0525 6.5403 89.9903 8.24074C90.9281 6.50293 92.3072 5.53125 94.8079 5.53125C97.8603 5.54994 100.232 7.86702 100.232 11.5482Z'
|
||||
fill='#292929'
|
||||
/>
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
|
||||
@@ -1,20 +1,14 @@
|
||||
'use client'
|
||||
|
||||
import Image from 'next/image'
|
||||
import Link from 'next/link'
|
||||
import { LanguageDropdown } from '@/components/ui/language-dropdown'
|
||||
import { SearchTrigger } from '@/components/ui/search-trigger'
|
||||
import { SimLogoFull } from '@/components/ui/sim-logo'
|
||||
import { ThemeToggle } from '@/components/ui/theme-toggle'
|
||||
|
||||
export function Navbar() {
|
||||
return (
|
||||
<nav
|
||||
className='sticky top-0 z-50 border-border/50 border-b'
|
||||
style={{
|
||||
backdropFilter: 'blur(25px) saturate(180%)',
|
||||
WebkitBackdropFilter: 'blur(25px) saturate(180%)',
|
||||
}}
|
||||
>
|
||||
<nav className='sticky top-0 z-50 border-border/50 border-b bg-background/80 backdrop-blur-md backdrop-saturate-150'>
|
||||
{/* Desktop: Single row layout */}
|
||||
<div className='hidden h-16 w-full items-center lg:flex'>
|
||||
<div
|
||||
@@ -27,13 +21,7 @@ export function Navbar() {
|
||||
{/* Left cluster: logo */}
|
||||
<div className='flex items-center'>
|
||||
<Link href='/' className='flex min-w-[100px] items-center'>
|
||||
<Image
|
||||
src='/static/logo.png'
|
||||
alt='Sim'
|
||||
width={72}
|
||||
height={28}
|
||||
className='h-7 w-auto'
|
||||
/>
|
||||
<SimLogoFull className='h-7 w-auto' />
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -1,45 +1,13 @@
|
||||
'use client'
|
||||
|
||||
import { useState } from 'react'
|
||||
import { useCopyButton } from 'fumadocs-ui/utils/use-copy-button'
|
||||
import { Check, Copy } from 'lucide-react'
|
||||
|
||||
const cache = new Map<string, string>()
|
||||
|
||||
export function LLMCopyButton({
|
||||
markdownUrl,
|
||||
}: {
|
||||
/**
|
||||
* A URL to fetch the raw Markdown/MDX content of page
|
||||
*/
|
||||
markdownUrl: string
|
||||
}) {
|
||||
const [isLoading, setLoading] = useState(false)
|
||||
const [checked, onClick] = useCopyButton(async () => {
|
||||
const cached = cache.get(markdownUrl)
|
||||
if (cached) return navigator.clipboard.writeText(cached)
|
||||
|
||||
setLoading(true)
|
||||
|
||||
try {
|
||||
await navigator.clipboard.write([
|
||||
new ClipboardItem({
|
||||
'text/plain': fetch(markdownUrl).then(async (res) => {
|
||||
const content = await res.text()
|
||||
cache.set(markdownUrl, content)
|
||||
|
||||
return content
|
||||
}),
|
||||
}),
|
||||
])
|
||||
} finally {
|
||||
setLoading(false)
|
||||
}
|
||||
})
|
||||
export function LLMCopyButton({ content }: { content: string }) {
|
||||
const [checked, onClick] = useCopyButton(() => navigator.clipboard.writeText(content))
|
||||
|
||||
return (
|
||||
<button
|
||||
disabled={isLoading}
|
||||
onClick={onClick}
|
||||
className='flex cursor-pointer items-center gap-1.5 rounded-lg border border-border/40 bg-background px-2.5 py-2 text-muted-foreground/60 text-sm leading-none transition-all hover:border-border hover:bg-accent/50 hover:text-muted-foreground'
|
||||
aria-label={checked ? 'Copied to clipboard' : 'Copy page content'}
|
||||
|
||||
87
apps/docs/components/ui/action-media.tsx
Normal file
87
apps/docs/components/ui/action-media.tsx
Normal file
@@ -0,0 +1,87 @@
|
||||
'use client'
|
||||
|
||||
import { useState } from 'react'
|
||||
import { cn, getAssetUrl } from '@/lib/utils'
|
||||
import { Lightbox } from './lightbox'
|
||||
|
||||
interface ActionImageProps {
|
||||
src: string
|
||||
alt: string
|
||||
enableLightbox?: boolean
|
||||
}
|
||||
|
||||
interface ActionVideoProps {
|
||||
src: string
|
||||
alt: string
|
||||
enableLightbox?: boolean
|
||||
}
|
||||
|
||||
export function ActionImage({ src, alt, enableLightbox = true }: ActionImageProps) {
|
||||
const [isLightboxOpen, setIsLightboxOpen] = useState(false)
|
||||
|
||||
const handleClick = () => {
|
||||
if (enableLightbox) {
|
||||
setIsLightboxOpen(true)
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<>
|
||||
<img
|
||||
src={src}
|
||||
alt={alt}
|
||||
onClick={handleClick}
|
||||
className={cn(
|
||||
'inline-block w-full max-w-[200px] rounded border border-neutral-200 dark:border-neutral-700',
|
||||
enableLightbox && 'cursor-pointer transition-opacity hover:opacity-90'
|
||||
)}
|
||||
/>
|
||||
{enableLightbox && (
|
||||
<Lightbox
|
||||
isOpen={isLightboxOpen}
|
||||
onClose={() => setIsLightboxOpen(false)}
|
||||
src={src}
|
||||
alt={alt}
|
||||
type='image'
|
||||
/>
|
||||
)}
|
||||
</>
|
||||
)
|
||||
}
|
||||
|
||||
export function ActionVideo({ src, alt, enableLightbox = true }: ActionVideoProps) {
|
||||
const [isLightboxOpen, setIsLightboxOpen] = useState(false)
|
||||
const resolvedSrc = getAssetUrl(src)
|
||||
|
||||
const handleClick = () => {
|
||||
if (enableLightbox) {
|
||||
setIsLightboxOpen(true)
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<>
|
||||
<video
|
||||
src={resolvedSrc}
|
||||
autoPlay
|
||||
loop
|
||||
muted
|
||||
playsInline
|
||||
onClick={handleClick}
|
||||
className={cn(
|
||||
'inline-block w-full max-w-[200px] rounded border border-neutral-200 dark:border-neutral-700',
|
||||
enableLightbox && 'cursor-pointer transition-opacity hover:opacity-90'
|
||||
)}
|
||||
/>
|
||||
{enableLightbox && (
|
||||
<Lightbox
|
||||
isOpen={isLightboxOpen}
|
||||
onClose={() => setIsLightboxOpen(false)}
|
||||
src={src}
|
||||
alt={alt}
|
||||
type='video'
|
||||
/>
|
||||
)}
|
||||
</>
|
||||
)
|
||||
}
|
||||
@@ -17,23 +17,16 @@ export function CodeBlock(props: React.ComponentProps<typeof FumadocsCodeBlock>)
|
||||
return (
|
||||
<FumadocsCodeBlock
|
||||
{...props}
|
||||
Actions={({ children, className }) => (
|
||||
Actions={({ className }) => (
|
||||
<div className={cn('empty:hidden', className)}>
|
||||
{/* Custom copy button */}
|
||||
<button
|
||||
type='button'
|
||||
aria-label={copied ? 'Copied Text' : 'Copy Text'}
|
||||
onClick={(e) => {
|
||||
const pre = (e.currentTarget as HTMLElement)
|
||||
.closest('.nd-codeblock')
|
||||
?.querySelector('pre')
|
||||
const pre = (e.currentTarget as HTMLElement).closest('figure')?.querySelector('pre')
|
||||
if (pre) handleCopy(pre.textContent || '')
|
||||
}}
|
||||
className={cn(
|
||||
'cursor-pointer rounded-md p-2 transition-all',
|
||||
'border border-border bg-background/80 hover:bg-muted',
|
||||
'backdrop-blur-sm'
|
||||
)}
|
||||
className='cursor-pointer rounded-md p-2 text-muted-foreground transition-colors hover:text-foreground'
|
||||
>
|
||||
<span className='flex items-center justify-center'>
|
||||
{copied ? (
|
||||
|
||||
@@ -13,9 +13,11 @@ import {
|
||||
AsanaIcon,
|
||||
BrainIcon,
|
||||
BrowserUseIcon,
|
||||
CalComIcon,
|
||||
CalendlyIcon,
|
||||
CirclebackIcon,
|
||||
ClayIcon,
|
||||
ClerkIcon,
|
||||
ConfluenceIcon,
|
||||
CursorIcon,
|
||||
DatadogIcon,
|
||||
@@ -99,9 +101,9 @@ import {
|
||||
ServiceNowIcon,
|
||||
SftpIcon,
|
||||
ShopifyIcon,
|
||||
SimilarwebIcon,
|
||||
SlackIcon,
|
||||
SmtpIcon,
|
||||
SpotifyIcon,
|
||||
SQSIcon,
|
||||
SshIcon,
|
||||
STTIcon,
|
||||
@@ -141,9 +143,11 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
||||
arxiv: ArxivIcon,
|
||||
asana: AsanaIcon,
|
||||
browser_use: BrowserUseIcon,
|
||||
calcom: CalComIcon,
|
||||
calendly: CalendlyIcon,
|
||||
circleback: CirclebackIcon,
|
||||
clay: ClayIcon,
|
||||
clerk: ClerkIcon,
|
||||
confluence_v2: ConfluenceIcon,
|
||||
cursor_v2: CursorIcon,
|
||||
datadog: DatadogIcon,
|
||||
@@ -182,7 +186,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
||||
jina: JinaAIIcon,
|
||||
jira: JiraIcon,
|
||||
jira_service_management: JiraServiceManagementIcon,
|
||||
kalshi: KalshiIcon,
|
||||
kalshi_v2: KalshiIcon,
|
||||
knowledge: PackageSearchIcon,
|
||||
langsmith: LangsmithIcon,
|
||||
lemlist: LemlistIcon,
|
||||
@@ -227,9 +231,9 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
||||
sftp: SftpIcon,
|
||||
sharepoint: MicrosoftSharepointIcon,
|
||||
shopify: ShopifyIcon,
|
||||
similarweb: SimilarwebIcon,
|
||||
slack: SlackIcon,
|
||||
smtp: SmtpIcon,
|
||||
spotify: SpotifyIcon,
|
||||
sqs: SQSIcon,
|
||||
ssh: SshIcon,
|
||||
stagehand: StagehandIcon,
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
'use client'
|
||||
|
||||
import { useEffect, useState } from 'react'
|
||||
import { Check, ChevronRight } from 'lucide-react'
|
||||
import { Check, ChevronDown } from 'lucide-react'
|
||||
import { useParams, usePathname, useRouter } from 'next/navigation'
|
||||
import { cn } from '@/lib/utils'
|
||||
|
||||
const languages = {
|
||||
en: { name: 'English', flag: '🇺🇸' },
|
||||
@@ -15,6 +16,7 @@ const languages = {
|
||||
|
||||
export function LanguageDropdown() {
|
||||
const [isOpen, setIsOpen] = useState(false)
|
||||
const [hoveredIndex, setHoveredIndex] = useState<number>(-1)
|
||||
const pathname = usePathname()
|
||||
const params = useParams()
|
||||
const router = useRouter()
|
||||
@@ -71,6 +73,15 @@ export function LanguageDropdown() {
|
||||
return () => window.removeEventListener('keydown', onKey)
|
||||
}, [isOpen])
|
||||
|
||||
// Reset hovered index when popover closes
|
||||
useEffect(() => {
|
||||
if (!isOpen) {
|
||||
setHoveredIndex(-1)
|
||||
}
|
||||
}, [isOpen])
|
||||
|
||||
const languageEntries = Object.entries(languages)
|
||||
|
||||
return (
|
||||
<div className='relative'>
|
||||
<button
|
||||
@@ -82,14 +93,14 @@ export function LanguageDropdown() {
|
||||
aria-haspopup='listbox'
|
||||
aria-expanded={isOpen}
|
||||
aria-controls='language-menu'
|
||||
className='flex cursor-pointer items-center gap-1.5 rounded-xl px-3 py-2 font-normal text-[0.9375rem] text-foreground/60 leading-[1.4] transition-colors hover:bg-foreground/8 hover:text-foreground focus:outline-none focus-visible:ring-2 focus-visible:ring-ring'
|
||||
className='flex cursor-pointer items-center gap-1.5 rounded-[6px] px-3 py-2 font-normal text-[0.9375rem] text-foreground/60 leading-[1.4] transition-colors hover:bg-foreground/8 hover:text-foreground focus:outline-none focus-visible:ring-2 focus-visible:ring-ring'
|
||||
style={{
|
||||
fontFamily:
|
||||
'-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif',
|
||||
}}
|
||||
>
|
||||
<span>{languages[currentLang as keyof typeof languages]?.name}</span>
|
||||
<ChevronRight className='h-3.5 w-3.5' />
|
||||
<ChevronDown className={cn('h-3.5 w-3.5 transition-transform', isOpen && 'rotate-180')} />
|
||||
</button>
|
||||
|
||||
{isOpen && (
|
||||
@@ -98,9 +109,13 @@ export function LanguageDropdown() {
|
||||
<div
|
||||
id='language-menu'
|
||||
role='listbox'
|
||||
className='absolute top-full right-0 z-[1001] mt-1 max-h-[75vh] w-56 overflow-auto rounded-xl border border-border/50 bg-white shadow-2xl md:w-44 md:bg-background/95 md:backdrop-blur-md dark:bg-neutral-950 md:dark:bg-background/95'
|
||||
className='absolute top-full right-0 z-[1001] mt-2 max-h-[400px] min-w-[160px] overflow-auto rounded-[6px] bg-white px-[6px] py-[6px] shadow-lg dark:bg-neutral-900'
|
||||
>
|
||||
{Object.entries(languages).map(([code, lang]) => (
|
||||
{languageEntries.map(([code, lang], index) => {
|
||||
const isSelected = currentLang === code
|
||||
const isHovered = hoveredIndex === index
|
||||
|
||||
return (
|
||||
<button
|
||||
key={code}
|
||||
onClick={(e) => {
|
||||
@@ -108,19 +123,23 @@ export function LanguageDropdown() {
|
||||
e.stopPropagation()
|
||||
handleLanguageChange(code)
|
||||
}}
|
||||
onMouseEnter={() => setHoveredIndex(index)}
|
||||
onMouseLeave={() => setHoveredIndex(-1)}
|
||||
role='option'
|
||||
aria-selected={currentLang === code}
|
||||
className={`flex w-full cursor-pointer items-center gap-3 px-3 py-3 text-base transition-colors first:rounded-t-xl last:rounded-b-xl hover:bg-muted/80 focus:outline-none focus-visible:ring-2 focus-visible:ring-ring md:gap-2 md:px-2.5 md:py-2 md:text-sm ${
|
||||
currentLang === code ? 'bg-muted/60 font-medium text-primary' : 'text-foreground'
|
||||
}`}
|
||||
>
|
||||
<span className='text-base md:text-sm'>{lang.flag}</span>
|
||||
<span className='leading-none'>{lang.name}</span>
|
||||
{currentLang === code && (
|
||||
<Check className='ml-auto h-4 w-4 text-primary md:h-3.5 md:w-3.5' />
|
||||
aria-selected={isSelected}
|
||||
className={cn(
|
||||
'flex h-[26px] w-full min-w-0 cursor-pointer items-center gap-[8px] rounded-[6px] px-[6px] text-[13px] transition-colors',
|
||||
'text-neutral-700 dark:text-neutral-200',
|
||||
isHovered && 'bg-neutral-100 dark:bg-neutral-800',
|
||||
'focus:outline-none'
|
||||
)}
|
||||
>
|
||||
<span className='text-[13px]'>{lang.flag}</span>
|
||||
<span className='flex-1 text-left leading-none'>{lang.name}</span>
|
||||
{isSelected && <Check className='ml-auto h-3.5 w-3.5' />}
|
||||
</button>
|
||||
))}
|
||||
)
|
||||
})}
|
||||
</div>
|
||||
</>
|
||||
)}
|
||||
|
||||
108
apps/docs/components/ui/sim-logo.tsx
Normal file
108
apps/docs/components/ui/sim-logo.tsx
Normal file
@@ -0,0 +1,108 @@
|
||||
'use client'
|
||||
|
||||
import { cn } from '@/lib/utils'
|
||||
|
||||
interface SimLogoProps {
|
||||
className?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Sim logo with icon and text.
|
||||
* The icon stays green (#33C482), text adapts to light/dark mode.
|
||||
*/
|
||||
export function SimLogo({ className }: SimLogoProps) {
|
||||
return (
|
||||
<svg
|
||||
viewBox='720 440 320 320'
|
||||
fill='none'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
className={cn('h-7 w-auto', className)}
|
||||
aria-label='Sim'
|
||||
>
|
||||
{/* Green icon - top left shape with cutout */}
|
||||
<path
|
||||
fillRule='evenodd'
|
||||
clipRule='evenodd'
|
||||
d='M875.791 577.171C875.791 581.922 873.911 586.483 870.576 589.842L870.098 590.323C866.764 593.692 862.234 595.575 857.517 595.575H750.806C740.978 595.575 733 603.6 733 613.498V728.902C733 738.799 740.978 746.826 750.806 746.826H865.382C875.209 746.826 883.177 738.799 883.177 728.902V620.853C883.177 616.448 884.912 612.222 888.008 609.104C891.093 605.997 895.29 604.249 899.664 604.249H1008.16C1017.99 604.249 1025.96 596.224 1025.96 586.327V470.923C1025.96 461.025 1017.99 453 1008.16 453H893.586C883.759 453 875.791 461.025 875.791 470.923V577.171ZM910.562 477.566H991.178C996.922 477.566 1001.57 482.254 1001.57 488.029V569.22C1001.57 574.995 996.922 579.683 991.178 579.683H910.562C904.828 579.683 900.173 574.995 900.173 569.22V488.029C900.173 482.254 904.828 477.566 910.562 477.566Z'
|
||||
fill='#33C482'
|
||||
/>
|
||||
{/* Green icon - bottom right square */}
|
||||
<path
|
||||
d='M1008.3 624.59H923.113C912.786 624.59 904.414 633.022 904.414 643.423V728.171C904.414 738.572 912.786 747.004 923.113 747.004H1008.3C1018.63 747.004 1027 738.572 1027 728.171V643.423C1027 633.022 1018.63 624.59 1008.3 624.59Z'
|
||||
fill='#33C482'
|
||||
/>
|
||||
{/* Gradient overlay on bottom right square */}
|
||||
<path
|
||||
d='M1008.3 624.199H923.113C912.786 624.199 904.414 632.631 904.414 643.033V727.78C904.414 738.181 912.786 746.612 923.113 746.612H1008.3C1018.63 746.612 1027 738.181 1027 727.78V643.033C1027 632.631 1018.63 624.199 1008.3 624.199Z'
|
||||
fill='url(#sim-logo-gradient)'
|
||||
fillOpacity='0.2'
|
||||
/>
|
||||
<defs>
|
||||
<linearGradient
|
||||
id='sim-logo-gradient'
|
||||
x1='904.414'
|
||||
y1='624.199'
|
||||
x2='978.836'
|
||||
y2='698.447'
|
||||
gradientUnits='userSpaceOnUse'
|
||||
>
|
||||
<stop />
|
||||
<stop offset='1' stopOpacity='0' />
|
||||
</linearGradient>
|
||||
</defs>
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Full Sim logo with icon and "Sim" text.
|
||||
* The icon stays green (#33C482), text adapts to light/dark mode.
|
||||
*/
|
||||
export function SimLogoFull({ className }: SimLogoProps) {
|
||||
return (
|
||||
<svg
|
||||
viewBox='720 440 1020 320'
|
||||
fill='none'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
className={cn('h-7 w-auto', className)}
|
||||
aria-label='Sim'
|
||||
>
|
||||
{/* Green icon - top left shape with cutout */}
|
||||
<path
|
||||
fillRule='evenodd'
|
||||
clipRule='evenodd'
|
||||
d='M875.791 577.171C875.791 581.922 873.911 586.483 870.576 589.842L870.098 590.323C866.764 593.692 862.234 595.575 857.517 595.575H750.806C740.978 595.575 733 603.6 733 613.498V728.902C733 738.799 740.978 746.826 750.806 746.826H865.382C875.209 746.826 883.177 738.799 883.177 728.902V620.853C883.177 616.448 884.912 612.222 888.008 609.104C891.093 605.997 895.29 604.249 899.664 604.249H1008.16C1017.99 604.249 1025.96 596.224 1025.96 586.327V470.923C1025.96 461.025 1017.99 453 1008.16 453H893.586C883.759 453 875.791 461.025 875.791 470.923V577.171ZM910.562 477.566H991.178C996.922 477.566 1001.57 482.254 1001.57 488.029V569.22C1001.57 574.995 996.922 579.683 991.178 579.683H910.562C904.828 579.683 900.173 574.995 900.173 569.22V488.029C900.173 482.254 904.828 477.566 910.562 477.566Z'
|
||||
fill='#33C482'
|
||||
/>
|
||||
{/* Green icon - bottom right square */}
|
||||
<path
|
||||
d='M1008.3 624.59H923.113C912.786 624.59 904.414 633.022 904.414 643.423V728.171C904.414 738.572 912.786 747.004 923.113 747.004H1008.3C1018.63 747.004 1027 738.572 1027 728.171V643.423C1027 633.022 1018.63 624.59 1008.3 624.59Z'
|
||||
fill='#33C482'
|
||||
/>
|
||||
{/* Gradient overlay on bottom right square */}
|
||||
<path
|
||||
d='M1008.3 624.199H923.113C912.786 624.199 904.414 632.631 904.414 643.033V727.78C904.414 738.181 912.786 746.612 923.113 746.612H1008.3C1018.63 746.612 1027 738.181 1027 727.78V643.033C1027 632.631 1018.63 624.199 1008.3 624.199Z'
|
||||
fill='url(#sim-logo-full-gradient)'
|
||||
fillOpacity='0.2'
|
||||
/>
|
||||
{/* "Sim" text - adapts to light/dark mode via currentColor */}
|
||||
<path
|
||||
d='M1210.54 515.657C1226.65 515.657 1240.59 518.51 1252.31 524.257H1252.31C1264.3 529.995 1273.63 538.014 1280.26 548.319H1280.26C1287.19 558.635 1290.78 570.899 1291.08 585.068L1291.1 586.089H1249.11L1249.09 585.115C1248.8 574.003 1245.18 565.493 1238.32 559.451C1231.45 553.399 1221.79 550.308 1209.21 550.308C1196.3 550.308 1186.48 553.113 1179.61 558.588C1172.76 564.046 1169.33 571.499 1169.33 581.063C1169.33 588.092 1171.88 593.978 1177.01 598.783C1182.17 603.618 1189.99 607.399 1200.56 610.061H1200.56L1238.77 619.451C1257.24 623.65 1271.21 630.571 1280.57 640.293L1281.01 640.739C1290.13 650.171 1294.64 662.97 1294.64 679.016C1294.64 692.923 1290.88 705.205 1283.34 715.822L1283.33 715.834C1275.81 726.134 1265.44 734.14 1252.26 739.866L1252.25 739.871C1239.36 745.302 1224.12 748 1206.54 748C1180.9 748 1160.36 741.696 1145.02 728.984C1129.67 716.258 1122 699.269 1122 678.121V677.121H1163.99V678.121C1163.99 688.869 1167.87 697.367 1175.61 703.722L1176.34 704.284C1184.04 709.997 1194.37 712.902 1207.43 712.902C1222.13 712.902 1233.3 710.087 1241.07 704.588C1248.8 698.812 1252.64 691.21 1252.64 681.699C1252.64 674.769 1250.5 669.057 1246.25 664.49L1246.23 664.478L1246.22 664.464C1242.28 659.929 1234.83 656.119 1223.64 653.152L1185.43 644.208L1185.42 644.204C1166.05 639.407 1151.49 632.035 1141.83 622.012L1141.83 622.006L1141.82 622C1132.43 611.94 1127.78 598.707 1127.78 582.405C1127.78 568.81 1131.23 556.976 1138.17 546.949L1138.18 546.941L1138.19 546.933C1145.41 536.936 1155.18 529.225 1167.48 523.793L1167.48 523.79C1180.07 518.36 1194.43 515.657 1210.54 515.657ZM1323.39 521.979C1331.68 525.008 1337.55 526.482 1343.51 526.482C1349.48 526.482 1355.64 525.005 1364.49 521.973L1365.82 521.52V742.633H1322.05V521.489L1323.39 521.979ZM1642.01 515.657C1667.11 515.657 1686.94 523.031 1701.39 537.876C1715.83 552.716 1723 572.968 1723 598.507V742.633H1680.12V608.794C1680.12 591.666 1675.72 578.681 1667.07 569.681L1667.06 569.669L1667.04 569.656C1658.67 560.359 1647.26 555.675 1632.68 555.675C1622.47 555.675 1613.47 558.022 1605.64 562.69L1605.63 562.696C1598.11 567.064 1592.17 573.475 1587.8 581.968C1583.44 590.448 1581.25 600.424 1581.25 611.925V742.633H1537.92V608.347C1537.92 591.208 1533.67 578.376 1525.31 569.68L1525.31 569.674L1525.3 569.668C1516.93 560.664 1505.52 556.122 1490.93 556.122C1480.72 556.122 1471.72 558.469 1463.89 563.138L1463.88 563.144C1456.36 567.511 1450.41 573.922 1446.05 582.415L1446.05 582.422L1446.04 582.428C1441.69 590.602 1439.5 600.423 1439.5 611.925V742.633H1395.72V521.919H1435.05V554.803C1439.92 544.379 1447.91 535.465 1458.37 528.356C1470.71 519.875 1485.58 515.657 1502.93 515.657C1522.37 515.657 1538.61 520.931 1551.55 531.538C1560.38 538.771 1567.1 547.628 1571.72 558.091C1576.05 547.619 1582.83 538.757 1592.07 531.524C1605.61 520.93 1622.28 515.657 1642.01 515.657ZM1343.49 452C1351.45 452 1358.23 454.786 1363.75 460.346C1369.27 465.905 1372.04 472.721 1372.04 480.73C1372.04 488.452 1369.27 495.254 1363.77 501.096L1363.76 501.105L1363.75 501.115C1358.23 506.675 1351.45 509.461 1343.49 509.461C1335.81 509.461 1329.05 506.669 1323.25 501.134L1323.23 501.115L1323.21 501.096C1317.71 495.254 1314.94 488.452 1314.94 480.73C1314.94 472.721 1317.7 465.905 1323.23 460.346L1323.24 460.337L1323.25 460.327C1329.05 454.792 1335.81 452 1343.49 452Z'
|
||||
className='fill-neutral-900 dark:fill-white'
|
||||
/>
|
||||
<defs>
|
||||
<linearGradient
|
||||
id='sim-logo-full-gradient'
|
||||
x1='904.414'
|
||||
y1='624.199'
|
||||
x2='978.836'
|
||||
y2='698.447'
|
||||
gradientUnits='userSpaceOnUse'
|
||||
>
|
||||
<stop />
|
||||
<stop offset='1' stopOpacity='0' />
|
||||
</linearGradient>
|
||||
</defs>
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
@@ -17,7 +17,7 @@ MCP-Server gruppieren Ihre Workflow-Tools zusammen. Erstellen und verwalten Sie
|
||||
<Video src="mcp/mcp-server.mp4" width={700} height={450} />
|
||||
</div>
|
||||
|
||||
1. Navigieren Sie zu **Einstellungen → Bereitgestellte MCPs**
|
||||
1. Navigieren Sie zu **Einstellungen → MCP-Server**
|
||||
2. Klicken Sie auf **Server erstellen**
|
||||
3. Geben Sie einen Namen und eine optionale Beschreibung ein
|
||||
4. Kopieren Sie die Server-URL zur Verwendung in Ihren MCP-Clients
|
||||
@@ -79,7 +79,7 @@ Füge deinen API-Key-Header (`X-API-Key`) für authentifizierten Zugriff hinzu,
|
||||
|
||||
## Server-Verwaltung
|
||||
|
||||
In der Server-Detailansicht unter **Einstellungen → Bereitgestellte MCPs** können Sie:
|
||||
In der Server-Detailansicht unter **Einstellungen → MCP-Server** können Sie:
|
||||
|
||||
- **Tools anzeigen**: Alle Workflows sehen, die einem Server hinzugefügt wurden
|
||||
- **URL kopieren**: Die Server-URL für MCP-Clients abrufen
|
||||
|
||||
@@ -27,7 +27,7 @@ MCP-Server stellen Sammlungen von Tools bereit, die Ihre Agenten nutzen können.
|
||||
</div>
|
||||
|
||||
1. Navigieren Sie zu Ihren Workspace-Einstellungen
|
||||
2. Gehen Sie zum Abschnitt **Bereitgestellte MCPs**
|
||||
2. Gehen Sie zum Abschnitt **MCP-Server**
|
||||
3. Klicken Sie auf **MCP-Server hinzufügen**
|
||||
4. Geben Sie die Server-Konfigurationsdetails ein
|
||||
5. Speichern Sie die Konfiguration
|
||||
|
||||
@@ -10,12 +10,20 @@ Stellen Sie Sim auf Ihrer eigenen Infrastruktur mit Docker oder Kubernetes berei
|
||||
|
||||
## Anforderungen
|
||||
|
||||
| Ressource | Minimum | Empfohlen |
|
||||
|----------|---------|-------------|
|
||||
| CPU | 2 Kerne | 4+ Kerne |
|
||||
| RAM | 12 GB | 16+ GB |
|
||||
| Speicher | 20 GB SSD | 50+ GB SSD |
|
||||
| Docker | 20.10+ | Neueste Version |
|
||||
| Ressource | Klein | Standard | Produktion |
|
||||
|----------|-------|----------|------------|
|
||||
| CPU | 2 Kerne | 4 Kerne | 8+ Kerne |
|
||||
| RAM | 12 GB | 16 GB | 32+ GB |
|
||||
| Speicher | 20 GB SSD | 50 GB SSD | 100+ GB SSD |
|
||||
| Docker | 20.10+ | 20.10+ | Neueste Version |
|
||||
|
||||
**Klein**: Entwicklung, Tests, Einzelnutzer (1-5 Nutzer)
|
||||
**Standard**: Teams (5-50 Nutzer), moderate Arbeitslasten
|
||||
**Produktion**: Große Teams (50+ Nutzer), Hochverfügbarkeit, intensive Workflow-Ausführung
|
||||
|
||||
<Callout type="info">
|
||||
Die Ressourcenanforderungen werden durch Workflow-Ausführung (isolated-vm Sandboxing), Dateiverarbeitung (In-Memory-Dokumentenparsing) und Vektoroperationen (pgvector) bestimmt. Arbeitsspeicher ist typischerweise der limitierende Faktor, nicht CPU. Produktionsdaten zeigen, dass die Hauptanwendung durchschnittlich 4-8 GB und bei hoher Last bis zu 12 GB benötigt.
|
||||
</Callout>
|
||||
|
||||
## Schnellstart
|
||||
|
||||
|
||||
@@ -56,6 +56,10 @@ Controls response randomness and creativity:
|
||||
- **Medium (0.3-0.7)**: Balanced creativity and focus. Good for general use.
|
||||
- **High (0.7-2.0)**: Creative and varied. Ideal for brainstorming and content generation.
|
||||
|
||||
### Max Output Tokens
|
||||
|
||||
Controls the maximum length of the model's response. For Anthropic models, Sim uses reliable defaults: streaming executions use the model's full capacity (e.g. 64,000 tokens for Claude 4.5), while non-streaming executions default to 8,192 to avoid timeout issues. When using tools with Anthropic models, intermediate tool-calling requests use a capped limit of 8,192 tokens to avoid SDK timeout errors, regardless of your configured max tokens—the final streaming response uses your full configured limit. This only affects Anthropic's direct API; AWS Bedrock handles this automatically. For long-form content generation via API, explicitly set a higher value.
|
||||
|
||||
### API Key
|
||||
|
||||
Your API key for the selected LLM provider. This is securely stored and used for authentication.
|
||||
|
||||
@@ -5,45 +5,25 @@ title: Copilot
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Card, Cards } from 'fumadocs-ui/components/card'
|
||||
import { Image } from '@/components/ui/image'
|
||||
import { MessageCircle, Package, Zap, Infinity as InfinityIcon, Brain, BrainCircuit } from 'lucide-react'
|
||||
import { MessageCircle, Hammer, Zap, Globe, Paperclip, History, RotateCcw, Brain } from 'lucide-react'
|
||||
|
||||
Copilot is your in-editor assistant that helps you build and edit workflows with Sim Copilot, as well as understand and improve them. It can:
|
||||
Copilot is your in-editor assistant that helps you build and edit workflows. It can:
|
||||
|
||||
- **Explain**: Answer questions about Sim and your current workflow
|
||||
- **Guide**: Suggest edits and best practices
|
||||
- **Edit**: Make changes to blocks, connections, and settings when you approve
|
||||
- **Build**: Add blocks, wire connections, and configure settings
|
||||
- **Debug**: Analyze execution issues and optimize performance
|
||||
|
||||
<Callout type="info">
|
||||
Copilot is a Sim-managed service. For self-hosted deployments, generate a Copilot API key in the hosted app (sim.ai → Settings → Copilot)
|
||||
Copilot is a Sim-managed service. For self-hosted deployments:
|
||||
1. Go to [sim.ai](https://sim.ai) → Settings → Copilot and generate a Copilot API key
|
||||
2. Set `COPILOT_API_KEY` in your self-hosted environment to that value
|
||||
2. Set `COPILOT_API_KEY` in your self-hosted environment
|
||||
</Callout>
|
||||
|
||||
## Context Menu (@)
|
||||
|
||||
Use the `@` symbol to reference various resources and give Copilot more context about your workspace:
|
||||
|
||||
<Image
|
||||
src="/static/copilot/copilot-menu.png"
|
||||
alt="Copilot context menu showing available reference options"
|
||||
width={600}
|
||||
height={400}
|
||||
/>
|
||||
|
||||
The `@` menu provides access to:
|
||||
- **Chats**: Reference previous copilot conversations
|
||||
- **All workflows**: Reference any workflow in your workspace
|
||||
- **Workflow Blocks**: Reference specific blocks from workflows
|
||||
- **Blocks**: Reference block types and templates
|
||||
- **Knowledge**: Reference your uploaded documents and knowledgebase
|
||||
- **Docs**: Reference Sim documentation
|
||||
- **Templates**: Reference workflow templates
|
||||
- **Logs**: Reference execution logs and results
|
||||
|
||||
This contextual information helps Copilot provide more accurate and relevant assistance for your specific use case.
|
||||
|
||||
## Modes
|
||||
|
||||
Switch between modes using the mode selector at the bottom of the input area.
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
title={
|
||||
@@ -60,113 +40,153 @@ This contextual information helps Copilot provide more accurate and relevant ass
|
||||
<Card
|
||||
title={
|
||||
<span className="inline-flex items-center gap-2">
|
||||
<Package className="h-4 w-4 text-muted-foreground" />
|
||||
Agent
|
||||
<Hammer className="h-4 w-4 text-muted-foreground" />
|
||||
Build
|
||||
</span>
|
||||
}
|
||||
>
|
||||
<div className="m-0 text-sm">
|
||||
Build-and-edit mode. Copilot proposes specific edits (add blocks, wire variables, tweak settings) and applies them when you approve.
|
||||
Workflow building mode. Copilot can add blocks, wire connections, edit configurations, and debug issues.
|
||||
</div>
|
||||
</Card>
|
||||
</Cards>
|
||||
|
||||
<div className="flex justify-center">
|
||||
<Image
|
||||
src="/static/copilot/copilot-mode.png"
|
||||
alt="Copilot mode selection interface"
|
||||
width={600}
|
||||
height={400}
|
||||
className="my-6"
|
||||
/>
|
||||
</div>
|
||||
## Models
|
||||
|
||||
## Depth Levels
|
||||
Select your preferred AI model using the model selector at the bottom right of the input area.
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
title={
|
||||
<span className="inline-flex items-center gap-2">
|
||||
<Zap className="h-4 w-4 text-muted-foreground" />
|
||||
Fast
|
||||
</span>
|
||||
}
|
||||
>
|
||||
<div className="m-0 text-sm">Quickest and cheapest. Best for small edits, simple workflows, and minor tweaks.</div>
|
||||
</Card>
|
||||
<Card
|
||||
title={
|
||||
<span className="inline-flex items-center gap-2">
|
||||
<InfinityIcon className="h-4 w-4 text-muted-foreground" />
|
||||
Auto
|
||||
</span>
|
||||
}
|
||||
>
|
||||
<div className="m-0 text-sm">Balanced speed and reasoning. Recommended default for most tasks.</div>
|
||||
</Card>
|
||||
<Card
|
||||
title={
|
||||
<span className="inline-flex items-center gap-2">
|
||||
<Brain className="h-4 w-4 text-muted-foreground" />
|
||||
Advanced
|
||||
</span>
|
||||
}
|
||||
>
|
||||
<div className="m-0 text-sm">More reasoning for larger workflows and complex edits while staying performant.</div>
|
||||
</Card>
|
||||
<Card
|
||||
title={
|
||||
<span className="inline-flex items-center gap-2">
|
||||
<BrainCircuit className="h-4 w-4 text-muted-foreground" />
|
||||
Behemoth
|
||||
</span>
|
||||
}
|
||||
>
|
||||
<div className="m-0 text-sm">Maximum reasoning for deep planning, debugging, and complex architectural changes.</div>
|
||||
</Card>
|
||||
</Cards>
|
||||
**Available Models:**
|
||||
- Claude 4.5 Opus, Sonnet (default), Haiku
|
||||
- GPT 5.2 Codex, Pro
|
||||
- Gemini 3 Pro
|
||||
|
||||
### Mode Selection Interface
|
||||
Choose based on your needs: faster models for simple tasks, more capable models for complex workflows.
|
||||
|
||||
You can easily switch between different reasoning modes using the mode selector in the Copilot interface:
|
||||
## Context Menu (@)
|
||||
|
||||
<Image
|
||||
src="/static/copilot/copilot-models.png"
|
||||
alt="Copilot mode selection showing Advanced mode with MAX toggle"
|
||||
width={600}
|
||||
height={300}
|
||||
/>
|
||||
Use the `@` symbol to reference resources and give Copilot more context:
|
||||
|
||||
The interface allows you to:
|
||||
- **Select reasoning level**: Choose from Fast, Auto, Advanced, or Behemoth
|
||||
- **Enable MAX mode**: Toggle for maximum reasoning capabilities when you need the most thorough analysis
|
||||
- **See mode descriptions**: Understand what each mode is optimized for
|
||||
| Reference | Description |
|
||||
|-----------|-------------|
|
||||
| **Chats** | Previous copilot conversations |
|
||||
| **Workflows** | Any workflow in your workspace |
|
||||
| **Workflow Blocks** | Blocks in the current workflow |
|
||||
| **Blocks** | Block types and templates |
|
||||
| **Knowledge** | Uploaded documents and knowledge bases |
|
||||
| **Docs** | Sim documentation |
|
||||
| **Templates** | Workflow templates |
|
||||
| **Logs** | Execution logs and results |
|
||||
|
||||
Choose your mode based on the complexity of your task - use Fast for simple questions and Behemoth for complex architectural changes.
|
||||
Type `@` in the input field to open the context menu, then search or browse to find what you need.
|
||||
|
||||
## Billing and Cost Calculation
|
||||
## Slash Commands (/)
|
||||
|
||||
### How Costs Are Calculated
|
||||
Use slash commands for quick actions:
|
||||
|
||||
Copilot usage is billed per token from the underlying LLM:
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `/fast` | Fast mode execution |
|
||||
| `/research` | Research and exploration mode |
|
||||
| `/actions` | Execute agent actions |
|
||||
|
||||
- **Input tokens**: billed at the provider's base rate (**at-cost**)
|
||||
- **Output tokens**: billed at **1.5×** the provider's base output rate
|
||||
**Web Commands:**
|
||||
|
||||
```javascript
|
||||
copilotCost = (inputTokens × inputPrice + outputTokens × (outputPrice × 1.5)) / 1,000,000
|
||||
```
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `/search` | Search the web |
|
||||
| `/read` | Read a specific URL |
|
||||
| `/scrape` | Scrape web page content |
|
||||
| `/crawl` | Crawl multiple pages |
|
||||
|
||||
| Component | Rate Applied |
|
||||
|----------|----------------------|
|
||||
| Input | inputPrice |
|
||||
| Output | outputPrice × 1.5 |
|
||||
Type `/` in the input field to see available commands.
|
||||
|
||||
<Callout type="warning">
|
||||
Pricing shown reflects rates as of September 4, 2025. Check provider documentation for current pricing.
|
||||
</Callout>
|
||||
## Chat Management
|
||||
|
||||
### Starting a New Chat
|
||||
|
||||
Click the **+** button in the Copilot header to start a fresh conversation.
|
||||
|
||||
### Chat History
|
||||
|
||||
Click **History** to view previous conversations grouped by date. You can:
|
||||
- Click a chat to resume it
|
||||
- Delete chats you no longer need
|
||||
|
||||
### Editing Messages
|
||||
|
||||
Hover over any of your messages and click **Edit** to modify and resend it. This is useful for refining your prompts.
|
||||
|
||||
### Message Queue
|
||||
|
||||
If you send a message while Copilot is still responding, it gets queued. You can:
|
||||
- View queued messages in the expandable queue panel
|
||||
- Send a queued message immediately (aborts current response)
|
||||
- Remove messages from the queue
|
||||
|
||||
## File Attachments
|
||||
|
||||
Click the attachment icon to upload files with your message. Supported file types include:
|
||||
- Images (preview thumbnails shown)
|
||||
- PDFs
|
||||
- Text files, JSON, XML
|
||||
- Other document formats
|
||||
|
||||
Files are displayed as clickable thumbnails that open in a new tab.
|
||||
|
||||
## Checkpoints & Changes
|
||||
|
||||
When Copilot makes changes to your workflow, it saves checkpoints so you can revert if needed.
|
||||
|
||||
### Viewing Checkpoints
|
||||
|
||||
Hover over a Copilot message and click the checkpoints icon to see saved workflow states for that message.
|
||||
|
||||
### Reverting Changes
|
||||
|
||||
Click **Revert** on any checkpoint to restore your workflow to that state. A confirmation dialog will warn that this action cannot be undone.
|
||||
|
||||
### Accepting Changes
|
||||
|
||||
When Copilot proposes changes, you can:
|
||||
- **Accept**: Apply the proposed changes (`Mod+Shift+Enter`)
|
||||
- **Reject**: Dismiss the changes and keep your current workflow
|
||||
|
||||
## Thinking Blocks
|
||||
|
||||
For complex requests, Copilot may show its reasoning process in expandable thinking blocks:
|
||||
|
||||
- Blocks auto-expand while Copilot is thinking
|
||||
- Click to manually expand/collapse
|
||||
- Shows duration of the thinking process
|
||||
- Helps you understand how Copilot arrived at its solution
|
||||
|
||||
## Options Selection
|
||||
|
||||
When Copilot presents multiple options, you can select using:
|
||||
|
||||
| Control | Action |
|
||||
|---------|--------|
|
||||
| **1-9** | Select option by number |
|
||||
| **Arrow Up/Down** | Navigate between options |
|
||||
| **Enter** | Select highlighted option |
|
||||
|
||||
Selected options are highlighted; unselected options appear struck through.
|
||||
|
||||
## Keyboard Shortcuts
|
||||
|
||||
| Shortcut | Action |
|
||||
|----------|--------|
|
||||
| `@` | Open context menu |
|
||||
| `/` | Open slash commands |
|
||||
| `Arrow Up/Down` | Navigate menu items |
|
||||
| `Enter` | Select menu item |
|
||||
| `Esc` | Close menus |
|
||||
| `Mod+Shift+Enter` | Accept Copilot changes |
|
||||
|
||||
## Usage Limits
|
||||
|
||||
Copilot usage is billed per token from the underlying LLM. If you reach your usage limit, Copilot will prompt you to increase your limit. You can add usage in increments ($50, $100) from your current base.
|
||||
|
||||
<Callout type="info">
|
||||
Model prices are per million tokens. The calculation divides by 1,000,000 to get the actual cost. See <a href="/execution/costs">the Cost Calculation page</a> for background and examples.
|
||||
See the [Cost Calculation page](/execution/costs) for billing details.
|
||||
</Callout>
|
||||
|
||||
|
||||
@@ -34,6 +34,8 @@ Speed up your workflow building with these keyboard shortcuts and mouse controls
|
||||
| `Mod` + `V` | Paste blocks |
|
||||
| `Delete` or `Backspace` | Delete selected blocks or edges |
|
||||
| `Shift` + `L` | Auto-layout canvas |
|
||||
| `Mod` + `Shift` + `F` | Fit to view |
|
||||
| `Mod` + `Shift` + `Enter` | Accept Copilot changes |
|
||||
|
||||
## Panel Navigation
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ MCP servers group your workflow tools together. Create and manage them in worksp
|
||||
<Video src="mcp/mcp-server.mp4" width={700} height={450} />
|
||||
</div>
|
||||
|
||||
1. Navigate to **Settings → Deployed MCPs**
|
||||
1. Navigate to **Settings → MCP Servers**
|
||||
2. Click **Create Server**
|
||||
3. Enter a name and optional description
|
||||
4. Copy the server URL for use in your MCP clients
|
||||
@@ -78,7 +78,7 @@ Include your API key header (`X-API-Key`) for authenticated access when using mc
|
||||
|
||||
## Server Management
|
||||
|
||||
From the server detail view in **Settings → Deployed MCPs**, you can:
|
||||
From the server detail view in **Settings → MCP Servers**, you can:
|
||||
|
||||
- **View tools**: See all workflows added to a server
|
||||
- **Copy URL**: Get the server URL for MCP clients
|
||||
|
||||
@@ -27,7 +27,7 @@ MCP servers provide collections of tools that your agents can use. Configure the
|
||||
</div>
|
||||
|
||||
1. Navigate to your workspace settings
|
||||
2. Go to the **Deployed MCPs** section
|
||||
2. Go to the **MCP Servers** section
|
||||
3. Click **Add MCP Server**
|
||||
4. Enter the server configuration details
|
||||
5. Save the configuration
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
"pages": [
|
||||
"./introduction/index",
|
||||
"./getting-started/index",
|
||||
"./quick-reference/index",
|
||||
"triggers",
|
||||
"blocks",
|
||||
"tools",
|
||||
|
||||
390
apps/docs/content/docs/en/quick-reference/index.mdx
Normal file
390
apps/docs/content/docs/en/quick-reference/index.mdx
Normal file
@@ -0,0 +1,390 @@
|
||||
---
|
||||
title: Quick Reference
|
||||
description: Essential actions for navigating and using the Sim workflow editor
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { ActionImage, ActionVideo } from '@/components/ui/action-media'
|
||||
|
||||
A quick lookup for everyday actions in the Sim workflow editor. For keyboard shortcuts, see [Keyboard Shortcuts](/keyboard-shortcuts).
|
||||
|
||||
<Callout type="info">
|
||||
**Mod** refers to `Cmd` on macOS and `Ctrl` on Windows/Linux.
|
||||
</Callout>
|
||||
|
||||
## Workspaces
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Action</th><th>How</th><th>Preview</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Create a workspace</td>
|
||||
<td>Click workspace dropdown → **New Workspace**</td>
|
||||
<td><ActionVideo src="quick-reference/create-workspace.mp4" alt="Create workspace" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Switch workspaces</td>
|
||||
<td>Click workspace dropdown → Select workspace</td>
|
||||
<td><ActionVideo src="quick-reference/switch-workspace.mp4" alt="Switch workspaces" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Invite team members</td>
|
||||
<td>Sidebar → **Invite**</td>
|
||||
<td><ActionVideo src="quick-reference/invite.mp4" alt="Invite team members" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Rename a workspace</td>
|
||||
<td>Right-click workspace → **Rename**</td>
|
||||
<td rowSpan={4}><ActionImage src="/static/quick-reference/workspace-context-menu.png" alt="Workspace context menu" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Duplicate a workspace</td>
|
||||
<td>Right-click workspace → **Duplicate**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Export a workspace</td>
|
||||
<td>Right-click workspace → **Export**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Delete a workspace</td>
|
||||
<td>Right-click workspace → **Delete**</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Workflows
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Action</th><th>How</th><th>Preview</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Create a workflow</td>
|
||||
<td>Click **+** button in sidebar</td>
|
||||
<td><ActionImage src="/static/quick-reference/create-workflow.png" alt="Create workflow" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Reorder / move workflows</td>
|
||||
<td>Drag workflow up/down or onto a folder</td>
|
||||
<td><ActionVideo src="quick-reference/reordering.mp4" alt="Reorder workflows" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Import a workflow</td>
|
||||
<td>Click import button in sidebar → Select file</td>
|
||||
<td><ActionImage src="/static/quick-reference/import-workflow.png" alt="Import workflow" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Multi-select workflows</td>
|
||||
<td>`Mod+Click` or `Shift+Click` workflows in sidebar</td>
|
||||
<td><ActionVideo src="quick-reference/multiselect.mp4" alt="Multi-select workflows" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Open in new tab</td>
|
||||
<td>Right-click workflow → **Open in New Tab**</td>
|
||||
<td rowSpan={6}><ActionImage src="/static/quick-reference/workflow-context-menu.png" alt="Workflow context menu" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Rename a workflow</td>
|
||||
<td>Right-click workflow → **Rename**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Assign workflow color</td>
|
||||
<td>Right-click workflow → **Change Color**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Duplicate a workflow</td>
|
||||
<td>Right-click workflow → **Duplicate**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Export a workflow</td>
|
||||
<td>Right-click workflow → **Export**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Delete a workflow</td>
|
||||
<td>Right-click workflow → **Delete**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Rename a folder</td>
|
||||
<td>Right-click folder → **Rename**</td>
|
||||
<td rowSpan={6}><ActionImage src="/static/quick-reference/folder-context-menu.png" alt="Folder context menu" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Create workflow in folder</td>
|
||||
<td>Right-click folder → **Create workflow**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Create folder in folder</td>
|
||||
<td>Right-click folder → **Create folder**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Duplicate a folder</td>
|
||||
<td>Right-click folder → **Duplicate**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Export a folder</td>
|
||||
<td>Right-click folder → **Export**</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Delete a folder</td>
|
||||
<td>Right-click folder → **Delete**</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Blocks
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Action</th><th>How</th><th>Preview</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Add a block</td>
|
||||
<td>Drag from Toolbar panel, or right-click canvas → **Add Block**</td>
|
||||
<td><ActionVideo src="quick-reference/add-block.mp4" alt="Add a block" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Multi-select blocks</td>
|
||||
<td>`Mod+Click` additional blocks, or shift-drag to draw selection box</td>
|
||||
<td><ActionVideo src="quick-reference/multiselect-blocks.mp4" alt="Multi-select blocks" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Copy blocks</td>
|
||||
<td>`Mod+C` with blocks selected</td>
|
||||
<td rowSpan={2}><ActionVideo src="quick-reference/copy-paste.mp4" alt="Copy and paste blocks" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Paste blocks</td>
|
||||
<td>`Mod+V` to paste copied blocks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Duplicate blocks</td>
|
||||
<td>Right-click → **Duplicate**</td>
|
||||
<td><ActionVideo src="quick-reference/duplicate-block.mp4" alt="Duplicate blocks" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Delete blocks</td>
|
||||
<td>`Delete` or `Backspace` key, or right-click → **Delete**</td>
|
||||
<td><ActionImage src="/static/quick-reference/delete-block.png" alt="Delete block" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Rename a block</td>
|
||||
<td>Click block name in header, or edit in the Editor panel</td>
|
||||
<td><ActionVideo src="quick-reference/rename-block.mp4" alt="Rename a block" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Enable/Disable a block</td>
|
||||
<td>Right-click → **Enable/Disable**</td>
|
||||
<td><ActionImage src="/static/quick-reference/disable-block.png" alt="Disable block" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Toggle handle orientation</td>
|
||||
<td>Right-click → **Toggle Handles**</td>
|
||||
<td><ActionVideo src="quick-reference/toggle-handles.mp4" alt="Toggle handle orientation" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Configure a block</td>
|
||||
<td>Select block → use Editor panel on right</td>
|
||||
<td><ActionVideo src="quick-reference/configure-block.mp4" alt="Configure a block" /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Connections
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Action</th><th>How</th><th>Preview</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Create a connection</td>
|
||||
<td>Drag from output handle to input handle</td>
|
||||
<td><ActionVideo src="quick-reference/connect-blocks.mp4" alt="Connect blocks" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Delete a connection</td>
|
||||
<td>Click edge to select → `Delete` key</td>
|
||||
<td><ActionVideo src="quick-reference/delete-connection.mp4" alt="Delete connection" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Use output in another block</td>
|
||||
<td>Drag connection tag into input field</td>
|
||||
<td><ActionVideo src="quick-reference/connection-tag.mp4" alt="Use connection tag" /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Panels & Views
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Action</th><th>How</th><th>Preview</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Search toolbar</td>
|
||||
<td>`Mod+F`</td>
|
||||
<td><ActionVideo src="quick-reference/search-toolbar.mp4" alt="Search toolbar" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Search everything</td>
|
||||
<td>`Mod+K`</td>
|
||||
<td><ActionImage src="/static/quick-reference/search-everything.png" alt="Search everything" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Toggle manual mode</td>
|
||||
<td>Click toggle button to switch between manual and selector</td>
|
||||
<td><ActionImage src="/static/quick-reference/toggle-manual-mode.png" alt="Toggle manual mode" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Collapse/expand sidebar</td>
|
||||
<td>Click collapse button on sidebar</td>
|
||||
<td><ActionVideo src="quick-reference/collapse-sidebar.mp4" alt="Collapse sidebar" /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Running & Testing
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Action</th><th>How</th><th>Preview</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Run workflow</td>
|
||||
<td>Click Run Workflow button or `Mod+Enter`</td>
|
||||
<td><ActionImage src="/static/quick-reference/run-workflow.png" alt="Run workflow" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stop workflow</td>
|
||||
<td>Click Stop button or `Mod+Enter` while running</td>
|
||||
<td><ActionImage src="/static/quick-reference/stop-workflow.png" alt="Stop workflow" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Test with chat</td>
|
||||
<td>Use Chat panel on the right side</td>
|
||||
<td><ActionImage src="/static/quick-reference/test-chat.png" alt="Test with chat" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Select output to view</td>
|
||||
<td>Click dropdown in Chat panel → Select block output</td>
|
||||
<td><ActionImage src="/static/quick-reference/output-select.png" alt="Select output to view" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Clear chat history</td>
|
||||
<td>Click clear button in Chat panel</td>
|
||||
<td><ActionImage src="/static/quick-reference/clear-chat.png" alt="Clear chat history" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Run from block</td>
|
||||
<td>Hover block → Click play button, or right-click → **Run from block**</td>
|
||||
<td><ActionImage src="/static/quick-reference/run-from-block.png" alt="Run from block" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Run until block</td>
|
||||
<td>Right-click block → **Run until block**</td>
|
||||
<td><ActionImage src="/static/quick-reference/run-until-block.png" alt="Run until block" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>View execution logs</td>
|
||||
<td>Open terminal panel at bottom, or `Mod+L`</td>
|
||||
<td><ActionImage src="/static/quick-reference/terminal.png" alt="Execution logs terminal" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Filter logs</td>
|
||||
<td>Click filter icon in terminal → Filter by block or status</td>
|
||||
<td><ActionImage src="/static/quick-reference/filter-block.png" alt="Filter logs by block" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Search logs</td>
|
||||
<td>Use search field in terminal or right-click log entry → **Search**</td>
|
||||
<td><ActionImage src="/static/quick-reference/terminal-search.png" alt="Search logs" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Copy log entry</td>
|
||||
<td>Clipboard Icon or Right-click log entry → **Copy**</td>
|
||||
<td><ActionImage src="/static/quick-reference/copy-log.png" alt="Copy log entry" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Clear terminal</td>
|
||||
<td>Trash icon or `Mod+D`</td>
|
||||
<td><ActionImage src="/static/quick-reference/clear-terminal.png" alt="Clear terminal" /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Deployment
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Action</th><th>How</th><th>Preview</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Deploy a workflow</td>
|
||||
<td>Click **Deploy** button in panel</td>
|
||||
<td><ActionImage src="/static/quick-reference/deploy.png" alt="Deploy workflow" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Update deployment</td>
|
||||
<td>Click **Update** when changes are detected</td>
|
||||
<td><ActionImage src="/static/quick-reference/update-deployment.png" alt="Update deployment" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>View deployment status</td>
|
||||
<td>Check status indicator (Live/Update/Deploy) in Deploy tab</td>
|
||||
<td><ActionImage src="/static/quick-reference/view-deployment.png" alt="View deployment status" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Revert deployment</td>
|
||||
<td>Access previous versions in Deploy tab → **Promote to live**</td>
|
||||
<td><ActionImage src="/static/quick-reference/promote-deployment.png" alt="Promote deployment to live" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Add version description</td>
|
||||
<td>Deploy tab → Click description icon → Add or generate description</td>
|
||||
<td><ActionVideo src="quick-reference/deployment-description.mp4" alt="Add deployment version description" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Copy API endpoint</td>
|
||||
<td>Deploy tab → API → Copy API cURL</td>
|
||||
<td><ActionImage src="/static/quick-reference/copy-api.png" alt="Copy API endpoint" /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Variables
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Action</th><th>How</th><th>Preview</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Add / Edit / Delete workflow variable</td>
|
||||
<td>Panel -> Variables -> **Add Variable**, click to edit, or delete icon</td>
|
||||
<td><ActionImage src="/static/quick-reference/variables.png" alt="Variables panel" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Add environment variable</td>
|
||||
<td>Settings → **Environment Variables** → **Add**</td>
|
||||
<td><ActionImage src="/static/quick-reference/add-env-variable.png" alt="Add environment variable" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Reference a workflow variable</td>
|
||||
<td>Use `<blockName.itemName>` syntax in block inputs</td>
|
||||
<td><ActionImage src="/static/quick-reference/variable-reference.png" alt="Reference workflow variable" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Reference an environment variable</td>
|
||||
<td>Use `{{ENV_VAR}}` syntax in block inputs</td>
|
||||
<td><ActionImage src="/static/quick-reference/env-variable-reference.png" alt="Reference environment variable" /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@@ -16,12 +16,20 @@ Deploy Sim on your own infrastructure with Docker or Kubernetes.
|
||||
|
||||
## Requirements
|
||||
|
||||
| Resource | Minimum | Recommended |
|
||||
|----------|---------|-------------|
|
||||
| CPU | 2 cores | 4+ cores |
|
||||
| RAM | 12 GB | 16+ GB |
|
||||
| Storage | 20 GB SSD | 50+ GB SSD |
|
||||
| Docker | 20.10+ | Latest |
|
||||
| Resource | Small | Standard | Production |
|
||||
|----------|-------|----------|------------|
|
||||
| CPU | 2 cores | 4 cores | 8+ cores |
|
||||
| RAM | 12 GB | 16 GB | 32+ GB |
|
||||
| Storage | 20 GB SSD | 50 GB SSD | 100+ GB SSD |
|
||||
| Docker | 20.10+ | 20.10+ | Latest |
|
||||
|
||||
**Small**: Development, testing, single user (1-5 users)
|
||||
**Standard**: Teams (5-50 users), moderate workloads
|
||||
**Production**: Large teams (50+ users), high availability, heavy workflow execution
|
||||
|
||||
<Callout type="info">
|
||||
Resource requirements are driven by workflow execution (isolated-vm sandboxing), file processing (in-memory document parsing), and vector operations (pgvector). Memory is typically the constraining factor rather than CPU. Production telemetry shows the main app uses 4-8 GB average with peaks up to 12 GB under heavy load.
|
||||
</Callout>
|
||||
|
||||
## Quick Start
|
||||
|
||||
|
||||
@@ -52,12 +52,12 @@ Send a message to an external A2A-compatible agent.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | The text response from the agent |
|
||||
| `taskId` | string | Task ID for follow-up interactions |
|
||||
| `contextId` | string | Context ID for conversation continuity |
|
||||
| `state` | string | Task state |
|
||||
| `artifacts` | array | Structured output artifacts |
|
||||
| `history` | array | Full message history |
|
||||
| `content` | string | Text response content from the agent |
|
||||
| `taskId` | string | Unique task identifier |
|
||||
| `contextId` | string | Groups related tasks/messages |
|
||||
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) |
|
||||
| `artifacts` | array | Task output artifacts |
|
||||
| `history` | array | Conversation history \(Message array\) |
|
||||
|
||||
### `a2a_get_task`
|
||||
|
||||
@@ -76,11 +76,11 @@ Query the status of an existing A2A task.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `taskId` | string | Task ID |
|
||||
| `contextId` | string | Context ID |
|
||||
| `state` | string | Task state |
|
||||
| `artifacts` | array | Output artifacts |
|
||||
| `history` | array | Message history |
|
||||
| `taskId` | string | Unique task identifier |
|
||||
| `contextId` | string | Groups related tasks/messages |
|
||||
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) |
|
||||
| `artifacts` | array | Task output artifacts |
|
||||
| `history` | array | Conversation history \(Message array\) |
|
||||
|
||||
### `a2a_cancel_task`
|
||||
|
||||
@@ -99,7 +99,7 @@ Cancel a running A2A task.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `cancelled` | boolean | Whether cancellation was successful |
|
||||
| `state` | string | Task state after cancellation |
|
||||
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) |
|
||||
|
||||
### `a2a_get_agent_card`
|
||||
|
||||
@@ -116,14 +116,15 @@ Fetch the Agent Card (discovery document) for an A2A agent.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `name` | string | Agent name |
|
||||
| `description` | string | Agent description |
|
||||
| `url` | string | Agent endpoint URL |
|
||||
| `version` | string | Agent version |
|
||||
| `capabilities` | object | Agent capabilities \(streaming, pushNotifications, etc.\) |
|
||||
| `skills` | array | Skills the agent can perform |
|
||||
| `defaultInputModes` | array | Default input modes \(text, file, data\) |
|
||||
| `defaultOutputModes` | array | Default output modes \(text, file, data\) |
|
||||
| `name` | string | Agent display name |
|
||||
| `description` | string | Agent purpose/capabilities |
|
||||
| `url` | string | Service endpoint URL |
|
||||
| `provider` | object | Creator organization details |
|
||||
| `capabilities` | object | Feature support matrix |
|
||||
| `skills` | array | Available operations |
|
||||
| `version` | string | A2A protocol version supported by the agent |
|
||||
| `defaultInputModes` | array | Default input content types accepted by the agent |
|
||||
| `defaultOutputModes` | array | Default output content types produced by the agent |
|
||||
|
||||
### `a2a_resubscribe`
|
||||
|
||||
@@ -141,12 +142,12 @@ Reconnect to an ongoing A2A task stream after connection interruption.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `taskId` | string | Task ID |
|
||||
| `contextId` | string | Context ID |
|
||||
| `state` | string | Current task state |
|
||||
| `taskId` | string | Unique task identifier |
|
||||
| `contextId` | string | Groups related tasks/messages |
|
||||
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) |
|
||||
| `isRunning` | boolean | Whether the task is still running |
|
||||
| `artifacts` | array | Output artifacts |
|
||||
| `history` | array | Message history |
|
||||
| `artifacts` | array | Task output artifacts |
|
||||
| `history` | array | Conversation history \(Message array\) |
|
||||
|
||||
### `a2a_set_push_notification`
|
||||
|
||||
@@ -166,9 +167,9 @@ Configure a webhook to receive task update notifications.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `url` | string | Configured webhook URL |
|
||||
| `token` | string | Token for webhook validation |
|
||||
| `success` | boolean | Whether configuration was successful |
|
||||
| `url` | string | HTTPS webhook URL for notifications |
|
||||
| `token` | string | Authentication token for webhook validation |
|
||||
| `success` | boolean | Whether the operation was successful |
|
||||
|
||||
### `a2a_get_push_notification`
|
||||
|
||||
@@ -186,9 +187,8 @@ Get the push notification webhook configuration for a task.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `url` | string | Configured webhook URL |
|
||||
| `token` | string | Token for webhook validation |
|
||||
| `exists` | boolean | Whether a push notification config exists |
|
||||
| `token` | string | Authentication token for webhook validation |
|
||||
| `exists` | boolean | Whether the resource exists |
|
||||
|
||||
### `a2a_delete_push_notification`
|
||||
|
||||
@@ -207,6 +207,6 @@ Delete the push notification webhook configuration for a task.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether deletion was successful |
|
||||
| `success` | boolean | Whether the operation was successful |
|
||||
|
||||
|
||||
|
||||
@@ -168,10 +168,10 @@ Search for tasks in an Asana workspace
|
||||
| `success` | boolean | Operation success status |
|
||||
| `ts` | string | Timestamp of the response |
|
||||
| `tasks` | array | Array of matching tasks |
|
||||
| ↳ `gid` | string | Assignee GID |
|
||||
| ↳ `gid` | string | Task GID |
|
||||
| ↳ `resource_type` | string | Resource type |
|
||||
| ↳ `resource_subtype` | string | Resource subtype |
|
||||
| ↳ `name` | string | Assignee name |
|
||||
| ↳ `name` | string | Task name |
|
||||
| ↳ `notes` | string | Task notes |
|
||||
| ↳ `completed` | boolean | Completion status |
|
||||
| ↳ `assignee` | object | Assignee details |
|
||||
|
||||
@@ -47,6 +47,7 @@ Runs a browser automation task using BrowserUse
|
||||
| `save_browser_data` | boolean | No | Whether to save browser data |
|
||||
| `model` | string | No | LLM model to use \(default: gpt-4o\) |
|
||||
| `apiKey` | string | Yes | API key for BrowserUse API |
|
||||
| `profile_id` | string | No | Browser profile ID for persistent sessions \(cookies, login state\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
789
apps/docs/content/docs/en/tools/calcom.mdx
Normal file
789
apps/docs/content/docs/en/tools/calcom.mdx
Normal file
@@ -0,0 +1,789 @@
|
||||
---
|
||||
title: CalCom
|
||||
description: Manage Cal.com bookings, event types, schedules, and availability
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="calcom"
|
||||
color="#FFFFFE"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Cal.com](https://cal.com/) is a flexible and open-source scheduling platform that makes it easy to manage appointments, bookings, event types, and team availabilities.
|
||||
|
||||
With Cal.com, you can:
|
||||
|
||||
- **Automate scheduling**: Allow users to view your available time slots and book meetings automatically, without back-and-forth emails.
|
||||
- **Manage events**: Create and customize event types, durations, and rules for one-on-one or group meetings.
|
||||
- **Integrate calendars**: Seamlessly connect with Google, Outlook, Apple, or other calendar providers to avoid double bookings.
|
||||
- **Handle attendees and guests**: Collect attendee information, manage guests, and send invitations or reminders.
|
||||
- **Control availability**: Define custom working hours, buffer times, and cancellation/rebooking rules.
|
||||
- **Power workflows**: Trigger custom actions via webhooks when a booking is created, cancelled, or rescheduled.
|
||||
|
||||
In Sim, the Cal.com integration enables your agents to book meetings, check availabilities, manage event types, and automate scheduling tasks programmatically. This helps agents coordinate meetings, send bookings on behalf of users, check schedules, or respond to booking events—all without manual intervention. By connecting Sim with Cal.com, you unlock highly automated and intelligent scheduling workflows that can integrate seamlessly with your broader automation needs.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Cal.com into your workflow. Create and manage bookings, event types, schedules, and check availability slots. Supports creating, listing, rescheduling, and canceling bookings, as well as managing event types and schedules. Can also trigger workflows based on Cal.com webhook events (booking created, cancelled, rescheduled). Connect your Cal.com account via OAuth.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `calcom_create_booking`
|
||||
|
||||
Create a new booking on Cal.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventTypeId` | number | Yes | The ID of the event type to book |
|
||||
| `start` | string | Yes | Start time in UTC ISO 8601 format \(e.g., 2024-01-15T09:00:00Z\) |
|
||||
| `attendee` | object | Yes | Attendee information object with name, email, timeZone, and optional phoneNumber \(constructed from individual attendee fields\) |
|
||||
| `guests` | array | No | Array of guest email addresses |
|
||||
| `items` | string | No | Guest email address |
|
||||
| `lengthInMinutes` | number | No | Duration of the booking in minutes \(overrides event type default\) |
|
||||
| `metadata` | object | No | Custom metadata to attach to the booking |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Created booking details |
|
||||
| ↳ `eventType` | object | Event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `attendees` | array | List of attendees |
|
||||
| ↳ `name` | string | Attendee name |
|
||||
| ↳ `email` | string | Attendee actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
|
||||
| ↳ `phoneNumber` | string | Attendee phone number |
|
||||
| ↳ `language` | string | Attendee language preference \(ISO code\) |
|
||||
| ↳ `absent` | boolean | Whether attendee was absent |
|
||||
| ↳ `hosts` | array | List of hosts |
|
||||
| ↳ `id` | number | Host user ID |
|
||||
| ↳ `name` | string | Host display name |
|
||||
| ↳ `email` | string | Host actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `username` | string | Host Cal.com username |
|
||||
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
|
||||
| ↳ `id` | number | Numeric booking ID |
|
||||
| ↳ `uid` | string | Unique identifier for the booking |
|
||||
| ↳ `title` | string | Title of the booking |
|
||||
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
|
||||
| ↳ `start` | string | Start time in ISO 8601 format |
|
||||
| ↳ `end` | string | End time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `eventTypeId` | number | Event type ID |
|
||||
| ↳ `meetingUrl` | string | URL to join the meeting |
|
||||
| ↳ `location` | string | Location of the booking |
|
||||
| ↳ `absentHost` | boolean | Whether the host was absent |
|
||||
| ↳ `guests` | array | Guest email addresses |
|
||||
| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) |
|
||||
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
|
||||
| ↳ `icsUid` | string | ICS calendar UID |
|
||||
| ↳ `createdAt` | string | When the booking was created |
|
||||
|
||||
### `calcom_get_booking`
|
||||
|
||||
Get details of a specific booking by its UID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Booking details |
|
||||
| ↳ `eventType` | object | Event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `attendees` | array | List of attendees |
|
||||
| ↳ `name` | string | Attendee name |
|
||||
| ↳ `email` | string | Attendee actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
|
||||
| ↳ `phoneNumber` | string | Attendee phone number |
|
||||
| ↳ `language` | string | Attendee language preference \(ISO code\) |
|
||||
| ↳ `absent` | boolean | Whether attendee was absent |
|
||||
| ↳ `hosts` | array | List of hosts |
|
||||
| ↳ `id` | number | Host user ID |
|
||||
| ↳ `name` | string | Host display name |
|
||||
| ↳ `email` | string | Host actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `username` | string | Host Cal.com username |
|
||||
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
|
||||
| ↳ `id` | number | Numeric booking ID |
|
||||
| ↳ `uid` | string | Unique identifier for the booking |
|
||||
| ↳ `title` | string | Title of the booking |
|
||||
| ↳ `description` | string | Description of the booking |
|
||||
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
|
||||
| ↳ `start` | string | Start time in ISO 8601 format |
|
||||
| ↳ `end` | string | End time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `eventTypeId` | number | Event type ID |
|
||||
| ↳ `meetingUrl` | string | URL to join the meeting |
|
||||
| ↳ `location` | string | Location of the booking |
|
||||
| ↳ `absentHost` | boolean | Whether the host was absent |
|
||||
| ↳ `guests` | array | Guest email addresses |
|
||||
| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) |
|
||||
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
|
||||
| ↳ `rating` | number | Booking rating |
|
||||
| ↳ `icsUid` | string | ICS calendar UID |
|
||||
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
|
||||
| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled |
|
||||
| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled |
|
||||
| ↳ `rescheduledToUid` | string | New booking UID after reschedule |
|
||||
| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking |
|
||||
| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking |
|
||||
| ↳ `createdAt` | string | When the booking was created |
|
||||
| ↳ `updatedAt` | string | When the booking was last updated |
|
||||
|
||||
### `calcom_list_bookings`
|
||||
|
||||
List all bookings with optional status filter
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `status` | string | No | Filter bookings by status: upcoming, recurring, past, cancelled, or unconfirmed |
|
||||
| `take` | number | No | Number of bookings to return \(pagination limit\) |
|
||||
| `skip` | number | No | Number of bookings to skip \(pagination offset\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | array | Array of bookings |
|
||||
| ↳ `eventType` | object | Event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `attendees` | array | List of attendees |
|
||||
| ↳ `name` | string | Attendee name |
|
||||
| ↳ `email` | string | Attendee actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
|
||||
| ↳ `phoneNumber` | string | Attendee phone number |
|
||||
| ↳ `language` | string | Attendee language preference \(ISO code\) |
|
||||
| ↳ `absent` | boolean | Whether attendee was absent |
|
||||
| ↳ `hosts` | array | List of hosts |
|
||||
| ↳ `id` | number | Host user ID |
|
||||
| ↳ `name` | string | Host display name |
|
||||
| ↳ `email` | string | Host actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `username` | string | Host Cal.com username |
|
||||
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
|
||||
| ↳ `id` | number | Numeric booking ID |
|
||||
| ↳ `uid` | string | Unique identifier for the booking |
|
||||
| ↳ `title` | string | Title of the booking |
|
||||
| ↳ `description` | string | Description of the booking |
|
||||
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
|
||||
| ↳ `start` | string | Start time in ISO 8601 format |
|
||||
| ↳ `end` | string | End time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `eventTypeId` | number | Event type ID |
|
||||
| ↳ `meetingUrl` | string | URL to join the meeting |
|
||||
| ↳ `location` | string | Location of the booking |
|
||||
| ↳ `absentHost` | boolean | Whether the host was absent |
|
||||
| ↳ `guests` | array | Guest email addresses |
|
||||
| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) |
|
||||
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
|
||||
| ↳ `rating` | number | Booking rating |
|
||||
| ↳ `icsUid` | string | ICS calendar UID |
|
||||
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
|
||||
| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking |
|
||||
| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled |
|
||||
| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking |
|
||||
| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled |
|
||||
| ↳ `rescheduledToUid` | string | New booking UID after reschedule |
|
||||
| ↳ `createdAt` | string | When the booking was created |
|
||||
| ↳ `updatedAt` | string | When the booking was last updated |
|
||||
| `pagination` | object | Pagination metadata |
|
||||
| ↳ `totalItems` | number | Total number of items |
|
||||
| ↳ `remainingItems` | number | Remaining items after current page |
|
||||
| ↳ `returnedItems` | number | Number of items returned in this response |
|
||||
| ↳ `itemsPerPage` | number | Items per page |
|
||||
| ↳ `currentPage` | number | Current page number |
|
||||
| ↳ `totalPages` | number | Total number of pages |
|
||||
| ↳ `hasNextPage` | boolean | Whether there is a next page |
|
||||
| ↳ `hasPreviousPage` | boolean | Whether there is a previous page |
|
||||
|
||||
### `calcom_cancel_booking`
|
||||
|
||||
Cancel an existing booking
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to cancel |
|
||||
| `cancellationReason` | string | No | Reason for cancelling the booking |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Cancelled booking details |
|
||||
| ↳ `eventType` | object | Event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `attendees` | array | List of attendees |
|
||||
| ↳ `name` | string | Attendee name |
|
||||
| ↳ `email` | string | Attendee actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
|
||||
| ↳ `phoneNumber` | string | Attendee phone number |
|
||||
| ↳ `language` | string | Attendee language preference \(ISO code\) |
|
||||
| ↳ `absent` | boolean | Whether attendee was absent |
|
||||
| ↳ `hosts` | array | List of hosts |
|
||||
| ↳ `id` | number | Host user ID |
|
||||
| ↳ `name` | string | Host display name |
|
||||
| ↳ `email` | string | Host actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `username` | string | Host Cal.com username |
|
||||
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
|
||||
| ↳ `id` | number | Numeric booking ID |
|
||||
| ↳ `uid` | string | Unique identifier for the booking |
|
||||
| ↳ `title` | string | Title of the booking |
|
||||
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
|
||||
| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking |
|
||||
| ↳ `start` | string | Start time in ISO 8601 format |
|
||||
| ↳ `end` | string | End time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `eventTypeId` | number | Event type ID |
|
||||
| ↳ `location` | string | Location of the booking |
|
||||
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
|
||||
| ↳ `createdAt` | string | When the booking was created |
|
||||
| ↳ `status` | string | Booking status \(should be cancelled\) |
|
||||
|
||||
### `calcom_reschedule_booking`
|
||||
|
||||
Reschedule an existing booking to a new time
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to reschedule |
|
||||
| `start` | string | Yes | New start time in UTC ISO 8601 format \(e.g., 2024-01-15T09:00:00Z\) |
|
||||
| `reschedulingReason` | string | No | Reason for rescheduling the booking |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Rescheduled booking details |
|
||||
| ↳ `eventType` | object | Event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `attendees` | array | List of attendees |
|
||||
| ↳ `name` | string | Attendee name |
|
||||
| ↳ `email` | string | Attendee actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
|
||||
| ↳ `phoneNumber` | string | Attendee phone number |
|
||||
| ↳ `language` | string | Attendee language preference \(ISO code\) |
|
||||
| ↳ `absent` | boolean | Whether attendee was absent |
|
||||
| ↳ `hosts` | array | List of hosts |
|
||||
| ↳ `id` | number | Host user ID |
|
||||
| ↳ `name` | string | Host display name |
|
||||
| ↳ `email` | string | Host actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `username` | string | Host Cal.com username |
|
||||
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
|
||||
| ↳ `id` | number | Numeric booking ID |
|
||||
| ↳ `title` | string | Title of the booking |
|
||||
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
|
||||
| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled |
|
||||
| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled |
|
||||
| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `eventTypeId` | number | Event type ID |
|
||||
| ↳ `meetingUrl` | string | URL to join the meeting |
|
||||
| ↳ `location` | string | Location of the booking |
|
||||
| ↳ `guests` | array | Guest email addresses |
|
||||
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
|
||||
| ↳ `icsUid` | string | ICS calendar UID |
|
||||
| ↳ `createdAt` | string | When the booking was created |
|
||||
| ↳ `uid` | string | Unique identifier for the new booking |
|
||||
| ↳ `start` | string | New start time in ISO 8601 format |
|
||||
| ↳ `end` | string | New end time in ISO 8601 format |
|
||||
|
||||
### `calcom_confirm_booking`
|
||||
|
||||
Confirm a pending booking that requires confirmation
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to confirm |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Confirmed booking details |
|
||||
| ↳ `eventType` | object | Event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `attendees` | array | List of attendees |
|
||||
| ↳ `name` | string | Attendee name |
|
||||
| ↳ `email` | string | Attendee actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
|
||||
| ↳ `phoneNumber` | string | Attendee phone number |
|
||||
| ↳ `language` | string | Attendee language preference \(ISO code\) |
|
||||
| ↳ `absent` | boolean | Whether attendee was absent |
|
||||
| ↳ `hosts` | array | List of hosts |
|
||||
| ↳ `id` | number | Host user ID |
|
||||
| ↳ `name` | string | Host display name |
|
||||
| ↳ `email` | string | Host actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `username` | string | Host Cal.com username |
|
||||
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
|
||||
| ↳ `id` | number | Numeric booking ID |
|
||||
| ↳ `uid` | string | Unique identifier for the booking |
|
||||
| ↳ `title` | string | Title of the booking |
|
||||
| ↳ `start` | string | Start time in ISO 8601 format |
|
||||
| ↳ `end` | string | End time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `eventTypeId` | number | Event type ID |
|
||||
| ↳ `meetingUrl` | string | URL to join the meeting |
|
||||
| ↳ `location` | string | Location of the booking |
|
||||
| ↳ `guests` | array | Guest email addresses |
|
||||
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
|
||||
| ↳ `icsUid` | string | ICS calendar UID |
|
||||
| ↳ `createdAt` | string | When the booking was created |
|
||||
| ↳ `status` | string | Booking status \(should be accepted/confirmed\) |
|
||||
|
||||
### `calcom_decline_booking`
|
||||
|
||||
Decline a pending booking request
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to decline |
|
||||
| `reason` | string | No | Reason for declining the booking |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Declined booking details |
|
||||
| ↳ `eventType` | object | Event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `attendees` | array | List of attendees |
|
||||
| ↳ `name` | string | Attendee name |
|
||||
| ↳ `email` | string | Attendee actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
|
||||
| ↳ `phoneNumber` | string | Attendee phone number |
|
||||
| ↳ `language` | string | Attendee language preference \(ISO code\) |
|
||||
| ↳ `absent` | boolean | Whether attendee was absent |
|
||||
| ↳ `hosts` | array | List of hosts |
|
||||
| ↳ `id` | number | Host user ID |
|
||||
| ↳ `name` | string | Host display name |
|
||||
| ↳ `email` | string | Host actual email address |
|
||||
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
|
||||
| ↳ `username` | string | Host Cal.com username |
|
||||
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
|
||||
| ↳ `id` | number | Numeric booking ID |
|
||||
| ↳ `uid` | string | Unique identifier for the booking |
|
||||
| ↳ `title` | string | Title of the booking |
|
||||
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
|
||||
| ↳ `start` | string | Start time in ISO 8601 format |
|
||||
| ↳ `end` | string | End time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `eventTypeId` | number | Event type ID |
|
||||
| ↳ `location` | string | Location of the booking |
|
||||
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
|
||||
| ↳ `createdAt` | string | When the booking was created |
|
||||
| ↳ `status` | string | Booking status \(should be cancelled/rejected\) |
|
||||
|
||||
### `calcom_create_event_type`
|
||||
|
||||
Create a new event type in Cal.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `title` | string | Yes | Title of the event type |
|
||||
| `slug` | string | Yes | Unique slug for the event type URL |
|
||||
| `lengthInMinutes` | number | Yes | Duration of the event in minutes |
|
||||
| `description` | string | No | Description of the event type |
|
||||
| `slotInterval` | number | No | Interval between available booking slots in minutes |
|
||||
| `minimumBookingNotice` | number | No | Minimum notice required before booking in minutes |
|
||||
| `beforeEventBuffer` | number | No | Buffer time before the event in minutes |
|
||||
| `afterEventBuffer` | number | No | Buffer time after the event in minutes |
|
||||
| `scheduleId` | number | No | ID of the schedule to use for availability |
|
||||
| `disableGuests` | boolean | No | Whether to disable guests from being added to bookings |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Created event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `title` | string | Event type title |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `description` | string | Event type description |
|
||||
| ↳ `lengthInMinutes` | number | Duration in minutes |
|
||||
| ↳ `slotInterval` | number | Slot interval in minutes |
|
||||
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
|
||||
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
|
||||
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
|
||||
| ↳ `scheduleId` | number | Schedule ID |
|
||||
| ↳ `disableGuests` | boolean | Whether guests are disabled |
|
||||
| ↳ `createdAt` | string | ISO timestamp of creation |
|
||||
| ↳ `updatedAt` | string | ISO timestamp of last update |
|
||||
|
||||
### `calcom_get_event_type`
|
||||
|
||||
Get detailed information about a specific event type
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventTypeId` | number | Yes | Event type ID to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `title` | string | Event type title |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `description` | string | Event type description |
|
||||
| ↳ `lengthInMinutes` | number | Duration in minutes |
|
||||
| ↳ `slotInterval` | number | Slot interval in minutes |
|
||||
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
|
||||
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
|
||||
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
|
||||
| ↳ `scheduleId` | number | Schedule ID |
|
||||
| ↳ `disableGuests` | boolean | Whether guests are disabled |
|
||||
| ↳ `createdAt` | string | ISO timestamp of creation |
|
||||
| ↳ `updatedAt` | string | ISO timestamp of last update |
|
||||
|
||||
### `calcom_list_event_types`
|
||||
|
||||
Retrieve a list of all event types
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `sortCreatedAt` | string | No | Sort by creation date: "asc" or "desc" |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | array | Array of event types |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `title` | string | Event type title |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `description` | string | Event type description |
|
||||
| ↳ `lengthInMinutes` | number | Duration in minutes |
|
||||
| ↳ `slotInterval` | number | Slot interval in minutes |
|
||||
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
|
||||
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
|
||||
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
|
||||
| ↳ `scheduleId` | number | Schedule ID |
|
||||
| ↳ `disableGuests` | boolean | Whether guests are disabled |
|
||||
| ↳ `createdAt` | string | ISO timestamp of creation |
|
||||
| ↳ `updatedAt` | string | ISO timestamp of last update |
|
||||
|
||||
### `calcom_update_event_type`
|
||||
|
||||
Update an existing event type in Cal.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventTypeId` | number | Yes | Event type ID to update |
|
||||
| `title` | string | No | Title of the event type |
|
||||
| `slug` | string | No | Unique slug for the event type URL |
|
||||
| `lengthInMinutes` | number | No | Duration of the event in minutes |
|
||||
| `description` | string | No | Description of the event type |
|
||||
| `slotInterval` | number | No | Interval between available booking slots in minutes |
|
||||
| `minimumBookingNotice` | number | No | Minimum notice required before booking in minutes |
|
||||
| `beforeEventBuffer` | number | No | Buffer time before the event in minutes |
|
||||
| `afterEventBuffer` | number | No | Buffer time after the event in minutes |
|
||||
| `scheduleId` | number | No | ID of the schedule to use for availability |
|
||||
| `disableGuests` | boolean | No | Whether to disable guests from being added to bookings |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Updated event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `title` | string | Event type title |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
| ↳ `description` | string | Event type description |
|
||||
| ↳ `lengthInMinutes` | number | Duration in minutes |
|
||||
| ↳ `slotInterval` | number | Slot interval in minutes |
|
||||
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
|
||||
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
|
||||
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
|
||||
| ↳ `scheduleId` | number | Schedule ID |
|
||||
| ↳ `disableGuests` | boolean | Whether guests are disabled |
|
||||
| ↳ `createdAt` | string | ISO timestamp of creation |
|
||||
| ↳ `updatedAt` | string | ISO timestamp of last update |
|
||||
|
||||
### `calcom_delete_event_type`
|
||||
|
||||
Delete an event type from Cal.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventTypeId` | number | Yes | Event type ID to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Deleted event type details |
|
||||
| ↳ `id` | number | Event type ID |
|
||||
| ↳ `lengthInMinutes` | number | Duration in minutes |
|
||||
| ↳ `title` | string | Event type title |
|
||||
| ↳ `slug` | string | Event type slug |
|
||||
|
||||
### `calcom_create_schedule`
|
||||
|
||||
Create a new availability schedule in Cal.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `name` | string | Yes | Name of the schedule |
|
||||
| `timeZone` | string | Yes | Timezone for the schedule \(e.g., America/New_York\) |
|
||||
| `isDefault` | boolean | Yes | Whether this schedule should be the default |
|
||||
| `availability` | array | No | Availability intervals for the schedule |
|
||||
| `items` | object | No | Availability interval |
|
||||
| `properties` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
|
||||
| `days` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
|
||||
| `startTime` | string | No | Start time in HH:MM format |
|
||||
| `endTime` | string | No | End time in HH:MM format |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Created schedule data |
|
||||
| ↳ `id` | number | Schedule ID |
|
||||
| ↳ `ownerId` | number | Owner user ID |
|
||||
| ↳ `name` | string | Schedule name |
|
||||
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
|
||||
| ↳ `isDefault` | boolean | Whether this is the default schedule |
|
||||
| ↳ `availability` | array | Availability windows |
|
||||
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
|
||||
| ↳ `startTime` | string | Start time in HH:MM format |
|
||||
| ↳ `endTime` | string | End time in HH:MM format |
|
||||
| ↳ `overrides` | array | Date-specific availability overrides |
|
||||
| ↳ `date` | string | Date in YYYY-MM-DD format |
|
||||
| ↳ `startTime` | string | Start time in HH:MM format |
|
||||
| ↳ `endTime` | string | End time in HH:MM format |
|
||||
|
||||
### `calcom_get_schedule`
|
||||
|
||||
Get a specific schedule by ID from Cal.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `scheduleId` | string | Yes | ID of the schedule to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Schedule data |
|
||||
| ↳ `id` | number | Schedule ID |
|
||||
| ↳ `ownerId` | number | Owner user ID |
|
||||
| ↳ `name` | string | Schedule name |
|
||||
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
|
||||
| ↳ `isDefault` | boolean | Whether this is the default schedule |
|
||||
| ↳ `availability` | array | Availability windows |
|
||||
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
|
||||
| ↳ `startTime` | string | Start time in HH:MM format |
|
||||
| ↳ `endTime` | string | End time in HH:MM format |
|
||||
| ↳ `overrides` | array | Date-specific availability overrides |
|
||||
| ↳ `date` | string | Date in YYYY-MM-DD format |
|
||||
| ↳ `startTime` | string | Start time in HH:MM format |
|
||||
| ↳ `endTime` | string | End time in HH:MM format |
|
||||
|
||||
### `calcom_list_schedules`
|
||||
|
||||
List all availability schedules from Cal.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | array | Array of schedule objects |
|
||||
| ↳ `id` | number | Schedule ID |
|
||||
| ↳ `ownerId` | number | Owner user ID |
|
||||
| ↳ `name` | string | Schedule name |
|
||||
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
|
||||
| ↳ `isDefault` | boolean | Whether this is the default schedule |
|
||||
| ↳ `availability` | array | Availability windows |
|
||||
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
|
||||
| ↳ `startTime` | string | Start time in HH:MM format |
|
||||
| ↳ `endTime` | string | End time in HH:MM format |
|
||||
| ↳ `overrides` | array | Date-specific availability overrides |
|
||||
| ↳ `date` | string | Date in YYYY-MM-DD format |
|
||||
| ↳ `startTime` | string | Start time in HH:MM format |
|
||||
| ↳ `endTime` | string | End time in HH:MM format |
|
||||
|
||||
### `calcom_update_schedule`
|
||||
|
||||
Update an existing schedule in Cal.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `scheduleId` | string | Yes | ID of the schedule to update |
|
||||
| `name` | string | No | New name for the schedule |
|
||||
| `timeZone` | string | No | New timezone for the schedule \(e.g., America/New_York\) |
|
||||
| `isDefault` | boolean | No | Whether this schedule should be the default |
|
||||
| `availability` | array | No | New availability intervals for the schedule |
|
||||
| `items` | object | No | Availability interval |
|
||||
| `properties` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
|
||||
| `days` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
|
||||
| `startTime` | string | No | Start time in HH:MM format |
|
||||
| `endTime` | string | No | End time in HH:MM format |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Updated schedule data |
|
||||
| ↳ `id` | number | Schedule ID |
|
||||
| ↳ `ownerId` | number | Owner user ID |
|
||||
| ↳ `name` | string | Schedule name |
|
||||
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
|
||||
| ↳ `isDefault` | boolean | Whether this is the default schedule |
|
||||
| ↳ `availability` | array | Availability windows |
|
||||
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
|
||||
| ↳ `startTime` | string | Start time in HH:MM format |
|
||||
| ↳ `endTime` | string | End time in HH:MM format |
|
||||
| ↳ `overrides` | array | Date-specific availability overrides |
|
||||
| ↳ `date` | string | Date in YYYY-MM-DD format |
|
||||
| ↳ `startTime` | string | Start time in HH:MM format |
|
||||
| ↳ `endTime` | string | End time in HH:MM format |
|
||||
|
||||
### `calcom_delete_schedule`
|
||||
|
||||
Delete a schedule from Cal.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `scheduleId` | string | Yes | ID of the schedule to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status \(success or error\) |
|
||||
|
||||
### `calcom_get_default_schedule`
|
||||
|
||||
Get the default availability schedule from Cal.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | object | Default schedule data |
|
||||
| ↳ `id` | number | Schedule ID |
|
||||
| ↳ `ownerId` | number | Owner user ID |
|
||||
| ↳ `name` | string | Schedule name |
|
||||
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
|
||||
| ↳ `isDefault` | boolean | Whether this is the default schedule |
|
||||
| ↳ `availability` | array | Availability windows |
|
||||
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
|
||||
| ↳ `startTime` | string | Start time in HH:MM format |
|
||||
| ↳ `endTime` | string | End time in HH:MM format |
|
||||
| ↳ `overrides` | array | Date-specific availability overrides |
|
||||
| ↳ `date` | string | Date in YYYY-MM-DD format |
|
||||
| ↳ `startTime` | string | Start time in HH:MM format |
|
||||
| ↳ `endTime` | string | End time in HH:MM format |
|
||||
|
||||
### `calcom_get_slots`
|
||||
|
||||
Get available booking slots for a Cal.com event type within a time range
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `start` | string | Yes | Start of time range in UTC ISO 8601 format \(e.g., 2024-01-15T00:00:00Z\) |
|
||||
| `end` | string | Yes | End of time range in UTC ISO 8601 format \(e.g., 2024-01-22T00:00:00Z\) |
|
||||
| `eventTypeId` | number | No | Event type ID for direct lookup |
|
||||
| `eventTypeSlug` | string | No | Event type slug \(requires username to be set\) |
|
||||
| `username` | string | No | Username for personal event types \(required when using eventTypeSlug\) |
|
||||
| `timeZone` | string | No | Timezone for returned slots \(defaults to UTC\) |
|
||||
| `duration` | number | No | Slot length in minutes |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Response status |
|
||||
| `data` | json | Available time slots grouped by date \(YYYY-MM-DD keys\). Each date maps to an array of slot objects with start time, optional end time, and seated event info. |
|
||||
|
||||
|
||||
@@ -51,7 +51,7 @@ Get information about the currently authenticated Calendly user
|
||||
| ↳ `name` | string | User full name |
|
||||
| ↳ `slug` | string | Unique identifier for the user in URLs |
|
||||
| ↳ `email` | string | User email address |
|
||||
| ↳ `scheduling_url` | string | URL to the user |
|
||||
| ↳ `scheduling_url` | string | URL to the user's scheduling page |
|
||||
| ↳ `timezone` | string | User timezone |
|
||||
| ↳ `avatar_url` | string | URL to user avatar image |
|
||||
| ↳ `created_at` | string | ISO timestamp when user was created |
|
||||
@@ -82,7 +82,7 @@ Retrieve a list of all event types for a user or organization
|
||||
| ↳ `uri` | string | Canonical reference to the event type |
|
||||
| ↳ `name` | string | Event type name |
|
||||
| ↳ `active` | boolean | Whether the event type is active |
|
||||
| ↳ `booking_method` | string | Booking method \(e.g., |
|
||||
| ↳ `booking_method` | string | Booking method \(e.g., "round_robin_or_collect", "collective"\) |
|
||||
| ↳ `color` | string | Hex color code |
|
||||
| ↳ `created_at` | string | ISO timestamp of creation |
|
||||
| ↳ `description_html` | string | HTML formatted description |
|
||||
@@ -116,7 +116,7 @@ Get detailed information about a specific event type
|
||||
| --------- | ---- | ----------- |
|
||||
| `resource` | object | Event type details |
|
||||
| ↳ `uri` | string | Canonical reference to the event type |
|
||||
| ↳ `name` | string | Question text |
|
||||
| ↳ `name` | string | Event type name |
|
||||
| ↳ `active` | boolean | Whether the event type is active |
|
||||
| ↳ `booking_method` | string | Booking method |
|
||||
| ↳ `color` | string | Hex color code |
|
||||
@@ -128,16 +128,12 @@ Get detailed information about a specific event type
|
||||
| ↳ `enabled` | boolean | Whether question is enabled |
|
||||
| ↳ `required` | boolean | Whether question is required |
|
||||
| ↳ `answer_choices` | array | Available answer choices |
|
||||
| ↳ `type` | string | Event type classification |
|
||||
| ↳ `position` | number | Question order |
|
||||
| ↳ `enabled` | boolean | Whether question is enabled |
|
||||
| ↳ `required` | boolean | Whether question is required |
|
||||
| ↳ `answer_choices` | array | Available answer choices |
|
||||
| ↳ `description_html` | string | HTML formatted description |
|
||||
| ↳ `description_plain` | string | Plain text description |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `scheduling_url` | string | URL to scheduling page |
|
||||
| ↳ `slug` | string | Unique identifier for URLs |
|
||||
| ↳ `type` | string | Event type classification |
|
||||
| ↳ `updated_at` | string | ISO timestamp of last update |
|
||||
|
||||
### `calendly_list_scheduled_events`
|
||||
@@ -170,16 +166,14 @@ Retrieve a list of scheduled events for a user or organization
|
||||
| ↳ `start_time` | string | ISO timestamp of event start |
|
||||
| ↳ `end_time` | string | ISO timestamp of event end |
|
||||
| ↳ `event_type` | string | URI of the event type |
|
||||
| ↳ `location` | object | Event location details |
|
||||
| ↳ `type` | string | Location type \(e.g., "zoom", "google_meet", "physical"\) |
|
||||
| ↳ `location` | string | Location description |
|
||||
| ↳ `type` | string | Location type \(e.g., |
|
||||
| ↳ `join_url` | string | URL to join online meeting \(if applicable\) |
|
||||
| ↳ `invitees_counter` | object | Invitee count information |
|
||||
| ↳ `total` | number | Total number of invitees |
|
||||
| ↳ `active` | number | Number of active invitees |
|
||||
| ↳ `limit` | number | Maximum number of invitees |
|
||||
| ↳ `total` | number | Total number of invitees |
|
||||
| ↳ `active` | number | Number of active invitees |
|
||||
| ↳ `limit` | number | Maximum number of invitees |
|
||||
| ↳ `created_at` | string | ISO timestamp of event creation |
|
||||
| ↳ `updated_at` | string | ISO timestamp of last update |
|
||||
| `pagination` | object | Pagination information |
|
||||
@@ -211,28 +205,22 @@ Get detailed information about a specific scheduled event
|
||||
| ↳ `start_time` | string | ISO timestamp of event start |
|
||||
| ↳ `end_time` | string | ISO timestamp of event end |
|
||||
| ↳ `event_type` | string | URI of the event type |
|
||||
| ↳ `location` | string | Location description |
|
||||
| ↳ `location` | object | Event location details |
|
||||
| ↳ `type` | string | Location type |
|
||||
| ↳ `location` | string | Location description |
|
||||
| ↳ `join_url` | string | URL to join online meeting |
|
||||
| ↳ `invitees_counter` | object | Invitee count information |
|
||||
| ↳ `total` | number | Total number of invitees |
|
||||
| ↳ `active` | number | Number of active invitees |
|
||||
| ↳ `limit` | number | Maximum number of invitees |
|
||||
| ↳ `total` | number | Total number of invitees |
|
||||
| ↳ `active` | number | Number of active invitees |
|
||||
| ↳ `limit` | number | Maximum number of invitees |
|
||||
| ↳ `event_memberships` | array | Event hosts/members |
|
||||
| ↳ `user` | string | User URI |
|
||||
| ↳ `user_email` | string | User email |
|
||||
| ↳ `user_name` | string | User name |
|
||||
| ↳ `user` | string | User URI |
|
||||
| ↳ `user_email` | string | User email |
|
||||
| ↳ `user_name` | string | User name |
|
||||
| ↳ `event_guests` | array | Additional guests |
|
||||
| ↳ `email` | string | Guest email |
|
||||
| ↳ `created_at` | string | When guest was added |
|
||||
| ↳ `updated_at` | string | When guest info was updated |
|
||||
| ↳ `email` | string | Guest email |
|
||||
| ↳ `created_at` | string | ISO timestamp of event creation |
|
||||
| ↳ `updated_at` | string | ISO timestamp of last update |
|
||||
|
||||
@@ -267,9 +255,6 @@ Retrieve a list of invitees for a scheduled event
|
||||
| ↳ `question` | string | Question text |
|
||||
| ↳ `answer` | string | Invitee answer |
|
||||
| ↳ `position` | number | Question order |
|
||||
| ↳ `question` | string | Question text |
|
||||
| ↳ `answer` | string | Invitee answer |
|
||||
| ↳ `position` | number | Question order |
|
||||
| ↳ `timezone` | string | Invitee timezone |
|
||||
| ↳ `event` | string | URI of the scheduled event |
|
||||
| ↳ `created_at` | string | ISO timestamp when invitee was created |
|
||||
|
||||
442
apps/docs/content/docs/en/tools/clerk.mdx
Normal file
442
apps/docs/content/docs/en/tools/clerk.mdx
Normal file
@@ -0,0 +1,442 @@
|
||||
---
|
||||
title: Clerk
|
||||
description: Manage users, organizations, and sessions in Clerk
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="clerk"
|
||||
color="#131316"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Clerk](https://clerk.com/) is a comprehensive identity infrastructure platform that helps you manage users, authentication, and sessions for your applications.
|
||||
|
||||
In Sim, the Clerk integration lets your agents automate user and session management through easy-to-use API-based tools. Agents can securely list users, update user profiles, manage organizations, monitor sessions, and revoke access directly in your workflow.
|
||||
|
||||
With Clerk, you can:
|
||||
|
||||
- **Authenticate users and manage sessions**: Seamlessly control sign-in, sign-up, and session lifecycle for your users.
|
||||
- **List and update users**: Automatically pull user lists, update user attributes, or view profile details as part of your agent tasks.
|
||||
- **Manage organizations and memberships**: Add or update organizations and administer user memberships with clarity.
|
||||
- **Monitor and revoke sessions**: See active or past user sessions, and revoke access immediately if needed for security.
|
||||
|
||||
The integration enables real-time, auditable management of your user base—all from within Sim. Connected agents can automate onboarding, enforce policies, keep directories up to date, and react to authentication events or organizational changes, helping you run secure and flexible processes using Clerk as your identity engine.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Clerk authentication and user management into your workflow. Create, update, delete, and list users. Manage organizations and their memberships. Monitor and control user sessions.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `clerk_list_users`
|
||||
|
||||
List all users in your Clerk application with optional filtering and pagination
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `limit` | number | No | Number of results per page \(1-500, default: 10\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `orderBy` | string | No | Sort field with optional +/- prefix for direction \(default: -created_at\) |
|
||||
| `emailAddress` | string | No | Filter by email address \(comma-separated for multiple\) |
|
||||
| `phoneNumber` | string | No | Filter by phone number \(comma-separated for multiple\) |
|
||||
| `externalId` | string | No | Filter by external ID \(comma-separated for multiple\) |
|
||||
| `username` | string | No | Filter by username \(comma-separated for multiple\) |
|
||||
| `userId` | string | No | Filter by user ID \(comma-separated for multiple\) |
|
||||
| `query` | string | No | Search query to match across email, phone, username, and names |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array of Clerk user objects |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `username` | string | Username |
|
||||
| ↳ `firstName` | string | First name |
|
||||
| ↳ `lastName` | string | Last name |
|
||||
| ↳ `imageUrl` | string | Profile image URL |
|
||||
| ↳ `hasImage` | boolean | Whether user has a profile image |
|
||||
| ↳ `primaryEmailAddressId` | string | Primary email address ID |
|
||||
| ↳ `primaryPhoneNumberId` | string | Primary phone number ID |
|
||||
| ↳ `emailAddresses` | array | User email addresses |
|
||||
| ↳ `id` | string | Email address ID |
|
||||
| ↳ `emailAddress` | string | Email address |
|
||||
| ↳ `phoneNumbers` | array | User phone numbers |
|
||||
| ↳ `id` | string | Phone number ID |
|
||||
| ↳ `phoneNumber` | string | Phone number |
|
||||
| ↳ `externalId` | string | External system ID |
|
||||
| ↳ `passwordEnabled` | boolean | Whether password is enabled |
|
||||
| ↳ `twoFactorEnabled` | boolean | Whether 2FA is enabled |
|
||||
| ↳ `banned` | boolean | Whether user is banned |
|
||||
| ↳ `locked` | boolean | Whether user is locked |
|
||||
| ↳ `lastSignInAt` | number | Last sign-in timestamp |
|
||||
| ↳ `lastActiveAt` | number | Last activity timestamp |
|
||||
| ↳ `createdAt` | number | Creation timestamp |
|
||||
| ↳ `updatedAt` | number | Last update timestamp |
|
||||
| ↳ `publicMetadata` | json | Public metadata |
|
||||
| `totalCount` | number | Total number of users matching the query |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `clerk_get_user`
|
||||
|
||||
Retrieve a single user by their ID from Clerk
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `userId` | string | Yes | The ID of the user to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | User ID |
|
||||
| `username` | string | Username |
|
||||
| `firstName` | string | First name |
|
||||
| `lastName` | string | Last name |
|
||||
| `imageUrl` | string | Profile image URL |
|
||||
| `hasImage` | boolean | Whether user has a profile image |
|
||||
| `primaryEmailAddressId` | string | Primary email address ID |
|
||||
| `primaryPhoneNumberId` | string | Primary phone number ID |
|
||||
| `primaryWeb3WalletId` | string | Primary Web3 wallet ID |
|
||||
| `emailAddresses` | array | User email addresses |
|
||||
| ↳ `id` | string | Email address ID |
|
||||
| ↳ `emailAddress` | string | Email address |
|
||||
| ↳ `verified` | boolean | Whether email is verified |
|
||||
| `phoneNumbers` | array | User phone numbers |
|
||||
| ↳ `id` | string | Phone number ID |
|
||||
| ↳ `phoneNumber` | string | Phone number |
|
||||
| ↳ `verified` | boolean | Whether phone is verified |
|
||||
| `externalId` | string | External system ID |
|
||||
| `passwordEnabled` | boolean | Whether password is enabled |
|
||||
| `twoFactorEnabled` | boolean | Whether 2FA is enabled |
|
||||
| `totpEnabled` | boolean | Whether TOTP is enabled |
|
||||
| `backupCodeEnabled` | boolean | Whether backup codes are enabled |
|
||||
| `banned` | boolean | Whether user is banned |
|
||||
| `locked` | boolean | Whether user is locked |
|
||||
| `deleteSelfEnabled` | boolean | Whether user can delete themselves |
|
||||
| `createOrganizationEnabled` | boolean | Whether user can create organizations |
|
||||
| `lastSignInAt` | number | Last sign-in timestamp |
|
||||
| `lastActiveAt` | number | Last activity timestamp |
|
||||
| `createdAt` | number | Creation timestamp |
|
||||
| `updatedAt` | number | Last update timestamp |
|
||||
| `publicMetadata` | json | Public metadata \(readable from frontend\) |
|
||||
| `privateMetadata` | json | Private metadata \(backend only\) |
|
||||
| `unsafeMetadata` | json | Unsafe metadata \(modifiable from frontend\) |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `clerk_create_user`
|
||||
|
||||
Create a new user in your Clerk application
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `emailAddress` | string | No | Email addresses for the user \(comma-separated for multiple\) |
|
||||
| `phoneNumber` | string | No | Phone numbers for the user \(comma-separated for multiple\) |
|
||||
| `username` | string | No | Username for the user \(must be unique\) |
|
||||
| `password` | string | No | Password for the user \(minimum 8 characters\) |
|
||||
| `firstName` | string | No | First name of the user |
|
||||
| `lastName` | string | No | Last name of the user |
|
||||
| `externalId` | string | No | External system identifier \(must be unique\) |
|
||||
| `publicMetadata` | json | No | Public metadata \(JSON object, readable from frontend\) |
|
||||
| `privateMetadata` | json | No | Private metadata \(JSON object, backend only\) |
|
||||
| `unsafeMetadata` | json | No | Unsafe metadata \(JSON object, modifiable from frontend\) |
|
||||
| `skipPasswordChecks` | boolean | No | Skip password validation checks |
|
||||
| `skipPasswordRequirement` | boolean | No | Make password optional |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Created user ID |
|
||||
| `username` | string | Username |
|
||||
| `firstName` | string | First name |
|
||||
| `lastName` | string | Last name |
|
||||
| `imageUrl` | string | Profile image URL |
|
||||
| `primaryEmailAddressId` | string | Primary email address ID |
|
||||
| `primaryPhoneNumberId` | string | Primary phone number ID |
|
||||
| `emailAddresses` | array | User email addresses |
|
||||
| ↳ `id` | string | Email address ID |
|
||||
| ↳ `emailAddress` | string | Email address |
|
||||
| ↳ `verified` | boolean | Whether email is verified |
|
||||
| `phoneNumbers` | array | User phone numbers |
|
||||
| ↳ `id` | string | Phone number ID |
|
||||
| ↳ `phoneNumber` | string | Phone number |
|
||||
| ↳ `verified` | boolean | Whether phone is verified |
|
||||
| `externalId` | string | External system ID |
|
||||
| `createdAt` | number | Creation timestamp |
|
||||
| `updatedAt` | number | Last update timestamp |
|
||||
| `publicMetadata` | json | Public metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `clerk_update_user`
|
||||
|
||||
Update an existing user in your Clerk application
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `userId` | string | Yes | The ID of the user to update |
|
||||
| `firstName` | string | No | First name of the user |
|
||||
| `lastName` | string | No | Last name of the user |
|
||||
| `username` | string | No | Username \(must be unique\) |
|
||||
| `password` | string | No | New password \(minimum 8 characters\) |
|
||||
| `externalId` | string | No | External system identifier |
|
||||
| `primaryEmailAddressId` | string | No | ID of verified email to set as primary |
|
||||
| `primaryPhoneNumberId` | string | No | ID of verified phone to set as primary |
|
||||
| `publicMetadata` | json | No | Public metadata \(JSON object\) |
|
||||
| `privateMetadata` | json | No | Private metadata \(JSON object\) |
|
||||
| `unsafeMetadata` | json | No | Unsafe metadata \(JSON object\) |
|
||||
| `skipPasswordChecks` | boolean | No | Skip password validation checks |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Updated user ID |
|
||||
| `username` | string | Username |
|
||||
| `firstName` | string | First name |
|
||||
| `lastName` | string | Last name |
|
||||
| `imageUrl` | string | Profile image URL |
|
||||
| `primaryEmailAddressId` | string | Primary email address ID |
|
||||
| `primaryPhoneNumberId` | string | Primary phone number ID |
|
||||
| `emailAddresses` | array | User email addresses |
|
||||
| ↳ `id` | string | Email address ID |
|
||||
| ↳ `emailAddress` | string | Email address |
|
||||
| ↳ `verified` | boolean | Whether email is verified |
|
||||
| `phoneNumbers` | array | User phone numbers |
|
||||
| ↳ `id` | string | Phone number ID |
|
||||
| ↳ `phoneNumber` | string | Phone number |
|
||||
| ↳ `verified` | boolean | Whether phone is verified |
|
||||
| `externalId` | string | External system ID |
|
||||
| `banned` | boolean | Whether user is banned |
|
||||
| `locked` | boolean | Whether user is locked |
|
||||
| `createdAt` | number | Creation timestamp |
|
||||
| `updatedAt` | number | Last update timestamp |
|
||||
| `publicMetadata` | json | Public metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `clerk_delete_user`
|
||||
|
||||
Delete a user from your Clerk application
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `userId` | string | Yes | The ID of the user to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Deleted user ID |
|
||||
| `object` | string | Object type \(user\) |
|
||||
| `deleted` | boolean | Whether the user was deleted |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `clerk_list_organizations`
|
||||
|
||||
List all organizations in your Clerk application with optional filtering
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `limit` | number | No | Number of results per page \(1-500, default: 10\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `includeMembersCount` | boolean | No | Include member count for each organization |
|
||||
| `query` | string | No | Search by organization ID, name, or slug |
|
||||
| `orderBy` | string | No | Sort field \(name, created_at, members_count\) with +/- prefix |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Array of Clerk organization objects |
|
||||
| ↳ `id` | string | Organization ID |
|
||||
| ↳ `name` | string | Organization name |
|
||||
| ↳ `slug` | string | Organization slug |
|
||||
| ↳ `imageUrl` | string | Organization image URL |
|
||||
| ↳ `hasImage` | boolean | Whether organization has an image |
|
||||
| ↳ `membersCount` | number | Number of members |
|
||||
| ↳ `pendingInvitationsCount` | number | Number of pending invitations |
|
||||
| ↳ `maxAllowedMemberships` | number | Max allowed memberships |
|
||||
| ↳ `adminDeleteEnabled` | boolean | Whether admin delete is enabled |
|
||||
| ↳ `createdBy` | string | Creator user ID |
|
||||
| ↳ `createdAt` | number | Creation timestamp |
|
||||
| ↳ `updatedAt` | number | Last update timestamp |
|
||||
| ↳ `publicMetadata` | json | Public metadata |
|
||||
| `totalCount` | number | Total number of organizations |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `clerk_get_organization`
|
||||
|
||||
Retrieve a single organization by ID or slug from Clerk
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `organizationId` | string | Yes | The ID or slug of the organization to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Organization ID |
|
||||
| `name` | string | Organization name |
|
||||
| `slug` | string | Organization slug |
|
||||
| `imageUrl` | string | Organization image URL |
|
||||
| `hasImage` | boolean | Whether organization has an image |
|
||||
| `membersCount` | number | Number of members |
|
||||
| `pendingInvitationsCount` | number | Number of pending invitations |
|
||||
| `maxAllowedMemberships` | number | Max allowed memberships |
|
||||
| `adminDeleteEnabled` | boolean | Whether admin delete is enabled |
|
||||
| `createdBy` | string | Creator user ID |
|
||||
| `createdAt` | number | Creation timestamp |
|
||||
| `updatedAt` | number | Last update timestamp |
|
||||
| `publicMetadata` | json | Public metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `clerk_create_organization`
|
||||
|
||||
Create a new organization in your Clerk application
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `name` | string | Yes | Name of the organization |
|
||||
| `createdBy` | string | Yes | User ID of the creator \(will become admin\) |
|
||||
| `slug` | string | No | Slug identifier for the organization |
|
||||
| `maxAllowedMemberships` | number | No | Maximum member capacity \(0 for unlimited\) |
|
||||
| `publicMetadata` | json | No | Public metadata \(JSON object\) |
|
||||
| `privateMetadata` | json | No | Private metadata \(JSON object\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Created organization ID |
|
||||
| `name` | string | Organization name |
|
||||
| `slug` | string | Organization slug |
|
||||
| `imageUrl` | string | Organization image URL |
|
||||
| `hasImage` | boolean | Whether organization has an image |
|
||||
| `membersCount` | number | Number of members |
|
||||
| `pendingInvitationsCount` | number | Number of pending invitations |
|
||||
| `maxAllowedMemberships` | number | Max allowed memberships |
|
||||
| `adminDeleteEnabled` | boolean | Whether admin delete is enabled |
|
||||
| `createdBy` | string | Creator user ID |
|
||||
| `createdAt` | number | Creation timestamp |
|
||||
| `updatedAt` | number | Last update timestamp |
|
||||
| `publicMetadata` | json | Public metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `clerk_list_sessions`
|
||||
|
||||
List sessions for a user or client in your Clerk application
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `userId` | string | No | User ID to list sessions for \(required if clientId not provided\) |
|
||||
| `clientId` | string | No | Client ID to list sessions for \(required if userId not provided\) |
|
||||
| `status` | string | No | Filter by session status \(abandoned, active, ended, expired, pending, removed, replaced, revoked\) |
|
||||
| `limit` | number | No | Number of results per page \(1-500, default: 10\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `sessions` | array | Array of Clerk session objects |
|
||||
| ↳ `id` | string | Session ID |
|
||||
| ↳ `userId` | string | User ID |
|
||||
| ↳ `clientId` | string | Client ID |
|
||||
| ↳ `status` | string | Session status |
|
||||
| ↳ `lastActiveAt` | number | Last activity timestamp |
|
||||
| ↳ `lastActiveOrganizationId` | string | Last active organization ID |
|
||||
| ↳ `expireAt` | number | Expiration timestamp |
|
||||
| ↳ `abandonAt` | number | Abandon timestamp |
|
||||
| ↳ `createdAt` | number | Creation timestamp |
|
||||
| ↳ `updatedAt` | number | Last update timestamp |
|
||||
| `totalCount` | number | Total number of sessions |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `clerk_get_session`
|
||||
|
||||
Retrieve a single session by ID from Clerk
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `sessionId` | string | Yes | The ID of the session to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Session ID |
|
||||
| `userId` | string | User ID |
|
||||
| `clientId` | string | Client ID |
|
||||
| `status` | string | Session status |
|
||||
| `lastActiveAt` | number | Last activity timestamp |
|
||||
| `lastActiveOrganizationId` | string | Last active organization ID |
|
||||
| `expireAt` | number | Expiration timestamp |
|
||||
| `abandonAt` | number | Abandon timestamp |
|
||||
| `createdAt` | number | Creation timestamp |
|
||||
| `updatedAt` | number | Last update timestamp |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `clerk_revoke_session`
|
||||
|
||||
Revoke a session to immediately invalidate it
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||
| `sessionId` | string | Yes | The ID of the session to revoke |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Session ID |
|
||||
| `userId` | string | User ID |
|
||||
| `clientId` | string | Client ID |
|
||||
| `status` | string | Session status \(should be revoked\) |
|
||||
| `lastActiveAt` | number | Last activity timestamp |
|
||||
| `lastActiveOrganizationId` | string | Last active organization ID |
|
||||
| `expireAt` | number | Expiration timestamp |
|
||||
| `abandonAt` | number | Abandon timestamp |
|
||||
| `createdAt` | number | Creation timestamp |
|
||||
| `updatedAt` | number | Last update timestamp |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
|
||||
@@ -140,7 +140,20 @@ Search for content across Confluence pages, blog posts, and other content.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of search |
|
||||
| `results` | array | Search results |
|
||||
| `results` | array | Array of search results |
|
||||
| ↳ `id` | string | Unique content identifier |
|
||||
| ↳ `title` | string | Content title |
|
||||
| ↳ `type` | string | Content type \(e.g., page, blogpost, attachment, comment\) |
|
||||
| ↳ `status` | string | Content status \(e.g., current\) |
|
||||
| ↳ `url` | string | URL to view the content in Confluence |
|
||||
| ↳ `excerpt` | string | Text excerpt matching the search query |
|
||||
| ↳ `spaceKey` | string | Key of the space containing the content |
|
||||
| ↳ `space` | object | Space information for the content |
|
||||
| ↳ `id` | string | Space identifier |
|
||||
| ↳ `key` | string | Space key |
|
||||
| ↳ `name` | string | Space name |
|
||||
| ↳ `lastModified` | string | ISO 8601 timestamp of last modification |
|
||||
| ↳ `entityType` | string | Entity type identifier \(e.g., content, space\) |
|
||||
|
||||
### `confluence_create_comment`
|
||||
|
||||
@@ -180,8 +193,25 @@ List all comments on a Confluence page.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of retrieval |
|
||||
| `comments` | array | List of comments |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `comments` | array | Array of Confluence comments |
|
||||
| ↳ `id` | string | Unique comment identifier |
|
||||
| ↳ `status` | string | Comment status \(e.g., current\) |
|
||||
| ↳ `title` | string | Comment title |
|
||||
| ↳ `pageId` | string | ID of the page the comment belongs to |
|
||||
| ↳ `blogPostId` | string | ID of the blog post the comment belongs to |
|
||||
| ↳ `parentCommentId` | string | ID of the parent comment |
|
||||
| ↳ `body` | object | Comment body content |
|
||||
| ↳ `value` | string | Comment body content |
|
||||
| ↳ `representation` | string | Content representation format \(e.g., storage, view\) |
|
||||
| ↳ `createdAt` | string | ISO 8601 timestamp when the comment was created |
|
||||
| ↳ `authorId` | string | Account ID of the comment author |
|
||||
| ↳ `version` | object | Comment version information |
|
||||
| ↳ `number` | number | Version number |
|
||||
| ↳ `message` | string | Version message |
|
||||
| ↳ `minorEdit` | boolean | Whether this is a minor edit |
|
||||
| ↳ `authorId` | string | Account ID of the version author |
|
||||
| ↳ `createdAt` | string | ISO 8601 timestamp of version creation |
|
||||
|
||||
### `confluence_update_comment`
|
||||
|
||||
@@ -268,8 +298,24 @@ List all attachments on a Confluence page.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of retrieval |
|
||||
| `attachments` | array | List of attachments |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `attachments` | array | Array of Confluence attachments |
|
||||
| ↳ `id` | string | Unique attachment identifier \(prefixed with "att"\) |
|
||||
| ↳ `title` | string | Attachment file name |
|
||||
| ↳ `status` | string | Attachment status \(e.g., current, archived, trashed\) |
|
||||
| ↳ `mediaType` | string | MIME type of the attachment |
|
||||
| ↳ `fileSize` | number | File size in bytes |
|
||||
| ↳ `downloadUrl` | string | URL to download the attachment |
|
||||
| ↳ `webuiUrl` | string | URL to view the attachment in Confluence UI |
|
||||
| ↳ `pageId` | string | ID of the page the attachment belongs to |
|
||||
| ↳ `blogPostId` | string | ID of the blog post the attachment belongs to |
|
||||
| ↳ `comment` | string | Comment/description of the attachment |
|
||||
| ↳ `version` | object | Attachment version information |
|
||||
| ↳ `number` | number | Version number |
|
||||
| ↳ `message` | string | Version message |
|
||||
| ↳ `minorEdit` | boolean | Whether this is a minor edit |
|
||||
| ↳ `authorId` | string | Account ID of the version author |
|
||||
| ↳ `createdAt` | string | ISO 8601 timestamp of version creation |
|
||||
|
||||
### `confluence_delete_attachment`
|
||||
|
||||
@@ -308,7 +354,10 @@ List all labels on a Confluence page.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of retrieval |
|
||||
| `labels` | array | List of labels |
|
||||
| `labels` | array | Array of labels on the page |
|
||||
| ↳ `id` | string | Unique label identifier |
|
||||
| ↳ `name` | string | Label name |
|
||||
| ↳ `prefix` | string | Label prefix/type \(e.g., global, my, team\) |
|
||||
|
||||
### `confluence_get_space`
|
||||
|
||||
@@ -350,7 +399,18 @@ List all Confluence spaces accessible to the user.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of retrieval |
|
||||
| `spaces` | array | List of spaces |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `spaces` | array | Array of Confluence spaces |
|
||||
| ↳ `id` | string | Unique space identifier |
|
||||
| ↳ `key` | string | Space key \(short identifier used in URLs\) |
|
||||
| ↳ `name` | string | Space name |
|
||||
| ↳ `type` | string | Space type \(e.g., global, personal\) |
|
||||
| ↳ `status` | string | Space status \(e.g., current, archived\) |
|
||||
| ↳ `authorId` | string | Account ID of the space creator |
|
||||
| ↳ `createdAt` | string | ISO 8601 timestamp when the space was created |
|
||||
| ↳ `homepageId` | string | ID of the space homepage |
|
||||
| ↳ `description` | object | Space description |
|
||||
| ↳ `value` | string | Description text content |
|
||||
| ↳ `representation` | string | Content representation format \(e.g., plain, view, storage\) |
|
||||
|
||||
|
||||
|
||||
@@ -257,11 +257,6 @@ Search and retrieve logs from Datadog. Use for troubleshooting, analysis, or mon
|
||||
| ↳ `service` | string | Service name |
|
||||
| ↳ `message` | string | Log message |
|
||||
| ↳ `status` | string | Log status/level |
|
||||
| ↳ `timestamp` | string | Log timestamp |
|
||||
| ↳ `host` | string | Host name |
|
||||
| ↳ `service` | string | Service name |
|
||||
| ↳ `message` | string | Log message |
|
||||
| ↳ `status` | string | Log status/level |
|
||||
| `nextLogId` | string | Cursor for pagination |
|
||||
|
||||
### `datadog_send_logs`
|
||||
|
||||
@@ -64,7 +64,7 @@ Send a message to a Discord channel
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Discord message data |
|
||||
| ↳ `id` | string | Author user ID |
|
||||
| ↳ `id` | string | Message ID |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `channel_id` | string | Channel ID where message was sent |
|
||||
| ↳ `author` | object | Message author information |
|
||||
@@ -72,9 +72,6 @@ Send a message to a Discord channel
|
||||
| ↳ `username` | string | Author username |
|
||||
| ↳ `avatar` | string | Author avatar hash |
|
||||
| ↳ `bot` | boolean | Whether author is a bot |
|
||||
| ↳ `username` | string | Author username |
|
||||
| ↳ `avatar` | string | Author avatar hash |
|
||||
| ↳ `bot` | boolean | Whether author is a bot |
|
||||
| ↳ `timestamp` | string | Message timestamp |
|
||||
| ↳ `edited_timestamp` | string | Message edited timestamp |
|
||||
| ↳ `embeds` | array | Message embeds |
|
||||
@@ -102,7 +99,7 @@ Retrieve messages from a Discord channel
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Container for messages data |
|
||||
| ↳ `messages` | array | Array of Discord messages with full metadata |
|
||||
| ↳ `id` | string | Author user ID |
|
||||
| ↳ `id` | string | Message ID |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `channel_id` | string | Channel ID |
|
||||
| ↳ `author` | object | Message author information |
|
||||
@@ -110,9 +107,6 @@ Retrieve messages from a Discord channel
|
||||
| ↳ `username` | string | Author username |
|
||||
| ↳ `avatar` | string | Author avatar hash |
|
||||
| ↳ `bot` | boolean | Whether author is a bot |
|
||||
| ↳ `username` | string | Author username |
|
||||
| ↳ `avatar` | string | Author avatar hash |
|
||||
| ↳ `bot` | boolean | Whether author is a bot |
|
||||
| ↳ `timestamp` | string | Message timestamp |
|
||||
| ↳ `edited_timestamp` | string | Message edited timestamp |
|
||||
| ↳ `embeds` | array | Message embeds |
|
||||
@@ -120,24 +114,7 @@ Retrieve messages from a Discord channel
|
||||
| ↳ `mentions` | array | User mentions in message |
|
||||
| ↳ `mention_roles` | array | Role mentions in message |
|
||||
| ↳ `mention_everyone` | boolean | Whether message mentions everyone |
|
||||
| ↳ `id` | string | Author user ID |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `channel_id` | string | Channel ID |
|
||||
| ↳ `author` | object | Message author information |
|
||||
| ↳ `id` | string | Author user ID |
|
||||
| ↳ `username` | string | Author username |
|
||||
| ↳ `avatar` | string | Author avatar hash |
|
||||
| ↳ `bot` | boolean | Whether author is a bot |
|
||||
| ↳ `username` | string | Author username |
|
||||
| ↳ `avatar` | string | Author avatar hash |
|
||||
| ↳ `bot` | boolean | Whether author is a bot |
|
||||
| ↳ `timestamp` | string | Message timestamp |
|
||||
| ↳ `edited_timestamp` | string | Message edited timestamp |
|
||||
| ↳ `embeds` | array | Message embeds |
|
||||
| ↳ `attachments` | array | Message attachments |
|
||||
| ↳ `mentions` | array | User mentions in message |
|
||||
| ↳ `mention_roles` | array | Role mentions in message |
|
||||
| ↳ `mention_everyone` | boolean | Whether message mentions everyone |
|
||||
|
||||
### `discord_get_server`
|
||||
|
||||
@@ -681,9 +658,6 @@ Get information about a member in a Discord server
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `username` | string | Username |
|
||||
| ↳ `avatar` | string | Avatar hash |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `username` | string | Username |
|
||||
| ↳ `avatar` | string | Avatar hash |
|
||||
| ↳ `nick` | string | Server nickname |
|
||||
| ↳ `roles` | array | Array of role IDs |
|
||||
| ↳ `joined_at` | string | When the member joined |
|
||||
|
||||
@@ -66,7 +66,7 @@ Search the web using Exa AI. Returns relevant search results with titles, URLs,
|
||||
| ↳ `publishedDate` | string | Date when the content was published |
|
||||
| ↳ `author` | string | The author of the content |
|
||||
| ↳ `summary` | string | A brief summary of the content |
|
||||
| ↳ `favicon` | string | URL of the site |
|
||||
| ↳ `favicon` | string | URL of the site's favicon |
|
||||
| ↳ `image` | string | URL of a representative image from the page |
|
||||
| ↳ `text` | string | Text snippet or full content from the page |
|
||||
| ↳ `score` | number | Relevance score for the search result |
|
||||
|
||||
@@ -61,6 +61,20 @@ Extract structured content from web pages with comprehensive metadata support. C
|
||||
| `markdown` | string | Page content in markdown format |
|
||||
| `html` | string | Raw HTML content of the page |
|
||||
| `metadata` | object | Page metadata including SEO and Open Graph information |
|
||||
| ↳ `title` | string | Page title |
|
||||
| ↳ `description` | string | Page meta description |
|
||||
| ↳ `language` | string | Page language code \(e.g., "en"\) |
|
||||
| ↳ `sourceURL` | string | Original source URL that was scraped |
|
||||
| ↳ `statusCode` | number | HTTP status code of the response |
|
||||
| ↳ `keywords` | string | Page meta keywords |
|
||||
| ↳ `robots` | string | Robots meta directive \(e.g., "follow, index"\) |
|
||||
| ↳ `ogTitle` | string | Open Graph title |
|
||||
| ↳ `ogDescription` | string | Open Graph description |
|
||||
| ↳ `ogUrl` | string | Open Graph URL |
|
||||
| ↳ `ogImage` | string | Open Graph image URL |
|
||||
| ↳ `ogLocaleAlternate` | array | Alternate locale versions for Open Graph |
|
||||
| ↳ `ogSiteName` | string | Open Graph site name |
|
||||
| ↳ `error` | string | Error message if scrape failed |
|
||||
|
||||
### `firecrawl_search`
|
||||
|
||||
@@ -77,7 +91,21 @@ Search for information on the web using Firecrawl
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `data` | array | Search results data |
|
||||
| `data` | array | Search results data with scraped content and metadata |
|
||||
| ↳ `title` | string | Search result title from search engine |
|
||||
| ↳ `description` | string | Search result description/snippet from search engine |
|
||||
| ↳ `url` | string | URL of the search result |
|
||||
| ↳ `markdown` | string | Page content in markdown \(when scrapeOptions.formats includes "markdown"\) |
|
||||
| ↳ `html` | string | Processed HTML content \(when scrapeOptions.formats includes "html"\) |
|
||||
| ↳ `rawHtml` | string | Unprocessed raw HTML \(when scrapeOptions.formats includes "rawHtml"\) |
|
||||
| ↳ `links` | array | Links found on the page \(when scrapeOptions.formats includes "links"\) |
|
||||
| ↳ `screenshot` | string | Screenshot URL \(expires after 24 hours, when scrapeOptions.formats includes "screenshot"\) |
|
||||
| ↳ `metadata` | object | Metadata about the search result page |
|
||||
| ↳ `title` | string | Page title |
|
||||
| ↳ `description` | string | Page meta description |
|
||||
| ↳ `sourceURL` | string | Original source URL |
|
||||
| ↳ `statusCode` | number | HTTP status code |
|
||||
| ↳ `error` | string | Error message if scrape failed |
|
||||
|
||||
### `firecrawl_crawl`
|
||||
|
||||
@@ -98,18 +126,17 @@ Crawl entire websites and extract structured content from all accessible pages
|
||||
| --------- | ---- | ----------- |
|
||||
| `pages` | array | Array of crawled pages with their content and metadata |
|
||||
| ↳ `markdown` | string | Page content in markdown format |
|
||||
| ↳ `html` | string | Page HTML content |
|
||||
| ↳ `metadata` | object | Page metadata |
|
||||
| ↳ `html` | string | Processed HTML content of the page |
|
||||
| ↳ `rawHtml` | string | Unprocessed raw HTML content |
|
||||
| ↳ `links` | array | Array of links found on the page |
|
||||
| ↳ `screenshot` | string | Screenshot URL \(expires after 24 hours\) |
|
||||
| ↳ `metadata` | object | Page metadata from crawl operation |
|
||||
| ↳ `title` | string | Page title |
|
||||
| ↳ `description` | string | Page description |
|
||||
| ↳ `language` | string | Page language |
|
||||
| ↳ `sourceURL` | string | Source URL of the page |
|
||||
| ↳ `statusCode` | number | HTTP status code |
|
||||
| ↳ `title` | string | Page title |
|
||||
| ↳ `description` | string | Page description |
|
||||
| ↳ `language` | string | Page language |
|
||||
| ↳ `sourceURL` | string | Source URL of the page |
|
||||
| ↳ `description` | string | Page meta description |
|
||||
| ↳ `language` | string | Page language code |
|
||||
| ↳ `sourceURL` | string | Original source URL |
|
||||
| ↳ `statusCode` | number | HTTP status code |
|
||||
| ↳ `ogLocaleAlternate` | array | Alternate locale versions |
|
||||
| `total` | number | Total number of pages found during crawl |
|
||||
| `creditsUsed` | number | Number of credits consumed by the crawl operation |
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -139,25 +139,10 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
|
||||
| ↳ `title` | string | The form title visible to responders |
|
||||
| ↳ `description` | string | The form description |
|
||||
| ↳ `documentTitle` | string | The document title visible in Drive |
|
||||
| ↳ `title` | string | Item title |
|
||||
| ↳ `description` | string | Item description |
|
||||
| ↳ `documentTitle` | string | The document title visible in Drive |
|
||||
| ↳ `settings` | object | Form settings |
|
||||
| ↳ `quizSettings` | object | Quiz settings |
|
||||
| ↳ `isQuiz` | boolean | Whether the form is a quiz |
|
||||
| ↳ `isQuiz` | boolean | Whether the form is a quiz |
|
||||
| ↳ `emailCollectionType` | string | Email collection type |
|
||||
| ↳ `quizSettings` | object | Quiz settings |
|
||||
| ↳ `isQuiz` | boolean | Whether the form is a quiz |
|
||||
| ↳ `isQuiz` | boolean | Whether the form is a quiz |
|
||||
| ↳ `emailCollectionType` | string | Email collection type |
|
||||
| ↳ `itemId` | string | Item ID |
|
||||
| ↳ `questionItem` | json | Question item configuration |
|
||||
| ↳ `questionGroupItem` | json | Question group configuration |
|
||||
| ↳ `pageBreakItem` | json | Page break configuration |
|
||||
| ↳ `textItem` | json | Text item configuration |
|
||||
| ↳ `imageItem` | json | Image item configuration |
|
||||
| ↳ `videoItem` | json | Video item configuration |
|
||||
| ↳ `revisionId` | string | The revision ID of the form |
|
||||
| ↳ `responderUri` | string | The URI to share with responders |
|
||||
| ↳ `linkedSheetId` | string | The ID of the linked Google Sheet |
|
||||
@@ -165,13 +150,6 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
|
||||
| ↳ `publishState` | object | Current publish state |
|
||||
| ↳ `isPublished` | boolean | Whether the form is published |
|
||||
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
|
||||
| ↳ `isPublished` | boolean | Whether the form is published |
|
||||
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
|
||||
| ↳ `publishState` | object | Current publish state |
|
||||
| ↳ `isPublished` | boolean | Whether the form is published |
|
||||
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
|
||||
| ↳ `isPublished` | boolean | Whether the form is published |
|
||||
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
|
||||
|
||||
### `google_forms_set_publish_settings`
|
||||
|
||||
@@ -194,8 +172,6 @@ Update the publish settings of a form (publish/unpublish, accept responses)
|
||||
| ↳ `publishState` | object | The publish state |
|
||||
| ↳ `isPublished` | boolean | Whether the form is published |
|
||||
| ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses |
|
||||
| ↳ `isPublished` | boolean | Whether the form is published |
|
||||
| ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses |
|
||||
|
||||
### `google_forms_create_watch`
|
||||
|
||||
|
||||
@@ -231,7 +231,7 @@ List all email aliases for a Google Group
|
||||
| --------- | ---- | ----------- |
|
||||
| `aliases` | array | List of email aliases for the group |
|
||||
| ↳ `id` | string | Unique group identifier |
|
||||
| ↳ `primaryEmail` | string | Group |
|
||||
| ↳ `primaryEmail` | string | Group's primary email address |
|
||||
| ↳ `alias` | string | Alias email address |
|
||||
| ↳ `kind` | string | API resource type |
|
||||
| ↳ `etag` | string | Resource version identifier |
|
||||
@@ -252,7 +252,7 @@ Add an email alias to a Google Group
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Unique group identifier |
|
||||
| `primaryEmail` | string | Group |
|
||||
| `primaryEmail` | string | Group's primary email address |
|
||||
| `alias` | string | The alias that was added |
|
||||
| `kind` | string | API resource type |
|
||||
| `etag` | string | Resource version identifier |
|
||||
@@ -288,7 +288,7 @@ Get the settings for a Google Group including access permissions, moderation, an
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `email` | string | The group |
|
||||
| `email` | string | The group's email address |
|
||||
| `name` | string | The group name \(max 75 characters\) |
|
||||
| `description` | string | The group description \(max 4096 characters\) |
|
||||
| `whoCanJoin` | string | Who can join the group \(ANYONE_CAN_JOIN, ALL_IN_DOMAIN_CAN_JOIN, INVITED_CAN_JOIN, CAN_REQUEST_TO_JOIN\) |
|
||||
@@ -297,7 +297,7 @@ Get the settings for a Google Group including access permissions, moderation, an
|
||||
| `whoCanPostMessage` | string | Who can post messages to the group |
|
||||
| `allowExternalMembers` | string | Whether external users can be members |
|
||||
| `allowWebPosting` | string | Whether web posting is allowed |
|
||||
| `primaryLanguage` | string | The group |
|
||||
| `primaryLanguage` | string | The group's primary language |
|
||||
| `isArchived` | string | Whether messages are archived |
|
||||
| `archiveOnly` | string | Whether the group is archive-only \(inactive\) |
|
||||
| `messageModerationLevel` | string | Message moderation level |
|
||||
@@ -368,7 +368,7 @@ Update the settings for a Google Group including access permissions, moderation,
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `email` | string | The group |
|
||||
| `email` | string | The group's email address |
|
||||
| `name` | string | The group name |
|
||||
| `description` | string | The group description |
|
||||
| `whoCanJoin` | string | Who can join the group |
|
||||
@@ -377,7 +377,7 @@ Update the settings for a Google Group including access permissions, moderation,
|
||||
| `whoCanPostMessage` | string | Who can post messages to the group |
|
||||
| `allowExternalMembers` | string | Whether external users can be members |
|
||||
| `allowWebPosting` | string | Whether web posting is allowed |
|
||||
| `primaryLanguage` | string | The group |
|
||||
| `primaryLanguage` | string | The group's primary language |
|
||||
| `isArchived` | string | Whether messages are archived |
|
||||
| `archiveOnly` | string | Whether the group is archive-only |
|
||||
| `messageModerationLevel` | string | Message moderation level |
|
||||
|
||||
@@ -66,8 +66,8 @@ Search the web with the Custom Search API
|
||||
| ↳ `title` | string | Title of the search result |
|
||||
| ↳ `link` | string | URL of the search result |
|
||||
| ↳ `snippet` | string | Snippet or description of the search result |
|
||||
| ↳ `displayLink` | string | Display URL |
|
||||
| ↳ `pagemap` | object | Additional page metadata |
|
||||
| ↳ `displayLink` | string | Display URL \(abbreviated form\) |
|
||||
| ↳ `pagemap` | object | PageMap information for the result \(structured data\) |
|
||||
| `searchInformation` | object | Information about the search query and results |
|
||||
| ↳ `totalResults` | string | Total number of search results available |
|
||||
| ↳ `searchTime` | number | Time taken to perform the search in seconds |
|
||||
|
||||
@@ -57,8 +57,6 @@ Read content from a Google Slides presentation
|
||||
| ↳ `pageSize` | object | Presentation page size |
|
||||
| ↳ `width` | json | Page width as a Dimension object |
|
||||
| ↳ `height` | json | Page height as a Dimension object |
|
||||
| ↳ `width` | json | Page width as a Dimension object |
|
||||
| ↳ `height` | json | Page height as a Dimension object |
|
||||
| ↳ `mimeType` | string | The mime type of the presentation |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
|
||||
|
||||
@@ -51,6 +51,12 @@ Retrieve all users from HubSpot account
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array of HubSpot user objects |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `email` | string | User email address |
|
||||
| ↳ `roleId` | string | User role ID |
|
||||
| ↳ `primaryTeamId` | string | Primary team ID |
|
||||
| ↳ `secondaryTeamIds` | array | Secondary team IDs |
|
||||
| ↳ `superAdmin` | boolean | Whether user is a super admin |
|
||||
| `totalItems` | number | Total number of users returned |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -71,9 +77,33 @@ Retrieve all contacts from HubSpot account with pagination support
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contacts` | array | Array of HubSpot contact objects |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Metadata with totalReturned and hasMore |
|
||||
| `contacts` | array | Array of HubSpot contact records |
|
||||
| ↳ `email` | string | Contact email address |
|
||||
| ↳ `firstname` | string | Contact first name |
|
||||
| ↳ `lastname` | string | Contact last name |
|
||||
| ↳ `phone` | string | Contact phone number |
|
||||
| ↳ `mobilephone` | string | Contact mobile phone number |
|
||||
| ↳ `company` | string | Associated company name |
|
||||
| ↳ `website` | string | Contact website URL |
|
||||
| ↳ `jobtitle` | string | Contact job title |
|
||||
| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `createdate` | string | Contact creation date \(ISO 8601\) |
|
||||
| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `address` | string | Street address |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `state` | string | State/Region |
|
||||
| ↳ `zip` | string | Postal/ZIP code |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `fax` | string | Fax number |
|
||||
| ↳ `hs_timezone` | string | Contact timezone |
|
||||
| `paging` | object | Pagination information for fetching more results |
|
||||
| ↳ `after` | string | Cursor for next page of results |
|
||||
| ↳ `link` | string | Link to next page |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records are available |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `hubspot_get_contact`
|
||||
@@ -93,7 +123,27 @@ Retrieve a single contact by ID or email from HubSpot
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contact` | object | HubSpot contact object with properties |
|
||||
| `contact` | object | HubSpot contact record |
|
||||
| ↳ `email` | string | Contact email address |
|
||||
| ↳ `firstname` | string | Contact first name |
|
||||
| ↳ `lastname` | string | Contact last name |
|
||||
| ↳ `phone` | string | Contact phone number |
|
||||
| ↳ `mobilephone` | string | Contact mobile phone number |
|
||||
| ↳ `company` | string | Associated company name |
|
||||
| ↳ `website` | string | Contact website URL |
|
||||
| ↳ `jobtitle` | string | Contact job title |
|
||||
| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `createdate` | string | Contact creation date \(ISO 8601\) |
|
||||
| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `address` | string | Street address |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `state` | string | State/Region |
|
||||
| ↳ `zip` | string | Postal/ZIP code |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `fax` | string | Fax number |
|
||||
| ↳ `hs_timezone` | string | Contact timezone |
|
||||
| `contactId` | string | The retrieved contact ID |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -112,7 +162,27 @@ Create a new contact in HubSpot. Requires at least one of: email, firstname, or
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contact` | object | Created HubSpot contact object |
|
||||
| `contact` | object | HubSpot contact record |
|
||||
| ↳ `email` | string | Contact email address |
|
||||
| ↳ `firstname` | string | Contact first name |
|
||||
| ↳ `lastname` | string | Contact last name |
|
||||
| ↳ `phone` | string | Contact phone number |
|
||||
| ↳ `mobilephone` | string | Contact mobile phone number |
|
||||
| ↳ `company` | string | Associated company name |
|
||||
| ↳ `website` | string | Contact website URL |
|
||||
| ↳ `jobtitle` | string | Contact job title |
|
||||
| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `createdate` | string | Contact creation date \(ISO 8601\) |
|
||||
| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `address` | string | Street address |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `state` | string | State/Region |
|
||||
| ↳ `zip` | string | Postal/ZIP code |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `fax` | string | Fax number |
|
||||
| ↳ `hs_timezone` | string | Contact timezone |
|
||||
| `contactId` | string | The created contact ID |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -132,7 +202,27 @@ Update an existing contact in HubSpot by ID or email
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contact` | object | Updated HubSpot contact object |
|
||||
| `contact` | object | HubSpot contact record |
|
||||
| ↳ `email` | string | Contact email address |
|
||||
| ↳ `firstname` | string | Contact first name |
|
||||
| ↳ `lastname` | string | Contact last name |
|
||||
| ↳ `phone` | string | Contact phone number |
|
||||
| ↳ `mobilephone` | string | Contact mobile phone number |
|
||||
| ↳ `company` | string | Associated company name |
|
||||
| ↳ `website` | string | Contact website URL |
|
||||
| ↳ `jobtitle` | string | Contact job title |
|
||||
| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `createdate` | string | Contact creation date \(ISO 8601\) |
|
||||
| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `address` | string | Street address |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `state` | string | State/Region |
|
||||
| ↳ `zip` | string | Postal/ZIP code |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `fax` | string | Fax number |
|
||||
| ↳ `hs_timezone` | string | Contact timezone |
|
||||
| `contactId` | string | The updated contact ID |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -155,10 +245,34 @@ Search for contacts in HubSpot using filters, sorting, and queries
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contacts` | array | Array of matching HubSpot contact objects |
|
||||
| `contacts` | array | Array of HubSpot contact records |
|
||||
| ↳ `email` | string | Contact email address |
|
||||
| ↳ `firstname` | string | Contact first name |
|
||||
| ↳ `lastname` | string | Contact last name |
|
||||
| ↳ `phone` | string | Contact phone number |
|
||||
| ↳ `mobilephone` | string | Contact mobile phone number |
|
||||
| ↳ `company` | string | Associated company name |
|
||||
| ↳ `website` | string | Contact website URL |
|
||||
| ↳ `jobtitle` | string | Contact job title |
|
||||
| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `createdate` | string | Contact creation date \(ISO 8601\) |
|
||||
| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `address` | string | Street address |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `state` | string | State/Region |
|
||||
| ↳ `zip` | string | Postal/ZIP code |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `fax` | string | Fax number |
|
||||
| ↳ `hs_timezone` | string | Contact timezone |
|
||||
| `paging` | object | Pagination information for fetching more results |
|
||||
| ↳ `after` | string | Cursor for next page of results |
|
||||
| ↳ `link` | string | Link to next page |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records are available |
|
||||
| `total` | number | Total number of matching contacts |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Metadata with totalReturned and hasMore |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `hubspot_list_companies`
|
||||
@@ -178,9 +292,34 @@ Retrieve all companies from HubSpot account with pagination support
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `companies` | array | Array of HubSpot company objects |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Metadata with totalReturned and hasMore |
|
||||
| `companies` | array | Array of HubSpot company records |
|
||||
| ↳ `name` | string | Company name |
|
||||
| ↳ `domain` | string | Company website domain \(unique identifier\) |
|
||||
| ↳ `description` | string | Company description |
|
||||
| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) |
|
||||
| ↳ `phone` | string | Company phone number |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `state` | string | State/Region |
|
||||
| ↳ `zip` | string | Postal/ZIP code |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `address` | string | Street address |
|
||||
| ↳ `numberofemployees` | string | Total number of employees |
|
||||
| ↳ `annualrevenue` | string | Annual revenue estimate |
|
||||
| ↳ `lifecyclestage` | string | Lifecycle stage |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) |
|
||||
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) |
|
||||
| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) |
|
||||
| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) |
|
||||
| ↳ `website` | string | Company website URL |
|
||||
| `paging` | object | Pagination information for fetching more results |
|
||||
| ↳ `after` | string | Cursor for next page of results |
|
||||
| ↳ `link` | string | Link to next page |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records are available |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `hubspot_get_company`
|
||||
@@ -200,7 +339,28 @@ Retrieve a single company by ID or domain from HubSpot
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `company` | object | HubSpot company object with properties |
|
||||
| `company` | object | HubSpot company record |
|
||||
| ↳ `name` | string | Company name |
|
||||
| ↳ `domain` | string | Company website domain \(unique identifier\) |
|
||||
| ↳ `description` | string | Company description |
|
||||
| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) |
|
||||
| ↳ `phone` | string | Company phone number |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `state` | string | State/Region |
|
||||
| ↳ `zip` | string | Postal/ZIP code |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `address` | string | Street address |
|
||||
| ↳ `numberofemployees` | string | Total number of employees |
|
||||
| ↳ `annualrevenue` | string | Annual revenue estimate |
|
||||
| ↳ `lifecyclestage` | string | Lifecycle stage |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) |
|
||||
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) |
|
||||
| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) |
|
||||
| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) |
|
||||
| ↳ `website` | string | Company website URL |
|
||||
| `companyId` | string | The retrieved company ID |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -219,7 +379,28 @@ Create a new company in HubSpot
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `company` | object | Created HubSpot company object |
|
||||
| `company` | object | HubSpot company record |
|
||||
| ↳ `name` | string | Company name |
|
||||
| ↳ `domain` | string | Company website domain \(unique identifier\) |
|
||||
| ↳ `description` | string | Company description |
|
||||
| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) |
|
||||
| ↳ `phone` | string | Company phone number |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `state` | string | State/Region |
|
||||
| ↳ `zip` | string | Postal/ZIP code |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `address` | string | Street address |
|
||||
| ↳ `numberofemployees` | string | Total number of employees |
|
||||
| ↳ `annualrevenue` | string | Annual revenue estimate |
|
||||
| ↳ `lifecyclestage` | string | Lifecycle stage |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) |
|
||||
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) |
|
||||
| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) |
|
||||
| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) |
|
||||
| ↳ `website` | string | Company website URL |
|
||||
| `companyId` | string | The created company ID |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -239,7 +420,28 @@ Update an existing company in HubSpot by ID or domain
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `company` | object | Updated HubSpot company object |
|
||||
| `company` | object | HubSpot company record |
|
||||
| ↳ `name` | string | Company name |
|
||||
| ↳ `domain` | string | Company website domain \(unique identifier\) |
|
||||
| ↳ `description` | string | Company description |
|
||||
| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) |
|
||||
| ↳ `phone` | string | Company phone number |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `state` | string | State/Region |
|
||||
| ↳ `zip` | string | Postal/ZIP code |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `address` | string | Street address |
|
||||
| ↳ `numberofemployees` | string | Total number of employees |
|
||||
| ↳ `annualrevenue` | string | Annual revenue estimate |
|
||||
| ↳ `lifecyclestage` | string | Lifecycle stage |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) |
|
||||
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) |
|
||||
| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) |
|
||||
| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) |
|
||||
| ↳ `website` | string | Company website URL |
|
||||
| `companyId` | string | The updated company ID |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -262,10 +464,35 @@ Search for companies in HubSpot using filters, sorting, and queries
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `companies` | array | Array of matching HubSpot company objects |
|
||||
| `companies` | array | Array of HubSpot company records |
|
||||
| ↳ `name` | string | Company name |
|
||||
| ↳ `domain` | string | Company website domain \(unique identifier\) |
|
||||
| ↳ `description` | string | Company description |
|
||||
| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) |
|
||||
| ↳ `phone` | string | Company phone number |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `state` | string | State/Region |
|
||||
| ↳ `zip` | string | Postal/ZIP code |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `address` | string | Street address |
|
||||
| ↳ `numberofemployees` | string | Total number of employees |
|
||||
| ↳ `annualrevenue` | string | Annual revenue estimate |
|
||||
| ↳ `lifecyclestage` | string | Lifecycle stage |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) |
|
||||
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) |
|
||||
| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) |
|
||||
| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) |
|
||||
| ↳ `website` | string | Company website URL |
|
||||
| `paging` | object | Pagination information for fetching more results |
|
||||
| ↳ `after` | string | Cursor for next page of results |
|
||||
| ↳ `link` | string | Link to next page |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records are available |
|
||||
| `total` | number | Total number of matching companies |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Metadata with totalReturned and hasMore |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `hubspot_list_deals`
|
||||
@@ -285,9 +512,25 @@ Retrieve all deals from HubSpot account with pagination support
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deals` | array | Array of HubSpot deal objects |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Metadata with totalReturned and hasMore |
|
||||
| `deals` | array | Array of HubSpot deal records |
|
||||
| ↳ `dealname` | string | Deal name |
|
||||
| ↳ `amount` | string | Deal amount |
|
||||
| ↳ `dealstage` | string | Current deal stage |
|
||||
| ↳ `pipeline` | string | Pipeline the deal is in |
|
||||
| ↳ `closedate` | string | Expected close date \(ISO 8601\) |
|
||||
| ↳ `dealtype` | string | Deal type \(New Business, Existing Business, etc.\) |
|
||||
| ↳ `description` | string | Deal description |
|
||||
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
|
||||
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
|
||||
| ↳ `createdate` | string | Deal creation date \(ISO 8601\) |
|
||||
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
|
||||
| ↳ `num_associated_contacts` | string | Number of associated contacts |
|
||||
| `paging` | object | Pagination information for fetching more results |
|
||||
| ↳ `after` | string | Cursor for next page of results |
|
||||
| ↳ `link` | string | Link to next page |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records are available |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
|
||||
|
||||
@@ -60,8 +60,5 @@ Generate completions using Hugging Face Inference API
|
||||
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
||||
| ↳ `completion_tokens` | number | Number of tokens in the completion |
|
||||
| ↳ `total_tokens` | number | Total number of tokens used |
|
||||
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
||||
| ↳ `completion_tokens` | number | Number of tokens in the completion |
|
||||
| ↳ `total_tokens` | number | Total number of tokens used |
|
||||
|
||||
|
||||
|
||||
@@ -52,7 +52,12 @@ Returns companies matching a set of criteria using Hunter.io AI-powered search.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array of companies matching the search criteria, each containing domain, name, headcount, technologies, and email_count |
|
||||
| `results` | array | List of companies matching the search criteria |
|
||||
| ↳ `domain` | string | Company domain |
|
||||
| ↳ `name` | string | Company/organization name |
|
||||
| ↳ `headcount` | number | Company size/headcount |
|
||||
| ↳ `technologies` | array | Technologies used by the company |
|
||||
| ↳ `email_count` | number | Total number of email addresses found |
|
||||
|
||||
### `hunter_domain_search`
|
||||
|
||||
@@ -74,26 +79,46 @@ Returns all the email addresses found using one given domain name, with sources.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `emails` | array | List of email addresses found for the domain \(up to 100 per request\) |
|
||||
| ↳ `value` | string | The email address |
|
||||
| ↳ `type` | string | Email type: personal or generic \(role-based\) |
|
||||
| ↳ `confidence` | number | Probability score \(0-100\) that the email is correct |
|
||||
| ↳ `first_name` | string | Person's first name |
|
||||
| ↳ `last_name` | string | Person's last name |
|
||||
| ↳ `position` | string | Job title/position |
|
||||
| ↳ `seniority` | string | Seniority level \(junior, senior, executive\) |
|
||||
| ↳ `department` | string | Department \(executive, it, finance, management, sales, legal, support, hr, marketing, communication\) |
|
||||
| ↳ `linkedin` | string | LinkedIn profile URL |
|
||||
| ↳ `twitter` | string | Twitter handle |
|
||||
| ↳ `phone_number` | string | Phone number |
|
||||
| ↳ `sources` | array | List of sources where the email was found \(limited to 20\) |
|
||||
| ↳ `domain` | string | Domain where the email was found |
|
||||
| ↳ `uri` | string | Full URL of the source page |
|
||||
| ↳ `extracted_on` | string | Date when the email was first extracted \(YYYY-MM-DD\) |
|
||||
| ↳ `last_seen_on` | string | Date when the email was last seen \(YYYY-MM-DD\) |
|
||||
| ↳ `still_on_page` | boolean | Whether the email is still present on the source page |
|
||||
| ↳ `verification` | object | Email verification information |
|
||||
| ↳ `date` | string | Date when the email was verified \(YYYY-MM-DD\) |
|
||||
| ↳ `status` | string | Verification status \(valid, invalid, accept_all, webmail, disposable, unknown\) |
|
||||
| `domain` | string | The searched domain name |
|
||||
| `disposable` | boolean | Whether the domain accepts disposable email addresses |
|
||||
| `webmail` | boolean | Whether the domain is a webmail provider |
|
||||
| `accept_all` | boolean | Whether the domain accepts all email addresses |
|
||||
| `pattern` | string | The email pattern used by the organization |
|
||||
| `organization` | string | The organization name |
|
||||
| `disposable` | boolean | Whether the domain is a disposable email service |
|
||||
| `webmail` | boolean | Whether the domain is a webmail provider \(e.g., Gmail\) |
|
||||
| `accept_all` | boolean | Whether the server accepts all email addresses \(may cause false positives\) |
|
||||
| `pattern` | string | The email pattern used by the organization \(e.g., \{first\}, \{first\}.\{last\}\) |
|
||||
| `organization` | string | The organization/company name |
|
||||
| `description` | string | Description of the organization |
|
||||
| `industry` | string | Industry of the organization |
|
||||
| `twitter` | string | Twitter profile of the organization |
|
||||
| `facebook` | string | Facebook profile of the organization |
|
||||
| `linkedin` | string | LinkedIn profile of the organization |
|
||||
| `industry` | string | Industry classification of the organization |
|
||||
| `twitter` | string | Twitter handle of the organization |
|
||||
| `facebook` | string | Facebook page URL of the organization |
|
||||
| `linkedin` | string | LinkedIn company page URL |
|
||||
| `instagram` | string | Instagram profile of the organization |
|
||||
| `youtube` | string | YouTube channel of the organization |
|
||||
| `technologies` | array | Array of technologies used by the organization |
|
||||
| `country` | string | Country where the organization is located |
|
||||
| `state` | string | State where the organization is located |
|
||||
| `technologies` | array | Technologies used by the organization |
|
||||
| `country` | string | Country where the organization is headquartered |
|
||||
| `state` | string | State/province where the organization is located |
|
||||
| `city` | string | City where the organization is located |
|
||||
| `postal_code` | string | Postal code of the organization |
|
||||
| `street` | string | Street address of the organization |
|
||||
| `emails` | array | Array of email addresses found for the domain, each containing value, type, confidence, sources, and person details |
|
||||
|
||||
### `hunter_email_finder`
|
||||
|
||||
@@ -113,10 +138,17 @@ Finds the most likely email address for a person given their name and company do
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `sources` | array | List of sources where the email was found \(limited to 20\) |
|
||||
| ↳ `domain` | string | Domain where the email was found |
|
||||
| ↳ `uri` | string | Full URL of the source page |
|
||||
| ↳ `extracted_on` | string | Date when the email was first extracted \(YYYY-MM-DD\) |
|
||||
| ↳ `last_seen_on` | string | Date when the email was last seen \(YYYY-MM-DD\) |
|
||||
| ↳ `still_on_page` | boolean | Whether the email is still present on the source page |
|
||||
| `verification` | object | Email verification information |
|
||||
| ↳ `date` | string | Date when the email was verified \(YYYY-MM-DD\) |
|
||||
| ↳ `status` | string | Verification status \(valid, invalid, accept_all, webmail, disposable, unknown\) |
|
||||
| `email` | string | The found email address |
|
||||
| `score` | number | Confidence score for the found email address |
|
||||
| `sources` | array | Array of sources where the email was found, each containing domain, uri, extracted_on, last_seen_on, and still_on_page |
|
||||
| `verification` | object | Verification information containing date and status |
|
||||
| `score` | number | Confidence score \(0-100\) for the found email address |
|
||||
|
||||
### `hunter_email_verifier`
|
||||
|
||||
@@ -133,20 +165,25 @@ Verifies the deliverability of an email address and provides detailed verificati
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `sources` | array | List of sources where the email was found \(limited to 20\) |
|
||||
| ↳ `domain` | string | Domain where the email was found |
|
||||
| ↳ `uri` | string | Full URL of the source page |
|
||||
| ↳ `extracted_on` | string | Date when the email was first extracted \(YYYY-MM-DD\) |
|
||||
| ↳ `last_seen_on` | string | Date when the email was last seen \(YYYY-MM-DD\) |
|
||||
| ↳ `still_on_page` | boolean | Whether the email is still present on the source page |
|
||||
| `result` | string | Deliverability result: deliverable, undeliverable, or risky |
|
||||
| `score` | number | Confidence score for the verification result |
|
||||
| `score` | number | Deliverability score \(0-100\). Webmail and disposable emails receive an arbitrary score of 50. |
|
||||
| `email` | string | The verified email address |
|
||||
| `regexp` | boolean | Whether the email follows a valid regex pattern |
|
||||
| `gibberish` | boolean | Whether the email appears to be gibberish |
|
||||
| `disposable` | boolean | Whether the email is from a disposable email provider |
|
||||
| `webmail` | boolean | Whether the email is from a webmail provider |
|
||||
| `regexp` | boolean | Whether the email passes regular expression validation |
|
||||
| `gibberish` | boolean | Whether the email appears to be auto-generated \(e.g., e65rc109q@company.com\) |
|
||||
| `disposable` | boolean | Whether the email is from a disposable email service |
|
||||
| `webmail` | boolean | Whether the email is from a webmail provider \(e.g., Gmail\) |
|
||||
| `mx_records` | boolean | Whether MX records exist for the domain |
|
||||
| `smtp_server` | boolean | Whether the SMTP server is reachable |
|
||||
| `smtp_check` | boolean | Whether the SMTP check was successful |
|
||||
| `accept_all` | boolean | Whether the domain accepts all email addresses |
|
||||
| `block` | boolean | Whether the email is blocked |
|
||||
| `status` | string | Verification status: valid, invalid, accept_all, webmail, disposable, or unknown |
|
||||
| `sources` | array | Array of sources where the email was found |
|
||||
| `smtp_server` | boolean | Whether connection to the SMTP server was successful |
|
||||
| `smtp_check` | boolean | Whether the email address doesn't bounce |
|
||||
| `accept_all` | boolean | Whether the server accepts all email addresses \(may cause false positives\) |
|
||||
| `block` | boolean | Whether the domain is blocking verification \(validity could not be determined\) |
|
||||
| `status` | string | Verification status: valid, invalid, accept_all, webmail, disposable, unknown, or blocked |
|
||||
|
||||
### `hunter_companies_find`
|
||||
|
||||
@@ -163,8 +200,15 @@ Enriches company data using domain name.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `company` | object | Company information |
|
||||
| ↳ `name` | string | Company name |
|
||||
| ↳ `domain` | string | Company domain |
|
||||
| ↳ `industry` | string | Industry classification |
|
||||
| ↳ `size` | string | Company size/headcount range |
|
||||
| ↳ `country` | string | Country where the company is located |
|
||||
| ↳ `linkedin` | string | LinkedIn company page URL |
|
||||
| ↳ `twitter` | string | Twitter handle |
|
||||
| `person` | object | Person information \(undefined for companies_find tool\) |
|
||||
| `company` | object | Company information including name, domain, industry, size, country, linkedin, and twitter |
|
||||
|
||||
### `hunter_email_count`
|
||||
|
||||
@@ -183,10 +227,27 @@ Returns the total number of email addresses found for a domain or company.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `department` | object | Email count breakdown by department |
|
||||
| ↳ `executive` | number | Number of executive department emails |
|
||||
| ↳ `it` | number | Number of IT department emails |
|
||||
| ↳ `finance` | number | Number of finance department emails |
|
||||
| ↳ `management` | number | Number of management department emails |
|
||||
| ↳ `sales` | number | Number of sales department emails |
|
||||
| ↳ `legal` | number | Number of legal department emails |
|
||||
| ↳ `support` | number | Number of support department emails |
|
||||
| ↳ `hr` | number | Number of HR department emails |
|
||||
| ↳ `marketing` | number | Number of marketing department emails |
|
||||
| ↳ `communication` | number | Number of communication department emails |
|
||||
| ↳ `education` | number | Number of education department emails |
|
||||
| ↳ `design` | number | Number of design department emails |
|
||||
| ↳ `health` | number | Number of health department emails |
|
||||
| ↳ `operations` | number | Number of operations department emails |
|
||||
| `seniority` | object | Email count breakdown by seniority level |
|
||||
| ↳ `junior` | number | Number of junior-level emails |
|
||||
| ↳ `senior` | number | Number of senior-level emails |
|
||||
| ↳ `executive` | number | Number of executive-level emails |
|
||||
| `total` | number | Total number of email addresses found |
|
||||
| `personal_emails` | number | Number of personal email addresses found |
|
||||
| `generic_emails` | number | Number of generic email addresses found |
|
||||
| `department` | object | Breakdown of email addresses by department \(executive, it, finance, management, sales, legal, support, hr, marketing, communication\) |
|
||||
| `seniority` | object | Breakdown of email addresses by seniority level \(junior, senior, executive\) |
|
||||
| `personal_emails` | number | Number of personal email addresses \(individual employees\) |
|
||||
| `generic_emails` | number | Number of generic/role-based email addresses \(e.g., contact@, info@\) |
|
||||
|
||||
|
||||
|
||||
@@ -62,6 +62,5 @@ Generate images using OpenAI
|
||||
| ↳ `image` | string | Base64 encoded image data |
|
||||
| ↳ `metadata` | object | Image generation metadata |
|
||||
| ↳ `model` | string | Model used for image generation |
|
||||
| ↳ `model` | string | Model used for image generation |
|
||||
|
||||
|
||||
|
||||
@@ -57,35 +57,37 @@ List incidents from incident.io. Returns a list of incidents with their details
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `incidents` | array | List of incidents |
|
||||
| ↳ `id` | string | Type ID |
|
||||
| ↳ `name` | string | Type name |
|
||||
| ↳ `summary` | string | Brief summary of the incident |
|
||||
| ↳ `description` | string | Detailed description of the incident |
|
||||
| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) |
|
||||
| ↳ `call_url` | string | URL for the incident call/bridge |
|
||||
| ↳ `severity` | object | Severity of the incident |
|
||||
| ↳ `id` | string | Incident ID |
|
||||
| ↳ `name` | string | Incident name/title |
|
||||
| ↳ `summary` | string | Incident summary |
|
||||
| ↳ `description` | string | Incident description |
|
||||
| ↳ `mode` | string | Incident mode \(standard, retrospective, test\) |
|
||||
| ↳ `call_url` | string | Video call URL |
|
||||
| ↳ `severity` | object | Incident severity |
|
||||
| ↳ `id` | string | Severity ID |
|
||||
| ↳ `name` | string | Severity name |
|
||||
| ↳ `rank` | number | Severity rank |
|
||||
| ↳ `rank` | number | Severity rank |
|
||||
| ↳ `status` | object | Current status of the incident |
|
||||
| ↳ `name` | string | Severity name \(e.g., Critical, Major, Minor\) |
|
||||
| ↳ `description` | string | Severity description |
|
||||
| ↳ `rank` | number | Severity rank \(lower = more severe\) |
|
||||
| ↳ `status` | object | Current incident status |
|
||||
| ↳ `id` | string | Status ID |
|
||||
| ↳ `name` | string | Status name |
|
||||
| ↳ `category` | string | Status category |
|
||||
| ↳ `category` | string | Status category |
|
||||
| ↳ `incident_type` | object | Type of the incident |
|
||||
| ↳ `id` | string | Type ID |
|
||||
| ↳ `name` | string | Type name |
|
||||
| ↳ `created_at` | string | Creation timestamp |
|
||||
| ↳ `updated_at` | string | Last update timestamp |
|
||||
| ↳ `incident_url` | string | URL to the incident |
|
||||
| ↳ `slack_channel_id` | string | Associated Slack channel ID |
|
||||
| ↳ `slack_channel_name` | string | Associated Slack channel name |
|
||||
| ↳ `visibility` | string | Incident visibility |
|
||||
| ↳ `description` | string | Status description |
|
||||
| ↳ `category` | string | Status category \(triage, active, post-incident, closed\) |
|
||||
| ↳ `incident_type` | object | Incident type |
|
||||
| ↳ `id` | string | Incident type ID |
|
||||
| ↳ `name` | string | Incident type name |
|
||||
| ↳ `description` | string | Incident type description |
|
||||
| ↳ `is_default` | boolean | Whether this is the default incident type |
|
||||
| ↳ `created_at` | string | When the incident was created \(ISO 8601\) |
|
||||
| ↳ `updated_at` | string | When the incident was last updated \(ISO 8601\) |
|
||||
| ↳ `incident_url` | string | URL to the incident page |
|
||||
| ↳ `slack_channel_id` | string | Slack channel ID |
|
||||
| ↳ `slack_channel_name` | string | Slack channel name |
|
||||
| ↳ `visibility` | string | Incident visibility \(public, private\) |
|
||||
| `pagination_meta` | object | Pagination metadata |
|
||||
| ↳ `after` | string | Cursor for the next page |
|
||||
| ↳ `after` | string | Cursor for next page |
|
||||
| ↳ `page_size` | number | Number of items per page |
|
||||
| ↳ `total_record_count` | number | Total number of records available |
|
||||
| ↳ `total_record_count` | number | Total number of records |
|
||||
|
||||
### `incidentio_incidents_create`
|
||||
|
||||
@@ -109,8 +111,8 @@ Create a new incident in incident.io. Requires idempotency_key, severity_id, and
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `incident` | object | The created incident object |
|
||||
| ↳ `id` | string | Type ID |
|
||||
| ↳ `name` | string | Type name |
|
||||
| ↳ `id` | string | Incident ID |
|
||||
| ↳ `name` | string | Incident name |
|
||||
| ↳ `summary` | string | Brief summary of the incident |
|
||||
| ↳ `description` | string | Detailed description of the incident |
|
||||
| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) |
|
||||
@@ -119,12 +121,10 @@ Create a new incident in incident.io. Requires idempotency_key, severity_id, and
|
||||
| ↳ `id` | string | Severity ID |
|
||||
| ↳ `name` | string | Severity name |
|
||||
| ↳ `rank` | number | Severity rank |
|
||||
| ↳ `rank` | number | Severity rank |
|
||||
| ↳ `status` | object | Current status of the incident |
|
||||
| ↳ `id` | string | Status ID |
|
||||
| ↳ `name` | string | Status name |
|
||||
| ↳ `category` | string | Status category |
|
||||
| ↳ `category` | string | Status category |
|
||||
| ↳ `incident_type` | object | Type of the incident |
|
||||
| ↳ `id` | string | Type ID |
|
||||
| ↳ `name` | string | Type name |
|
||||
@@ -151,8 +151,8 @@ Retrieve detailed information about a specific incident from incident.io by its
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `incident` | object | Detailed incident information |
|
||||
| ↳ `id` | string | Type ID |
|
||||
| ↳ `name` | string | Type name |
|
||||
| ↳ `id` | string | Incident ID |
|
||||
| ↳ `name` | string | Incident name |
|
||||
| ↳ `summary` | string | Brief summary of the incident |
|
||||
| ↳ `description` | string | Detailed description of the incident |
|
||||
| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) |
|
||||
@@ -162,12 +162,10 @@ Retrieve detailed information about a specific incident from incident.io by its
|
||||
| ↳ `id` | string | Severity ID |
|
||||
| ↳ `name` | string | Severity name |
|
||||
| ↳ `rank` | number | Severity rank |
|
||||
| ↳ `rank` | number | Severity rank |
|
||||
| ↳ `status` | object | Current status of the incident |
|
||||
| ↳ `id` | string | Status ID |
|
||||
| ↳ `name` | string | Status name |
|
||||
| ↳ `category` | string | Status category |
|
||||
| ↳ `category` | string | Status category |
|
||||
| ↳ `incident_type` | object | Type of the incident |
|
||||
| ↳ `id` | string | Type ID |
|
||||
| ↳ `name` | string | Type name |
|
||||
@@ -202,8 +200,8 @@ Update an existing incident in incident.io. Can update name, summary, severity,
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `incident` | object | The updated incident object |
|
||||
| ↳ `id` | string | Type ID |
|
||||
| ↳ `name` | string | Type name |
|
||||
| ↳ `id` | string | Incident ID |
|
||||
| ↳ `name` | string | Incident name |
|
||||
| ↳ `summary` | string | Brief summary of the incident |
|
||||
| ↳ `description` | string | Detailed description of the incident |
|
||||
| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) |
|
||||
@@ -212,12 +210,10 @@ Update an existing incident in incident.io. Can update name, summary, severity,
|
||||
| ↳ `id` | string | Severity ID |
|
||||
| ↳ `name` | string | Severity name |
|
||||
| ↳ `rank` | number | Severity rank |
|
||||
| ↳ `rank` | number | Severity rank |
|
||||
| ↳ `status` | object | Current status of the incident |
|
||||
| ↳ `id` | string | Status ID |
|
||||
| ↳ `name` | string | Status name |
|
||||
| ↳ `category` | string | Status category |
|
||||
| ↳ `category` | string | Status category |
|
||||
| ↳ `incident_type` | object | Type of the incident |
|
||||
| ↳ `id` | string | Type ID |
|
||||
| ↳ `name` | string | Type name |
|
||||
@@ -245,14 +241,12 @@ List actions from incident.io. Optionally filter by incident ID.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `actions` | array | List of actions |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | Action ID |
|
||||
| ↳ `description` | string | Action description |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `status` | string | Action status |
|
||||
| ↳ `due_at` | string | Due date/time |
|
||||
| ↳ `created_at` | string | Creation timestamp |
|
||||
@@ -267,9 +261,6 @@ List actions from incident.io. Optionally filter by incident ID.
|
||||
| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) |
|
||||
| ↳ `issue_name` | string | Issue identifier |
|
||||
| ↳ `issue_permalink` | string | URL to the external issue |
|
||||
| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) |
|
||||
| ↳ `issue_name` | string | Issue identifier |
|
||||
| ↳ `issue_permalink` | string | URL to the external issue |
|
||||
|
||||
### `incidentio_actions_show`
|
||||
|
||||
@@ -287,14 +278,12 @@ Get detailed information about a specific action from incident.io.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `action` | object | Action details |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | Action ID |
|
||||
| ↳ `description` | string | Action description |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `status` | string | Action status |
|
||||
| ↳ `due_at` | string | Due date/time |
|
||||
| ↳ `created_at` | string | Creation timestamp |
|
||||
@@ -309,9 +298,6 @@ Get detailed information about a specific action from incident.io.
|
||||
| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) |
|
||||
| ↳ `issue_name` | string | Issue identifier |
|
||||
| ↳ `issue_permalink` | string | URL to the external issue |
|
||||
| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) |
|
||||
| ↳ `issue_name` | string | Issue identifier |
|
||||
| ↳ `issue_permalink` | string | URL to the external issue |
|
||||
|
||||
### `incidentio_follow_ups_list`
|
||||
|
||||
@@ -330,22 +316,19 @@ List follow-ups from incident.io. Optionally filter by incident ID.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `follow_ups` | array | List of follow-ups |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | Follow-up ID |
|
||||
| ↳ `title` | string | Follow-up title |
|
||||
| ↳ `description` | string | Priority description |
|
||||
| ↳ `description` | string | Follow-up description |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `status` | string | Follow-up status |
|
||||
| ↳ `priority` | object | Follow-up priority |
|
||||
| ↳ `id` | string | Priority ID |
|
||||
| ↳ `name` | string | Priority name |
|
||||
| ↳ `description` | string | Priority description |
|
||||
| ↳ `rank` | number | Priority rank |
|
||||
| ↳ `rank` | number | Priority rank |
|
||||
| ↳ `created_at` | string | Creation timestamp |
|
||||
| ↳ `updated_at` | string | Last update timestamp |
|
||||
| ↳ `incident_id` | string | Associated incident ID |
|
||||
@@ -359,9 +342,6 @@ List follow-ups from incident.io. Optionally filter by incident ID.
|
||||
| ↳ `provider` | string | External provider name |
|
||||
| ↳ `issue_name` | string | External issue name or ID |
|
||||
| ↳ `issue_permalink` | string | Permalink to external issue |
|
||||
| ↳ `provider` | string | External provider name |
|
||||
| ↳ `issue_name` | string | External issue name or ID |
|
||||
| ↳ `issue_permalink` | string | Permalink to external issue |
|
||||
|
||||
### `incidentio_follow_ups_show`
|
||||
|
||||
@@ -379,22 +359,19 @@ Get detailed information about a specific follow-up from incident.io.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `follow_up` | object | Follow-up details |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | Follow-up ID |
|
||||
| ↳ `title` | string | Follow-up title |
|
||||
| ↳ `description` | string | Priority description |
|
||||
| ↳ `description` | string | Follow-up description |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `status` | string | Follow-up status |
|
||||
| ↳ `priority` | object | Follow-up priority |
|
||||
| ↳ `id` | string | Priority ID |
|
||||
| ↳ `name` | string | Priority name |
|
||||
| ↳ `description` | string | Priority description |
|
||||
| ↳ `rank` | number | Priority rank |
|
||||
| ↳ `rank` | number | Priority rank |
|
||||
| ↳ `created_at` | string | Creation timestamp |
|
||||
| ↳ `updated_at` | string | Last update timestamp |
|
||||
| ↳ `incident_id` | string | Associated incident ID |
|
||||
@@ -408,9 +385,6 @@ Get detailed information about a specific follow-up from incident.io.
|
||||
| ↳ `provider` | string | External provider name |
|
||||
| ↳ `issue_name` | string | External issue name or ID |
|
||||
| ↳ `issue_permalink` | string | Permalink to external issue |
|
||||
| ↳ `provider` | string | External provider name |
|
||||
| ↳ `issue_name` | string | External issue name or ID |
|
||||
| ↳ `issue_permalink` | string | Permalink to external issue |
|
||||
|
||||
### `incidentio_users_list`
|
||||
|
||||
@@ -1089,25 +1063,21 @@ List all updates for a specific incident in incident.io
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `incident_updates` | array | List of incident updates |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | The update ID |
|
||||
| ↳ `incident_id` | string | The incident ID |
|
||||
| ↳ `message` | string | The update message |
|
||||
| ↳ `new_severity` | object | New severity if changed |
|
||||
| ↳ `id` | string | Severity ID |
|
||||
| ↳ `name` | string | Severity name |
|
||||
| ↳ `rank` | number | Severity rank |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `rank` | number | Severity rank |
|
||||
| ↳ `new_status` | object | New status if changed |
|
||||
| ↳ `id` | string | Status ID |
|
||||
| ↳ `name` | string | Status name |
|
||||
| ↳ `category` | string | Status category |
|
||||
| ↳ `category` | string | Status category |
|
||||
| ↳ `updater` | object | User who created the update |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `created_at` | string | When the update was created |
|
||||
| ↳ `updated_at` | string | When the update was last modified |
|
||||
| `pagination_meta` | object | Pagination information |
|
||||
@@ -1134,14 +1104,12 @@ List all entries for a specific schedule in incident.io
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `schedule_entries` | array | List of schedule entries |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | The entry ID |
|
||||
| ↳ `schedule_id` | string | The schedule ID |
|
||||
| ↳ `user` | object | User assigned to this entry |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `start_at` | string | When the entry starts |
|
||||
| ↳ `end_at` | string | When the entry ends |
|
||||
| ↳ `layer_id` | string | The schedule layer ID |
|
||||
@@ -1174,15 +1142,13 @@ Create a new schedule override in incident.io
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `override` | object | The created schedule override |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | The override ID |
|
||||
| ↳ `rotation_id` | string | The rotation ID |
|
||||
| ↳ `schedule_id` | string | The schedule ID |
|
||||
| ↳ `user` | object | User assigned to this override |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `start_at` | string | When the override starts |
|
||||
| ↳ `end_at` | string | When the override ends |
|
||||
| ↳ `created_at` | string | When the override was created |
|
||||
@@ -1206,7 +1172,7 @@ Create a new escalation path in incident.io
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `escalation_path` | object | The created escalation path |
|
||||
| ↳ `id` | string | Target ID |
|
||||
| ↳ `id` | string | The escalation path ID |
|
||||
| ↳ `name` | string | The escalation path name |
|
||||
| ↳ `path` | array | Array of escalation levels |
|
||||
| ↳ `targets` | array | Targets for this level |
|
||||
@@ -1215,30 +1181,11 @@ Create a new escalation path in incident.io
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `id` | string | Target ID |
|
||||
| ↳ `type` | string | Target type |
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
|
||||
| ↳ `targets` | array | Targets for this level |
|
||||
| ↳ `id` | string | Target ID |
|
||||
| ↳ `type` | string | Target type |
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `type` | string | Target type |
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
|
||||
| ↳ `working_hours` | array | Working hours configuration |
|
||||
| ↳ `weekday` | string | Day of week |
|
||||
| ↳ `start_time` | string | Start time |
|
||||
| ↳ `end_time` | string | End time |
|
||||
| ↳ `weekday` | string | Day of week |
|
||||
| ↳ `start_time` | string | Start time |
|
||||
| ↳ `end_time` | string | End time |
|
||||
| ↳ `created_at` | string | When the path was created |
|
||||
| ↳ `updated_at` | string | When the path was last updated |
|
||||
|
||||
@@ -1258,7 +1205,7 @@ Get details of a specific escalation path in incident.io
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `escalation_path` | object | The escalation path details |
|
||||
| ↳ `id` | string | Target ID |
|
||||
| ↳ `id` | string | The escalation path ID |
|
||||
| ↳ `name` | string | The escalation path name |
|
||||
| ↳ `path` | array | Array of escalation levels |
|
||||
| ↳ `targets` | array | Targets for this level |
|
||||
@@ -1267,30 +1214,11 @@ Get details of a specific escalation path in incident.io
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `id` | string | Target ID |
|
||||
| ↳ `type` | string | Target type |
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
|
||||
| ↳ `targets` | array | Targets for this level |
|
||||
| ↳ `id` | string | Target ID |
|
||||
| ↳ `type` | string | Target type |
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `type` | string | Target type |
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
|
||||
| ↳ `working_hours` | array | Working hours configuration |
|
||||
| ↳ `weekday` | string | Day of week |
|
||||
| ↳ `start_time` | string | Start time |
|
||||
| ↳ `end_time` | string | End time |
|
||||
| ↳ `weekday` | string | Day of week |
|
||||
| ↳ `start_time` | string | Start time |
|
||||
| ↳ `end_time` | string | End time |
|
||||
| ↳ `created_at` | string | When the path was created |
|
||||
| ↳ `updated_at` | string | When the path was last updated |
|
||||
|
||||
@@ -1313,7 +1241,7 @@ Update an existing escalation path in incident.io
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `escalation_path` | object | The updated escalation path |
|
||||
| ↳ `id` | string | Target ID |
|
||||
| ↳ `id` | string | The escalation path ID |
|
||||
| ↳ `name` | string | The escalation path name |
|
||||
| ↳ `path` | array | Array of escalation levels |
|
||||
| ↳ `targets` | array | Targets for this level |
|
||||
@@ -1322,30 +1250,11 @@ Update an existing escalation path in incident.io
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `id` | string | Target ID |
|
||||
| ↳ `type` | string | Target type |
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
|
||||
| ↳ `targets` | array | Targets for this level |
|
||||
| ↳ `id` | string | Target ID |
|
||||
| ↳ `type` | string | Target type |
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `type` | string | Target type |
|
||||
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
|
||||
| ↳ `user_id` | string | User ID if type is user |
|
||||
| ↳ `urgency` | string | Urgency level |
|
||||
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
|
||||
| ↳ `working_hours` | array | Working hours configuration |
|
||||
| ↳ `weekday` | string | Day of week |
|
||||
| ↳ `start_time` | string | Start time |
|
||||
| ↳ `end_time` | string | End time |
|
||||
| ↳ `weekday` | string | Day of week |
|
||||
| ↳ `start_time` | string | Start time |
|
||||
| ↳ `end_time` | string | End time |
|
||||
| ↳ `created_at` | string | When the path was created |
|
||||
| ↳ `updated_at` | string | When the path was last updated |
|
||||
|
||||
|
||||
@@ -62,7 +62,7 @@ Create a new contact in Intercom with email, external_id, or role. Returns API-a
|
||||
| --------- | ---- | ----------- |
|
||||
| `contact` | object | Created contact object |
|
||||
| ↳ `id` | string | Unique identifier for the contact |
|
||||
| ↳ `type` | string | List type |
|
||||
| ↳ `type` | string | Object type \(contact\) |
|
||||
| ↳ `role` | string | Role of the contact \(user or lead\) |
|
||||
| ↳ `email` | string | Email address of the contact |
|
||||
| ↳ `phone` | string | Phone number of the contact |
|
||||
@@ -82,10 +82,6 @@ Create a new contact in Intercom with email, external_id, or role. Returns API-a
|
||||
| ↳ `data` | array | Array of tag objects |
|
||||
| ↳ `has_more` | boolean | Whether there are more tags |
|
||||
| ↳ `total_count` | number | Total number of tags |
|
||||
| ↳ `url` | string | URL to fetch companies |
|
||||
| ↳ `data` | array | Array of social profile objects |
|
||||
| ↳ `has_more` | boolean | Whether there are more companies |
|
||||
| ↳ `total_count` | number | Total number of companies |
|
||||
| ↳ `notes` | object | Notes associated with the contact |
|
||||
| ↳ `type` | string | List type |
|
||||
| ↳ `url` | string | URL to fetch notes |
|
||||
@@ -105,11 +101,6 @@ Create a new contact in Intercom with email, external_id, or role. Returns API-a
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `country_code` | string | Country code |
|
||||
| ↳ `continent_code` | string | Continent code |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `region` | string | Region/State |
|
||||
| ↳ `country` | string | Country |
|
||||
| ↳ `country_code` | string | Country code |
|
||||
| ↳ `continent_code` | string | Continent code |
|
||||
| ↳ `social_profiles` | object | Social profiles of the contact |
|
||||
| ↳ `type` | string | List type |
|
||||
| ↳ `data` | array | Array of social profile objects |
|
||||
@@ -135,21 +126,61 @@ Get a single contact by ID from Intercom. Returns API-aligned fields only.
|
||||
| ↳ `type` | string | Object type \(contact\) |
|
||||
| ↳ `role` | string | Role of the contact \(user or lead\) |
|
||||
| ↳ `email` | string | Email address of the contact |
|
||||
| ↳ `email_domain` | string | Email domain of the contact |
|
||||
| ↳ `phone` | string | Phone number of the contact |
|
||||
| ↳ `name` | string | Name of the contact |
|
||||
| ↳ `avatar` | string | Avatar URL of the contact |
|
||||
| ↳ `owner_id` | string | ID of the admin assigned to this contact |
|
||||
| ↳ `external_id` | string | External identifier for the contact |
|
||||
| ↳ `owner_id` | string | ID of the admin assigned account ownership |
|
||||
| ↳ `external_id` | string | External identifier provided by the client |
|
||||
| ↳ `workspace_id` | string | Workspace ID the contact belongs to |
|
||||
| ↳ `created_at` | number | Unix timestamp when contact was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when contact was last updated |
|
||||
| ↳ `workspace_id` | string | Workspace ID the contact belongs to |
|
||||
| ↳ `custom_attributes` | object | Custom attributes set on the contact |
|
||||
| ↳ `tags` | object | Tags associated with the contact |
|
||||
| ↳ `notes` | object | Notes associated with the contact |
|
||||
| ↳ `companies` | object | Companies associated with the contact |
|
||||
| ↳ `location` | object | Location information for the contact |
|
||||
| ↳ `social_profiles` | object | Social profiles of the contact |
|
||||
| ↳ `signed_up_at` | number | Unix timestamp when user signed up |
|
||||
| ↳ `last_seen_at` | number | Unix timestamp when user was last seen |
|
||||
| ↳ `last_contacted_at` | number | Unix timestamp when contact was last contacted |
|
||||
| ↳ `last_replied_at` | number | Unix timestamp when contact last replied |
|
||||
| ↳ `last_email_opened_at` | number | Unix timestamp when contact last opened an email |
|
||||
| ↳ `last_email_clicked_at` | number | Unix timestamp when contact last clicked an email link |
|
||||
| ↳ `has_hard_bounced` | boolean | Whether email to this contact has hard bounced |
|
||||
| ↳ `marked_email_as_spam` | boolean | Whether contact marked email as spam |
|
||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
||||
| ↳ `browser` | string | Browser used by contact |
|
||||
| ↳ `browser_version` | string | Browser version |
|
||||
| ↳ `browser_language` | string | Browser language setting |
|
||||
| ↳ `os` | string | Operating system |
|
||||
| ↳ `language_override` | string | Language override setting |
|
||||
| ↳ `custom_attributes` | object | Custom attributes set on the contact |
|
||||
| ↳ `tags` | object | Tags associated with the contact \(up to 10 displayed\) |
|
||||
| ↳ `type` | string | List type identifier |
|
||||
| ↳ `url` | string | URL to fetch full list |
|
||||
| ↳ `data` | array | Array of objects \(up to 10\) |
|
||||
| ↳ `has_more` | boolean | Whether there are more items beyond this list |
|
||||
| ↳ `total_count` | number | Total number of items |
|
||||
| ↳ `notes` | object | Notes associated with the contact \(up to 10 displayed\) |
|
||||
| ↳ `type` | string | List type identifier |
|
||||
| ↳ `url` | string | URL to fetch full list |
|
||||
| ↳ `data` | array | Array of objects \(up to 10\) |
|
||||
| ↳ `has_more` | boolean | Whether there are more items beyond this list |
|
||||
| ↳ `total_count` | number | Total number of items |
|
||||
| ↳ `companies` | object | Companies associated with the contact \(up to 10 displayed\) |
|
||||
| ↳ `type` | string | List type identifier |
|
||||
| ↳ `url` | string | URL to fetch full list |
|
||||
| ↳ `data` | array | Array of objects \(up to 10\) |
|
||||
| ↳ `has_more` | boolean | Whether there are more items beyond this list |
|
||||
| ↳ `total_count` | number | Total number of items |
|
||||
| ↳ `location` | object | Location information for the contact |
|
||||
| ↳ `type` | string | Object type \(location\) |
|
||||
| ↳ `city` | string | City name |
|
||||
| ↳ `region` | string | Region or state name |
|
||||
| ↳ `country` | string | Country name |
|
||||
| ↳ `country_code` | string | ISO country code |
|
||||
| ↳ `continent_code` | string | Continent code |
|
||||
| ↳ `social_profiles` | object | Social profiles of the contact |
|
||||
| ↳ `type` | string | Social network type \(e.g., twitter, facebook\) |
|
||||
| ↳ `name` | string | Social network name |
|
||||
| ↳ `url` | string | Profile URL |
|
||||
| ↳ `username` | string | Username on the social network |
|
||||
| ↳ `id` | string | User ID on the social network |
|
||||
|
||||
### `intercom_update_contact`
|
||||
|
||||
@@ -323,7 +354,7 @@ Create or update a company in Intercom
|
||||
| --------- | ---- | ----------- |
|
||||
| `company` | object | Created or updated company object |
|
||||
| ↳ `id` | string | Unique identifier for the company |
|
||||
| ↳ `type` | string | Segment list type |
|
||||
| ↳ `type` | string | Object type \(company\) |
|
||||
| ↳ `app_id` | string | Intercom app ID |
|
||||
| ↳ `company_id` | string | Your unique identifier for the company |
|
||||
| ↳ `name` | string | Name of the company |
|
||||
@@ -338,7 +369,11 @@ Create or update a company in Intercom
|
||||
| ↳ `updated_at` | number | Unix timestamp when company was last updated |
|
||||
| ↳ `remote_created_at` | number | Unix timestamp when company was created by you |
|
||||
| ↳ `custom_attributes` | object | Custom attributes set on the company |
|
||||
| ↳ `tags` | object | Tags associated with the company |
|
||||
| ↳ `type` | string | Tag list type |
|
||||
| ↳ `tags` | array | Array of tag objects |
|
||||
| ↳ `segments` | object | Segments the company belongs to |
|
||||
| ↳ `type` | string | Segment list type |
|
||||
| ↳ `segments` | array | Array of segment objects |
|
||||
| `companyId` | string | ID of the created/updated company |
|
||||
|
||||
@@ -647,6 +682,42 @@ Retrieve a single ticket by ID from Intercom. Returns API-aligned fields only.
|
||||
| `ticketId` | string | ID of the retrieved ticket |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `intercom_update_ticket`
|
||||
|
||||
Update a ticket in Intercom (change state, assignment, attributes)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticketId` | string | Yes | The ID of the ticket to update |
|
||||
| `ticket_attributes` | string | No | JSON object with ticket attributes \(e.g., \{"_default_title_":"New Title","_default_description_":"Updated description"\}\) |
|
||||
| `open` | boolean | No | Set to false to close the ticket, true to keep it open |
|
||||
| `is_shared` | boolean | No | Whether the ticket is visible to users |
|
||||
| `snoozed_until` | number | No | Unix timestamp for when the ticket should reopen |
|
||||
| `admin_id` | string | No | The ID of the admin performing the update \(needed for workflows and attribution\) |
|
||||
| `assignee_id` | string | No | The ID of the admin or team to assign the ticket to. Set to "0" to unassign. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | The updated ticket object |
|
||||
| ↳ `id` | string | Unique identifier for the ticket |
|
||||
| ↳ `type` | string | Object type \(ticket\) |
|
||||
| ↳ `ticket_id` | string | Ticket ID shown in Intercom UI |
|
||||
| ↳ `ticket_state` | string | State of the ticket |
|
||||
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
||||
| ↳ `open` | boolean | Whether the ticket is open |
|
||||
| ↳ `is_shared` | boolean | Whether the ticket is visible to users |
|
||||
| ↳ `snoozed_until` | number | Unix timestamp when ticket will reopen |
|
||||
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
||||
| `ticketId` | string | ID of the updated ticket |
|
||||
| `ticket_state` | string | Current state of the ticket |
|
||||
|
||||
### `intercom_create_message`
|
||||
|
||||
Create and send a new admin-initiated message in Intercom. Returns API-aligned fields only.
|
||||
@@ -680,4 +751,340 @@ Create and send a new admin-initiated message in Intercom. Returns API-aligned f
|
||||
| `messageId` | string | ID of the created message |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `intercom_list_admins`
|
||||
|
||||
Fetch a list of all admins for the workspace
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `admins` | array | Array of admin objects |
|
||||
| ↳ `id` | string | Unique identifier for the admin |
|
||||
| ↳ `type` | string | Object type \(admin\) |
|
||||
| ↳ `name` | string | Name of the admin |
|
||||
| ↳ `email` | string | Email of the admin |
|
||||
| ↳ `job_title` | string | Job title of the admin |
|
||||
| ↳ `away_mode_enabled` | boolean | Whether admin is in away mode |
|
||||
| ↳ `away_mode_reassign` | boolean | Whether to reassign conversations when away |
|
||||
| ↳ `has_inbox_seat` | boolean | Whether admin has a paid inbox seat |
|
||||
| ↳ `team_ids` | array | List of team IDs the admin belongs to |
|
||||
| ↳ `avatar` | object | Avatar information |
|
||||
| ↳ `email_verified` | boolean | Whether email is verified |
|
||||
| `type` | string | Object type \(admin.list\) |
|
||||
|
||||
### `intercom_close_conversation`
|
||||
|
||||
Close a conversation in Intercom
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `conversationId` | string | Yes | The ID of the conversation to close |
|
||||
| `admin_id` | string | Yes | The ID of the admin performing the action |
|
||||
| `body` | string | No | Optional closing message to add to the conversation |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `conversation` | object | The closed conversation object |
|
||||
| ↳ `id` | string | Unique identifier for the conversation |
|
||||
| ↳ `type` | string | Object type \(conversation\) |
|
||||
| ↳ `state` | string | State of the conversation \(closed\) |
|
||||
| ↳ `open` | boolean | Whether the conversation is open \(false\) |
|
||||
| ↳ `read` | boolean | Whether the conversation has been read |
|
||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||
| `conversationId` | string | ID of the closed conversation |
|
||||
| `state` | string | State of the conversation \(closed\) |
|
||||
|
||||
### `intercom_open_conversation`
|
||||
|
||||
Open a closed or snoozed conversation in Intercom
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `conversationId` | string | Yes | The ID of the conversation to open |
|
||||
| `admin_id` | string | Yes | The ID of the admin performing the action |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `conversation` | object | The opened conversation object |
|
||||
| ↳ `id` | string | Unique identifier for the conversation |
|
||||
| ↳ `type` | string | Object type \(conversation\) |
|
||||
| ↳ `state` | string | State of the conversation \(open\) |
|
||||
| ↳ `open` | boolean | Whether the conversation is open \(true\) |
|
||||
| ↳ `read` | boolean | Whether the conversation has been read |
|
||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||
| `conversationId` | string | ID of the opened conversation |
|
||||
| `state` | string | State of the conversation \(open\) |
|
||||
|
||||
### `intercom_snooze_conversation`
|
||||
|
||||
Snooze a conversation to reopen at a future time
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `conversationId` | string | Yes | The ID of the conversation to snooze |
|
||||
| `admin_id` | string | Yes | The ID of the admin performing the action |
|
||||
| `snoozed_until` | number | Yes | Unix timestamp for when the conversation should reopen |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `conversation` | object | The snoozed conversation object |
|
||||
| ↳ `id` | string | Unique identifier for the conversation |
|
||||
| ↳ `type` | string | Object type \(conversation\) |
|
||||
| ↳ `state` | string | State of the conversation \(snoozed\) |
|
||||
| ↳ `open` | boolean | Whether the conversation is open |
|
||||
| ↳ `snoozed_until` | number | Unix timestamp when conversation will reopen |
|
||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||
| `conversationId` | string | ID of the snoozed conversation |
|
||||
| `state` | string | State of the conversation \(snoozed\) |
|
||||
| `snoozed_until` | number | Unix timestamp when conversation will reopen |
|
||||
|
||||
### `intercom_assign_conversation`
|
||||
|
||||
Assign a conversation to an admin or team in Intercom
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `conversationId` | string | Yes | The ID of the conversation to assign |
|
||||
| `admin_id` | string | Yes | The ID of the admin performing the assignment |
|
||||
| `assignee_id` | string | Yes | The ID of the admin or team to assign the conversation to. Set to "0" to unassign. |
|
||||
| `body` | string | No | Optional message to add when assigning \(e.g., "Passing to the support team"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `conversation` | object | The assigned conversation object |
|
||||
| ↳ `id` | string | Unique identifier for the conversation |
|
||||
| ↳ `type` | string | Object type \(conversation\) |
|
||||
| ↳ `state` | string | State of the conversation |
|
||||
| ↳ `open` | boolean | Whether the conversation is open |
|
||||
| ↳ `admin_assignee_id` | number | ID of the assigned admin |
|
||||
| ↳ `team_assignee_id` | string | ID of the assigned team |
|
||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||
| `conversationId` | string | ID of the assigned conversation |
|
||||
| `admin_assignee_id` | number | ID of the assigned admin |
|
||||
| `team_assignee_id` | string | ID of the assigned team |
|
||||
|
||||
### `intercom_list_tags`
|
||||
|
||||
Fetch a list of all tags in the workspace
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tags` | array | Array of tag objects |
|
||||
| ↳ `id` | string | Unique identifier for the tag |
|
||||
| ↳ `type` | string | Object type \(tag\) |
|
||||
| ↳ `name` | string | Name of the tag |
|
||||
| `type` | string | Object type \(list\) |
|
||||
|
||||
### `intercom_create_tag`
|
||||
|
||||
Create a new tag or update an existing tag name
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `name` | string | Yes | The name of the tag. Will create a new tag if not found, or update the name if id is provided. |
|
||||
| `id` | string | No | The ID of an existing tag to update. Omit to create a new tag. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Unique identifier for the tag |
|
||||
| `name` | string | Name of the tag |
|
||||
| `type` | string | Object type \(tag\) |
|
||||
|
||||
### `intercom_tag_contact`
|
||||
|
||||
Add a tag to a specific contact
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `contactId` | string | Yes | The ID of the contact to tag |
|
||||
| `tagId` | string | Yes | The ID of the tag to apply |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Unique identifier for the tag |
|
||||
| `name` | string | Name of the tag |
|
||||
| `type` | string | Object type \(tag\) |
|
||||
|
||||
### `intercom_untag_contact`
|
||||
|
||||
Remove a tag from a specific contact
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `contactId` | string | Yes | The ID of the contact to untag |
|
||||
| `tagId` | string | Yes | The ID of the tag to remove |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Unique identifier for the tag that was removed |
|
||||
| `name` | string | Name of the tag that was removed |
|
||||
| `type` | string | Object type \(tag\) |
|
||||
|
||||
### `intercom_tag_conversation`
|
||||
|
||||
Add a tag to a specific conversation
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `conversationId` | string | Yes | The ID of the conversation to tag |
|
||||
| `tagId` | string | Yes | The ID of the tag to apply |
|
||||
| `admin_id` | string | Yes | The ID of the admin applying the tag |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Unique identifier for the tag |
|
||||
| `name` | string | Name of the tag |
|
||||
| `type` | string | Object type \(tag\) |
|
||||
|
||||
### `intercom_create_note`
|
||||
|
||||
Add a note to a specific contact
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `contactId` | string | Yes | The ID of the contact to add the note to |
|
||||
| `body` | string | Yes | The text content of the note |
|
||||
| `admin_id` | string | No | The ID of the admin creating the note |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Unique identifier for the note |
|
||||
| `body` | string | The text content of the note |
|
||||
| `created_at` | number | Unix timestamp when the note was created |
|
||||
| `type` | string | Object type \(note\) |
|
||||
| `author` | object | The admin who created the note |
|
||||
| ↳ `type` | string | Author type \(admin\) |
|
||||
| ↳ `id` | string | Author ID |
|
||||
| ↳ `name` | string | Author name |
|
||||
| ↳ `email` | string | Author email |
|
||||
| `contact` | object | The contact the note was created for |
|
||||
| ↳ `type` | string | Contact type |
|
||||
| ↳ `id` | string | Contact ID |
|
||||
|
||||
### `intercom_create_event`
|
||||
|
||||
Track a custom event for a contact in Intercom
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `event_name` | string | Yes | The name of the event \(e.g., "order-completed"\). Use past-tense verb-noun format for readability. |
|
||||
| `created_at` | number | No | Unix timestamp for when the event occurred. Strongly recommended for uniqueness. |
|
||||
| `user_id` | string | No | Your identifier for the user \(external_id\) |
|
||||
| `email` | string | No | Email address of the user. Use only if your app uses email to uniquely identify users. |
|
||||
| `id` | string | No | The Intercom contact ID |
|
||||
| `metadata` | string | No | JSON object with up to 10 metadata key-value pairs about the event \(e.g., \{"order_value": 99.99\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `accepted` | boolean | Whether the event was accepted \(202 Accepted\) |
|
||||
|
||||
### `intercom_attach_contact_to_company`
|
||||
|
||||
Attach a contact to a company in Intercom
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `contactId` | string | Yes | The ID of the contact to attach to the company |
|
||||
| `companyId` | string | Yes | The ID of the company to attach the contact to |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `company` | object | The company object the contact was attached to |
|
||||
| ↳ `id` | string | Unique identifier for the company |
|
||||
| ↳ `type` | string | Object type \(company\) |
|
||||
| ↳ `company_id` | string | The company_id you defined |
|
||||
| ↳ `name` | string | Name of the company |
|
||||
| ↳ `created_at` | number | Unix timestamp when company was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when company was updated |
|
||||
| ↳ `user_count` | number | Number of users in the company |
|
||||
| ↳ `session_count` | number | Number of sessions |
|
||||
| ↳ `monthly_spend` | number | Monthly spend amount |
|
||||
| ↳ `plan` | object | Company plan details |
|
||||
| `companyId` | string | ID of the company |
|
||||
| `name` | string | Name of the company |
|
||||
|
||||
### `intercom_detach_contact_from_company`
|
||||
|
||||
Remove a contact from a company in Intercom
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `contactId` | string | Yes | The ID of the contact to detach from the company |
|
||||
| `companyId` | string | Yes | The ID of the company to detach the contact from |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `company` | object | The company object the contact was detached from |
|
||||
| ↳ `id` | string | Unique identifier for the company |
|
||||
| ↳ `type` | string | Object type \(company\) |
|
||||
| ↳ `company_id` | string | The company_id you defined |
|
||||
| ↳ `name` | string | Name of the company |
|
||||
| `companyId` | string | ID of the company |
|
||||
| `name` | string | Name of the company |
|
||||
|
||||
|
||||
|
||||
@@ -91,5 +91,11 @@ Search the web and return top 5 results with LLM-friendly content. Each result i
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array of search results, each containing title, description, url, and LLM-friendly content |
|
||||
| ↳ `title` | string | Page title |
|
||||
| ↳ `description` | string | Page description or meta description |
|
||||
| ↳ `url` | string | Page URL |
|
||||
| ↳ `content` | string | LLM-friendly extracted content |
|
||||
| ↳ `usage` | object | Token usage information |
|
||||
| ↳ `tokens` | number | Number of tokens consumed by this request |
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ description: Access prediction markets and trade on Kalshi
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="kalshi"
|
||||
type="kalshi_v2"
|
||||
color="#09C285"
|
||||
/>
|
||||
|
||||
@@ -36,7 +36,7 @@ Integrate Kalshi prediction markets into the workflow. Can get markets, market,
|
||||
|
||||
### `kalshi_get_markets`
|
||||
|
||||
Retrieve a list of prediction markets from Kalshi with optional filtering
|
||||
Retrieve a list of prediction markets from Kalshi with all filtering options (V2 - full API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -52,12 +52,39 @@ Retrieve a list of prediction markets from Kalshi with optional filtering
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | Array of market objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `markets` | array | Array of market objects with all API fields |
|
||||
| ↳ `ticker` | string | Unique market ticker identifier |
|
||||
| ↳ `event_ticker` | string | Parent event ticker |
|
||||
| ↳ `market_type` | string | Market type \(binary, etc.\) |
|
||||
| ↳ `title` | string | Market title/question |
|
||||
| ↳ `subtitle` | string | Market subtitle |
|
||||
| ↳ `yes_sub_title` | string | Yes outcome subtitle |
|
||||
| ↳ `no_sub_title` | string | No outcome subtitle |
|
||||
| ↳ `open_time` | string | Market open time \(ISO 8601\) |
|
||||
| ↳ `close_time` | string | Market close time \(ISO 8601\) |
|
||||
| ↳ `expiration_time` | string | Contract expiration time |
|
||||
| ↳ `status` | string | Market status \(open, closed, settled, etc.\) |
|
||||
| ↳ `yes_bid` | number | Current best yes bid price in cents |
|
||||
| ↳ `yes_ask` | number | Current best yes ask price in cents |
|
||||
| ↳ `no_bid` | number | Current best no bid price in cents |
|
||||
| ↳ `no_ask` | number | Current best no ask price in cents |
|
||||
| ↳ `last_price` | number | Last trade price in cents |
|
||||
| ↳ `previous_yes_bid` | number | Previous yes bid |
|
||||
| ↳ `previous_yes_ask` | number | Previous yes ask |
|
||||
| ↳ `previous_price` | number | Previous last price |
|
||||
| ↳ `volume` | number | Total volume \(contracts traded\) |
|
||||
| ↳ `volume_24h` | number | 24-hour trading volume |
|
||||
| ↳ `liquidity` | number | Market liquidity measure |
|
||||
| ↳ `open_interest` | number | Open interest \(outstanding contracts\) |
|
||||
| ↳ `result` | string | Settlement result \(yes, no, null\) |
|
||||
| ↳ `cap_strike` | number | Cap strike for ranged markets |
|
||||
| ↳ `floor_strike` | number | Floor strike for ranged markets |
|
||||
| ↳ `category` | string | Market category |
|
||||
| `cursor` | string | Pagination cursor for fetching more results |
|
||||
|
||||
### `kalshi_get_market`
|
||||
|
||||
Retrieve details of a specific prediction market by ticker
|
||||
Retrieve details of a specific prediction market by ticker (V2 - full API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -69,11 +96,62 @@ Retrieve details of a specific prediction market by ticker
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | Market object with details |
|
||||
| `market` | object | Market object with all API fields |
|
||||
| ↳ `ticker` | string | Market ticker |
|
||||
| ↳ `event_ticker` | string | Event ticker |
|
||||
| ↳ `market_type` | string | Market type |
|
||||
| ↳ `title` | string | Market title |
|
||||
| ↳ `subtitle` | string | Market subtitle |
|
||||
| ↳ `yes_sub_title` | string | Yes outcome subtitle |
|
||||
| ↳ `no_sub_title` | string | No outcome subtitle |
|
||||
| ↳ `open_time` | string | Market open time |
|
||||
| ↳ `close_time` | string | Market close time |
|
||||
| ↳ `expected_expiration_time` | string | Expected expiration time |
|
||||
| ↳ `expiration_time` | string | Expiration time |
|
||||
| ↳ `latest_expiration_time` | string | Latest expiration time |
|
||||
| ↳ `settlement_timer_seconds` | number | Settlement timer in seconds |
|
||||
| ↳ `status` | string | Market status |
|
||||
| ↳ `response_price_units` | string | Response price units |
|
||||
| ↳ `notional_value` | number | Notional value |
|
||||
| ↳ `tick_size` | number | Tick size |
|
||||
| ↳ `yes_bid` | number | Current yes bid price |
|
||||
| ↳ `yes_ask` | number | Current yes ask price |
|
||||
| ↳ `no_bid` | number | Current no bid price |
|
||||
| ↳ `no_ask` | number | Current no ask price |
|
||||
| ↳ `last_price` | number | Last trade price |
|
||||
| ↳ `previous_yes_bid` | number | Previous yes bid |
|
||||
| ↳ `previous_yes_ask` | number | Previous yes ask |
|
||||
| ↳ `previous_price` | number | Previous price |
|
||||
| ↳ `volume` | number | Total volume |
|
||||
| ↳ `volume_24h` | number | 24-hour volume |
|
||||
| ↳ `liquidity` | number | Market liquidity |
|
||||
| ↳ `open_interest` | number | Open interest |
|
||||
| ↳ `result` | string | Market result |
|
||||
| ↳ `cap_strike` | number | Cap strike |
|
||||
| ↳ `floor_strike` | number | Floor strike |
|
||||
| ↳ `can_close_early` | boolean | Can close early |
|
||||
| ↳ `expiration_value` | string | Expiration value |
|
||||
| ↳ `category` | string | Market category |
|
||||
| ↳ `risk_limit_cents` | number | Risk limit in cents |
|
||||
| ↳ `strike_type` | string | Strike type |
|
||||
| ↳ `rules_primary` | string | Primary rules |
|
||||
| ↳ `rules_secondary` | string | Secondary rules |
|
||||
| ↳ `settlement_source_url` | string | Settlement source URL |
|
||||
| ↳ `custom_strike` | object | Custom strike object |
|
||||
| ↳ `underlying` | string | Underlying asset |
|
||||
| ↳ `settlement_value` | number | Settlement value |
|
||||
| ↳ `cfd_contract_size` | number | CFD contract size |
|
||||
| ↳ `yes_fee_fp` | number | Yes fee \(fixed-point\) |
|
||||
| ↳ `no_fee_fp` | number | No fee \(fixed-point\) |
|
||||
| ↳ `last_price_fp` | number | Last price \(fixed-point\) |
|
||||
| ↳ `yes_bid_fp` | number | Yes bid \(fixed-point\) |
|
||||
| ↳ `yes_ask_fp` | number | Yes ask \(fixed-point\) |
|
||||
| ↳ `no_bid_fp` | number | No bid \(fixed-point\) |
|
||||
| ↳ `no_ask_fp` | number | No ask \(fixed-point\) |
|
||||
|
||||
### `kalshi_get_events`
|
||||
|
||||
Retrieve a list of events from Kalshi with optional filtering
|
||||
Retrieve a list of events from Kalshi with optional filtering (V2 - exact API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -90,11 +168,24 @@ Retrieve a list of events from Kalshi with optional filtering
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | Array of event objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| ↳ `event_ticker` | string | Unique event ticker identifier |
|
||||
| ↳ `series_ticker` | string | Parent series ticker |
|
||||
| ↳ `title` | string | Event title |
|
||||
| ↳ `sub_title` | string | Event subtitle |
|
||||
| ↳ `mutually_exclusive` | boolean | Whether markets are mutually exclusive |
|
||||
| ↳ `category` | string | Event category |
|
||||
| ↳ `strike_date` | string | Strike/settlement date |
|
||||
| ↳ `status` | string | Event status |
|
||||
| `milestones` | array | Array of milestone objects \(if requested\) |
|
||||
| ↳ `event_ticker` | string | Event ticker |
|
||||
| ↳ `milestone_type` | string | Milestone type |
|
||||
| ↳ `milestone_date` | string | Milestone date |
|
||||
| ↳ `milestone_title` | string | Milestone title |
|
||||
| `cursor` | string | Pagination cursor for fetching more results |
|
||||
|
||||
### `kalshi_get_event`
|
||||
|
||||
Retrieve details of a specific event by ticker
|
||||
Retrieve details of a specific event by ticker (V2 - exact API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -107,11 +198,23 @@ Retrieve details of a specific event by ticker
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Event object with details |
|
||||
| `event` | object | Event object with full details matching Kalshi API response |
|
||||
| ↳ `event_ticker` | string | Event ticker |
|
||||
| ↳ `series_ticker` | string | Series ticker |
|
||||
| ↳ `title` | string | Event title |
|
||||
| ↳ `sub_title` | string | Event subtitle |
|
||||
| ↳ `mutually_exclusive` | boolean | Mutually exclusive markets |
|
||||
| ↳ `category` | string | Event category |
|
||||
| ↳ `collateral_return_type` | string | Collateral return type |
|
||||
| ↳ `strike_date` | string | Strike date |
|
||||
| ↳ `strike_period` | string | Strike period |
|
||||
| ↳ `available_on_brokers` | boolean | Available on brokers |
|
||||
| ↳ `product_metadata` | object | Product metadata |
|
||||
| ↳ `markets` | array | Nested markets \(if requested\) |
|
||||
|
||||
### `kalshi_get_balance`
|
||||
|
||||
Retrieve your account balance and portfolio value from Kalshi
|
||||
Retrieve your account balance and portfolio value from Kalshi (V2 - exact API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -125,11 +228,12 @@ Retrieve your account balance and portfolio value from Kalshi
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `balance` | number | Account balance in cents |
|
||||
| `portfolioValue` | number | Portfolio value in cents |
|
||||
| `portfolio_value` | number | Portfolio value in cents |
|
||||
| `updated_ts` | number | Unix timestamp of last update \(milliseconds\) |
|
||||
|
||||
### `kalshi_get_positions`
|
||||
|
||||
Retrieve your open positions from Kalshi
|
||||
Retrieve your open positions from Kalshi (V2 - exact API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -147,12 +251,27 @@ Retrieve your open positions from Kalshi
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `positions` | array | Array of position objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `market_positions` | array | Array of market position objects |
|
||||
| ↳ `ticker` | string | Market ticker |
|
||||
| ↳ `event_ticker` | string | Event ticker |
|
||||
| ↳ `event_title` | string | Event title |
|
||||
| ↳ `market_title` | string | Market title |
|
||||
| ↳ `position` | number | Net position \(positive=yes, negative=no\) |
|
||||
| ↳ `market_exposure` | number | Maximum potential loss in cents |
|
||||
| ↳ `realized_pnl` | number | Realized profit/loss in cents |
|
||||
| ↳ `total_traded` | number | Total contracts traded |
|
||||
| ↳ `resting_orders_count` | number | Number of resting orders |
|
||||
| ↳ `fees_paid` | number | Total fees paid in cents |
|
||||
| `event_positions` | array | Array of event position objects |
|
||||
| ↳ `event_ticker` | string | Event ticker |
|
||||
| ↳ `event_exposure` | number | Event-level exposure in cents |
|
||||
| ↳ `realized_pnl` | number | Realized P&L in cents |
|
||||
| ↳ `total_cost` | number | Total cost basis in cents |
|
||||
| `cursor` | string | Pagination cursor for fetching more results |
|
||||
|
||||
### `kalshi_get_orders`
|
||||
|
||||
Retrieve your orders from Kalshi with optional filtering
|
||||
Retrieve your orders from Kalshi with optional filtering (V2 with full API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -170,12 +289,30 @@ Retrieve your orders from Kalshi with optional filtering
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | Array of order objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `orders` | array | Array of order objects with full API response fields |
|
||||
| ↳ `order_id` | string | Unique order identifier |
|
||||
| ↳ `user_id` | string | User ID |
|
||||
| ↳ `client_order_id` | string | Client-provided order ID |
|
||||
| ↳ `ticker` | string | Market ticker |
|
||||
| ↳ `side` | string | Order side \(yes/no\) |
|
||||
| ↳ `action` | string | Order action \(buy/sell\) |
|
||||
| ↳ `type` | string | Order type \(limit/market\) |
|
||||
| ↳ `status` | string | Order status \(resting, canceled, executed\) |
|
||||
| ↳ `yes_price` | number | Yes price in cents |
|
||||
| ↳ `no_price` | number | No price in cents |
|
||||
| ↳ `fill_count` | number | Number of contracts filled |
|
||||
| ↳ `remaining_count` | number | Remaining contracts to fill |
|
||||
| ↳ `initial_count` | number | Initial order size |
|
||||
| ↳ `taker_fees` | number | Taker fees paid in cents |
|
||||
| ↳ `maker_fees` | number | Maker fees paid in cents |
|
||||
| ↳ `created_time` | string | Order creation time \(ISO 8601\) |
|
||||
| ↳ `expiration_time` | string | Order expiration time |
|
||||
| ↳ `last_update_time` | string | Last order update time |
|
||||
| `cursor` | string | Pagination cursor for fetching more results |
|
||||
|
||||
### `kalshi_get_order`
|
||||
|
||||
Retrieve details of a specific order by ID from Kalshi
|
||||
Retrieve details of a specific order by ID from Kalshi (V2 with full API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -189,11 +326,44 @@ Retrieve details of a specific order by ID from Kalshi
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Order object with details |
|
||||
| `order` | object | Order object with full API response fields |
|
||||
| ↳ `order_id` | string | Order ID |
|
||||
| ↳ `user_id` | string | User ID |
|
||||
| ↳ `client_order_id` | string | Client order ID |
|
||||
| ↳ `ticker` | string | Market ticker |
|
||||
| ↳ `side` | string | Order side \(yes/no\) |
|
||||
| ↳ `action` | string | Action \(buy/sell\) |
|
||||
| ↳ `type` | string | Order type \(limit/market\) |
|
||||
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
|
||||
| ↳ `yes_price` | number | Yes price in cents |
|
||||
| ↳ `no_price` | number | No price in cents |
|
||||
| ↳ `yes_price_dollars` | string | Yes price in dollars |
|
||||
| ↳ `no_price_dollars` | string | No price in dollars |
|
||||
| ↳ `fill_count` | number | Filled contract count |
|
||||
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
|
||||
| ↳ `remaining_count` | number | Remaining contracts |
|
||||
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
|
||||
| ↳ `initial_count` | number | Initial contract count |
|
||||
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
|
||||
| ↳ `taker_fees` | number | Taker fees in cents |
|
||||
| ↳ `maker_fees` | number | Maker fees in cents |
|
||||
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
|
||||
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
|
||||
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
|
||||
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
|
||||
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
|
||||
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
|
||||
| ↳ `queue_position` | number | Queue position \(deprecated\) |
|
||||
| ↳ `expiration_time` | string | Order expiration time |
|
||||
| ↳ `created_time` | string | Order creation time |
|
||||
| ↳ `last_update_time` | string | Last update time |
|
||||
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
|
||||
| ↳ `order_group_id` | string | Order group ID |
|
||||
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
|
||||
|
||||
### `kalshi_get_orderbook`
|
||||
|
||||
Retrieve the orderbook (yes and no bids) for a specific market
|
||||
Retrieve the orderbook (yes and no bids) for a specific market (V2 - includes depth and fp fields)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -205,11 +375,18 @@ Retrieve the orderbook (yes and no bids) for a specific market
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orderbook` | object | Orderbook with yes/no bids and asks |
|
||||
| `orderbook` | object | Orderbook with yes/no bids \(legacy integer counts\) |
|
||||
| ↳ `yes` | array | Yes side bids as tuples \[price_cents, count\] |
|
||||
| ↳ `no` | array | No side bids as tuples \[price_cents, count\] |
|
||||
| ↳ `yes_dollars` | array | Yes side bids as tuples \[dollars_string, count\] |
|
||||
| ↳ `no_dollars` | array | No side bids as tuples \[dollars_string, count\] |
|
||||
| `orderbook_fp` | object | Orderbook with fixed-point counts \(preferred\) |
|
||||
| ↳ `yes_dollars` | array | Yes side bids as tuples \[dollars_string, fp_count_string\] |
|
||||
| ↳ `no_dollars` | array | No side bids as tuples \[dollars_string, fp_count_string\] |
|
||||
|
||||
### `kalshi_get_trades`
|
||||
|
||||
Retrieve recent trades across all markets
|
||||
Retrieve recent trades with additional filtering options (V2 - includes trade_id and count_fp)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -222,12 +399,18 @@ Retrieve recent trades across all markets
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | Array of trade objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `trades` | array | Array of trade objects with trade_id and count_fp |
|
||||
| ↳ `ticker` | string | Market ticker |
|
||||
| ↳ `yes_price` | number | Trade price for yes in cents |
|
||||
| ↳ `no_price` | number | Trade price for no in cents |
|
||||
| ↳ `count` | number | Number of contracts traded |
|
||||
| ↳ `taker_side` | string | Taker side \(yes/no\) |
|
||||
| ↳ `created_time` | string | Trade time \(ISO 8601\) |
|
||||
| `cursor` | string | Pagination cursor for fetching more results |
|
||||
|
||||
### `kalshi_get_candlesticks`
|
||||
|
||||
Retrieve OHLC candlestick data for a specific market
|
||||
Retrieve OHLC candlestick data for a specific market (V2 - full API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -243,7 +426,8 @@ Retrieve OHLC candlestick data for a specific market
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `candlesticks` | array | Array of OHLC candlestick data |
|
||||
| `ticker` | string | Market ticker |
|
||||
| `candlesticks` | array | Array of OHLC candlestick data with nested bid/ask/price objects |
|
||||
|
||||
### `kalshi_get_fills`
|
||||
|
||||
@@ -266,12 +450,22 @@ Retrieve your portfolio
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fills` | array | Array of fill/trade objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `fills` | array | Array of fill/trade objects with all API fields |
|
||||
| ↳ `trade_id` | string | Unique trade identifier |
|
||||
| ↳ `order_id` | string | Associated order ID |
|
||||
| ↳ `ticker` | string | Market ticker |
|
||||
| ↳ `side` | string | Trade side \(yes/no\) |
|
||||
| ↳ `action` | string | Trade action \(buy/sell\) |
|
||||
| ↳ `count` | number | Number of contracts |
|
||||
| ↳ `yes_price` | number | Yes price in cents |
|
||||
| ↳ `no_price` | number | No price in cents |
|
||||
| ↳ `is_taker` | boolean | Whether this was a taker trade |
|
||||
| ↳ `created_time` | string | Trade execution time \(ISO 8601\) |
|
||||
| `cursor` | string | Pagination cursor for fetching more results |
|
||||
|
||||
### `kalshi_get_series_by_ticker`
|
||||
|
||||
Retrieve details of a specific market series by ticker
|
||||
Retrieve details of a specific market series by ticker (V2 - exact API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -283,11 +477,25 @@ Retrieve details of a specific market series by ticker
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | object | Series object with details |
|
||||
| `series` | object | Series object with full details matching Kalshi API response |
|
||||
| ↳ `ticker` | string | Series ticker |
|
||||
| ↳ `title` | string | Series title |
|
||||
| ↳ `frequency` | string | Event frequency |
|
||||
| ↳ `category` | string | Series category |
|
||||
| ↳ `tags` | array | Series tags |
|
||||
| ↳ `settlement_sources` | array | Settlement sources |
|
||||
| ↳ `contract_url` | string | Contract URL |
|
||||
| ↳ `contract_terms_url` | string | Contract terms URL |
|
||||
| ↳ `fee_type` | string | Fee type |
|
||||
| ↳ `fee_multiplier` | number | Fee multiplier |
|
||||
| ↳ `additional_prohibitions` | array | Additional prohibitions |
|
||||
| ↳ `product_metadata` | object | Product metadata |
|
||||
| ↳ `volume` | number | Series volume |
|
||||
| ↳ `volume_fp` | number | Volume \(fixed-point\) |
|
||||
|
||||
### `kalshi_get_exchange_status`
|
||||
|
||||
Retrieve the current status of the Kalshi exchange (trading and exchange activity)
|
||||
Retrieve the current status of the Kalshi exchange (V2 - exact API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -298,11 +506,13 @@ Retrieve the current status of the Kalshi exchange (trading and exchange activit
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | object | Exchange status with trading_active and exchange_active flags |
|
||||
| `exchange_active` | boolean | Whether the exchange is active |
|
||||
| `trading_active` | boolean | Whether trading is active |
|
||||
| `exchange_estimated_resume_time` | string | Estimated time when exchange will resume \(if inactive\) |
|
||||
|
||||
### `kalshi_create_order`
|
||||
|
||||
Create a new order on a Kalshi prediction market
|
||||
Create a new order on a Kalshi prediction market (V2 with full API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -332,11 +542,44 @@ Create a new order on a Kalshi prediction market
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The created order object |
|
||||
| `order` | object | The created order object with full API response fields |
|
||||
| ↳ `order_id` | string | Order ID |
|
||||
| ↳ `user_id` | string | User ID |
|
||||
| ↳ `client_order_id` | string | Client order ID |
|
||||
| ↳ `ticker` | string | Market ticker |
|
||||
| ↳ `side` | string | Order side \(yes/no\) |
|
||||
| ↳ `action` | string | Action \(buy/sell\) |
|
||||
| ↳ `type` | string | Order type \(limit/market\) |
|
||||
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
|
||||
| ↳ `yes_price` | number | Yes price in cents |
|
||||
| ↳ `no_price` | number | No price in cents |
|
||||
| ↳ `yes_price_dollars` | string | Yes price in dollars |
|
||||
| ↳ `no_price_dollars` | string | No price in dollars |
|
||||
| ↳ `fill_count` | number | Filled contract count |
|
||||
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
|
||||
| ↳ `remaining_count` | number | Remaining contracts |
|
||||
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
|
||||
| ↳ `initial_count` | number | Initial contract count |
|
||||
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
|
||||
| ↳ `taker_fees` | number | Taker fees in cents |
|
||||
| ↳ `maker_fees` | number | Maker fees in cents |
|
||||
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
|
||||
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
|
||||
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
|
||||
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
|
||||
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
|
||||
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
|
||||
| ↳ `queue_position` | number | Queue position \(deprecated\) |
|
||||
| ↳ `expiration_time` | string | Order expiration time |
|
||||
| ↳ `created_time` | string | Order creation time |
|
||||
| ↳ `last_update_time` | string | Last update time |
|
||||
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
|
||||
| ↳ `order_group_id` | string | Order group ID |
|
||||
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
|
||||
|
||||
### `kalshi_cancel_order`
|
||||
|
||||
Cancel an existing order on Kalshi
|
||||
Cancel an existing order on Kalshi (V2 with full API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -350,12 +593,46 @@ Cancel an existing order on Kalshi
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The canceled order object |
|
||||
| `reducedBy` | number | Number of contracts canceled |
|
||||
| `order` | object | The canceled order object with full API response fields |
|
||||
| ↳ `order_id` | string | Order ID |
|
||||
| ↳ `user_id` | string | User ID |
|
||||
| ↳ `client_order_id` | string | Client order ID |
|
||||
| ↳ `ticker` | string | Market ticker |
|
||||
| ↳ `side` | string | Order side \(yes/no\) |
|
||||
| ↳ `action` | string | Action \(buy/sell\) |
|
||||
| ↳ `type` | string | Order type \(limit/market\) |
|
||||
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
|
||||
| ↳ `yes_price` | number | Yes price in cents |
|
||||
| ↳ `no_price` | number | No price in cents |
|
||||
| ↳ `yes_price_dollars` | string | Yes price in dollars |
|
||||
| ↳ `no_price_dollars` | string | No price in dollars |
|
||||
| ↳ `fill_count` | number | Filled contract count |
|
||||
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
|
||||
| ↳ `remaining_count` | number | Remaining contracts |
|
||||
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
|
||||
| ↳ `initial_count` | number | Initial contract count |
|
||||
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
|
||||
| ↳ `taker_fees` | number | Taker fees in cents |
|
||||
| ↳ `maker_fees` | number | Maker fees in cents |
|
||||
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
|
||||
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
|
||||
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
|
||||
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
|
||||
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
|
||||
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
|
||||
| ↳ `queue_position` | number | Queue position \(deprecated\) |
|
||||
| ↳ `expiration_time` | string | Order expiration time |
|
||||
| ↳ `created_time` | string | Order creation time |
|
||||
| ↳ `last_update_time` | string | Last update time |
|
||||
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
|
||||
| ↳ `order_group_id` | string | Order group ID |
|
||||
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
|
||||
| `reduced_by` | number | Number of contracts canceled |
|
||||
| `reduced_by_fp` | string | Number of contracts canceled in fixed-point format |
|
||||
|
||||
### `kalshi_amend_order`
|
||||
|
||||
Modify the price or quantity of an existing order on Kalshi
|
||||
Modify the price or quantity of an existing order on Kalshi (V2 with full API response)
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -379,6 +656,63 @@ Modify the price or quantity of an existing order on Kalshi
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The amended order object |
|
||||
| `old_order` | object | The original order object before amendment |
|
||||
| ↳ `order_id` | string | Order ID |
|
||||
| ↳ `user_id` | string | User ID |
|
||||
| ↳ `ticker` | string | Market ticker |
|
||||
| ↳ `event_ticker` | string | Event ticker |
|
||||
| ↳ `status` | string | Order status |
|
||||
| ↳ `side` | string | Order side \(yes/no\) |
|
||||
| ↳ `type` | string | Order type \(limit/market\) |
|
||||
| ↳ `yes_price` | number | Yes price in cents |
|
||||
| ↳ `no_price` | number | No price in cents |
|
||||
| ↳ `action` | string | Action \(buy/sell\) |
|
||||
| ↳ `count` | number | Number of contracts |
|
||||
| ↳ `remaining_count` | number | Remaining contracts |
|
||||
| ↳ `created_time` | string | Order creation time |
|
||||
| ↳ `expiration_time` | string | Order expiration time |
|
||||
| ↳ `order_group_id` | string | Order group ID |
|
||||
| ↳ `client_order_id` | string | Client order ID |
|
||||
| ↳ `place_count` | number | Place count |
|
||||
| ↳ `decrease_count` | number | Decrease count |
|
||||
| ↳ `queue_position` | number | Queue position |
|
||||
| ↳ `maker_fill_count` | number | Maker fill count |
|
||||
| ↳ `taker_fill_count` | number | Taker fill count |
|
||||
| ↳ `maker_fees` | number | Maker fees |
|
||||
| ↳ `taker_fees` | number | Taker fees |
|
||||
| ↳ `last_update_time` | string | Last update time |
|
||||
| ↳ `take_profit_order_id` | string | Take profit order ID |
|
||||
| ↳ `stop_loss_order_id` | string | Stop loss order ID |
|
||||
| ↳ `amend_count` | number | Amend count |
|
||||
| ↳ `amend_taker_fill_count` | number | Amend taker fill count |
|
||||
| `order` | object | The amended order object with full API response fields |
|
||||
| ↳ `order_id` | string | Order ID |
|
||||
| ↳ `user_id` | string | User ID |
|
||||
| ↳ `ticker` | string | Market ticker |
|
||||
| ↳ `event_ticker` | string | Event ticker |
|
||||
| ↳ `status` | string | Order status |
|
||||
| ↳ `side` | string | Order side \(yes/no\) |
|
||||
| ↳ `type` | string | Order type \(limit/market\) |
|
||||
| ↳ `yes_price` | number | Yes price in cents |
|
||||
| ↳ `no_price` | number | No price in cents |
|
||||
| ↳ `action` | string | Action \(buy/sell\) |
|
||||
| ↳ `count` | number | Number of contracts |
|
||||
| ↳ `remaining_count` | number | Remaining contracts |
|
||||
| ↳ `created_time` | string | Order creation time |
|
||||
| ↳ `expiration_time` | string | Order expiration time |
|
||||
| ↳ `order_group_id` | string | Order group ID |
|
||||
| ↳ `client_order_id` | string | Client order ID |
|
||||
| ↳ `place_count` | number | Place count |
|
||||
| ↳ `decrease_count` | number | Decrease count |
|
||||
| ↳ `queue_position` | number | Queue position |
|
||||
| ↳ `maker_fill_count` | number | Maker fill count |
|
||||
| ↳ `taker_fill_count` | number | Taker fill count |
|
||||
| ↳ `maker_fees` | number | Maker fees |
|
||||
| ↳ `taker_fees` | number | Taker fees |
|
||||
| ↳ `last_update_time` | string | Last update time |
|
||||
| ↳ `take_profit_order_id` | string | Take profit order ID |
|
||||
| ↳ `stop_loss_order_id` | string | Stop loss order ID |
|
||||
| ↳ `amend_count` | number | Amend count |
|
||||
| ↳ `amend_taker_fill_count` | number | Amend taker fill count |
|
||||
|
||||
|
||||
|
||||
@@ -59,18 +59,27 @@ Fetch and filter issues from Linear
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `hasNextPage` | boolean | Whether there are more results |
|
||||
| `endCursor` | string | Cursor for the next page |
|
||||
| `issues` | array | Array of filtered issues from Linear |
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `title` | string | Issue title |
|
||||
| ↳ `description` | string | Issue description |
|
||||
| ↳ `priority` | number | Issue priority |
|
||||
| ↳ `estimate` | number | Issue estimate |
|
||||
| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
|
||||
| ↳ `estimate` | number | Estimate in points |
|
||||
| ↳ `url` | string | Issue URL |
|
||||
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| ↳ `state` | object | Issue state |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
| ↳ `state` | object | Workflow state/status |
|
||||
| ↳ `id` | string | State ID |
|
||||
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
|
||||
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
|
||||
| ↳ `assignee` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `teamId` | string | Team ID |
|
||||
| ↳ `teamName` | string | Team name |
|
||||
| ↳ `projectId` | string | Project ID |
|
||||
@@ -79,8 +88,9 @@ Fetch and filter issues from Linear
|
||||
| ↳ `cycleNumber` | number | Cycle number |
|
||||
| ↳ `cycleName` | string | Cycle name |
|
||||
| ↳ `labels` | array | Issue labels |
|
||||
| `hasNextPage` | boolean | Whether there are more results available |
|
||||
| `endCursor` | string | Cursor for fetching the next page \(use as |
|
||||
| ↳ `id` | string | Label ID |
|
||||
| ↳ `name` | string | Label name |
|
||||
| ↳ `color` | string | Label color \(hex\) |
|
||||
|
||||
### `linear_get_issue`
|
||||
|
||||
@@ -100,14 +110,29 @@ Get a single issue by ID from Linear with full details
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `title` | string | Issue title |
|
||||
| ↳ `description` | string | Issue description |
|
||||
| ↳ `priority` | number | Issue priority \(0-4\) |
|
||||
| ↳ `estimate` | number | Issue estimate in points |
|
||||
| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
|
||||
| ↳ `estimate` | number | Estimate in points |
|
||||
| ↳ `url` | string | Issue URL |
|
||||
| ↳ `state` | object | Issue state/status |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
|
||||
| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
| ↳ `state` | object | Workflow state/status |
|
||||
| ↳ `id` | string | State ID |
|
||||
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
|
||||
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
|
||||
| ↳ `assignee` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `teamId` | string | Team ID |
|
||||
| ↳ `projectId` | string | Project ID |
|
||||
| ↳ `labels` | array | Issue labels |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| ↳ `id` | string | Label ID |
|
||||
| ↳ `name` | string | Label name |
|
||||
| ↳ `color` | string | Label color \(hex\) |
|
||||
|
||||
### `linear_create_issue`
|
||||
|
||||
@@ -140,14 +165,29 @@ Create a new issue in Linear
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `title` | string | Issue title |
|
||||
| ↳ `description` | string | Issue description |
|
||||
| ↳ `priority` | number | Issue priority |
|
||||
| ↳ `estimate` | number | Issue estimate |
|
||||
| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
|
||||
| ↳ `estimate` | number | Estimate in points |
|
||||
| ↳ `url` | string | Issue URL |
|
||||
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
|
||||
| ↳ `state` | object | Issue state |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
|
||||
| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
| ↳ `state` | object | Workflow state/status |
|
||||
| ↳ `id` | string | State ID |
|
||||
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
|
||||
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
|
||||
| ↳ `assignee` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `teamId` | string | Team ID |
|
||||
| ↳ `projectId` | string | Project ID |
|
||||
| ↳ `labels` | array | Issue labels |
|
||||
| ↳ `id` | string | Label ID |
|
||||
| ↳ `name` | string | Label name |
|
||||
| ↳ `color` | string | Label color \(hex\) |
|
||||
| ↳ `cycleId` | string | Cycle ID |
|
||||
| ↳ `cycleNumber` | number | Cycle number |
|
||||
| ↳ `cycleName` | string | Cycle name |
|
||||
@@ -155,7 +195,6 @@ Create a new issue in Linear
|
||||
| ↳ `parentTitle` | string | Parent issue title |
|
||||
| ↳ `projectMilestoneId` | string | Project milestone ID |
|
||||
| ↳ `projectMilestoneName` | string | Project milestone name |
|
||||
| ↳ `labels` | array | Issue labels |
|
||||
|
||||
### `linear_update_issue`
|
||||
|
||||
@@ -188,19 +227,36 @@ Update an existing issue in Linear
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `title` | string | Issue title |
|
||||
| ↳ `description` | string | Issue description |
|
||||
| ↳ `priority` | number | Issue priority |
|
||||
| ↳ `estimate` | number | Issue estimate |
|
||||
| ↳ `state` | object | Issue state |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `labels` | array | Issue labels |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
|
||||
| ↳ `estimate` | number | Estimate in points |
|
||||
| ↳ `url` | string | Issue URL |
|
||||
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
|
||||
| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
| ↳ `state` | object | Workflow state/status |
|
||||
| ↳ `id` | string | State ID |
|
||||
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
|
||||
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
|
||||
| ↳ `assignee` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `teamId` | string | Team ID |
|
||||
| ↳ `projectId` | string | Project ID |
|
||||
| ↳ `labels` | array | Issue labels |
|
||||
| ↳ `id` | string | Label ID |
|
||||
| ↳ `name` | string | Label name |
|
||||
| ↳ `color` | string | Label color \(hex\) |
|
||||
| ↳ `cycleId` | string | Cycle ID |
|
||||
| ↳ `cycleNumber` | number | Cycle number |
|
||||
| ↳ `cycleName` | string | Cycle name |
|
||||
| ↳ `parentId` | string | Parent issue ID |
|
||||
| ↳ `parentTitle` | string | Parent issue title |
|
||||
| ↳ `projectMilestoneId` | string | Project milestone ID |
|
||||
| ↳ `projectMilestoneName` | string | Project milestone name |
|
||||
|
||||
### `linear_archive_issue`
|
||||
|
||||
@@ -269,17 +325,36 @@ Search for issues in Linear using full-text search
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for the next page |
|
||||
| `issues` | array | Array of matching issues |
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `title` | string | Issue title |
|
||||
| ↳ `description` | string | Issue description |
|
||||
| ↳ `priority` | number | Issue priority |
|
||||
| ↳ `state` | object | Issue state |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
|
||||
| ↳ `estimate` | number | Estimate in points |
|
||||
| ↳ `url` | string | Issue URL |
|
||||
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
|
||||
| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
| ↳ `state` | object | Workflow state/status |
|
||||
| ↳ `id` | string | State ID |
|
||||
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
|
||||
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
|
||||
| ↳ `assignee` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `teamId` | string | Team ID |
|
||||
| ↳ `projectId` | string | Project ID |
|
||||
| ↳ `labels` | array | Issue labels |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for next page |
|
||||
| ↳ `id` | string | Label ID |
|
||||
| ↳ `name` | string | Label name |
|
||||
| ↳ `color` | string | Label color \(hex\) |
|
||||
|
||||
### `linear_add_label_to_issue`
|
||||
|
||||
@@ -334,10 +409,16 @@ Add a comment to an issue in Linear
|
||||
| --------- | ---- | ----------- |
|
||||
| `comment` | object | The created comment |
|
||||
| ↳ `id` | string | Comment ID |
|
||||
| ↳ `body` | string | Comment text |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `user` | object | User who created the comment |
|
||||
| ↳ `issue` | object | Associated issue |
|
||||
| ↳ `body` | string | Comment text \(Markdown\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| ↳ `user` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `issue` | object | Issue object |
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `title` | string | Issue title |
|
||||
|
||||
### `linear_update_comment`
|
||||
|
||||
@@ -356,9 +437,16 @@ Edit a comment in Linear
|
||||
| --------- | ---- | ----------- |
|
||||
| `comment` | object | The updated comment |
|
||||
| ↳ `id` | string | Comment ID |
|
||||
| ↳ `body` | string | Comment text |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| ↳ `user` | object | User who created the comment |
|
||||
| ↳ `body` | string | Comment text \(Markdown\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| ↳ `user` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `issue` | object | Issue object |
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `title` | string | Issue title |
|
||||
|
||||
### `linear_delete_comment`
|
||||
|
||||
@@ -392,15 +480,21 @@ List all comments on an issue in Linear
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `comments` | array | Array of comments on the issue |
|
||||
| ↳ `id` | string | Comment ID |
|
||||
| ↳ `body` | string | Comment text |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| ↳ `user` | object | User who created the comment |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for next page |
|
||||
| ↳ `endCursor` | string | Cursor for the next page |
|
||||
| `comments` | array | Array of comments on the issue |
|
||||
| ↳ `id` | string | Comment ID |
|
||||
| ↳ `body` | string | Comment text \(Markdown\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| ↳ `user` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `issue` | object | Issue object |
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `title` | string | Issue title |
|
||||
|
||||
### `linear_list_projects`
|
||||
|
||||
@@ -419,15 +513,25 @@ List projects in Linear with optional filtering
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for the next page |
|
||||
| `projects` | array | Array of projects |
|
||||
| ↳ `id` | string | Project ID |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `description` | string | Project description |
|
||||
| ↳ `state` | string | Project state |
|
||||
| ↳ `priority` | number | Project priority |
|
||||
| ↳ `lead` | object | Project lead |
|
||||
| ↳ `teams` | array | Teams associated with project |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) |
|
||||
| ↳ `priority` | number | Project priority \(0-4\) |
|
||||
| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) |
|
||||
| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) |
|
||||
| ↳ `url` | string | Project URL |
|
||||
| ↳ `lead` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `teams` | array | Associated teams |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
|
||||
### `linear_get_project`
|
||||
|
||||
@@ -447,12 +551,18 @@ Get a single project by ID from Linear
|
||||
| ↳ `id` | string | Project ID |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `description` | string | Project description |
|
||||
| ↳ `state` | string | Project state |
|
||||
| ↳ `priority` | number | Project priority |
|
||||
| ↳ `startDate` | string | Start date |
|
||||
| ↳ `targetDate` | string | Target completion date |
|
||||
| ↳ `lead` | object | Project lead |
|
||||
| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) |
|
||||
| ↳ `priority` | number | Project priority \(0-4\) |
|
||||
| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) |
|
||||
| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) |
|
||||
| ↳ `url` | string | Project URL |
|
||||
| ↳ `lead` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `teams` | array | Associated teams |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
|
||||
### `linear_create_project`
|
||||
|
||||
@@ -478,10 +588,18 @@ Create a new project in Linear
|
||||
| ↳ `id` | string | Project ID |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `description` | string | Project description |
|
||||
| ↳ `state` | string | Project state |
|
||||
| ↳ `priority` | number | Project priority |
|
||||
| ↳ `lead` | object | Project lead |
|
||||
| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) |
|
||||
| ↳ `priority` | number | Project priority \(0-4\) |
|
||||
| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) |
|
||||
| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) |
|
||||
| ↳ `url` | string | Project URL |
|
||||
| ↳ `lead` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `teams` | array | Associated teams |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
|
||||
### `linear_update_project`
|
||||
|
||||
@@ -508,12 +626,18 @@ Update an existing project in Linear
|
||||
| ↳ `id` | string | Project ID |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `description` | string | Project description |
|
||||
| ↳ `state` | string | Project state |
|
||||
| ↳ `priority` | number | Project priority |
|
||||
| ↳ `startDate` | string | Project start date |
|
||||
| ↳ `targetDate` | string | Project target date |
|
||||
| ↳ `lead` | object | Project lead |
|
||||
| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) |
|
||||
| ↳ `priority` | number | Project priority \(0-4\) |
|
||||
| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) |
|
||||
| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) |
|
||||
| ↳ `url` | string | Project URL |
|
||||
| ↳ `lead` | object | User object |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `teams` | array | Associated teams |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
|
||||
### `linear_archive_project`
|
||||
|
||||
@@ -548,6 +672,9 @@ List all users in the Linear workspace
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for the next page |
|
||||
| `users` | array | Array of workspace users |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
@@ -556,7 +683,6 @@ List all users in the Linear workspace
|
||||
| ↳ `active` | boolean | Whether user is active |
|
||||
| ↳ `admin` | boolean | Whether user is admin |
|
||||
| ↳ `avatarUrl` | string | Avatar URL |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
### `linear_list_teams`
|
||||
|
||||
@@ -573,12 +699,14 @@ List all teams in the Linear workspace
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for the next page |
|
||||
| `teams` | array | Array of teams |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
| ↳ `key` | string | Team key \(used in issue identifiers\) |
|
||||
| ↳ `description` | string | Team description |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
### `linear_get_viewer`
|
||||
|
||||
@@ -618,13 +746,17 @@ List all labels in Linear workspace or team
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for the next page |
|
||||
| `labels` | array | Array of labels |
|
||||
| ↳ `id` | string | Label ID |
|
||||
| ↳ `name` | string | Label name |
|
||||
| ↳ `color` | string | Label color \(hex\) |
|
||||
| ↳ `description` | string | Label description |
|
||||
| ↳ `team` | object | Team this label belongs to |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `team` | object | Team object |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
|
||||
### `linear_create_label`
|
||||
|
||||
@@ -646,9 +778,11 @@ Create a new label in Linear
|
||||
| `label` | object | The created label |
|
||||
| ↳ `id` | string | Label ID |
|
||||
| ↳ `name` | string | Label name |
|
||||
| ↳ `color` | string | Label color |
|
||||
| ↳ `color` | string | Label color \(hex\) |
|
||||
| ↳ `description` | string | Label description |
|
||||
| ↳ `team` | object | Team this label belongs to |
|
||||
| ↳ `team` | object | Team object |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
|
||||
### `linear_update_label`
|
||||
|
||||
@@ -670,8 +804,11 @@ Update an existing label in Linear
|
||||
| `label` | object | The updated label |
|
||||
| ↳ `id` | string | Label ID |
|
||||
| ↳ `name` | string | Label name |
|
||||
| ↳ `color` | string | Label color |
|
||||
| ↳ `color` | string | Label color \(hex\) |
|
||||
| ↳ `description` | string | Label description |
|
||||
| ↳ `team` | object | Team object |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
|
||||
### `linear_archive_label`
|
||||
|
||||
@@ -706,14 +843,18 @@ List all workflow states (statuses) in Linear
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for the next page |
|
||||
| `states` | array | Array of workflow states |
|
||||
| ↳ `id` | string | State ID |
|
||||
| ↳ `name` | string | State name \(e.g., |
|
||||
| ↳ `type` | string | State type \(e.g., |
|
||||
| ↳ `color` | string | State color |
|
||||
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
|
||||
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
|
||||
| ↳ `color` | string | State color \(hex\) |
|
||||
| ↳ `position` | number | State position in workflow |
|
||||
| ↳ `team` | object | Team this state belongs to |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `team` | object | Team object |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
|
||||
### `linear_create_workflow_state`
|
||||
|
||||
@@ -783,16 +924,20 @@ List cycles (sprints/iterations) in Linear
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for the next page |
|
||||
| `cycles` | array | Array of cycles |
|
||||
| ↳ `id` | string | Cycle ID |
|
||||
| ↳ `number` | number | Cycle number |
|
||||
| ↳ `name` | string | Cycle name |
|
||||
| ↳ `startsAt` | string | Start date |
|
||||
| ↳ `endsAt` | string | End date |
|
||||
| ↳ `completedAt` | string | Completion date |
|
||||
| ↳ `startsAt` | string | Start date \(ISO 8601\) |
|
||||
| ↳ `endsAt` | string | End date \(ISO 8601\) |
|
||||
| ↳ `completedAt` | string | Completion date \(ISO 8601\) |
|
||||
| ↳ `progress` | number | Progress percentage \(0-1\) |
|
||||
| ↳ `team` | object | Team this cycle belongs to |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `team` | object | Team object |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
|
||||
### `linear_get_cycle`
|
||||
|
||||
@@ -812,10 +957,13 @@ Get a single cycle by ID from Linear
|
||||
| ↳ `id` | string | Cycle ID |
|
||||
| ↳ `number` | number | Cycle number |
|
||||
| ↳ `name` | string | Cycle name |
|
||||
| ↳ `startsAt` | string | Start date |
|
||||
| ↳ `endsAt` | string | End date |
|
||||
| ↳ `progress` | number | Progress percentage |
|
||||
| ↳ `team` | object | Team this cycle belongs to |
|
||||
| ↳ `startsAt` | string | Start date \(ISO 8601\) |
|
||||
| ↳ `endsAt` | string | End date \(ISO 8601\) |
|
||||
| ↳ `completedAt` | string | Completion date \(ISO 8601\) |
|
||||
| ↳ `progress` | number | Progress percentage \(0-1\) |
|
||||
| ↳ `team` | object | Team object |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `name` | string | Team name |
|
||||
|
||||
### `linear_create_cycle`
|
||||
|
||||
@@ -887,7 +1035,8 @@ Add an attachment to an issue in Linear
|
||||
| ↳ `title` | string | Attachment title |
|
||||
| ↳ `subtitle` | string | Attachment subtitle |
|
||||
| ↳ `url` | string | Attachment URL |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_list_attachments`
|
||||
|
||||
@@ -905,13 +1054,16 @@ List all attachments on an issue in Linear
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for the next page |
|
||||
| `attachments` | array | Array of attachments |
|
||||
| ↳ `id` | string | Attachment ID |
|
||||
| ↳ `title` | string | Attachment title |
|
||||
| ↳ `subtitle` | string | Attachment subtitle |
|
||||
| ↳ `url` | string | Attachment URL |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_update_attachment`
|
||||
|
||||
@@ -934,7 +1086,8 @@ Update an attachment metadata in Linear
|
||||
| ↳ `title` | string | Attachment title |
|
||||
| ↳ `subtitle` | string | Attachment subtitle |
|
||||
| ↳ `url` | string | Attachment URL |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_delete_attachment`
|
||||
|
||||
@@ -1178,11 +1331,11 @@ Create a new customer in Linear
|
||||
| ↳ `id` | string | Customer ID |
|
||||
| ↳ `name` | string | Customer name |
|
||||
| ↳ `domains` | array | Associated domains |
|
||||
| ↳ `externalIds` | array | External IDs |
|
||||
| ↳ `externalIds` | array | External IDs from other systems |
|
||||
| ↳ `logoUrl` | string | Logo URL |
|
||||
| ↳ `approximateNeedCount` | number | Number of customer needs |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_list_customers`
|
||||
|
||||
@@ -1200,16 +1353,18 @@ List all customers in Linear
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results |
|
||||
| ↳ `endCursor` | string | Cursor for the next page |
|
||||
| `customers` | array | Array of customers |
|
||||
| ↳ `id` | string | Customer ID |
|
||||
| ↳ `name` | string | Customer name |
|
||||
| ↳ `domains` | array | Associated domains |
|
||||
| ↳ `externalIds` | array | External IDs |
|
||||
| ↳ `externalIds` | array | External IDs from other systems |
|
||||
| ↳ `logoUrl` | string | Logo URL |
|
||||
| ↳ `approximateNeedCount` | number | Number of customer needs |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_create_customer_request`
|
||||
|
||||
@@ -1322,11 +1477,11 @@ Get a single customer by ID in Linear
|
||||
| ↳ `id` | string | Customer ID |
|
||||
| ↳ `name` | string | Customer name |
|
||||
| ↳ `domains` | array | Associated domains |
|
||||
| ↳ `externalIds` | array | External IDs |
|
||||
| ↳ `externalIds` | array | External IDs from other systems |
|
||||
| ↳ `logoUrl` | string | Logo URL |
|
||||
| ↳ `approximateNeedCount` | number | Number of customer needs |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_update_customer`
|
||||
|
||||
@@ -1352,6 +1507,14 @@ Update a customer in Linear
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | The updated customer |
|
||||
| ↳ `id` | string | Customer ID |
|
||||
| ↳ `name` | string | Customer name |
|
||||
| ↳ `domains` | array | Associated domains |
|
||||
| ↳ `externalIds` | array | External IDs from other systems |
|
||||
| ↳ `logoUrl` | string | Logo URL |
|
||||
| ↳ `approximateNeedCount` | number | Number of customer needs |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_delete_customer`
|
||||
|
||||
@@ -1405,6 +1568,14 @@ Create a new customer status in Linear
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customerStatus` | object | The created customer status |
|
||||
| ↳ `id` | string | Customer status ID |
|
||||
| ↳ `name` | string | Status name |
|
||||
| ↳ `displayName` | string | Display name |
|
||||
| ↳ `description` | string | Status description |
|
||||
| ↳ `color` | string | Status color \(hex\) |
|
||||
| ↳ `position` | number | Position in list |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_update_customer_status`
|
||||
|
||||
@@ -1457,6 +1628,14 @@ List all customer statuses in Linear
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customerStatuses` | array | List of customer statuses |
|
||||
| ↳ `id` | string | Customer status ID |
|
||||
| ↳ `name` | string | Status name |
|
||||
| ↳ `displayName` | string | Display name |
|
||||
| ↳ `description` | string | Status description |
|
||||
| ↳ `color` | string | Status color \(hex\) |
|
||||
| ↳ `position` | number | Position in list |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_create_customer_tier`
|
||||
|
||||
@@ -1477,6 +1656,14 @@ Create a new customer tier in Linear
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customerTier` | object | The created customer tier |
|
||||
| ↳ `id` | string | Customer tier ID |
|
||||
| ↳ `name` | string | Tier name |
|
||||
| ↳ `displayName` | string | Display name |
|
||||
| ↳ `description` | string | Tier description |
|
||||
| ↳ `color` | string | Tier color \(hex\) |
|
||||
| ↳ `position` | number | Position in list |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_update_customer_tier`
|
||||
|
||||
@@ -1529,6 +1716,14 @@ List all customer tiers in Linear
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customerTiers` | array | List of customer tiers |
|
||||
| ↳ `id` | string | Customer tier ID |
|
||||
| ↳ `name` | string | Tier name |
|
||||
| ↳ `displayName` | string | Display name |
|
||||
| ↳ `description` | string | Tier description |
|
||||
| ↳ `color` | string | Tier color \(hex\) |
|
||||
| ↳ `position` | number | Position in list |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
|
||||
|
||||
### `linear_delete_project`
|
||||
|
||||
|
||||
@@ -52,6 +52,10 @@ Add memories to Mem0 for persistent storage and retrieval
|
||||
| --------- | ---- | ----------- |
|
||||
| `ids` | array | Array of memory IDs that were created |
|
||||
| `memories` | array | Array of memory objects that were created |
|
||||
| ↳ `id` | string | Unique identifier for the memory |
|
||||
| ↳ `memory` | string | The content of the memory |
|
||||
| ↳ `event` | string | Event type indicating operation performed \(ADD, UPDATE, DELETE, NOOP\) |
|
||||
| ↳ `metadata` | json | Custom metadata associated with the memory |
|
||||
|
||||
### `mem0_search_memories`
|
||||
|
||||
@@ -70,7 +74,19 @@ Search for memories in Mem0 using semantic search
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `searchResults` | array | Array of search results with memory data, each containing id, data, and score |
|
||||
| `searchResults` | array | Array of search results with memory data and similarity scores |
|
||||
| ↳ `id` | string | Unique identifier for the memory |
|
||||
| ↳ `memory` | string | The content of the memory |
|
||||
| ↳ `user_id` | string | User ID associated with this memory |
|
||||
| ↳ `agent_id` | string | Agent ID associated with this memory |
|
||||
| ↳ `app_id` | string | App ID associated with this memory |
|
||||
| ↳ `run_id` | string | Run/session ID associated with this memory |
|
||||
| ↳ `hash` | string | Hash of the memory content |
|
||||
| ↳ `metadata` | json | Custom metadata associated with the memory |
|
||||
| ↳ `categories` | json | Auto-assigned categories for the memory |
|
||||
| ↳ `created_at` | string | ISO 8601 timestamp when the memory was created |
|
||||
| ↳ `updated_at` | string | ISO 8601 timestamp when the memory was last updated |
|
||||
| ↳ `score` | number | Similarity score from vector search |
|
||||
| `ids` | array | Array of memory IDs found in the search results |
|
||||
|
||||
### `mem0_get_memories`
|
||||
@@ -93,6 +109,21 @@ Retrieve memories from Mem0 by ID or filter criteria
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `memories` | array | Array of retrieved memory objects |
|
||||
| ↳ `id` | string | Unique identifier for the memory |
|
||||
| ↳ `memory` | string | The content of the memory |
|
||||
| ↳ `user_id` | string | User ID associated with this memory |
|
||||
| ↳ `agent_id` | string | Agent ID associated with this memory |
|
||||
| ↳ `app_id` | string | App ID associated with this memory |
|
||||
| ↳ `run_id` | string | Run/session ID associated with this memory |
|
||||
| ↳ `hash` | string | Hash of the memory content |
|
||||
| ↳ `metadata` | json | Custom metadata associated with the memory |
|
||||
| ↳ `categories` | json | Auto-assigned categories for the memory |
|
||||
| ↳ `created_at` | string | ISO 8601 timestamp when the memory was created |
|
||||
| ↳ `updated_at` | string | ISO 8601 timestamp when the memory was last updated |
|
||||
| ↳ `owner` | string | Owner of the memory |
|
||||
| ↳ `organization` | string | Organization associated with the memory |
|
||||
| ↳ `immutable` | boolean | Whether the memory can be modified |
|
||||
| ↳ `expiration_date` | string | Expiration date after which memory is not retrieved |
|
||||
| `ids` | array | Array of memory IDs that were retrieved |
|
||||
|
||||
|
||||
|
||||
@@ -9,9 +9,11 @@
|
||||
"arxiv",
|
||||
"asana",
|
||||
"browser_use",
|
||||
"calcom",
|
||||
"calendly",
|
||||
"circleback",
|
||||
"clay",
|
||||
"clerk",
|
||||
"confluence",
|
||||
"cursor",
|
||||
"datadog",
|
||||
@@ -95,9 +97,9 @@
|
||||
"sftp",
|
||||
"sharepoint",
|
||||
"shopify",
|
||||
"similarweb",
|
||||
"slack",
|
||||
"smtp",
|
||||
"spotify",
|
||||
"sqs",
|
||||
"ssh",
|
||||
"stagehand",
|
||||
|
||||
@@ -64,21 +64,12 @@ Parse PDF documents using Mistral OCR API
|
||||
| ↳ `bottom_right_x` | number | Bottom-right X coordinate in pixels |
|
||||
| ↳ `bottom_right_y` | number | Bottom-right Y coordinate in pixels |
|
||||
| ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) |
|
||||
| ↳ `id` | string | Image identifier \(e.g., img-0.jpeg\) |
|
||||
| ↳ `top_left_x` | number | Top-left X coordinate in pixels |
|
||||
| ↳ `top_left_y` | number | Top-left Y coordinate in pixels |
|
||||
| ↳ `bottom_right_x` | number | Bottom-right X coordinate in pixels |
|
||||
| ↳ `bottom_right_y` | number | Bottom-right Y coordinate in pixels |
|
||||
| ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) |
|
||||
| ↳ `dimensions` | object | Page dimensions |
|
||||
| ↳ `dpi` | number | Dots per inch |
|
||||
| ↳ `height` | number | Page height in pixels |
|
||||
| ↳ `width` | number | Page width in pixels |
|
||||
| ↳ `dpi` | number | Dots per inch |
|
||||
| ↳ `height` | number | Page height in pixels |
|
||||
| ↳ `width` | number | Page width in pixels |
|
||||
| ↳ `tables` | array | Extracted tables as HTML/markdown \(when table_format is set\). Referenced via placeholders like \[tbl-0.html\] |
|
||||
| ↳ `hyperlinks` | array | Array of URL strings detected in the page \(e.g., \[ |
|
||||
| ↳ `hyperlinks` | array | Array of URL strings detected in the page \(e.g., \["https://...", "mailto:..."\]\) |
|
||||
| ↳ `header` | string | Page header content \(when extract_header=true\) |
|
||||
| ↳ `footer` | string | Page footer content \(when extract_footer=true\) |
|
||||
| `model` | string | Mistral OCR model identifier \(e.g., mistral-ocr-latest\) |
|
||||
|
||||
@@ -32,11 +32,11 @@ Read content from a Notion page
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `url` | string | Notion page URL |
|
||||
| `created_time` | string | ISO 8601 creation timestamp |
|
||||
| `last_edited_time` | string | ISO 8601 last edit timestamp |
|
||||
| `content` | string | Page content in markdown format |
|
||||
| `title` | string | Page title |
|
||||
| `url` | string | Page URL |
|
||||
| `created_time` | string | Creation timestamp |
|
||||
| `last_edited_time` | string | Last edit timestamp |
|
||||
|
||||
### `notion_read_database`
|
||||
|
||||
@@ -52,12 +52,12 @@ Read database information and structure from Notion
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Database ID |
|
||||
| `title` | string | Database title |
|
||||
| `url` | string | Database URL |
|
||||
| `created_time` | string | Creation timestamp |
|
||||
| `last_edited_time` | string | Last edit timestamp |
|
||||
| `id` | string | Database UUID |
|
||||
| `url` | string | Notion database URL |
|
||||
| `created_time` | string | ISO 8601 creation timestamp |
|
||||
| `last_edited_time` | string | ISO 8601 last edit timestamp |
|
||||
| `properties` | object | Database properties schema |
|
||||
| `title` | string | Database title |
|
||||
|
||||
### `notion_write`
|
||||
|
||||
@@ -92,11 +92,11 @@ Create a new page in Notion
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Page ID |
|
||||
| `id` | string | Page UUID |
|
||||
| `url` | string | Notion page URL |
|
||||
| `created_time` | string | ISO 8601 creation timestamp |
|
||||
| `last_edited_time` | string | ISO 8601 last edit timestamp |
|
||||
| `title` | string | Page title |
|
||||
| `url` | string | Page URL |
|
||||
| `created_time` | string | Creation timestamp |
|
||||
| `last_edited_time` | string | Last edit timestamp |
|
||||
|
||||
### `notion_query_database`
|
||||
|
||||
@@ -115,13 +115,43 @@ Query and filter Notion database entries with advanced filtering
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array of Notion page objects from the database |
|
||||
| ↳ `id` | string | Page ID |
|
||||
| ↳ `created_time` | string | Creation timestamp |
|
||||
| ↳ `last_edited_time` | string | Last edit timestamp |
|
||||
| ↳ `url` | string | Page URL |
|
||||
| `results` | array | Array of page objects from the database |
|
||||
| ↳ `object` | string | Always "page" |
|
||||
| ↳ `id` | string | Page UUID |
|
||||
| ↳ `created_time` | string | ISO 8601 creation timestamp |
|
||||
| ↳ `last_edited_time` | string | ISO 8601 last edit timestamp |
|
||||
| ↳ `created_by` | object | Partial user object |
|
||||
| ↳ `object` | string | Always "user" |
|
||||
| ↳ `id` | string | User UUID |
|
||||
| ↳ `last_edited_by` | object | Partial user object |
|
||||
| ↳ `object` | string | Always "user" |
|
||||
| ↳ `id` | string | User UUID |
|
||||
| ↳ `archived` | boolean | Whether the page is archived |
|
||||
| ↳ `in_trash` | boolean | Whether the page is in trash |
|
||||
| ↳ `url` | string | Notion page URL |
|
||||
| ↳ `public_url` | string | Public web URL if shared, null otherwise |
|
||||
| ↳ `parent` | object | Parent object specifying hierarchical relationship |
|
||||
| ↳ `type` | string | Parent type: "database_id", "data_source_id", "page_id", "workspace", or "block_id" |
|
||||
| ↳ `database_id` | string | Parent database UUID \(if type is database_id\) |
|
||||
| ↳ `data_source_id` | string | Parent data source UUID \(if type is data_source_id\) |
|
||||
| ↳ `page_id` | string | Parent page UUID \(if type is page_id\) |
|
||||
| ↳ `workspace` | boolean | True if parent is workspace \(if type is workspace\) |
|
||||
| ↳ `block_id` | string | Parent block UUID \(if type is block_id\) |
|
||||
| ↳ `icon` | object | Page/database icon \(emoji, custom_emoji, or file\) |
|
||||
| ↳ `url` | string | Authenticated URL valid for one hour |
|
||||
| ↳ `expiry_time` | string | ISO 8601 timestamp when URL expires |
|
||||
| ↳ `cover` | object | Page/database cover image |
|
||||
| ↳ `type` | string | File type: "file", "file_upload", or "external" |
|
||||
| ↳ `file` | object | Notion-hosted file object \(when type is "file"\) |
|
||||
| ↳ `url` | string | Authenticated URL valid for one hour |
|
||||
| ↳ `expiry_time` | string | ISO 8601 timestamp when URL expires |
|
||||
| ↳ `file_upload` | object | API-uploaded file object \(when type is "file_upload"\) |
|
||||
| ↳ `id` | string | File upload UUID |
|
||||
| ↳ `external` | object | External file object \(when type is "external"\) |
|
||||
| ↳ `url` | string | External file URL \(never expires\) |
|
||||
| ↳ `properties` | object | Page property values \(structure depends on parent type - database properties or title only\) |
|
||||
| `has_more` | boolean | Whether more results are available |
|
||||
| `next_cursor` | string | Cursor for pagination |
|
||||
| `next_cursor` | string | Cursor for next page of results |
|
||||
| `total_results` | number | Number of results returned |
|
||||
|
||||
### `notion_search`
|
||||
@@ -140,14 +170,31 @@ Search across all pages and databases in Notion workspace
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array of search results \(pages and databases\) |
|
||||
| ↳ `id` | string | Object ID |
|
||||
| ↳ `object` | string | Object type \(page or database\) |
|
||||
| `results` | array | Array of search results \(pages and/or databases\) |
|
||||
| ↳ `object` | string | Object type: "page" or "database" |
|
||||
| ↳ `id` | string | Object UUID |
|
||||
| ↳ `created_time` | string | ISO 8601 creation timestamp |
|
||||
| ↳ `last_edited_time` | string | ISO 8601 last edit timestamp |
|
||||
| ↳ `created_by` | object | Partial user object |
|
||||
| ↳ `object` | string | Always "user" |
|
||||
| ↳ `id` | string | User UUID |
|
||||
| ↳ `last_edited_by` | object | Partial user object |
|
||||
| ↳ `object` | string | Always "user" |
|
||||
| ↳ `id` | string | User UUID |
|
||||
| ↳ `archived` | boolean | Whether the object is archived |
|
||||
| ↳ `in_trash` | boolean | Whether the object is in trash |
|
||||
| ↳ `url` | string | Object URL |
|
||||
| ↳ `created_time` | string | Creation timestamp |
|
||||
| ↳ `last_edited_time` | string | Last edit timestamp |
|
||||
| ↳ `public_url` | string | Public web URL if shared |
|
||||
| ↳ `parent` | object | Parent object specifying hierarchical relationship |
|
||||
| ↳ `type` | string | Parent type: "database_id", "data_source_id", "page_id", "workspace", or "block_id" |
|
||||
| ↳ `database_id` | string | Parent database UUID \(if type is database_id\) |
|
||||
| ↳ `data_source_id` | string | Parent data source UUID \(if type is data_source_id\) |
|
||||
| ↳ `page_id` | string | Parent page UUID \(if type is page_id\) |
|
||||
| ↳ `workspace` | boolean | True if parent is workspace \(if type is workspace\) |
|
||||
| ↳ `block_id` | string | Parent block UUID \(if type is block_id\) |
|
||||
| ↳ `properties` | object | Object properties |
|
||||
| `has_more` | boolean | Whether more results are available |
|
||||
| `next_cursor` | string | Cursor for pagination |
|
||||
| `next_cursor` | string | Cursor for next page of results |
|
||||
| `total_results` | number | Number of results returned |
|
||||
|
||||
### `notion_create_database`
|
||||
@@ -166,11 +213,11 @@ Create a new database in Notion with custom properties
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Database ID |
|
||||
| `title` | string | Database title |
|
||||
| `url` | string | Database URL |
|
||||
| `created_time` | string | Creation timestamp |
|
||||
| `id` | string | Database UUID |
|
||||
| `url` | string | Notion database URL |
|
||||
| `created_time` | string | ISO 8601 creation timestamp |
|
||||
| `properties` | object | Database properties schema |
|
||||
| `title` | string | Database title |
|
||||
|
||||
### `notion_add_database_row`
|
||||
|
||||
@@ -187,10 +234,10 @@ Add a new row to a Notion database with specified properties
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Page/row ID |
|
||||
| `url` | string | Page/row URL |
|
||||
| `id` | string | Page UUID |
|
||||
| `url` | string | Notion page URL |
|
||||
| `created_time` | string | ISO 8601 creation timestamp |
|
||||
| `last_edited_time` | string | ISO 8601 last edit timestamp |
|
||||
| `title` | string | Row title |
|
||||
| `created_time` | string | Creation timestamp |
|
||||
| `last_edited_time` | string | Last edit timestamp |
|
||||
|
||||
|
||||
|
||||
@@ -59,7 +59,5 @@ Generate embeddings from text using OpenAI
|
||||
| ↳ `usage` | object | Token usage information |
|
||||
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
||||
| ↳ `total_tokens` | number | Total number of tokens used |
|
||||
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
||||
| ↳ `total_tokens` | number | Total number of tokens used |
|
||||
|
||||
|
||||
|
||||
@@ -115,6 +115,29 @@ Read emails from Outlook
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or status message |
|
||||
| `results` | array | Array of email message objects |
|
||||
| ↳ `id` | string | Unique message identifier |
|
||||
| ↳ `subject` | string | Email subject |
|
||||
| ↳ `bodyPreview` | string | Preview of the message body |
|
||||
| ↳ `body` | object | Message body |
|
||||
| ↳ `contentType` | string | Body content type \(text or html\) |
|
||||
| ↳ `content` | string | Body content |
|
||||
| ↳ `sender` | object | Sender information |
|
||||
| ↳ `name` | string | Display name of the person or entity |
|
||||
| ↳ `address` | string | Email address |
|
||||
| ↳ `from` | object | From address information |
|
||||
| ↳ `name` | string | Display name of the person or entity |
|
||||
| ↳ `address` | string | Email address |
|
||||
| ↳ `toRecipients` | array | To recipients |
|
||||
| ↳ `name` | string | Display name of the person or entity |
|
||||
| ↳ `address` | string | Email address |
|
||||
| ↳ `ccRecipients` | array | CC recipients |
|
||||
| ↳ `name` | string | Display name of the person or entity |
|
||||
| ↳ `address` | string | Email address |
|
||||
| ↳ `receivedDateTime` | string | When the message was received \(ISO 8601\) |
|
||||
| ↳ `sentDateTime` | string | When the message was sent \(ISO 8601\) |
|
||||
| ↳ `hasAttachments` | boolean | Whether the message has attachments |
|
||||
| ↳ `isRead` | boolean | Whether the message has been read |
|
||||
| ↳ `importance` | string | Message importance \(low, normal, high\) |
|
||||
| `attachments` | file[] | All email attachments flattened from all emails |
|
||||
|
||||
### `outlook_forward`
|
||||
|
||||
@@ -112,9 +112,6 @@ Conduct comprehensive deep research across the web using Parallel AI. Synthesize
|
||||
| ↳ `url` | string | Source URL |
|
||||
| ↳ `title` | string | Source title |
|
||||
| ↳ `excerpts` | array | Relevant excerpts from the source |
|
||||
| ↳ `url` | string | Source URL |
|
||||
| ↳ `title` | string | Source title |
|
||||
| ↳ `excerpts` | array | Relevant excerpts from the source |
|
||||
| ↳ `confidence` | string | Confidence level indicator |
|
||||
|
||||
|
||||
|
||||
@@ -87,7 +87,7 @@ Get ranked search results from Perplexity
|
||||
| ↳ `title` | string | Title of the search result |
|
||||
| ↳ `url` | string | URL of the search result |
|
||||
| ↳ `snippet` | string | Brief excerpt or summary of the content |
|
||||
| ↳ `date` | string | Date the page was crawled and added to Perplexity |
|
||||
| ↳ `last_updated` | string | Date the page was last updated in Perplexity |
|
||||
| ↳ `date` | string | Date the page was crawled and added to Perplexity's index |
|
||||
| ↳ `last_updated` | string | Date the page was last updated in Perplexity's index |
|
||||
|
||||
|
||||
|
||||
@@ -55,7 +55,25 @@ Retrieve all deals from Pipedrive with optional filters
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deals` | array | Array of deal objects from Pipedrive |
|
||||
| ↳ `id` | number | Deal ID |
|
||||
| ↳ `title` | string | Deal title |
|
||||
| ↳ `value` | number | Deal value |
|
||||
| ↳ `currency` | string | Currency code |
|
||||
| ↳ `status` | string | Deal status \(open, won, lost, deleted\) |
|
||||
| ↳ `stage_id` | number | Pipeline stage ID |
|
||||
| ↳ `pipeline_id` | number | Pipeline ID |
|
||||
| ↳ `person_id` | number | Associated person ID |
|
||||
| ↳ `org_id` | number | Associated organization ID |
|
||||
| ↳ `owner_id` | number | Deal owner user ID |
|
||||
| ↳ `add_time` | string | When the deal was created \(ISO 8601\) |
|
||||
| ↳ `update_time` | string | When the deal was last updated \(ISO 8601\) |
|
||||
| ↳ `won_time` | string | When the deal was won |
|
||||
| ↳ `lost_time` | string | When the deal was lost |
|
||||
| ↳ `close_time` | string | When the deal was closed |
|
||||
| ↳ `expected_close_date` | string | Expected close date |
|
||||
| `metadata` | object | Pagination metadata for the response |
|
||||
| ↳ `total_items` | number | Total number of items |
|
||||
| ↳ `has_more` | boolean | Whether more items are available |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `pipedrive_get_deal`
|
||||
@@ -140,6 +158,16 @@ Retrieve files from Pipedrive with optional filters
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `files` | array | Array of file objects from Pipedrive |
|
||||
| ↳ `id` | number | File ID |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `file_type` | string | File type/extension |
|
||||
| ↳ `file_size` | number | File size in bytes |
|
||||
| ↳ `add_time` | string | When the file was uploaded |
|
||||
| ↳ `update_time` | string | When the file was last updated |
|
||||
| ↳ `deal_id` | number | Associated deal ID |
|
||||
| ↳ `person_id` | number | Associated person ID |
|
||||
| ↳ `org_id` | number | Associated organization ID |
|
||||
| ↳ `url` | string | File download URL |
|
||||
| `total_items` | number | Total number of files returned |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -198,6 +226,14 @@ Retrieve all pipelines from Pipedrive
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipelines` | array | Array of pipeline objects from Pipedrive |
|
||||
| ↳ `id` | number | Pipeline ID |
|
||||
| ↳ `name` | string | Pipeline name |
|
||||
| ↳ `url_title` | string | URL-friendly title |
|
||||
| ↳ `order_nr` | number | Pipeline order number |
|
||||
| ↳ `active` | boolean | Whether the pipeline is active |
|
||||
| ↳ `deal_probability` | boolean | Whether deal probability is enabled |
|
||||
| ↳ `add_time` | string | When the pipeline was created |
|
||||
| ↳ `update_time` | string | When the pipeline was last updated |
|
||||
| `total_items` | number | Total number of pipelines returned |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -283,6 +319,19 @@ Retrieve activities (tasks) from Pipedrive with optional filters
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `activities` | array | Array of activity objects from Pipedrive |
|
||||
| ↳ `id` | number | Activity ID |
|
||||
| ↳ `subject` | string | Activity subject |
|
||||
| ↳ `type` | string | Activity type \(call, meeting, task, etc.\) |
|
||||
| ↳ `due_date` | string | Due date \(YYYY-MM-DD\) |
|
||||
| ↳ `due_time` | string | Due time \(HH:MM\) |
|
||||
| ↳ `duration` | string | Duration \(HH:MM\) |
|
||||
| ↳ `deal_id` | number | Associated deal ID |
|
||||
| ↳ `person_id` | number | Associated person ID |
|
||||
| ↳ `org_id` | number | Associated organization ID |
|
||||
| ↳ `done` | boolean | Whether the activity is done |
|
||||
| ↳ `note` | string | Activity note |
|
||||
| ↳ `add_time` | string | When the activity was created |
|
||||
| ↳ `update_time` | string | When the activity was last updated |
|
||||
| `total_items` | number | Total number of activities returned |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -354,7 +403,33 @@ Retrieve all leads or a specific lead from Pipedrive
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `leads` | array | Array of lead objects \(when listing all\) |
|
||||
| ↳ `id` | string | Lead ID \(UUID\) |
|
||||
| ↳ `title` | string | Lead title |
|
||||
| ↳ `person_id` | number | ID of the associated person |
|
||||
| ↳ `organization_id` | number | ID of the associated organization |
|
||||
| ↳ `owner_id` | number | ID of the lead owner |
|
||||
| ↳ `value` | object | Lead value |
|
||||
| ↳ `amount` | number | Value amount |
|
||||
| ↳ `currency` | string | Currency code \(e.g., USD, EUR\) |
|
||||
| ↳ `expected_close_date` | string | Expected close date \(YYYY-MM-DD\) |
|
||||
| ↳ `is_archived` | boolean | Whether the lead is archived |
|
||||
| ↳ `was_seen` | boolean | Whether the lead was seen |
|
||||
| ↳ `add_time` | string | When the lead was created \(ISO 8601\) |
|
||||
| ↳ `update_time` | string | When the lead was last updated \(ISO 8601\) |
|
||||
| `lead` | object | Single lead object \(when lead_id is provided\) |
|
||||
| ↳ `id` | string | Lead ID \(UUID\) |
|
||||
| ↳ `title` | string | Lead title |
|
||||
| ↳ `person_id` | number | ID of the associated person |
|
||||
| ↳ `organization_id` | number | ID of the associated organization |
|
||||
| ↳ `owner_id` | number | ID of the lead owner |
|
||||
| ↳ `value` | object | Lead value |
|
||||
| ↳ `amount` | number | Value amount |
|
||||
| ↳ `currency` | string | Currency code \(e.g., USD, EUR\) |
|
||||
| ↳ `expected_close_date` | string | Expected close date \(YYYY-MM-DD\) |
|
||||
| ↳ `is_archived` | boolean | Whether the lead is archived |
|
||||
| ↳ `was_seen` | boolean | Whether the lead was seen |
|
||||
| ↳ `add_time` | string | When the lead was created \(ISO 8601\) |
|
||||
| ↳ `update_time` | string | When the lead was last updated \(ISO 8601\) |
|
||||
| `total_items` | number | Total number of leads returned |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ By using these documented API endpoints, you can seamlessly integrate Polymarket
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Polymarket prediction markets into the workflow. Can get markets, market, events, event, tags, series, orderbook, price, midpoint, price history, last trade price, spread, tick size, positions, trades, and search.
|
||||
Integrate Polymarket prediction markets into the workflow. Can get markets, market, events, event, tags, series, orderbook, price, midpoint, price history, last trade price, spread, tick size, positions, trades, activity, leaderboard, holders, and search.
|
||||
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ Retrieve a list of prediction markets from Polymarket with optional filtering
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | No | Filter by closed status \(true/false\). Use false for active markets only. |
|
||||
| `closed` | string | No | Filter by closed status \(true/false\). Use false for open markets only. |
|
||||
| `order` | string | No | Sort field \(e.g., volumeNum, liquidityNum, startDate, endDate, createdAt\) |
|
||||
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
|
||||
| `tagId` | string | No | Filter by tag ID |
|
||||
@@ -55,6 +55,21 @@ Retrieve a list of prediction markets from Polymarket with optional filtering
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | Array of market objects |
|
||||
| ↳ `id` | string | Market ID |
|
||||
| ↳ `question` | string | Market question |
|
||||
| ↳ `conditionId` | string | Condition ID |
|
||||
| ↳ `slug` | string | Market slug |
|
||||
| ↳ `endDate` | string | End date |
|
||||
| ↳ `image` | string | Market image URL |
|
||||
| ↳ `outcomes` | string | Outcomes JSON string |
|
||||
| ↳ `outcomePrices` | string | Outcome prices JSON string |
|
||||
| ↳ `volume` | string | Total volume |
|
||||
| ↳ `liquidity` | string | Total liquidity |
|
||||
| ↳ `active` | boolean | Whether market is active |
|
||||
| ↳ `closed` | boolean | Whether market is closed |
|
||||
| ↳ `volumeNum` | number | Volume as number |
|
||||
| ↳ `liquidityNum` | number | Liquidity as number |
|
||||
| ↳ `clobTokenIds` | array | CLOB token IDs |
|
||||
|
||||
### `polymarket_get_market`
|
||||
|
||||
@@ -72,6 +87,28 @@ Retrieve details of a specific prediction market by ID or slug
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | Market object with details |
|
||||
| ↳ `id` | string | Market ID |
|
||||
| ↳ `question` | string | Market question |
|
||||
| ↳ `conditionId` | string | Condition ID |
|
||||
| ↳ `slug` | string | Market slug |
|
||||
| ↳ `resolutionSource` | string | Resolution source |
|
||||
| ↳ `endDate` | string | End date |
|
||||
| ↳ `startDate` | string | Start date |
|
||||
| ↳ `image` | string | Market image URL |
|
||||
| ↳ `icon` | string | Market icon URL |
|
||||
| ↳ `description` | string | Market description |
|
||||
| ↳ `outcomes` | string | Outcomes JSON string |
|
||||
| ↳ `outcomePrices` | string | Outcome prices JSON string |
|
||||
| ↳ `volume` | string | Total volume |
|
||||
| ↳ `liquidity` | string | Total liquidity |
|
||||
| ↳ `active` | boolean | Whether market is active |
|
||||
| ↳ `closed` | boolean | Whether market is closed |
|
||||
| ↳ `archived` | boolean | Whether market is archived |
|
||||
| ↳ `volumeNum` | number | Volume as number |
|
||||
| ↳ `liquidityNum` | number | Liquidity as number |
|
||||
| ↳ `clobTokenIds` | array | CLOB token IDs |
|
||||
| ↳ `acceptingOrders` | boolean | Whether accepting orders |
|
||||
| ↳ `negRisk` | boolean | Whether negative risk |
|
||||
|
||||
### `polymarket_get_events`
|
||||
|
||||
@@ -81,7 +118,7 @@ Retrieve a list of events from Polymarket with optional filtering
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | No | Filter by closed status \(true/false\). Use false for active events only. |
|
||||
| `closed` | string | No | Filter by closed status \(true/false\). Use false for open events only. |
|
||||
| `order` | string | No | Sort field \(e.g., volume, liquidity, startDate, endDate, createdAt\) |
|
||||
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
|
||||
| `tagId` | string | No | Filter by tag ID |
|
||||
@@ -93,6 +130,21 @@ Retrieve a list of events from Polymarket with optional filtering
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | Array of event objects |
|
||||
| ↳ `id` | string | Event ID |
|
||||
| ↳ `ticker` | string | Event ticker |
|
||||
| ↳ `slug` | string | Event slug |
|
||||
| ↳ `title` | string | Event title |
|
||||
| ↳ `description` | string | Event description |
|
||||
| ↳ `startDate` | string | Start date |
|
||||
| ↳ `endDate` | string | End date |
|
||||
| ↳ `image` | string | Event image URL |
|
||||
| ↳ `icon` | string | Event icon URL |
|
||||
| ↳ `active` | boolean | Whether event is active |
|
||||
| ↳ `closed` | boolean | Whether event is closed |
|
||||
| ↳ `archived` | boolean | Whether event is archived |
|
||||
| ↳ `liquidity` | number | Total liquidity |
|
||||
| ↳ `volume` | number | Total volume |
|
||||
| ↳ `markets` | array | Array of markets in this event |
|
||||
|
||||
### `polymarket_get_event`
|
||||
|
||||
@@ -110,6 +162,24 @@ Retrieve details of a specific event by ID or slug
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Event object with details |
|
||||
| ↳ `id` | string | Event ID |
|
||||
| ↳ `ticker` | string | Event ticker |
|
||||
| ↳ `slug` | string | Event slug |
|
||||
| ↳ `title` | string | Event title |
|
||||
| ↳ `description` | string | Event description |
|
||||
| ↳ `startDate` | string | Start date |
|
||||
| ↳ `creationDate` | string | Creation date |
|
||||
| ↳ `endDate` | string | End date |
|
||||
| ↳ `image` | string | Event image URL |
|
||||
| ↳ `icon` | string | Event icon URL |
|
||||
| ↳ `active` | boolean | Whether event is active |
|
||||
| ↳ `closed` | boolean | Whether event is closed |
|
||||
| ↳ `archived` | boolean | Whether event is archived |
|
||||
| ↳ `liquidity` | number | Total liquidity |
|
||||
| ↳ `volume` | number | Total volume |
|
||||
| ↳ `openInterest` | number | Open interest |
|
||||
| ↳ `commentCount` | number | Comment count |
|
||||
| ↳ `markets` | array | Array of markets in this event |
|
||||
|
||||
### `polymarket_get_tags`
|
||||
|
||||
@@ -126,7 +196,12 @@ Retrieve available tags for filtering markets from Polymarket
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tags` | array | Array of tag objects with id, label, and slug |
|
||||
| `tags` | array | Array of tag objects |
|
||||
| ↳ `id` | string | Tag ID |
|
||||
| ↳ `label` | string | Tag label |
|
||||
| ↳ `slug` | string | Tag slug |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
|
||||
### `polymarket_search`
|
||||
|
||||
@@ -138,13 +213,28 @@ Search for markets, events, and profiles on Polymarket
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Search query term |
|
||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
||||
| `offset` | string | No | Pagination offset |
|
||||
| `page` | string | No | Page number for pagination \(1-indexed\) |
|
||||
| `cache` | string | No | Enable caching \(true/false\) |
|
||||
| `eventsStatus` | string | No | Filter events by status |
|
||||
| `limitPerType` | string | No | Limit results per type \(markets, events, profiles\) |
|
||||
| `eventsTag` | string | No | Filter by event tags \(comma-separated\) |
|
||||
| `sort` | string | No | Sort field |
|
||||
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
|
||||
| `searchTags` | string | No | Include tags in search results \(true/false\) |
|
||||
| `searchProfiles` | string | No | Include profiles in search results \(true/false\) |
|
||||
| `recurrence` | string | No | Filter by recurrence type |
|
||||
| `excludeTagId` | string | No | Exclude events with these tag IDs \(comma-separated\) |
|
||||
| `keepClosedMarkets` | string | No | Include closed markets in results \(0 or 1\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | object | Search results containing markets, events, and profiles arrays |
|
||||
| `results` | object | Search results containing markets, events, tags, and profiles arrays |
|
||||
| ↳ `markets` | array | Array of matching market objects |
|
||||
| ↳ `events` | array | Array of matching event objects |
|
||||
| ↳ `tags` | array | Array of matching tag objects |
|
||||
| ↳ `profiles` | array | Array of matching profile objects |
|
||||
|
||||
### `polymarket_get_series`
|
||||
|
||||
@@ -162,6 +252,21 @@ Retrieve series (related market groups) from Polymarket
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | array | Array of series objects |
|
||||
| ↳ `id` | string | Series ID |
|
||||
| ↳ `ticker` | string | Series ticker |
|
||||
| ↳ `slug` | string | Series slug |
|
||||
| ↳ `title` | string | Series title |
|
||||
| ↳ `seriesType` | string | Series type |
|
||||
| ↳ `recurrence` | string | Recurrence pattern |
|
||||
| ↳ `image` | string | Series image URL |
|
||||
| ↳ `icon` | string | Series icon URL |
|
||||
| ↳ `active` | boolean | Whether series is active |
|
||||
| ↳ `closed` | boolean | Whether series is closed |
|
||||
| ↳ `archived` | boolean | Whether series is archived |
|
||||
| ↳ `featured` | boolean | Whether series is featured |
|
||||
| ↳ `volume` | number | Total volume |
|
||||
| ↳ `liquidity` | number | Total liquidity |
|
||||
| ↳ `eventCount` | number | Number of events in series |
|
||||
|
||||
### `polymarket_get_series_by_id`
|
||||
|
||||
@@ -178,6 +283,23 @@ Retrieve a specific series (related market group) by ID from Polymarket
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | object | Series object with details |
|
||||
| ↳ `id` | string | Series ID |
|
||||
| ↳ `ticker` | string | Series ticker |
|
||||
| ↳ `slug` | string | Series slug |
|
||||
| ↳ `title` | string | Series title |
|
||||
| ↳ `seriesType` | string | Series type |
|
||||
| ↳ `recurrence` | string | Recurrence pattern |
|
||||
| ↳ `image` | string | Series image URL |
|
||||
| ↳ `icon` | string | Series icon URL |
|
||||
| ↳ `active` | boolean | Whether series is active |
|
||||
| ↳ `closed` | boolean | Whether series is closed |
|
||||
| ↳ `archived` | boolean | Whether series is archived |
|
||||
| ↳ `featured` | boolean | Whether series is featured |
|
||||
| ↳ `volume` | number | Total volume |
|
||||
| ↳ `liquidity` | number | Total liquidity |
|
||||
| ↳ `commentCount` | number | Comment count |
|
||||
| ↳ `eventCount` | number | Number of events in series |
|
||||
| ↳ `events` | array | Array of events in this series |
|
||||
|
||||
### `polymarket_get_orderbook`
|
||||
|
||||
@@ -194,6 +316,19 @@ Retrieve the order book summary for a specific token
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orderbook` | object | Order book with bids and asks arrays |
|
||||
| ↳ `market` | string | Market identifier |
|
||||
| ↳ `asset_id` | string | Asset token ID |
|
||||
| ↳ `hash` | string | Order book hash |
|
||||
| ↳ `timestamp` | string | Timestamp |
|
||||
| ↳ `bids` | array | Bid orders |
|
||||
| ↳ `price` | string | Bid price |
|
||||
| ↳ `size` | string | Bid size |
|
||||
| ↳ `asks` | array | Ask orders |
|
||||
| ↳ `price` | string | Ask price |
|
||||
| ↳ `size` | string | Ask size |
|
||||
| ↳ `min_order_size` | string | Minimum order size |
|
||||
| ↳ `tick_size` | string | Tick size |
|
||||
| ↳ `neg_risk` | boolean | Whether negative risk |
|
||||
|
||||
### `polymarket_get_price`
|
||||
|
||||
@@ -246,7 +381,9 @@ Retrieve historical price data for a specific market token
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `history` | array | Array of price history entries with timestamp \(t\) and price \(p\) |
|
||||
| `history` | array | Array of price history entries |
|
||||
| ↳ `t` | number | Unix timestamp |
|
||||
| ↳ `p` | number | Price at timestamp |
|
||||
|
||||
### `polymarket_get_last_trade_price`
|
||||
|
||||
@@ -263,6 +400,7 @@ Retrieve the last trade price for a specific token
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `price` | string | Last trade price |
|
||||
| `side` | string | Side of the last trade \(BUY or SELL\) |
|
||||
|
||||
### `polymarket_get_spread`
|
||||
|
||||
@@ -278,7 +416,8 @@ Retrieve the bid-ask spread for a specific token
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `spread` | object | Bid-ask spread with bid and ask prices |
|
||||
| `spread` | object | Spread value between bid and ask |
|
||||
| ↳ `spread` | string | The spread value |
|
||||
|
||||
### `polymarket_get_tick_size`
|
||||
|
||||
@@ -305,13 +444,47 @@ Retrieve user positions from Polymarket
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | Yes | User wallet address |
|
||||
| `market` | string | No | Optional market ID to filter positions |
|
||||
| `market` | string | No | Condition IDs to filter positions \(comma-separated, mutually exclusive with eventId\) |
|
||||
| `eventId` | string | No | Event ID to filter positions \(mutually exclusive with market\) |
|
||||
| `sizeThreshold` | string | No | Minimum position size threshold \(default: 1\) |
|
||||
| `redeemable` | string | No | Filter for redeemable positions only \(true/false\) |
|
||||
| `mergeable` | string | No | Filter for mergeable positions only \(true/false\) |
|
||||
| `sortBy` | string | No | Sort field \(TOKENS, CURRENT, INITIAL, CASHPNL, PERCENTPNL, TITLE, RESOLVING, PRICE, AVGPRICE\) |
|
||||
| `sortDirection` | string | No | Sort direction \(ASC or DESC\) |
|
||||
| `title` | string | No | Search filter by title |
|
||||
| `limit` | string | No | Number of results per page |
|
||||
| `offset` | string | No | Pagination offset |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `positions` | array | Array of position objects |
|
||||
| ↳ `proxyWallet` | string | Proxy wallet address |
|
||||
| ↳ `asset` | string | Asset token ID |
|
||||
| ↳ `conditionId` | string | Condition ID |
|
||||
| ↳ `size` | number | Position size |
|
||||
| ↳ `avgPrice` | number | Average price |
|
||||
| ↳ `initialValue` | number | Initial value |
|
||||
| ↳ `currentValue` | number | Current value |
|
||||
| ↳ `cashPnl` | number | Cash profit/loss |
|
||||
| ↳ `percentPnl` | number | Percent profit/loss |
|
||||
| ↳ `totalBought` | number | Total bought |
|
||||
| ↳ `realizedPnl` | number | Realized profit/loss |
|
||||
| ↳ `percentRealizedPnl` | number | Percent realized profit/loss |
|
||||
| ↳ `curPrice` | number | Current price |
|
||||
| ↳ `redeemable` | boolean | Whether position is redeemable |
|
||||
| ↳ `mergeable` | boolean | Whether position is mergeable |
|
||||
| ↳ `title` | string | Market title |
|
||||
| ↳ `slug` | string | Market slug |
|
||||
| ↳ `icon` | string | Market icon URL |
|
||||
| ↳ `eventSlug` | string | Event slug |
|
||||
| ↳ `outcome` | string | Outcome name |
|
||||
| ↳ `outcomeIndex` | number | Outcome index |
|
||||
| ↳ `oppositeOutcome` | string | Opposite outcome name |
|
||||
| ↳ `oppositeAsset` | string | Opposite asset token ID |
|
||||
| ↳ `endDate` | string | End date |
|
||||
| ↳ `negativeRisk` | boolean | Whether negative risk |
|
||||
|
||||
### `polymarket_get_trades`
|
||||
|
||||
@@ -322,8 +495,13 @@ Retrieve trade history from Polymarket
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | No | User wallet address to filter trades |
|
||||
| `market` | string | No | Market ID to filter trades |
|
||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
||||
| `market` | string | No | Market/condition ID to filter trades \(mutually exclusive with eventId\) |
|
||||
| `eventId` | string | No | Event ID to filter trades \(mutually exclusive with market\) |
|
||||
| `side` | string | No | Trade direction filter \(BUY or SELL\) |
|
||||
| `takerOnly` | string | No | Filter for taker trades only \(true/false, default: true\) |
|
||||
| `filterType` | string | No | Filter type \(CASH or TOKENS\) - requires filterAmount |
|
||||
| `filterAmount` | string | No | Filter amount threshold - requires filterType |
|
||||
| `limit` | string | No | Number of results per page \(default: 100, max: 10000\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
@@ -331,5 +509,131 @@ Retrieve trade history from Polymarket
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | Array of trade objects |
|
||||
| ↳ `proxyWallet` | string | Proxy wallet address |
|
||||
| ↳ `side` | string | Trade side \(BUY or SELL\) |
|
||||
| ↳ `asset` | string | Asset token ID |
|
||||
| ↳ `conditionId` | string | Condition ID |
|
||||
| ↳ `size` | number | Trade size |
|
||||
| ↳ `price` | number | Trade price |
|
||||
| ↳ `timestamp` | number | Unix timestamp |
|
||||
| ↳ `title` | string | Market title |
|
||||
| ↳ `slug` | string | Market slug |
|
||||
| ↳ `icon` | string | Market icon URL |
|
||||
| ↳ `eventSlug` | string | Event slug |
|
||||
| ↳ `outcome` | string | Outcome name |
|
||||
| ↳ `outcomeIndex` | number | Outcome index |
|
||||
| ↳ `name` | string | Trader name |
|
||||
| ↳ `pseudonym` | string | Trader pseudonym |
|
||||
| ↳ `bio` | string | Trader bio |
|
||||
| ↳ `profileImage` | string | Profile image URL |
|
||||
| ↳ `profileImageOptimized` | string | Optimized profile image URL |
|
||||
| ↳ `transactionHash` | string | Transaction hash |
|
||||
|
||||
### `polymarket_get_activity`
|
||||
|
||||
Retrieve on-chain activity for a user including trades, splits, merges, redemptions, rewards, and conversions
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | Yes | User wallet address \(0x-prefixed\) |
|
||||
| `limit` | string | No | Maximum results \(default: 100, max: 500\) |
|
||||
| `offset` | string | No | Pagination offset \(default: 0, max: 10000\) |
|
||||
| `market` | string | No | Comma-separated condition IDs \(mutually exclusive with eventId\) |
|
||||
| `eventId` | string | No | Comma-separated event IDs \(mutually exclusive with market\) |
|
||||
| `type` | string | No | Activity type filter: TRADE, SPLIT, MERGE, REDEEM, REWARD, CONVERSION, MAKER_REBATE |
|
||||
| `start` | number | No | Start timestamp \(Unix seconds\) |
|
||||
| `end` | number | No | End timestamp \(Unix seconds\) |
|
||||
| `sortBy` | string | No | Sort field: TIMESTAMP, TOKENS, or CASH \(default: TIMESTAMP\) |
|
||||
| `sortDirection` | string | No | Sort direction: ASC or DESC \(default: DESC\) |
|
||||
| `side` | string | No | Trade side filter: BUY or SELL \(only applies to trades\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `activity` | array | Array of activity entries |
|
||||
| ↳ `proxyWallet` | string | User proxy wallet address |
|
||||
| ↳ `timestamp` | number | Unix timestamp of activity |
|
||||
| ↳ `conditionId` | string | Market condition ID |
|
||||
| ↳ `type` | string | Activity type \(TRADE, SPLIT, MERGE, REDEEM, REWARD, CONVERSION\) |
|
||||
| ↳ `size` | number | Size in tokens |
|
||||
| ↳ `usdcSize` | number | Size in USDC |
|
||||
| ↳ `transactionHash` | string | Blockchain transaction hash |
|
||||
| ↳ `price` | number | Price \(for trades\) |
|
||||
| ↳ `asset` | string | Asset/token ID |
|
||||
| ↳ `side` | string | Trade side \(BUY/SELL\) |
|
||||
| ↳ `outcomeIndex` | number | Outcome index |
|
||||
| ↳ `title` | string | Market title |
|
||||
| ↳ `slug` | string | Market slug |
|
||||
| ↳ `icon` | string | Market icon URL |
|
||||
| ↳ `eventSlug` | string | Event slug |
|
||||
| ↳ `outcome` | string | Outcome name |
|
||||
| ↳ `name` | string | User display name |
|
||||
| ↳ `pseudonym` | string | User pseudonym |
|
||||
| ↳ `bio` | string | User bio |
|
||||
| ↳ `profileImage` | string | User profile image URL |
|
||||
| ↳ `profileImageOptimized` | string | Optimized profile image URL |
|
||||
|
||||
### `polymarket_get_leaderboard`
|
||||
|
||||
Retrieve trader leaderboard rankings by profit/loss or volume
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `category` | string | No | Category filter: OVERALL, POLITICS, SPORTS, CRYPTO, CULTURE, MENTIONS, WEATHER, ECONOMICS, TECH, FINANCE \(default: OVERALL\) |
|
||||
| `timePeriod` | string | No | Time period: DAY, WEEK, MONTH, ALL \(default: DAY\) |
|
||||
| `orderBy` | string | No | Order by: PNL or VOL \(default: PNL\) |
|
||||
| `limit` | string | No | Number of results \(1-50, default: 25\) |
|
||||
| `offset` | string | No | Pagination offset \(0-1000, default: 0\) |
|
||||
| `user` | string | No | Filter by specific user wallet address |
|
||||
| `userName` | string | No | Filter by username |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `leaderboard` | array | Array of leaderboard entries |
|
||||
| ↳ `rank` | string | Leaderboard rank position |
|
||||
| ↳ `proxyWallet` | string | User proxy wallet address |
|
||||
| ↳ `userName` | string | User display name |
|
||||
| ↳ `vol` | number | Trading volume |
|
||||
| ↳ `pnl` | number | Profit and loss |
|
||||
| ↳ `profileImage` | string | User profile image URL |
|
||||
| ↳ `xUsername` | string | Twitter/X username |
|
||||
| ↳ `verifiedBadge` | boolean | Whether user has verified badge |
|
||||
|
||||
### `polymarket_get_holders`
|
||||
|
||||
Retrieve top holders of a specific market token
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `market` | string | Yes | Comma-separated list of condition IDs |
|
||||
| `limit` | string | No | Number of holders to return \(0-20, default: 20\) |
|
||||
| `minBalance` | string | No | Minimum balance threshold \(default: 1\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `holders` | array | Array of market holder groups by token |
|
||||
| ↳ `token` | string | Token/asset ID |
|
||||
| ↳ `holders` | array | Array of holders for this token |
|
||||
| ↳ `proxyWallet` | string | Holder wallet address |
|
||||
| ↳ `bio` | string | Holder bio |
|
||||
| ↳ `asset` | string | Asset ID |
|
||||
| ↳ `pseudonym` | string | Holder pseudonym |
|
||||
| ↳ `amount` | number | Amount held |
|
||||
| ↳ `displayUsernamePublic` | boolean | Whether username is publicly displayed |
|
||||
| ↳ `outcomeIndex` | number | Outcome index |
|
||||
| ↳ `name` | string | Holder display name |
|
||||
| ↳ `profileImage` | string | Profile image URL |
|
||||
| ↳ `profileImageOptimized` | string | Optimized profile image URL |
|
||||
|
||||
|
||||
|
||||
@@ -179,6 +179,27 @@ Introspect PostgreSQL database schema to retrieve table structures, columns, and
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `tables` | array | Array of table schemas with columns, keys, and indexes |
|
||||
| ↳ `name` | string | Table name |
|
||||
| ↳ `schema` | string | Schema name \(e.g., public\) |
|
||||
| ↳ `columns` | array | Table columns |
|
||||
| ↳ `name` | string | Column name |
|
||||
| ↳ `type` | string | Data type \(e.g., integer, varchar, timestamp\) |
|
||||
| ↳ `nullable` | boolean | Whether the column allows NULL values |
|
||||
| ↳ `default` | string | Default value expression |
|
||||
| ↳ `isPrimaryKey` | boolean | Whether the column is part of the primary key |
|
||||
| ↳ `isForeignKey` | boolean | Whether the column is a foreign key |
|
||||
| ↳ `references` | object | Foreign key reference information |
|
||||
| ↳ `table` | string | Referenced table name |
|
||||
| ↳ `column` | string | Referenced column name |
|
||||
| ↳ `primaryKey` | array | Primary key column names |
|
||||
| ↳ `foreignKeys` | array | Foreign key constraints |
|
||||
| ↳ `column` | string | Local column name |
|
||||
| ↳ `referencesTable` | string | Referenced table name |
|
||||
| ↳ `referencesColumn` | string | Referenced column name |
|
||||
| ↳ `indexes` | array | Table indexes |
|
||||
| ↳ `name` | string | Index name |
|
||||
| ↳ `columns` | array | Columns included in the index |
|
||||
| ↳ `unique` | boolean | Whether the index enforces uniqueness |
|
||||
| `schemas` | array | List of available schemas in the database |
|
||||
|
||||
|
||||
|
||||
@@ -56,8 +56,10 @@ Insert or update points in a Qdrant collection
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Status of the upsert operation |
|
||||
| `status` | string | Operation status \(ok, error\) |
|
||||
| `data` | object | Result data from the upsert operation |
|
||||
| ↳ `operation_id` | number | Operation ID for async tracking |
|
||||
| ↳ `status` | string | Operation status \(acknowledged, completed\) |
|
||||
|
||||
### `qdrant_search_vector`
|
||||
|
||||
@@ -81,8 +83,15 @@ Search for similar vectors in a Qdrant collection
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Operation status \(ok, error\) |
|
||||
| `data` | array | Vector search results with ID, score, payload, and optional vector data |
|
||||
| `status` | string | Status of the search operation |
|
||||
| ↳ `id` | string | Point ID \(integer or UUID string\) |
|
||||
| ↳ `version` | number | Point version number |
|
||||
| ↳ `score` | number | Similarity score |
|
||||
| ↳ `payload` | json | Point payload data \(key-value pairs\) |
|
||||
| ↳ `vector` | json | Point vector\(s\) - single array or named vectors object |
|
||||
| ↳ `shard_key` | string | Shard key for routing |
|
||||
| ↳ `order_value` | number | Order value for sorting |
|
||||
|
||||
### `qdrant_fetch_points`
|
||||
|
||||
@@ -104,7 +113,12 @@ Fetch points by ID from a Qdrant collection
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Operation status \(ok, error\) |
|
||||
| `data` | array | Fetched points with ID, payload, and optional vector data |
|
||||
| `status` | string | Status of the fetch operation |
|
||||
| ↳ `id` | string | Point ID \(integer or UUID string\) |
|
||||
| ↳ `payload` | json | Point payload data \(key-value pairs\) |
|
||||
| ↳ `vector` | json | Point vector\(s\) - single array or named vectors object |
|
||||
| ↳ `shard_key` | string | Shard key for routing |
|
||||
| ↳ `order_value` | number | Order value for sorting |
|
||||
|
||||
|
||||
|
||||
@@ -208,6 +208,10 @@ Submit a new post to a subreddit (text or link)
|
||||
| `success` | boolean | Whether the post was submitted successfully |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Post data including ID, name, URL, and permalink |
|
||||
| ↳ `id` | string | New post ID |
|
||||
| ↳ `name` | string | Thing fullname \(t3_xxxxx\) |
|
||||
| ↳ `url` | string | Post URL from API response |
|
||||
| ↳ `permalink` | string | Full Reddit permalink |
|
||||
|
||||
### `reddit_vote`
|
||||
|
||||
@@ -279,6 +283,10 @@ Add a comment reply to a Reddit post or comment
|
||||
| `success` | boolean | Whether the reply was posted successfully |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Comment data including ID, name, permalink, and body |
|
||||
| ↳ `id` | string | New comment ID |
|
||||
| ↳ `name` | string | Thing fullname \(t1_xxxxx\) |
|
||||
| ↳ `permalink` | string | Comment permalink |
|
||||
| ↳ `body` | string | Comment body text |
|
||||
|
||||
### `reddit_edit`
|
||||
|
||||
@@ -298,6 +306,9 @@ Edit the text of your own Reddit post or comment
|
||||
| `success` | boolean | Whether the edit was successful |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Updated content data |
|
||||
| ↳ `id` | string | Edited thing ID |
|
||||
| ↳ `body` | string | Updated comment body \(for comments\) |
|
||||
| ↳ `selftext` | string | Updated post text \(for self posts\) |
|
||||
|
||||
### `reddit_delete`
|
||||
|
||||
|
||||
@@ -53,19 +53,14 @@ Retrieve accounts from Salesforce CRM
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Accounts data |
|
||||
| ↳ `accounts` | array | Array of account objects |
|
||||
| ↳ `paging` | object | Pagination information |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of accounts returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `totalReturned` | number | Number of accounts returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||
| ↳ `accounts` | array | Array of account objects |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
|
||||
### `salesforce_create_account`
|
||||
@@ -98,9 +93,9 @@ Create a new account in Salesforce CRM
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Created account data |
|
||||
| ↳ `id` | string | Created account ID |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
| ↳ `created` | boolean | Whether account was created |
|
||||
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||
|
||||
### `salesforce_update_account`
|
||||
|
||||
@@ -133,8 +128,8 @@ Update an existing account in Salesforce CRM
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Updated account data |
|
||||
| ↳ `id` | string | Updated account ID |
|
||||
| ↳ `updated` | boolean | Whether account was updated |
|
||||
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||
|
||||
### `salesforce_delete_account`
|
||||
|
||||
@@ -154,8 +149,8 @@ Delete an account from Salesforce CRM
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Deleted account data |
|
||||
| ↳ `id` | string | Deleted account ID |
|
||||
| ↳ `deleted` | boolean | Whether account was deleted |
|
||||
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||
|
||||
### `salesforce_get_contacts`
|
||||
|
||||
@@ -178,20 +173,15 @@ Get contact(s) from Salesforce - single contact if ID provided, or list if not
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Contact\(s\) data |
|
||||
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||
| ↳ `contacts` | array | Array of contacts \(list query\) |
|
||||
| ↳ `contact` | object | Single contact \(by ID\) |
|
||||
| ↳ `paging` | object | Pagination information |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of contacts returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `totalReturned` | number | Number of contacts returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `singleContact` | boolean | Whether single contact was returned |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
|
||||
@@ -225,9 +215,9 @@ Create a new contact in Salesforce CRM
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Created contact data |
|
||||
| ↳ `id` | string | Created contact ID |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
| ↳ `created` | boolean | Whether contact was created |
|
||||
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||
|
||||
### `salesforce_update_contact`
|
||||
|
||||
@@ -260,8 +250,8 @@ Update an existing contact in Salesforce CRM
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Updated contact data |
|
||||
| ↳ `id` | string | Updated contact ID |
|
||||
| ↳ `updated` | boolean | Whether contact was updated |
|
||||
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||
|
||||
### `salesforce_delete_contact`
|
||||
|
||||
@@ -281,8 +271,8 @@ Delete a contact from Salesforce CRM
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Deleted contact data |
|
||||
| ↳ `id` | string | Deleted contact ID |
|
||||
| ↳ `deleted` | boolean | Whether contact was deleted |
|
||||
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||
|
||||
### `salesforce_get_leads`
|
||||
|
||||
@@ -305,20 +295,15 @@ Get lead(s) from Salesforce
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Lead data |
|
||||
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||
| ↳ `lead` | object | Single lead object \(when leadId provided\) |
|
||||
| ↳ `leads` | array | Array of lead objects \(when listing\) |
|
||||
| ↳ `paging` | object | Pagination information |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of leads returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `totalReturned` | number | Number of leads returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `singleLead` | boolean | Whether single lead was returned |
|
||||
| ↳ `success` | boolean | Operation success status |
|
||||
|
||||
@@ -348,9 +333,9 @@ Create a new lead
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Created lead data |
|
||||
| ↳ `id` | string | Created lead ID |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
| ↳ `created` | boolean | Whether lead was created |
|
||||
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||
|
||||
### `salesforce_update_lead`
|
||||
|
||||
@@ -379,8 +364,8 @@ Update an existing lead
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Updated lead data |
|
||||
| ↳ `id` | string | Updated lead ID |
|
||||
| ↳ `updated` | boolean | Whether lead was updated |
|
||||
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||
|
||||
### `salesforce_delete_lead`
|
||||
|
||||
@@ -400,8 +385,8 @@ Delete a lead
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Deleted lead data |
|
||||
| ↳ `id` | string | Deleted lead ID |
|
||||
| ↳ `deleted` | boolean | Whether lead was deleted |
|
||||
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||
|
||||
### `salesforce_get_opportunities`
|
||||
|
||||
@@ -424,20 +409,15 @@ Get opportunity(ies) from Salesforce
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Opportunity data |
|
||||
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||
| ↳ `opportunity` | object | Single opportunity object \(when opportunityId provided\) |
|
||||
| ↳ `opportunities` | array | Array of opportunity objects \(when listing\) |
|
||||
| ↳ `paging` | object | Pagination information |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of opportunities returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `totalReturned` | number | Number of opportunities returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `success` | boolean | Operation success status |
|
||||
|
||||
### `salesforce_create_opportunity`
|
||||
@@ -464,9 +444,9 @@ Create a new opportunity
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Created opportunity data |
|
||||
| ↳ `id` | string | Created opportunity ID |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
| ↳ `created` | boolean | Whether opportunity was created |
|
||||
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||
|
||||
### `salesforce_update_opportunity`
|
||||
|
||||
@@ -493,8 +473,8 @@ Update an existing opportunity
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Updated opportunity data |
|
||||
| ↳ `id` | string | Updated opportunity ID |
|
||||
| ↳ `updated` | boolean | Whether opportunity was updated |
|
||||
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||
|
||||
### `salesforce_delete_opportunity`
|
||||
|
||||
@@ -514,8 +494,8 @@ Delete an opportunity
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Deleted opportunity data |
|
||||
| ↳ `id` | string | Deleted opportunity ID |
|
||||
| ↳ `deleted` | boolean | Whether opportunity was deleted |
|
||||
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||
|
||||
### `salesforce_get_cases`
|
||||
|
||||
@@ -538,20 +518,15 @@ Get case(s) from Salesforce
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Case data |
|
||||
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||
| ↳ `case` | object | Single case object \(when caseId provided\) |
|
||||
| ↳ `cases` | array | Array of case objects \(when listing\) |
|
||||
| ↳ `paging` | object | Pagination information |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of cases returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `totalReturned` | number | Number of cases returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `success` | boolean | Operation success status |
|
||||
|
||||
### `salesforce_create_case`
|
||||
@@ -578,9 +553,9 @@ Create a new case
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Created case data |
|
||||
| ↳ `id` | string | Created case ID |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
| ↳ `created` | boolean | Whether case was created |
|
||||
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||
|
||||
### `salesforce_update_case`
|
||||
|
||||
@@ -604,8 +579,8 @@ Update an existing case
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Updated case data |
|
||||
| ↳ `id` | string | Updated case ID |
|
||||
| ↳ `updated` | boolean | Whether case was updated |
|
||||
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||
|
||||
### `salesforce_delete_case`
|
||||
|
||||
@@ -625,8 +600,8 @@ Delete a case
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Deleted case data |
|
||||
| ↳ `id` | string | Deleted case ID |
|
||||
| ↳ `deleted` | boolean | Whether case was deleted |
|
||||
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||
|
||||
### `salesforce_get_tasks`
|
||||
|
||||
@@ -649,20 +624,15 @@ Get task(s) from Salesforce
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Task data |
|
||||
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||
| ↳ `task` | object | Single task object \(when taskId provided\) |
|
||||
| ↳ `tasks` | array | Array of task objects \(when listing\) |
|
||||
| ↳ `paging` | object | Pagination information |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
||||
| ↳ `totalSize` | number | Total number of records |
|
||||
| ↳ `done` | boolean | Whether all records returned |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of tasks returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `totalReturned` | number | Number of tasks returned |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `success` | boolean | Operation success status |
|
||||
|
||||
### `salesforce_create_task`
|
||||
@@ -689,9 +659,9 @@ Create a new task
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Created task data |
|
||||
| ↳ `id` | string | Created task ID |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
| ↳ `created` | boolean | Whether task was created |
|
||||
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||
|
||||
### `salesforce_update_task`
|
||||
|
||||
@@ -716,8 +686,8 @@ Update an existing task
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Updated task data |
|
||||
| ↳ `id` | string | Updated task ID |
|
||||
| ↳ `updated` | boolean | Whether task was updated |
|
||||
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||
|
||||
### `salesforce_delete_task`
|
||||
|
||||
@@ -737,8 +707,8 @@ Delete a task
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Deleted task data |
|
||||
| ↳ `id` | string | Deleted task ID |
|
||||
| ↳ `deleted` | boolean | Whether task was deleted |
|
||||
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||
|
||||
### `salesforce_list_reports`
|
||||
|
||||
@@ -759,9 +729,9 @@ Get a list of reports accessible by the current user
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Reports data |
|
||||
| ↳ `reports` | array | Array of report objects |
|
||||
| ↳ `totalReturned` | number | Number of reports returned |
|
||||
| ↳ `totalReturned` | number | Number of items returned |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
| ↳ `reports` | array | Array of report objects |
|
||||
|
||||
### `salesforce_get_report`
|
||||
|
||||
@@ -806,15 +776,15 @@ Execute a report and retrieve the results
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Report results |
|
||||
| ↳ `reportId` | string | Report ID |
|
||||
| ↳ `reportMetadata` | object | Report metadata |
|
||||
| ↳ `reportExtendedMetadata` | object | Extended metadata |
|
||||
| ↳ `factMap` | object | Report data organized by groupings |
|
||||
| ↳ `groupingsDown` | object | Row groupings |
|
||||
| ↳ `groupingsAcross` | object | Column groupings |
|
||||
| ↳ `hasDetailRows` | boolean | Whether report has detail rows |
|
||||
| ↳ `allData` | boolean | Whether all data is returned |
|
||||
| ↳ `reportName` | string | Report name |
|
||||
| ↳ `reportFormat` | string | Report format type |
|
||||
| ↳ `reportMetadata` | object | Report metadata including name, format, and filter definitions |
|
||||
| ↳ `reportExtendedMetadata` | object | Extended metadata for aggregate columns and groupings |
|
||||
| ↳ `factMap` | object | Report data organized by groupings with aggregates and row data |
|
||||
| ↳ `groupingsDown` | object | Row grouping hierarchy and values |
|
||||
| ↳ `groupingsAcross` | object | Column grouping hierarchy and values |
|
||||
| ↳ `hasDetailRows` | boolean | Whether the report includes detail-level row data |
|
||||
| ↳ `allData` | boolean | Whether all data is returned \(false if truncated due to size limits\) |
|
||||
| ↳ `reportName` | string | Display name of the report |
|
||||
| ↳ `reportFormat` | string | Report format type \(TABULAR, SUMMARY, MATRIX, JOINED\) |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
|
||||
### `salesforce_list_report_types`
|
||||
@@ -834,9 +804,9 @@ Get a list of available report types
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Report types data |
|
||||
| ↳ `reportTypes` | array | Array of report type objects |
|
||||
| ↳ `totalReturned` | number | Number of report types returned |
|
||||
| ↳ `totalReturned` | number | Number of items returned |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
| ↳ `reportTypes` | array | Array of report type objects |
|
||||
|
||||
### `salesforce_list_dashboards`
|
||||
|
||||
@@ -856,9 +826,9 @@ Get a list of dashboards accessible by the current user
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Dashboards data |
|
||||
| ↳ `dashboards` | array | Array of dashboard objects |
|
||||
| ↳ `totalReturned` | number | Number of dashboards returned |
|
||||
| ↳ `totalReturned` | number | Number of items returned |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
| ↳ `dashboards` | array | Array of dashboard objects |
|
||||
|
||||
### `salesforce_get_dashboard`
|
||||
|
||||
@@ -878,12 +848,12 @@ Get details and results for a specific dashboard
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Dashboard data |
|
||||
| ↳ `dashboard` | object | Dashboard details |
|
||||
| ↳ `dashboard` | object | Full dashboard details object |
|
||||
| ↳ `dashboardId` | string | Dashboard ID |
|
||||
| ↳ `components` | array | Dashboard component data |
|
||||
| ↳ `dashboardName` | string | Dashboard name |
|
||||
| ↳ `folderId` | string | Folder ID containing the dashboard |
|
||||
| ↳ `runningUser` | object | Running user information |
|
||||
| ↳ `components` | array | Array of dashboard component data with visualizations and filters |
|
||||
| ↳ `dashboardName` | string | Display name of the dashboard |
|
||||
| ↳ `folderId` | string | ID of the folder containing the dashboard |
|
||||
| ↳ `runningUser` | object | User context under which the dashboard data was retrieved |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
|
||||
### `salesforce_refresh_dashboard`
|
||||
@@ -904,12 +874,12 @@ Refresh a dashboard to get the latest data
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Refreshed dashboard data |
|
||||
| ↳ `dashboard` | object | Dashboard details |
|
||||
| ↳ `dashboard` | object | Full dashboard details object |
|
||||
| ↳ `dashboardId` | string | Dashboard ID |
|
||||
| ↳ `components` | array | Dashboard component data |
|
||||
| ↳ `status` | object | Dashboard status |
|
||||
| ↳ `dashboardName` | string | Dashboard name |
|
||||
| ↳ `refreshDate` | string | Date when dashboard was refreshed |
|
||||
| ↳ `components` | array | Array of dashboard component data with fresh visualizations |
|
||||
| ↳ `status` | object | Dashboard refresh status information |
|
||||
| ↳ `dashboardName` | string | Display name of the dashboard |
|
||||
| ↳ `refreshDate` | string | ISO 8601 timestamp when the dashboard was last refreshed |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
|
||||
### `salesforce_query`
|
||||
@@ -930,16 +900,11 @@ Execute a custom SOQL query to retrieve data from Salesforce
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Query results |
|
||||
| ↳ `records` | array | Array of record objects |
|
||||
| ↳ `totalSize` | number | Total number of records matching query |
|
||||
| ↳ `done` | boolean | Whether all records have been returned |
|
||||
| ↳ `nextRecordsUrl` | string | URL to fetch next batch of records |
|
||||
| ↳ `records` | array | Array of sObject records matching the query |
|
||||
| ↳ `query` | string | The executed SOQL query |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
|
||||
### `salesforce_query_more`
|
||||
@@ -960,15 +925,10 @@ Retrieve additional query results using the nextRecordsUrl from a previous query
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Query results |
|
||||
| ↳ `records` | array | Array of record objects |
|
||||
| ↳ `totalSize` | number | Total number of records matching query |
|
||||
| ↳ `done` | boolean | Whether all records have been returned |
|
||||
| ↳ `nextRecordsUrl` | string | URL to fetch next batch of records |
|
||||
| ↳ `records` | array | Array of sObject records matching the query |
|
||||
| ↳ `metadata` | object | Response metadata |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
||||
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
|
||||
### `salesforce_describe_object`
|
||||
@@ -989,18 +949,41 @@ Get metadata and field information for a Salesforce object
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Object metadata |
|
||||
| ↳ `objectName` | string | API name of the object |
|
||||
| ↳ `label` | string | Display label |
|
||||
| ↳ `labelPlural` | string | Plural display label |
|
||||
| ↳ `fields` | array | Array of field definitions |
|
||||
| ↳ `keyPrefix` | string | ID prefix for this object type |
|
||||
| ↳ `queryable` | boolean | Whether object can be queried |
|
||||
| ↳ `createable` | boolean | Whether records can be created |
|
||||
| ↳ `updateable` | boolean | Whether records can be updated |
|
||||
| ↳ `deletable` | boolean | Whether records can be deleted |
|
||||
| ↳ `childRelationships` | array | Child relationship definitions |
|
||||
| ↳ `recordTypeInfos` | array | Record type information |
|
||||
| ↳ `fieldCount` | number | Number of fields in the object |
|
||||
| ↳ `objectName` | string | API name of the object \(e.g., Account, Contact\) |
|
||||
| ↳ `label` | string | Human-readable singular label for the object |
|
||||
| ↳ `labelPlural` | string | Human-readable plural label for the object |
|
||||
| ↳ `fields` | array | Array of field metadata objects |
|
||||
| ↳ `name` | string | API name of the field |
|
||||
| ↳ `label` | string | Display label of the field |
|
||||
| ↳ `type` | string | Field data type \(string, boolean, int, double, date, etc.\) |
|
||||
| ↳ `length` | number | Maximum length for text fields |
|
||||
| ↳ `precision` | number | Precision for numeric fields |
|
||||
| ↳ `scale` | number | Scale for numeric fields |
|
||||
| ↳ `nillable` | boolean | Whether the field can be null |
|
||||
| ↳ `unique` | boolean | Whether values must be unique |
|
||||
| ↳ `createable` | boolean | Whether field can be set on create |
|
||||
| ↳ `updateable` | boolean | Whether field can be updated |
|
||||
| ↳ `defaultedOnCreate` | boolean | Whether field has default value on create |
|
||||
| ↳ `calculated` | boolean | Whether field is a formula field |
|
||||
| ↳ `autoNumber` | boolean | Whether field is auto-number |
|
||||
| ↳ `externalId` | boolean | Whether field is an external ID |
|
||||
| ↳ `idLookup` | boolean | Whether field can be used in ID lookup |
|
||||
| ↳ `inlineHelpText` | string | Help text for the field |
|
||||
| ↳ `picklistValues` | array | Available picklist values for picklist fields |
|
||||
| ↳ `referenceTo` | array | Objects this field can reference \(for lookup fields\) |
|
||||
| ↳ `relationshipName` | string | Relationship name for lookup fields |
|
||||
| ↳ `custom` | boolean | Whether this is a custom field |
|
||||
| ↳ `filterable` | boolean | Whether field can be used in SOQL filter |
|
||||
| ↳ `groupable` | boolean | Whether field can be used in GROUP BY |
|
||||
| ↳ `sortable` | boolean | Whether field can be used in ORDER BY |
|
||||
| ↳ `keyPrefix` | string | Three-character prefix used in record IDs \(e.g., "001" for Account\) |
|
||||
| ↳ `queryable` | boolean | Whether the object can be queried via SOQL |
|
||||
| ↳ `createable` | boolean | Whether records can be created for this object |
|
||||
| ↳ `updateable` | boolean | Whether records can be updated for this object |
|
||||
| ↳ `deletable` | boolean | Whether records can be deleted for this object |
|
||||
| ↳ `childRelationships` | array | Array of child relationship metadata for related objects |
|
||||
| ↳ `recordTypeInfos` | array | Array of record type information for the object |
|
||||
| ↳ `fieldCount` | number | Total number of fields on the object |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
|
||||
### `salesforce_list_objects`
|
||||
@@ -1020,9 +1003,25 @@ Get a list of all available Salesforce objects
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Objects list |
|
||||
| ↳ `objects` | array | Array of available Salesforce objects |
|
||||
| ↳ `encoding` | string | Encoding used |
|
||||
| ↳ `maxBatchSize` | number | Maximum batch size |
|
||||
| ↳ `objects` | array | Array of sObject metadata |
|
||||
| ↳ `name` | string | API name of the object |
|
||||
| ↳ `label` | string | Display label of the object |
|
||||
| ↳ `labelPlural` | string | Plural display label |
|
||||
| ↳ `keyPrefix` | string | Three-character ID prefix |
|
||||
| ↳ `custom` | boolean | Whether this is a custom object |
|
||||
| ↳ `queryable` | boolean | Whether object can be queried |
|
||||
| ↳ `createable` | boolean | Whether records can be created |
|
||||
| ↳ `updateable` | boolean | Whether records can be updated |
|
||||
| ↳ `deletable` | boolean | Whether records can be deleted |
|
||||
| ↳ `searchable` | boolean | Whether object is searchable |
|
||||
| ↳ `triggerable` | boolean | Whether triggers are supported |
|
||||
| ↳ `layoutable` | boolean | Whether page layouts are supported |
|
||||
| ↳ `replicateable` | boolean | Whether object can be replicated |
|
||||
| ↳ `retrieveable` | boolean | Whether records can be retrieved |
|
||||
| ↳ `undeletable` | boolean | Whether records can be undeleted |
|
||||
| ↳ `urls` | object | URLs for accessing object resources |
|
||||
| ↳ `encoding` | string | Character encoding for the organization \(e.g., UTF-8\) |
|
||||
| ↳ `maxBatchSize` | number | Maximum number of records that can be returned in a single query batch \(typically 200\) |
|
||||
| ↳ `totalReturned` | number | Number of objects returned |
|
||||
| ↳ `success` | boolean | Salesforce operation success |
|
||||
|
||||
|
||||
@@ -68,7 +68,7 @@ List issues from Sentry for a specific organization and optionally a specific pr
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issues` | array | List of Sentry issues |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | Unique issue ID |
|
||||
| ↳ `shortId` | string | Short issue identifier |
|
||||
| ↳ `title` | string | Issue title |
|
||||
| ↳ `culprit` | string | Function or location that caused the issue |
|
||||
@@ -78,27 +78,22 @@ List issues from Sentry for a specific organization and optionally a specific pr
|
||||
| ↳ `status` | string | Current issue status |
|
||||
| ↳ `statusDetails` | object | Additional details about the status |
|
||||
| ↳ `isPublic` | boolean | Whether the issue is publicly visible |
|
||||
| ↳ `platform` | string | Project platform |
|
||||
| ↳ `platform` | string | Platform where the issue occurred |
|
||||
| ↳ `project` | object | Project information |
|
||||
| ↳ `id` | string | Project ID |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `slug` | string | Project slug |
|
||||
| ↳ `platform` | string | Project platform |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `slug` | string | Project slug |
|
||||
| ↳ `type` | string | Type of error \(e.g., TypeError\) |
|
||||
| ↳ `type` | string | Issue type |
|
||||
| ↳ `metadata` | object | Error metadata |
|
||||
| ↳ `type` | string | Type of error \(e.g., TypeError\) |
|
||||
| ↳ `value` | string | Error message or value |
|
||||
| ↳ `function` | string | Function where the error occurred |
|
||||
| ↳ `value` | string | Error message or value |
|
||||
| ↳ `function` | string | Function where the error occurred |
|
||||
| ↳ `numComments` | number | Number of comments on the issue |
|
||||
| ↳ `assignedTo` | object | User assigned to the issue |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
|
||||
| ↳ `isSubscribed` | boolean | Whether subscribed to updates |
|
||||
| ↳ `hasSeen` | boolean | Whether the user has seen this issue |
|
||||
@@ -130,7 +125,7 @@ Retrieve detailed information about a specific Sentry issue by its ID. Returns c
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | Detailed information about the Sentry issue |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | Unique issue ID |
|
||||
| ↳ `shortId` | string | Short issue identifier |
|
||||
| ↳ `title` | string | Issue title |
|
||||
| ↳ `culprit` | string | Function or location that caused the issue |
|
||||
@@ -140,27 +135,22 @@ Retrieve detailed information about a specific Sentry issue by its ID. Returns c
|
||||
| ↳ `status` | string | Current issue status |
|
||||
| ↳ `statusDetails` | object | Additional details about the status |
|
||||
| ↳ `isPublic` | boolean | Whether the issue is publicly visible |
|
||||
| ↳ `platform` | string | Project platform |
|
||||
| ↳ `platform` | string | Platform where the issue occurred |
|
||||
| ↳ `project` | object | Project information |
|
||||
| ↳ `id` | string | Project ID |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `slug` | string | Project slug |
|
||||
| ↳ `platform` | string | Project platform |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `slug` | string | Project slug |
|
||||
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
|
||||
| ↳ `type` | string | Issue type |
|
||||
| ↳ `metadata` | object | Error metadata |
|
||||
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
|
||||
| ↳ `value` | string | Error message or value |
|
||||
| ↳ `function` | string | Function where the error occurred |
|
||||
| ↳ `value` | string | Error message or value |
|
||||
| ↳ `function` | string | Function where the error occurred |
|
||||
| ↳ `numComments` | number | Number of comments on the issue |
|
||||
| ↳ `assignedTo` | object | User assigned to the issue \(if any\) |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
|
||||
| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates |
|
||||
| ↳ `hasSeen` | boolean | Whether the user has seen this issue |
|
||||
@@ -194,7 +184,7 @@ Update a Sentry issue by changing its status, assignment, bookmark state, or oth
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | The updated Sentry issue |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | Unique issue ID |
|
||||
| ↳ `shortId` | string | Short issue identifier |
|
||||
| ↳ `title` | string | Issue title |
|
||||
| ↳ `status` | string | Updated issue status |
|
||||
@@ -202,8 +192,6 @@ Update a Sentry issue by changing its status, assignment, bookmark state, or oth
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
|
||||
| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates |
|
||||
| ↳ `isPublic` | boolean | Whether the issue is publicly visible |
|
||||
@@ -227,9 +215,9 @@ List all projects in a Sentry organization. Returns project details including na
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `projects` | array | List of Sentry projects |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `slug` | string | Team slug |
|
||||
| ↳ `name` | string | Team name |
|
||||
| ↳ `id` | string | Unique project ID |
|
||||
| ↳ `slug` | string | URL-friendly project identifier |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `platform` | string | Platform/language \(e.g., javascript, python\) |
|
||||
| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) |
|
||||
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
|
||||
@@ -266,9 +254,9 @@ Retrieve detailed information about a specific Sentry project by its slug. Retur
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `project` | object | Detailed information about the Sentry project |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `slug` | string | Team slug |
|
||||
| ↳ `name` | string | Team name |
|
||||
| ↳ `id` | string | Unique project ID |
|
||||
| ↳ `slug` | string | URL-friendly project identifier |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `platform` | string | Platform/language \(e.g., javascript, python\) |
|
||||
| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) |
|
||||
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
|
||||
@@ -321,9 +309,9 @@ Create a new Sentry project in an organization. Requires a team to associate the
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `project` | object | The newly created Sentry project |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `slug` | string | Team slug |
|
||||
| ↳ `name` | string | Team name |
|
||||
| ↳ `id` | string | Unique project ID |
|
||||
| ↳ `slug` | string | URL-friendly project identifier |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `platform` | string | Platform/language |
|
||||
| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) |
|
||||
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
|
||||
@@ -370,9 +358,9 @@ Update a Sentry project by changing its name, slug, platform, or other settings.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `project` | object | The updated Sentry project |
|
||||
| ↳ `id` | string | Team ID |
|
||||
| ↳ `slug` | string | Team slug |
|
||||
| ↳ `name` | string | Team name |
|
||||
| ↳ `id` | string | Unique project ID |
|
||||
| ↳ `slug` | string | URL-friendly project identifier |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `platform` | string | Platform/language |
|
||||
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
|
||||
| ↳ `organization` | object | Organization information |
|
||||
@@ -406,7 +394,7 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | List of Sentry events |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | Unique event ID |
|
||||
| ↳ `eventID` | string | Event identifier |
|
||||
| ↳ `projectID` | string | Project ID |
|
||||
| ↳ `groupID` | string | Issue group ID |
|
||||
@@ -422,23 +410,16 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p
|
||||
| ↳ `username` | string | Username |
|
||||
| ↳ `ipAddress` | string | IP address |
|
||||
| ↳ `name` | string | User display name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `username` | string | Username |
|
||||
| ↳ `ipAddress` | string | IP address |
|
||||
| ↳ `name` | string | SDK name |
|
||||
| ↳ `tags` | array | Tags associated with the event |
|
||||
| ↳ `key` | string | Tag key |
|
||||
| ↳ `value` | string | Tag value |
|
||||
| ↳ `key` | string | Tag key |
|
||||
| ↳ `value` | string | Error message or value |
|
||||
| ↳ `contexts` | object | Additional context data \(device, OS, etc.\) |
|
||||
| ↳ `platform` | string | Platform where the event occurred |
|
||||
| ↳ `type` | string | Type of error \(e.g., TypeError\) |
|
||||
| ↳ `type` | string | Event type |
|
||||
| ↳ `metadata` | object | Error metadata |
|
||||
| ↳ `type` | string | Type of error \(e.g., TypeError\) |
|
||||
| ↳ `value` | string | Error message or value |
|
||||
| ↳ `function` | string | Function where the error occurred |
|
||||
| ↳ `function` | string | Function where the error occurred |
|
||||
| ↳ `entries` | array | Event entries \(exception, breadcrumbs, etc.\) |
|
||||
| ↳ `errors` | array | Processing errors |
|
||||
| ↳ `dist` | string | Distribution identifier |
|
||||
@@ -446,7 +427,6 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p
|
||||
| ↳ `sdk` | object | SDK information |
|
||||
| ↳ `name` | string | SDK name |
|
||||
| ↳ `version` | string | SDK version |
|
||||
| ↳ `version` | string | SDK version |
|
||||
| `metadata` | object | Pagination metadata |
|
||||
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
|
||||
| ↳ `hasMore` | boolean | Whether there are more results available |
|
||||
@@ -469,7 +449,7 @@ Retrieve detailed information about a specific Sentry event by its ID. Returns c
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Detailed information about the Sentry event |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | Unique event ID |
|
||||
| ↳ `eventID` | string | Event identifier |
|
||||
| ↳ `projectID` | string | Project ID |
|
||||
| ↳ `groupID` | string | Issue group ID this event belongs to |
|
||||
@@ -485,23 +465,16 @@ Retrieve detailed information about a specific Sentry event by its ID. Returns c
|
||||
| ↳ `username` | string | Username |
|
||||
| ↳ `ipAddress` | string | IP address |
|
||||
| ↳ `name` | string | User display name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `username` | string | Username |
|
||||
| ↳ `ipAddress` | string | IP address |
|
||||
| ↳ `name` | string | SDK name |
|
||||
| ↳ `tags` | array | Tags associated with the event |
|
||||
| ↳ `key` | string | Tag key |
|
||||
| ↳ `value` | string | Tag value |
|
||||
| ↳ `key` | string | Tag key |
|
||||
| ↳ `value` | string | Error message or value |
|
||||
| ↳ `contexts` | object | Additional context data \(device, OS, browser, etc.\) |
|
||||
| ↳ `platform` | string | Platform where the event occurred |
|
||||
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
|
||||
| ↳ `type` | string | Event type \(error, transaction, etc.\) |
|
||||
| ↳ `metadata` | object | Error metadata |
|
||||
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
|
||||
| ↳ `value` | string | Error message or value |
|
||||
| ↳ `function` | string | Function where the error occurred |
|
||||
| ↳ `function` | string | Function where the error occurred |
|
||||
| ↳ `entries` | array | Event entries including exception, breadcrumbs, and request data |
|
||||
| ↳ `errors` | array | Processing errors that occurred |
|
||||
| ↳ `dist` | string | Distribution identifier |
|
||||
@@ -509,7 +482,6 @@ Retrieve detailed information about a specific Sentry event by its ID. Returns c
|
||||
| ↳ `sdk` | object | SDK information |
|
||||
| ↳ `name` | string | SDK name |
|
||||
| ↳ `version` | string | SDK version |
|
||||
| ↳ `version` | string | SDK version |
|
||||
|
||||
### `sentry_releases_list`
|
||||
|
||||
@@ -531,36 +503,30 @@ List releases for a Sentry organization or project. Returns release details incl
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `releases` | array | List of Sentry releases |
|
||||
| ↳ `id` | string | Project ID |
|
||||
| ↳ `version` | object | Version details |
|
||||
| ↳ `raw` | string | Raw version string |
|
||||
| ↳ `id` | string | Unique release ID |
|
||||
| ↳ `version` | string | Release version identifier |
|
||||
| ↳ `shortVersion` | string | Shortened version identifier |
|
||||
| ↳ `ref` | string | Git reference \(commit SHA, tag, or branch\) |
|
||||
| ↳ `url` | string | URL to the release \(e.g., GitHub release page\) |
|
||||
| ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) |
|
||||
| ↳ `dateCreated` | string | Commit timestamp |
|
||||
| ↳ `dateStarted` | string | Deploy start timestamp |
|
||||
| ↳ `dateCreated` | string | When the release was created \(ISO timestamp\) |
|
||||
| ↳ `dateStarted` | string | When the release started \(ISO timestamp\) |
|
||||
| ↳ `newGroups` | number | Number of new issues introduced in this release |
|
||||
| ↳ `owner` | object | Owner of the release |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `email` | string | Author email |
|
||||
| ↳ `commitCount` | number | Number of commits in this release |
|
||||
| ↳ `deployCount` | number | Number of deploys for this release |
|
||||
| ↳ `lastCommit` | object | Last commit in the release |
|
||||
| ↳ `id` | string | Commit SHA |
|
||||
| ↳ `message` | string | Commit message |
|
||||
| ↳ `dateCreated` | string | Commit timestamp |
|
||||
| ↳ `message` | string | Commit message |
|
||||
| ↳ `lastDeploy` | object | Last deploy of the release |
|
||||
| ↳ `id` | string | Deploy ID |
|
||||
| ↳ `environment` | string | Deploy environment |
|
||||
| ↳ `dateStarted` | string | Deploy start timestamp |
|
||||
| ↳ `dateFinished` | string | Deploy finish timestamp |
|
||||
| ↳ `environment` | string | Deploy environment |
|
||||
| ↳ `dateFinished` | string | Deploy finish timestamp |
|
||||
| ↳ `authors` | array | Authors of commits in the release |
|
||||
| ↳ `id` | string | Author ID |
|
||||
| ↳ `name` | string | Author name |
|
||||
@@ -570,18 +536,12 @@ List releases for a Sentry organization or project. Returns release details incl
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `slug` | string | Project slug |
|
||||
| ↳ `platform` | string | Project platform |
|
||||
| ↳ `slug` | string | Project slug |
|
||||
| ↳ `platform` | string | Project platform |
|
||||
| ↳ `firstEvent` | string | First event timestamp |
|
||||
| ↳ `lastEvent` | string | Last event timestamp |
|
||||
| ↳ `versionInfo` | object | Version metadata |
|
||||
| ↳ `buildHash` | string | Build hash |
|
||||
| ↳ `version` | object | Version details |
|
||||
| ↳ `raw` | string | Raw version string |
|
||||
| ↳ `raw` | string | Raw version string |
|
||||
| ↳ `package` | string | Package name |
|
||||
| ↳ `buildHash` | string | Build hash |
|
||||
| ↳ `raw` | string | Raw version string |
|
||||
| ↳ `package` | string | Package name |
|
||||
| `metadata` | object | Pagination metadata |
|
||||
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
|
||||
@@ -609,15 +569,14 @@ Create a new release in Sentry. A release is a version of your code deployed to
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `release` | object | The newly created Sentry release |
|
||||
| ↳ `id` | string | Project ID |
|
||||
| ↳ `version` | object | Version details |
|
||||
| ↳ `raw` | string | Raw version string |
|
||||
| ↳ `id` | string | Unique release ID |
|
||||
| ↳ `version` | string | Release version identifier |
|
||||
| ↳ `shortVersion` | string | Shortened version identifier |
|
||||
| ↳ `ref` | string | Git reference \(commit SHA, tag, or branch\) |
|
||||
| ↳ `url` | string | URL to the release |
|
||||
| ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) |
|
||||
| ↳ `dateCreated` | string | Commit timestamp |
|
||||
| ↳ `dateStarted` | string | Deploy start timestamp |
|
||||
| ↳ `dateCreated` | string | When the release was created \(ISO timestamp\) |
|
||||
| ↳ `dateStarted` | string | When the release started \(ISO timestamp\) |
|
||||
| ↳ `newGroups` | number | Number of new issues introduced |
|
||||
| ↳ `commitCount` | number | Number of commits in this release |
|
||||
| ↳ `deployCount` | number | Number of deploys for this release |
|
||||
@@ -625,20 +584,15 @@ Create a new release in Sentry. A release is a version of your code deployed to
|
||||
| ↳ `id` | string | Owner ID |
|
||||
| ↳ `name` | string | Owner name |
|
||||
| ↳ `email` | string | Owner email |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `email` | string | Author email |
|
||||
| ↳ `lastCommit` | object | Last commit in the release |
|
||||
| ↳ `id` | string | Commit SHA |
|
||||
| ↳ `message` | string | Commit message |
|
||||
| ↳ `dateCreated` | string | Commit timestamp |
|
||||
| ↳ `message` | string | Commit message |
|
||||
| ↳ `lastDeploy` | object | Last deploy of the release |
|
||||
| ↳ `id` | string | Deploy ID |
|
||||
| ↳ `environment` | string | Deploy environment |
|
||||
| ↳ `dateStarted` | string | Deploy start timestamp |
|
||||
| ↳ `dateFinished` | string | Deploy finish timestamp |
|
||||
| ↳ `environment` | string | Deploy environment |
|
||||
| ↳ `dateFinished` | string | Deploy finish timestamp |
|
||||
| ↳ `authors` | array | Authors of commits in the release |
|
||||
| ↳ `id` | string | Author ID |
|
||||
| ↳ `name` | string | Author name |
|
||||
@@ -648,18 +602,12 @@ Create a new release in Sentry. A release is a version of your code deployed to
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `slug` | string | Project slug |
|
||||
| ↳ `platform` | string | Project platform |
|
||||
| ↳ `slug` | string | Project slug |
|
||||
| ↳ `platform` | string | Project platform |
|
||||
| ↳ `firstEvent` | string | First event timestamp |
|
||||
| ↳ `lastEvent` | string | Last event timestamp |
|
||||
| ↳ `versionInfo` | object | Version metadata |
|
||||
| ↳ `buildHash` | string | Build hash |
|
||||
| ↳ `version` | object | Version details |
|
||||
| ↳ `raw` | string | Raw version string |
|
||||
| ↳ `raw` | string | Raw version string |
|
||||
| ↳ `package` | string | Package name |
|
||||
| ↳ `buildHash` | string | Build hash |
|
||||
| ↳ `raw` | string | Raw version string |
|
||||
| ↳ `package` | string | Package name |
|
||||
|
||||
### `sentry_releases_deploy`
|
||||
|
||||
@@ -35,7 +35,7 @@ Integrate Serper into the workflow. Can search the web.
|
||||
|
||||
### `serper_search`
|
||||
|
||||
A powerful web search tool that provides access to Google search results through Serper.dev API. Supports different types of searches including regular web search, news, places, and images, with each result containing relevant metadata like titles, URLs, snippets, and type-specific information.
|
||||
A powerful web search tool that provides access to Google search results through Serper.dev API. Supports different types of searches including regular web search, news, places, images, videos, and shopping. Returns comprehensive results including organic results, knowledge graph, answer box, people also ask, related searches, and top stories.
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -53,5 +53,17 @@ A powerful web search tool that provides access to Google search results through
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `searchResults` | array | Search results with titles, links, snippets, and type-specific metadata \(date for news, rating for places, imageUrl for images\) |
|
||||
| ↳ `title` | string | Result title |
|
||||
| ↳ `link` | string | Result URL |
|
||||
| ↳ `snippet` | string | Result description/snippet |
|
||||
| ↳ `position` | number | Position in search results |
|
||||
| ↳ `date` | string | Publication date \(news/videos\) |
|
||||
| ↳ `imageUrl` | string | Image URL \(images/news/shopping\) |
|
||||
| ↳ `source` | string | Source name \(news/videos/shopping\) |
|
||||
| ↳ `rating` | number | Rating \(places\) |
|
||||
| ↳ `ratingCount` | number | Number of reviews \(places\) |
|
||||
| ↳ `address` | string | Address \(places\) |
|
||||
| ↳ `price` | string | Price \(shopping\) |
|
||||
| ↳ `duration` | string | Duration \(videos\) |
|
||||
|
||||
|
||||
|
||||
@@ -95,13 +95,7 @@ Read a specific page from a SharePoint site
|
||||
| ↳ `pageLayout` | string | The layout type of the page |
|
||||
| ↳ `createdDateTime` | string | When the page was created |
|
||||
| ↳ `lastModifiedDateTime` | string | When the page was last modified |
|
||||
| ↳ `id` | string | The unique ID of the page |
|
||||
| ↳ `name` | string | The name of the page |
|
||||
| ↳ `title` | string | The title of the page |
|
||||
| ↳ `webUrl` | string | The URL to access the page |
|
||||
| ↳ `pageLayout` | string | The layout type of the page |
|
||||
| ↳ `createdDateTime` | string | When the page was created |
|
||||
| ↳ `lastModifiedDateTime` | string | When the page was last modified |
|
||||
| ↳ `content` | object | Extracted text content from the page |
|
||||
| ↳ `content` | string | Extracted text content from the page |
|
||||
| ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure |
|
||||
| `content` | object | Content of the SharePoint page |
|
||||
@@ -135,10 +129,8 @@ List details of all SharePoint sites
|
||||
| ↳ `isPersonalSite` | boolean | Whether this is a personal site |
|
||||
| ↳ `root` | object | Server relative URL |
|
||||
| ↳ `serverRelativeUrl` | string | Server relative URL |
|
||||
| ↳ `serverRelativeUrl` | string | Server relative URL |
|
||||
| ↳ `siteCollection` | object | Site collection hostname |
|
||||
| ↳ `hostname` | string | Site collection hostname |
|
||||
| ↳ `hostname` | string | Site collection hostname |
|
||||
| `sites` | array | List of all accessible SharePoint sites |
|
||||
| ↳ `id` | string | The unique ID of the site |
|
||||
| ↳ `name` | string | The name of the site |
|
||||
@@ -193,7 +185,7 @@ Get metadata (and optionally columns/items) for a SharePoint list
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `list` | object | Information about the SharePoint list |
|
||||
| ↳ `id` | string | Item ID |
|
||||
| ↳ `id` | string | The unique ID of the list |
|
||||
| ↳ `displayName` | string | The display name of the list |
|
||||
| ↳ `name` | string | The internal name of the list |
|
||||
| ↳ `webUrl` | string | The web URL of the list |
|
||||
@@ -201,7 +193,6 @@ Get metadata (and optionally columns/items) for a SharePoint list
|
||||
| ↳ `lastModifiedDateTime` | string | When the list was last modified |
|
||||
| ↳ `list` | object | List properties \(e.g., template\) |
|
||||
| ↳ `columns` | array | List column definitions |
|
||||
| ↳ `fields` | object | Field values for the item |
|
||||
| `lists` | array | All lists in the site when no listId/title provided |
|
||||
|
||||
### `sharepoint_update_list`
|
||||
|
||||
@@ -53,6 +53,18 @@ Create a new product in your Shopify store
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | The created product |
|
||||
| ↳ `id` | string | Unique product identifier \(GID\) |
|
||||
| ↳ `title` | string | Product title |
|
||||
| ↳ `handle` | string | URL-friendly product identifier |
|
||||
| ↳ `descriptionHtml` | string | Product description in HTML format |
|
||||
| ↳ `vendor` | string | Product vendor or manufacturer |
|
||||
| ↳ `productType` | string | Product type classification |
|
||||
| ↳ `tags` | array | Product tags for categorization |
|
||||
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `variants` | object | Product variants with edges/nodes structure |
|
||||
| ↳ `images` | object | Product images with edges/nodes structure |
|
||||
|
||||
### `shopify_get_product`
|
||||
|
||||
@@ -70,6 +82,18 @@ Get a single product by ID from your Shopify store
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | The product details |
|
||||
| ↳ `id` | string | Unique product identifier \(GID\) |
|
||||
| ↳ `title` | string | Product title |
|
||||
| ↳ `handle` | string | URL-friendly product identifier |
|
||||
| ↳ `descriptionHtml` | string | Product description in HTML format |
|
||||
| ↳ `vendor` | string | Product vendor or manufacturer |
|
||||
| ↳ `productType` | string | Product type classification |
|
||||
| ↳ `tags` | array | Product tags for categorization |
|
||||
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `variants` | object | Product variants with edges/nodes structure |
|
||||
| ↳ `images` | object | Product images with edges/nodes structure |
|
||||
|
||||
### `shopify_list_products`
|
||||
|
||||
@@ -88,7 +112,21 @@ List products from your Shopify store with optional filtering
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `products` | array | List of products |
|
||||
| ↳ `id` | string | Unique product identifier \(GID\) |
|
||||
| ↳ `title` | string | Product title |
|
||||
| ↳ `handle` | string | URL-friendly product identifier |
|
||||
| ↳ `descriptionHtml` | string | Product description in HTML format |
|
||||
| ↳ `vendor` | string | Product vendor or manufacturer |
|
||||
| ↳ `productType` | string | Product type classification |
|
||||
| ↳ `tags` | array | Product tags for categorization |
|
||||
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `variants` | object | Product variants with edges/nodes structure |
|
||||
| ↳ `images` | object | Product images with edges/nodes structure |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||
|
||||
### `shopify_update_product`
|
||||
|
||||
@@ -112,6 +150,18 @@ Update an existing product in your Shopify store
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | The updated product |
|
||||
| ↳ `id` | string | Unique product identifier \(GID\) |
|
||||
| ↳ `title` | string | Product title |
|
||||
| ↳ `handle` | string | URL-friendly product identifier |
|
||||
| ↳ `descriptionHtml` | string | Product description in HTML format |
|
||||
| ↳ `vendor` | string | Product vendor or manufacturer |
|
||||
| ↳ `productType` | string | Product type classification |
|
||||
| ↳ `tags` | array | Product tags for categorization |
|
||||
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `variants` | object | Product variants with edges/nodes structure |
|
||||
| ↳ `images` | object | Product images with edges/nodes structure |
|
||||
|
||||
### `shopify_delete_product`
|
||||
|
||||
@@ -146,6 +196,27 @@ Get a single order by ID from your Shopify store
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The order details |
|
||||
| ↳ `id` | string | Unique order identifier \(GID\) |
|
||||
| ↳ `name` | string | Order name \(e.g., #1001\) |
|
||||
| ↳ `email` | string | Customer email for the order |
|
||||
| ↳ `phone` | string | Customer phone for the order |
|
||||
| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) |
|
||||
| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) |
|
||||
| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) |
|
||||
| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) |
|
||||
| ↳ `totalPriceSet` | object | Total order price |
|
||||
| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) |
|
||||
| ↳ `totalTaxSet` | object | Total tax amount |
|
||||
| ↳ `totalShippingPriceSet` | object | Total shipping price |
|
||||
| ↳ `note` | string | Order note |
|
||||
| ↳ `tags` | array | Order tags |
|
||||
| ↳ `customer` | object | Customer who placed the order |
|
||||
| ↳ `lineItems` | object | Order line items with edges/nodes structure |
|
||||
| ↳ `shippingAddress` | object | Shipping address |
|
||||
| ↳ `billingAddress` | object | Billing address |
|
||||
| ↳ `fulfillments` | array | Order fulfillments |
|
||||
|
||||
### `shopify_list_orders`
|
||||
|
||||
@@ -165,7 +236,30 @@ List orders from your Shopify store with optional filtering
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | List of orders |
|
||||
| ↳ `id` | string | Unique order identifier \(GID\) |
|
||||
| ↳ `name` | string | Order name \(e.g., #1001\) |
|
||||
| ↳ `email` | string | Customer email for the order |
|
||||
| ↳ `phone` | string | Customer phone for the order |
|
||||
| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) |
|
||||
| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) |
|
||||
| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) |
|
||||
| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) |
|
||||
| ↳ `totalPriceSet` | object | Total order price |
|
||||
| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) |
|
||||
| ↳ `totalTaxSet` | object | Total tax amount |
|
||||
| ↳ `totalShippingPriceSet` | object | Total shipping price |
|
||||
| ↳ `note` | string | Order note |
|
||||
| ↳ `tags` | array | Order tags |
|
||||
| ↳ `customer` | object | Customer who placed the order |
|
||||
| ↳ `lineItems` | object | Order line items with edges/nodes structure |
|
||||
| ↳ `shippingAddress` | object | Shipping address |
|
||||
| ↳ `billingAddress` | object | Billing address |
|
||||
| ↳ `fulfillments` | array | Order fulfillments |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||
|
||||
### `shopify_update_order`
|
||||
|
||||
@@ -186,6 +280,27 @@ Update an existing order in your Shopify store (note, tags, email)
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The updated order |
|
||||
| ↳ `id` | string | Unique order identifier \(GID\) |
|
||||
| ↳ `name` | string | Order name \(e.g., #1001\) |
|
||||
| ↳ `email` | string | Customer email for the order |
|
||||
| ↳ `phone` | string | Customer phone for the order |
|
||||
| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) |
|
||||
| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) |
|
||||
| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) |
|
||||
| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) |
|
||||
| ↳ `totalPriceSet` | object | Total order price |
|
||||
| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) |
|
||||
| ↳ `totalTaxSet` | object | Total tax amount |
|
||||
| ↳ `totalShippingPriceSet` | object | Total shipping price |
|
||||
| ↳ `note` | string | Order note |
|
||||
| ↳ `tags` | array | Order tags |
|
||||
| ↳ `customer` | object | Customer who placed the order |
|
||||
| ↳ `lineItems` | object | Order line items with edges/nodes structure |
|
||||
| ↳ `shippingAddress` | object | Shipping address |
|
||||
| ↳ `billingAddress` | object | Billing address |
|
||||
| ↳ `fulfillments` | array | Order fulfillments |
|
||||
|
||||
### `shopify_cancel_order`
|
||||
|
||||
@@ -208,6 +323,9 @@ Cancel an order in your Shopify store
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The cancellation result |
|
||||
| ↳ `id` | string | Job identifier for the cancellation |
|
||||
| ↳ `cancelled` | boolean | Whether the cancellation completed |
|
||||
| ↳ `message` | string | Status message |
|
||||
|
||||
### `shopify_create_customer`
|
||||
|
||||
@@ -231,6 +349,18 @@ Create a new customer in your Shopify store
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | The created customer |
|
||||
| ↳ `id` | string | Unique customer identifier \(GID\) |
|
||||
| ↳ `email` | string | Customer email address |
|
||||
| ↳ `firstName` | string | Customer first name |
|
||||
| ↳ `lastName` | string | Customer last name |
|
||||
| ↳ `phone` | string | Customer phone number |
|
||||
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `note` | string | Internal notes about the customer |
|
||||
| ↳ `tags` | array | Customer tags for categorization |
|
||||
| ↳ `amountSpent` | object | Total amount spent by customer |
|
||||
| ↳ `addresses` | array | Customer addresses |
|
||||
| ↳ `defaultAddress` | object | Customer default address |
|
||||
|
||||
### `shopify_get_customer`
|
||||
|
||||
@@ -248,6 +378,18 @@ Get a single customer by ID from your Shopify store
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | The customer details |
|
||||
| ↳ `id` | string | Unique customer identifier \(GID\) |
|
||||
| ↳ `email` | string | Customer email address |
|
||||
| ↳ `firstName` | string | Customer first name |
|
||||
| ↳ `lastName` | string | Customer last name |
|
||||
| ↳ `phone` | string | Customer phone number |
|
||||
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `note` | string | Internal notes about the customer |
|
||||
| ↳ `tags` | array | Customer tags for categorization |
|
||||
| ↳ `amountSpent` | object | Total amount spent by customer |
|
||||
| ↳ `addresses` | array | Customer addresses |
|
||||
| ↳ `defaultAddress` | object | Customer default address |
|
||||
|
||||
### `shopify_list_customers`
|
||||
|
||||
@@ -266,7 +408,21 @@ List customers from your Shopify store with optional filtering
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customers` | array | List of customers |
|
||||
| ↳ `id` | string | Unique customer identifier \(GID\) |
|
||||
| ↳ `email` | string | Customer email address |
|
||||
| ↳ `firstName` | string | Customer first name |
|
||||
| ↳ `lastName` | string | Customer last name |
|
||||
| ↳ `phone` | string | Customer phone number |
|
||||
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `note` | string | Internal notes about the customer |
|
||||
| ↳ `tags` | array | Customer tags for categorization |
|
||||
| ↳ `amountSpent` | object | Total amount spent by customer |
|
||||
| ↳ `addresses` | array | Customer addresses |
|
||||
| ↳ `defaultAddress` | object | Customer default address |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||
|
||||
### `shopify_update_customer`
|
||||
|
||||
@@ -290,6 +446,18 @@ Update an existing customer in your Shopify store
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | The updated customer |
|
||||
| ↳ `id` | string | Unique customer identifier \(GID\) |
|
||||
| ↳ `email` | string | Customer email address |
|
||||
| ↳ `firstName` | string | Customer first name |
|
||||
| ↳ `lastName` | string | Customer last name |
|
||||
| ↳ `phone` | string | Customer phone number |
|
||||
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `note` | string | Internal notes about the customer |
|
||||
| ↳ `tags` | array | Customer tags for categorization |
|
||||
| ↳ `amountSpent` | object | Total amount spent by customer |
|
||||
| ↳ `addresses` | array | Customer addresses |
|
||||
| ↳ `defaultAddress` | object | Customer default address |
|
||||
|
||||
### `shopify_delete_customer`
|
||||
|
||||
@@ -325,7 +493,26 @@ List inventory items from your Shopify store. Use this to find inventory item ID
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryItems` | array | List of inventory items with their IDs, SKUs, and stock levels |
|
||||
| ↳ `id` | string | Unique inventory item identifier \(GID\) |
|
||||
| ↳ `sku` | string | Stock keeping unit |
|
||||
| ↳ `tracked` | boolean | Whether inventory is tracked |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `variant` | object | Associated product variant |
|
||||
| ↳ `id` | string | Variant identifier \(GID\) |
|
||||
| ↳ `title` | string | Variant title |
|
||||
| ↳ `product` | object | Associated product |
|
||||
| ↳ `id` | string | Product identifier \(GID\) |
|
||||
| ↳ `title` | string | Product title |
|
||||
| ↳ `inventoryLevels` | array | Inventory levels at different locations |
|
||||
| ↳ `id` | string | Inventory level identifier \(GID\) |
|
||||
| ↳ `available` | number | Available quantity |
|
||||
| ↳ `location` | object | Location for this inventory level |
|
||||
| ↳ `id` | string | Location identifier \(GID\) |
|
||||
| ↳ `name` | string | Location name |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||
|
||||
### `shopify_get_inventory_level`
|
||||
|
||||
@@ -344,6 +531,19 @@ Get inventory level for a product variant at a specific location
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryLevel` | object | The inventory level details |
|
||||
| ↳ `id` | string | Inventory item identifier \(GID\) |
|
||||
| ↳ `sku` | string | Stock keeping unit |
|
||||
| ↳ `tracked` | boolean | Whether inventory is tracked |
|
||||
| ↳ `levels` | array | Inventory levels at different locations |
|
||||
| ↳ `id` | string | Inventory level identifier \(GID\) |
|
||||
| ↳ `available` | number | Available quantity |
|
||||
| ↳ `onHand` | number | On-hand quantity |
|
||||
| ↳ `committed` | number | Committed quantity |
|
||||
| ↳ `incoming` | number | Incoming quantity |
|
||||
| ↳ `reserved` | number | Reserved quantity |
|
||||
| ↳ `location` | object | Location for this inventory level |
|
||||
| ↳ `id` | string | Location identifier \(GID\) |
|
||||
| ↳ `name` | string | Location name |
|
||||
|
||||
### `shopify_adjust_inventory`
|
||||
|
||||
@@ -363,6 +563,19 @@ Adjust inventory quantity for a product variant at a specific location
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryLevel` | object | The inventory adjustment result |
|
||||
| ↳ `adjustmentGroup` | object | Inventory adjustment group details |
|
||||
| ↳ `createdAt` | string | Adjustment timestamp \(ISO 8601\) |
|
||||
| ↳ `reason` | string | Adjustment reason |
|
||||
| ↳ `changes` | array | Inventory changes applied |
|
||||
| ↳ `name` | string | Quantity name \(e.g., available\) |
|
||||
| ↳ `delta` | number | Quantity change amount |
|
||||
| ↳ `quantityAfterChange` | number | Quantity after adjustment |
|
||||
| ↳ `item` | object | Inventory item |
|
||||
| ↳ `id` | string | Inventory item identifier \(GID\) |
|
||||
| ↳ `sku` | string | Stock keeping unit |
|
||||
| ↳ `location` | object | Location of the adjustment |
|
||||
| ↳ `id` | string | Location identifier \(GID\) |
|
||||
| ↳ `name` | string | Location name |
|
||||
|
||||
### `shopify_list_locations`
|
||||
|
||||
@@ -381,7 +594,14 @@ List inventory locations from your Shopify store. Use this to find location IDs
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `locations` | array | List of locations with their IDs, names, and addresses |
|
||||
| ↳ `id` | string | Unique location identifier \(GID\) |
|
||||
| ↳ `name` | string | Location name |
|
||||
| ↳ `isActive` | boolean | Whether the location is active |
|
||||
| ↳ `fulfillsOnlineOrders` | boolean | Whether the location fulfills online orders |
|
||||
| ↳ `address` | object | Location address |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||
|
||||
### `shopify_create_fulfillment`
|
||||
|
||||
@@ -403,6 +623,16 @@ Create a fulfillment to mark order items as shipped. Requires a fulfillment orde
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fulfillment` | object | The created fulfillment with tracking info and fulfilled items |
|
||||
| ↳ `id` | string | Unique fulfillment identifier \(GID\) |
|
||||
| ↳ `status` | string | Fulfillment status \(pending, open, success, cancelled, error, failure\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `trackingInfo` | array | Tracking information for shipments |
|
||||
| ↳ `fulfillmentLineItems` | array | Fulfilled line items |
|
||||
| ↳ `id` | string | Fulfillment line item identifier \(GID\) |
|
||||
| ↳ `quantity` | number | Quantity fulfilled |
|
||||
| ↳ `lineItem` | object | Associated order line item |
|
||||
| ↳ `title` | string | Product title |
|
||||
|
||||
### `shopify_list_collections`
|
||||
|
||||
@@ -421,7 +651,18 @@ List product collections from your Shopify store. Filter by title, type (custom/
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `collections` | array | List of collections with their IDs, titles, and product counts |
|
||||
| ↳ `id` | string | Unique collection identifier \(GID\) |
|
||||
| ↳ `title` | string | Collection title |
|
||||
| ↳ `handle` | string | URL-friendly collection identifier |
|
||||
| ↳ `description` | string | Plain text description |
|
||||
| ↳ `descriptionHtml` | string | HTML-formatted description |
|
||||
| ↳ `productsCount` | number | Number of products in the collection |
|
||||
| ↳ `sortOrder` | string | Product sort order in the collection |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `image` | object | Collection image |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||
|
||||
### `shopify_get_collection`
|
||||
|
||||
@@ -440,5 +681,15 @@ Get a specific collection by ID, including its products. Use this to retrieve pr
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `collection` | object | The collection details including its products |
|
||||
| ↳ `id` | string | Unique collection identifier \(GID\) |
|
||||
| ↳ `title` | string | Collection title |
|
||||
| ↳ `handle` | string | URL-friendly collection identifier |
|
||||
| ↳ `description` | string | Plain text description |
|
||||
| ↳ `descriptionHtml` | string | HTML-formatted description |
|
||||
| ↳ `productsCount` | number | Number of products in the collection |
|
||||
| ↳ `sortOrder` | string | Product sort order in the collection |
|
||||
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||
| ↳ `image` | object | Collection image |
|
||||
| ↳ `products` | array | Products in the collection |
|
||||
|
||||
|
||||
|
||||
183
apps/docs/content/docs/en/tools/similarweb.mdx
Normal file
183
apps/docs/content/docs/en/tools/similarweb.mdx
Normal file
@@ -0,0 +1,183 @@
|
||||
---
|
||||
title: Similarweb
|
||||
description: Website traffic and analytics data
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="similarweb"
|
||||
color="#000922"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Similarweb](https://www.similarweb.com/) is a leading platform for web analytics that provides in-depth traffic and engagement data for millions of websites. Similarweb gives you insights into website visits, traffic sources, audience behavior, and competitive benchmarks.
|
||||
|
||||
With Similarweb in Sim, your agents can:
|
||||
|
||||
- **Analyze website traffic**: Retrieve key metrics such as monthly visits, average duration, bounce rates, and top countries.
|
||||
- **Understand audience engagement**: Gain insights into how users interact with websites, including pages per visit and engagement duration.
|
||||
- **Track rankings and performance**: Access global, country, and category ranks to benchmark sites against competitors.
|
||||
- **Discover traffic sources**: Break down traffic by channels like direct, search, social, referrals, and more.
|
||||
|
||||
Use Sim's Similarweb integration to automate the monitoring of competitors, track your site’s performance, or surface actionable market research—all integrated directly into your workflows and automations. Empower your agents to access and utilize reliable web analytics data easily and programmatically.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Access comprehensive website analytics including traffic estimates, engagement metrics, rankings, and traffic sources using the Similarweb API.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `similarweb_website_overview`
|
||||
|
||||
Get comprehensive website analytics including traffic, rankings, engagement, and traffic sources
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SimilarWeb API key |
|
||||
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `siteName` | string | Website name |
|
||||
| `description` | string | Website description |
|
||||
| `globalRank` | number | Global traffic rank |
|
||||
| `countryRank` | number | Country traffic rank |
|
||||
| `categoryRank` | number | Category traffic rank |
|
||||
| `category` | string | Website category |
|
||||
| `monthlyVisits` | number | Estimated monthly visits |
|
||||
| `engagementVisitDuration` | number | Average visit duration in seconds |
|
||||
| `engagementPagesPerVisit` | number | Average pages per visit |
|
||||
| `engagementBounceRate` | number | Bounce rate \(0-1\) |
|
||||
| `topCountries` | array | Top countries by traffic share |
|
||||
| ↳ `country` | string | Country code |
|
||||
| ↳ `share` | number | Traffic share \(0-1\) |
|
||||
| `trafficSources` | json | Traffic source breakdown |
|
||||
| ↳ `direct` | number | Direct traffic share |
|
||||
| ↳ `referrals` | number | Referral traffic share |
|
||||
| ↳ `search` | number | Search traffic share |
|
||||
| ↳ `social` | number | Social traffic share |
|
||||
| ↳ `mail` | number | Email traffic share |
|
||||
| ↳ `paidReferrals` | number | Paid referral traffic share |
|
||||
|
||||
### `similarweb_traffic_visits`
|
||||
|
||||
Get total website visits over time (desktop and mobile combined)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SimilarWeb API key |
|
||||
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
|
||||
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
|
||||
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
|
||||
| `startDate` | string | No | Start date in YYYY-MM format |
|
||||
| `endDate` | string | No | End date in YYYY-MM format |
|
||||
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `domain` | string | Analyzed domain |
|
||||
| `country` | string | Country filter applied |
|
||||
| `granularity` | string | Data granularity |
|
||||
| `lastUpdated` | string | Data last updated timestamp |
|
||||
| `visits` | array | Visit data over time |
|
||||
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
|
||||
| ↳ `visits` | number | Number of visits |
|
||||
|
||||
### `similarweb_bounce_rate`
|
||||
|
||||
Get website bounce rate over time (desktop and mobile combined)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SimilarWeb API key |
|
||||
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
|
||||
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
|
||||
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
|
||||
| `startDate` | string | No | Start date in YYYY-MM format |
|
||||
| `endDate` | string | No | End date in YYYY-MM format |
|
||||
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `domain` | string | Analyzed domain |
|
||||
| `country` | string | Country filter applied |
|
||||
| `granularity` | string | Data granularity |
|
||||
| `lastUpdated` | string | Data last updated timestamp |
|
||||
| `bounceRate` | array | Bounce rate data over time |
|
||||
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
|
||||
| ↳ `bounceRate` | number | Bounce rate \(0-1\) |
|
||||
|
||||
### `similarweb_pages_per_visit`
|
||||
|
||||
Get average pages per visit over time (desktop and mobile combined)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SimilarWeb API key |
|
||||
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
|
||||
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
|
||||
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
|
||||
| `startDate` | string | No | Start date in YYYY-MM format |
|
||||
| `endDate` | string | No | End date in YYYY-MM format |
|
||||
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `domain` | string | Analyzed domain |
|
||||
| `country` | string | Country filter applied |
|
||||
| `granularity` | string | Data granularity |
|
||||
| `lastUpdated` | string | Data last updated timestamp |
|
||||
| `pagesPerVisit` | array | Pages per visit data over time |
|
||||
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
|
||||
| ↳ `pagesPerVisit` | number | Average pages per visit |
|
||||
|
||||
### `similarweb_visit_duration`
|
||||
|
||||
Get average desktop visit duration over time (in seconds)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SimilarWeb API key |
|
||||
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
|
||||
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
|
||||
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
|
||||
| `startDate` | string | No | Start date in YYYY-MM format |
|
||||
| `endDate` | string | No | End date in YYYY-MM format |
|
||||
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `domain` | string | Analyzed domain |
|
||||
| `country` | string | Country filter applied |
|
||||
| `granularity` | string | Data granularity |
|
||||
| `lastUpdated` | string | Data last updated timestamp |
|
||||
| `averageVisitDuration` | array | Desktop visit duration data over time |
|
||||
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
|
||||
| ↳ `durationSeconds` | number | Average visit duration in seconds |
|
||||
|
||||
|
||||
@@ -97,6 +97,60 @@ Send messages to Slack channels or direct messages. Supports Slack mrkdwn format
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | object | Complete message object with all properties returned by Slack |
|
||||
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||
| ↳ `text` | string | Message text content |
|
||||
| ↳ `user` | string | User ID who sent the message |
|
||||
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||
| ↳ `username` | string | Display username |
|
||||
| ↳ `channel` | string | Channel ID |
|
||||
| ↳ `team` | string | Team/workspace ID |
|
||||
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||
| ↳ `last_read` | string | Timestamp of last read message |
|
||||
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||
| ↳ `permalink` | string | Permanent URL to the message |
|
||||
| ↳ `reactions` | array | Reactions on this message |
|
||||
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||
| ↳ `count` | number | Number of times this reaction was added |
|
||||
| ↳ `users` | array | Array of user IDs who reacted |
|
||||
| ↳ `files` | array | Files attached to the message |
|
||||
| ↳ `id` | string | Unique file identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimetype` | string | MIME type of the file |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||
| ↳ `permalink` | string | Permanent link to the file |
|
||||
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||
| ↳ `id` | number | Attachment ID |
|
||||
| ↳ `fallback` | string | Plain text summary |
|
||||
| ↳ `text` | string | Main attachment text |
|
||||
| ↳ `pretext` | string | Text shown before attachment |
|
||||
| ↳ `color` | string | Color bar hex code or preset |
|
||||
| ↳ `author_name` | string | Author display name |
|
||||
| ↳ `author_link` | string | Author link URL |
|
||||
| ↳ `author_icon` | string | Author icon URL |
|
||||
| ↳ `title` | string | Attachment title |
|
||||
| ↳ `title_link` | string | Title link URL |
|
||||
| ↳ `image_url` | string | Image URL |
|
||||
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||
| ↳ `footer` | string | Footer text |
|
||||
| ↳ `footer_icon` | string | Footer icon URL |
|
||||
| ↳ `ts` | string | Timestamp shown in footer |
|
||||
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||
| ↳ `block_id` | string | Unique block identifier |
|
||||
| ↳ `edited` | object | Edit information if message was edited |
|
||||
| ↳ `user` | string | User ID who edited the message |
|
||||
| ↳ `ts` | string | Timestamp of the edit |
|
||||
| `ts` | string | Message timestamp |
|
||||
| `channel` | string | Channel ID where message was sent |
|
||||
| `fileCount` | number | Number of files uploaded \(when files are attached\) |
|
||||
@@ -120,9 +174,9 @@ Create and share Slack canvases in channels. Canvases are collaborative document
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `canvas_id` | string | ID of the created canvas |
|
||||
| `canvas_id` | string | Unique canvas identifier |
|
||||
| `channel` | string | Channel where canvas was created |
|
||||
| `title` | string | Title of the canvas |
|
||||
| `title` | string | Canvas title |
|
||||
|
||||
### `slack_message_reader`
|
||||
|
||||
@@ -146,51 +200,60 @@ Read the latest messages from Slack channels. Retrieve conversation history with
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `messages` | array | Array of message objects from the channel |
|
||||
| ↳ `type` | string | Message type |
|
||||
| ↳ `ts` | string | Edit timestamp |
|
||||
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||
| ↳ `text` | string | Message text content |
|
||||
| ↳ `user` | string | User ID who edited |
|
||||
| ↳ `user` | string | User ID who sent the message |
|
||||
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||
| ↳ `username` | string | Display username |
|
||||
| ↳ `channel` | string | Channel ID |
|
||||
| ↳ `team` | string | Team ID |
|
||||
| ↳ `thread_ts` | string | Thread parent message timestamp |
|
||||
| ↳ `parent_user_id` | string | User ID of thread parent |
|
||||
| ↳ `reply_count` | number | Number of thread replies |
|
||||
| ↳ `reply_users_count` | number | Number of users who replied |
|
||||
| ↳ `latest_reply` | string | Timestamp of latest reply |
|
||||
| ↳ `team` | string | Team/workspace ID |
|
||||
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||
| ↳ `last_read` | string | Last read timestamp |
|
||||
| ↳ `unread_count` | number | Number of unread messages |
|
||||
| ↳ `subtype` | string | Message subtype |
|
||||
| ↳ `reactions` | array | Array of reactions on this message |
|
||||
| ↳ `name` | string | Emoji name |
|
||||
| ↳ `count` | number | Number of reactions |
|
||||
| ↳ `last_read` | string | Timestamp of last read message |
|
||||
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||
| ↳ `permalink` | string | Permanent URL to the message |
|
||||
| ↳ `reactions` | array | Reactions on this message |
|
||||
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||
| ↳ `count` | number | Number of times this reaction was added |
|
||||
| ↳ `users` | array | Array of user IDs who reacted |
|
||||
| ↳ `files` | array | Files attached to the message |
|
||||
| ↳ `id` | string | Unique file identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `count` | number | Number of reactions |
|
||||
| ↳ `users` | array | Array of user IDs who reacted |
|
||||
| ↳ `is_starred` | boolean | Whether message is starred |
|
||||
| ↳ `pinned_to` | array | Array of channel IDs where message is pinned |
|
||||
| ↳ `files` | array | Array of files attached to message |
|
||||
| ↳ `id` | string | File ID |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimetype` | string | MIME type |
|
||||
| ↳ `mimetype` | string | MIME type of the file |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `url_private` | string | Private download URL |
|
||||
| ↳ `permalink` | string | Permanent link to file |
|
||||
| ↳ `mode` | string | File mode |
|
||||
| ↳ `id` | string | File ID |
|
||||
| ↳ `mimetype` | string | MIME type |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `url_private` | string | Private download URL |
|
||||
| ↳ `permalink` | string | Permanent link to message |
|
||||
| ↳ `mode` | string | File mode |
|
||||
| ↳ `attachments` | array | Array of legacy attachments |
|
||||
| ↳ `blocks` | array | Array of Block Kit blocks |
|
||||
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||
| ↳ `permalink` | string | Permanent link to the file |
|
||||
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||
| ↳ `id` | number | Attachment ID |
|
||||
| ↳ `fallback` | string | Plain text summary |
|
||||
| ↳ `text` | string | Main attachment text |
|
||||
| ↳ `pretext` | string | Text shown before attachment |
|
||||
| ↳ `color` | string | Color bar hex code or preset |
|
||||
| ↳ `author_name` | string | Author display name |
|
||||
| ↳ `author_link` | string | Author link URL |
|
||||
| ↳ `author_icon` | string | Author icon URL |
|
||||
| ↳ `title` | string | Attachment title |
|
||||
| ↳ `title_link` | string | Title link URL |
|
||||
| ↳ `image_url` | string | Image URL |
|
||||
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||
| ↳ `footer` | string | Footer text |
|
||||
| ↳ `footer_icon` | string | Footer icon URL |
|
||||
| ↳ `ts` | string | Timestamp shown in footer |
|
||||
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||
| ↳ `block_id` | string | Unique block identifier |
|
||||
| ↳ `edited` | object | Edit information if message was edited |
|
||||
| ↳ `user` | string | User ID who edited |
|
||||
| ↳ `ts` | string | Edit timestamp |
|
||||
| ↳ `user` | string | User ID who edited the message |
|
||||
| ↳ `ts` | string | Timestamp of the edit |
|
||||
|
||||
### `slack_get_message`
|
||||
|
||||
@@ -210,46 +273,60 @@ Retrieve a specific message by its timestamp. Useful for getting a thread parent
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | object | The retrieved message object |
|
||||
| ↳ `type` | string | Message type |
|
||||
| ↳ `ts` | string | Edit timestamp |
|
||||
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||
| ↳ `text` | string | Message text content |
|
||||
| ↳ `user` | string | User ID who edited |
|
||||
| ↳ `user` | string | User ID who sent the message |
|
||||
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||
| ↳ `username` | string | Display username |
|
||||
| ↳ `channel` | string | Channel ID |
|
||||
| ↳ `team` | string | Team ID |
|
||||
| ↳ `thread_ts` | string | Thread parent timestamp |
|
||||
| ↳ `parent_user_id` | string | User ID of thread parent |
|
||||
| ↳ `reply_count` | number | Number of thread replies |
|
||||
| ↳ `reply_users_count` | number | Number of users who replied |
|
||||
| ↳ `latest_reply` | string | Timestamp of latest reply |
|
||||
| ↳ `subtype` | string | Message subtype |
|
||||
| ↳ `reactions` | array | Array of reactions on this message |
|
||||
| ↳ `name` | string | Emoji name |
|
||||
| ↳ `count` | number | Number of reactions |
|
||||
| ↳ `users` | array | User IDs who reacted |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `count` | number | Number of reactions |
|
||||
| ↳ `users` | array | User IDs who reacted |
|
||||
| ↳ `is_starred` | boolean | Whether message is starred |
|
||||
| ↳ `team` | string | Team/workspace ID |
|
||||
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||
| ↳ `last_read` | string | Timestamp of last read message |
|
||||
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||
| ↳ `files` | array | Files attached to message |
|
||||
| ↳ `id` | string | File ID |
|
||||
| ↳ `permalink` | string | Permanent URL to the message |
|
||||
| ↳ `reactions` | array | Reactions on this message |
|
||||
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||
| ↳ `count` | number | Number of times this reaction was added |
|
||||
| ↳ `users` | array | Array of user IDs who reacted |
|
||||
| ↳ `files` | array | Files attached to the message |
|
||||
| ↳ `id` | string | Unique file identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimetype` | string | MIME type |
|
||||
| ↳ `mimetype` | string | MIME type of the file |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `url_private` | string | Private download URL |
|
||||
| ↳ `permalink` | string | Permanent link to file |
|
||||
| ↳ `id` | string | File ID |
|
||||
| ↳ `mimetype` | string | MIME type |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `url_private` | string | Private download URL |
|
||||
| ↳ `permalink` | string | Permanent link to message |
|
||||
| ↳ `attachments` | array | Legacy attachments |
|
||||
| ↳ `blocks` | array | Block Kit blocks |
|
||||
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||
| ↳ `permalink` | string | Permanent link to the file |
|
||||
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||
| ↳ `id` | number | Attachment ID |
|
||||
| ↳ `fallback` | string | Plain text summary |
|
||||
| ↳ `text` | string | Main attachment text |
|
||||
| ↳ `pretext` | string | Text shown before attachment |
|
||||
| ↳ `color` | string | Color bar hex code or preset |
|
||||
| ↳ `author_name` | string | Author display name |
|
||||
| ↳ `author_link` | string | Author link URL |
|
||||
| ↳ `author_icon` | string | Author icon URL |
|
||||
| ↳ `title` | string | Attachment title |
|
||||
| ↳ `title_link` | string | Title link URL |
|
||||
| ↳ `image_url` | string | Image URL |
|
||||
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||
| ↳ `footer` | string | Footer text |
|
||||
| ↳ `footer_icon` | string | Footer icon URL |
|
||||
| ↳ `ts` | string | Timestamp shown in footer |
|
||||
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||
| ↳ `block_id` | string | Unique block identifier |
|
||||
| ↳ `edited` | object | Edit information if message was edited |
|
||||
| ↳ `user` | string | User ID who edited |
|
||||
| ↳ `ts` | string | Edit timestamp |
|
||||
| ↳ `user` | string | User ID who edited the message |
|
||||
| ↳ `ts` | string | Timestamp of the edit |
|
||||
|
||||
### `slack_get_thread`
|
||||
|
||||
@@ -270,37 +347,170 @@ Retrieve an entire thread including the parent message and all replies. Useful f
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `parentMessage` | object | The thread parent message |
|
||||
| ↳ `type` | string | Message type |
|
||||
| ↳ `ts` | string | Message timestamp |
|
||||
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||
| ↳ `text` | string | Message text content |
|
||||
| ↳ `user` | string | User ID who sent the message |
|
||||
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||
| ↳ `username` | string | Display username |
|
||||
| ↳ `reply_count` | number | Total number of thread replies |
|
||||
| ↳ `reply_users_count` | number | Number of users who replied |
|
||||
| ↳ `latest_reply` | string | Timestamp of latest reply |
|
||||
| ↳ `reactions` | array | Array of reactions on the parent message |
|
||||
| ↳ `name` | string | Emoji name |
|
||||
| ↳ `count` | number | Number of reactions |
|
||||
| ↳ `users` | array | User IDs who reacted |
|
||||
| ↳ `channel` | string | Channel ID |
|
||||
| ↳ `team` | string | Team/workspace ID |
|
||||
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||
| ↳ `last_read` | string | Timestamp of last read message |
|
||||
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||
| ↳ `permalink` | string | Permanent URL to the message |
|
||||
| ↳ `reactions` | array | Reactions on this message |
|
||||
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||
| ↳ `count` | number | Number of times this reaction was added |
|
||||
| ↳ `users` | array | Array of user IDs who reacted |
|
||||
| ↳ `files` | array | Files attached to the message |
|
||||
| ↳ `id` | string | Unique file identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `count` | number | Number of reactions |
|
||||
| ↳ `users` | array | User IDs who reacted |
|
||||
| ↳ `files` | array | Files attached to the parent message |
|
||||
| ↳ `id` | string | File ID |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimetype` | string | MIME type |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `id` | string | File ID |
|
||||
| ↳ `mimetype` | string | MIME type |
|
||||
| ↳ `mimetype` | string | MIME type of the file |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||
| ↳ `permalink` | string | Permanent link to the file |
|
||||
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||
| ↳ `id` | number | Attachment ID |
|
||||
| ↳ `fallback` | string | Plain text summary |
|
||||
| ↳ `text` | string | Main attachment text |
|
||||
| ↳ `pretext` | string | Text shown before attachment |
|
||||
| ↳ `color` | string | Color bar hex code or preset |
|
||||
| ↳ `author_name` | string | Author display name |
|
||||
| ↳ `author_link` | string | Author link URL |
|
||||
| ↳ `author_icon` | string | Author icon URL |
|
||||
| ↳ `title` | string | Attachment title |
|
||||
| ↳ `title_link` | string | Title link URL |
|
||||
| ↳ `image_url` | string | Image URL |
|
||||
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||
| ↳ `footer` | string | Footer text |
|
||||
| ↳ `footer_icon` | string | Footer icon URL |
|
||||
| ↳ `ts` | string | Timestamp shown in footer |
|
||||
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||
| ↳ `block_id` | string | Unique block identifier |
|
||||
| ↳ `edited` | object | Edit information if message was edited |
|
||||
| ↳ `user` | string | User ID who edited the message |
|
||||
| ↳ `ts` | string | Timestamp of the edit |
|
||||
| `replies` | array | Array of reply messages in the thread \(excluding the parent\) |
|
||||
| ↳ `ts` | string | Message timestamp |
|
||||
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||
| ↳ `text` | string | Message text content |
|
||||
| ↳ `user` | string | User ID who sent the reply |
|
||||
| ↳ `reactions` | array | Reactions on the reply |
|
||||
| ↳ `files` | array | Files attached to the reply |
|
||||
| ↳ `user` | string | User ID who sent the message |
|
||||
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||
| ↳ `username` | string | Display username |
|
||||
| ↳ `channel` | string | Channel ID |
|
||||
| ↳ `team` | string | Team/workspace ID |
|
||||
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||
| ↳ `last_read` | string | Timestamp of last read message |
|
||||
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||
| ↳ `permalink` | string | Permanent URL to the message |
|
||||
| ↳ `reactions` | array | Reactions on this message |
|
||||
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||
| ↳ `count` | number | Number of times this reaction was added |
|
||||
| ↳ `users` | array | Array of user IDs who reacted |
|
||||
| ↳ `files` | array | Files attached to the message |
|
||||
| ↳ `id` | string | Unique file identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimetype` | string | MIME type of the file |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||
| ↳ `permalink` | string | Permanent link to the file |
|
||||
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||
| ↳ `id` | number | Attachment ID |
|
||||
| ↳ `fallback` | string | Plain text summary |
|
||||
| ↳ `text` | string | Main attachment text |
|
||||
| ↳ `pretext` | string | Text shown before attachment |
|
||||
| ↳ `color` | string | Color bar hex code or preset |
|
||||
| ↳ `author_name` | string | Author display name |
|
||||
| ↳ `author_link` | string | Author link URL |
|
||||
| ↳ `author_icon` | string | Author icon URL |
|
||||
| ↳ `title` | string | Attachment title |
|
||||
| ↳ `title_link` | string | Title link URL |
|
||||
| ↳ `image_url` | string | Image URL |
|
||||
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||
| ↳ `footer` | string | Footer text |
|
||||
| ↳ `footer_icon` | string | Footer icon URL |
|
||||
| ↳ `ts` | string | Timestamp shown in footer |
|
||||
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||
| ↳ `block_id` | string | Unique block identifier |
|
||||
| ↳ `edited` | object | Edit information if message was edited |
|
||||
| ↳ `user` | string | User ID who edited the message |
|
||||
| ↳ `ts` | string | Timestamp of the edit |
|
||||
| `messages` | array | All messages in the thread \(parent + replies\) in chronological order |
|
||||
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||
| ↳ `text` | string | Message text content |
|
||||
| ↳ `user` | string | User ID who sent the message |
|
||||
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||
| ↳ `username` | string | Display username |
|
||||
| ↳ `channel` | string | Channel ID |
|
||||
| ↳ `team` | string | Team/workspace ID |
|
||||
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||
| ↳ `last_read` | string | Timestamp of last read message |
|
||||
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||
| ↳ `permalink` | string | Permanent URL to the message |
|
||||
| ↳ `reactions` | array | Reactions on this message |
|
||||
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||
| ↳ `count` | number | Number of times this reaction was added |
|
||||
| ↳ `users` | array | Array of user IDs who reacted |
|
||||
| ↳ `files` | array | Files attached to the message |
|
||||
| ↳ `id` | string | Unique file identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimetype` | string | MIME type of the file |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||
| ↳ `permalink` | string | Permanent link to the file |
|
||||
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||
| ↳ `id` | number | Attachment ID |
|
||||
| ↳ `fallback` | string | Plain text summary |
|
||||
| ↳ `text` | string | Main attachment text |
|
||||
| ↳ `pretext` | string | Text shown before attachment |
|
||||
| ↳ `color` | string | Color bar hex code or preset |
|
||||
| ↳ `author_name` | string | Author display name |
|
||||
| ↳ `author_link` | string | Author link URL |
|
||||
| ↳ `author_icon` | string | Author icon URL |
|
||||
| ↳ `title` | string | Attachment title |
|
||||
| ↳ `title_link` | string | Title link URL |
|
||||
| ↳ `image_url` | string | Image URL |
|
||||
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||
| ↳ `footer` | string | Footer text |
|
||||
| ↳ `footer_icon` | string | Footer icon URL |
|
||||
| ↳ `ts` | string | Timestamp shown in footer |
|
||||
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||
| ↳ `block_id` | string | Unique block identifier |
|
||||
| ↳ `edited` | object | Edit information if message was edited |
|
||||
| ↳ `user` | string | User ID who edited the message |
|
||||
| ↳ `ts` | string | Timestamp of the edit |
|
||||
| `replyCount` | number | Number of replies returned in this response |
|
||||
| `hasMore` | boolean | Whether there are more messages in the thread \(pagination needed\) |
|
||||
|
||||
@@ -325,14 +535,20 @@ List all channels in a Slack workspace. Returns public and private channels the
|
||||
| `channels` | array | Array of channel objects from the workspace |
|
||||
| ↳ `id` | string | Channel ID \(e.g., C1234567890\) |
|
||||
| ↳ `name` | string | Channel name without # prefix |
|
||||
| ↳ `is_private` | boolean | Whether the channel is private |
|
||||
| ↳ `is_archived` | boolean | Whether the channel is archived |
|
||||
| ↳ `is_member` | boolean | Whether the bot is a member of the channel |
|
||||
| ↳ `is_channel` | boolean | Whether this is a channel |
|
||||
| ↳ `is_private` | boolean | Whether channel is private |
|
||||
| ↳ `is_archived` | boolean | Whether channel is archived |
|
||||
| ↳ `is_general` | boolean | Whether this is the general channel |
|
||||
| ↳ `is_member` | boolean | Whether the bot/user is a member |
|
||||
| ↳ `is_shared` | boolean | Whether channel is shared across workspaces |
|
||||
| ↳ `is_ext_shared` | boolean | Whether channel is externally shared |
|
||||
| ↳ `is_org_shared` | boolean | Whether channel is org-wide shared |
|
||||
| ↳ `num_members` | number | Number of members in the channel |
|
||||
| ↳ `topic` | string | Channel topic |
|
||||
| ↳ `purpose` | string | Channel purpose/description |
|
||||
| ↳ `created` | number | Unix timestamp when channel was created |
|
||||
| ↳ `creator` | string | User ID of channel creator |
|
||||
| ↳ `updated` | number | Unix timestamp of last update |
|
||||
| `ids` | array | Array of channel IDs for easy access |
|
||||
| `names` | array | Array of channel names for easy access |
|
||||
| `count` | number | Total number of channels returned |
|
||||
@@ -408,7 +624,8 @@ Get detailed information about a specific Slack user by their user ID.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Detailed user information |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `id` | string | User ID \(e.g., U1234567890\) |
|
||||
| ↳ `team_id` | string | Workspace/team ID |
|
||||
| ↳ `name` | string | Username \(handle\) |
|
||||
| ↳ `real_name` | string | Full real name |
|
||||
| ↳ `display_name` | string | Display name shown in Slack |
|
||||
@@ -423,10 +640,14 @@ Get detailed information about a specific Slack user by their user ID.
|
||||
| ↳ `is_primary_owner` | boolean | Whether the user is the primary owner |
|
||||
| ↳ `is_restricted` | boolean | Whether the user is a guest \(restricted\) |
|
||||
| ↳ `is_ultra_restricted` | boolean | Whether the user is a single-channel guest |
|
||||
| ↳ `is_app_user` | boolean | Whether user is an app user |
|
||||
| ↳ `is_stranger` | boolean | Whether user is from different workspace |
|
||||
| ↳ `deleted` | boolean | Whether the user is deactivated |
|
||||
| ↳ `color` | string | User color for display |
|
||||
| ↳ `timezone` | string | Timezone identifier \(e.g., America/Los_Angeles\) |
|
||||
| ↳ `timezone_label` | string | Human-readable timezone label |
|
||||
| ↳ `timezone_offset` | number | Timezone offset in seconds from UTC |
|
||||
| ↳ `avatar` | string | URL to user avatar image |
|
||||
| ↳ `avatar_24` | string | URL to 24px avatar |
|
||||
| ↳ `avatar_48` | string | URL to 48px avatar |
|
||||
| ↳ `avatar_72` | string | URL to 72px avatar |
|
||||
@@ -436,6 +657,7 @@ Get detailed information about a specific Slack user by their user ID.
|
||||
| ↳ `status_emoji` | string | Custom status emoji |
|
||||
| ↳ `status_expiration` | number | Unix timestamp when status expires |
|
||||
| ↳ `updated` | number | Unix timestamp of last profile update |
|
||||
| ↳ `has_2fa` | boolean | Whether two-factor auth is enabled |
|
||||
|
||||
### `slack_download`
|
||||
|
||||
@@ -475,6 +697,60 @@ Update a message previously sent by the bot in Slack
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | object | Complete updated message object with all properties returned by Slack |
|
||||
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||
| ↳ `text` | string | Message text content |
|
||||
| ↳ `user` | string | User ID who sent the message |
|
||||
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||
| ↳ `username` | string | Display username |
|
||||
| ↳ `channel` | string | Channel ID |
|
||||
| ↳ `team` | string | Team/workspace ID |
|
||||
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||
| ↳ `last_read` | string | Timestamp of last read message |
|
||||
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||
| ↳ `permalink` | string | Permanent URL to the message |
|
||||
| ↳ `reactions` | array | Reactions on this message |
|
||||
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||
| ↳ `count` | number | Number of times this reaction was added |
|
||||
| ↳ `users` | array | Array of user IDs who reacted |
|
||||
| ↳ `files` | array | Files attached to the message |
|
||||
| ↳ `id` | string | Unique file identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimetype` | string | MIME type of the file |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||
| ↳ `permalink` | string | Permanent link to the file |
|
||||
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||
| ↳ `id` | number | Attachment ID |
|
||||
| ↳ `fallback` | string | Plain text summary |
|
||||
| ↳ `text` | string | Main attachment text |
|
||||
| ↳ `pretext` | string | Text shown before attachment |
|
||||
| ↳ `color` | string | Color bar hex code or preset |
|
||||
| ↳ `author_name` | string | Author display name |
|
||||
| ↳ `author_link` | string | Author link URL |
|
||||
| ↳ `author_icon` | string | Author icon URL |
|
||||
| ↳ `title` | string | Attachment title |
|
||||
| ↳ `title_link` | string | Title link URL |
|
||||
| ↳ `image_url` | string | Image URL |
|
||||
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||
| ↳ `footer` | string | Footer text |
|
||||
| ↳ `footer_icon` | string | Footer icon URL |
|
||||
| ↳ `ts` | string | Timestamp shown in footer |
|
||||
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||
| ↳ `block_id` | string | Unique block identifier |
|
||||
| ↳ `edited` | object | Edit information if message was edited |
|
||||
| ↳ `user` | string | User ID who edited the message |
|
||||
| ↳ `ts` | string | Timestamp of the edit |
|
||||
| `content` | string | Success message |
|
||||
| `metadata` | object | Updated message metadata |
|
||||
| ↳ `channel` | string | Channel ID |
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -79,16 +79,19 @@ Run an autonomous web agent to complete tasks and extract structured data
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `agentResult` | object | Result from the Stagehand agent execution |
|
||||
| ↳ `success` | boolean | Whether the agent task completed successfully |
|
||||
| ↳ `completed` | boolean | Whether the task was fully completed |
|
||||
| ↳ `message` | string | Status message or final result |
|
||||
| ↳ `actions` | array | Type of action performed |
|
||||
| ↳ `type` | string | Type of action performed |
|
||||
| ↳ `params` | object | Parameters used for the action |
|
||||
| ↳ `result` | object | Result of the action |
|
||||
| ↳ `type` | string | Type of action performed |
|
||||
| ↳ `params` | object | Parameters used for the action |
|
||||
| ↳ `result` | object | Result of the action |
|
||||
| ↳ `success` | boolean | Whether the agent task completed successfully without errors |
|
||||
| ↳ `completed` | boolean | Whether the agent finished executing \(may be false if max steps reached\) |
|
||||
| ↳ `message` | string | Final status message or result summary from the agent |
|
||||
| ↳ `actions` | array | List of all actions performed by the agent during task execution |
|
||||
| ↳ `type` | string | Type of action performed \(e.g., "act", "observe", "ariaTree", "close", "wait", "navigate"\) |
|
||||
| ↳ `reasoning` | string | AI reasoning for why this action was taken |
|
||||
| ↳ `taskCompleted` | boolean | Whether the task was completed after this action |
|
||||
| ↳ `action` | string | Description of the action taken \(e.g., "click the submit button"\) |
|
||||
| ↳ `instruction` | string | Instruction that triggered this action |
|
||||
| ↳ `pageUrl` | string | URL of the page when this action was performed |
|
||||
| ↳ `pageText` | string | Page text content \(for ariaTree actions\) |
|
||||
| ↳ `timestamp` | number | Unix timestamp when the action was performed |
|
||||
| ↳ `timeMs` | number | Time in milliseconds \(for wait actions\) |
|
||||
| `structuredOutput` | object | Extracted data matching the provided output schema |
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -74,6 +74,11 @@ Transcribe audio to text using OpenAI Whisper
|
||||
| --------- | ---- | ----------- |
|
||||
| `transcript` | string | Full transcribed text |
|
||||
| `segments` | array | Timestamped segments |
|
||||
| ↳ `text` | string | Transcribed text for this segment |
|
||||
| ↳ `start` | number | Start time in seconds |
|
||||
| ↳ `end` | number | End time in seconds |
|
||||
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
|
||||
| ↳ `confidence` | number | Confidence score \(0-1\) |
|
||||
| `language` | string | Detected or specified language |
|
||||
| `duration` | number | Audio duration in seconds |
|
||||
|
||||
@@ -101,6 +106,11 @@ Transcribe audio to text using Deepgram
|
||||
| --------- | ---- | ----------- |
|
||||
| `transcript` | string | Full transcribed text |
|
||||
| `segments` | array | Timestamped segments with speaker labels |
|
||||
| ↳ `text` | string | Transcribed text for this segment |
|
||||
| ↳ `start` | number | Start time in seconds |
|
||||
| ↳ `end` | number | End time in seconds |
|
||||
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
|
||||
| ↳ `confidence` | number | Confidence score \(0-1\) |
|
||||
| `language` | string | Detected or specified language |
|
||||
| `duration` | number | Audio duration in seconds |
|
||||
| `confidence` | number | Overall confidence score |
|
||||
@@ -160,11 +170,25 @@ Transcribe audio to text using AssemblyAI with advanced NLP features
|
||||
| --------- | ---- | ----------- |
|
||||
| `transcript` | string | Full transcribed text |
|
||||
| `segments` | array | Timestamped segments with speaker labels |
|
||||
| ↳ `text` | string | Transcribed text for this segment |
|
||||
| ↳ `start` | number | Start time in seconds |
|
||||
| ↳ `end` | number | End time in seconds |
|
||||
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
|
||||
| ↳ `confidence` | number | Confidence score \(0-1\) |
|
||||
| `language` | string | Detected or specified language |
|
||||
| `duration` | number | Audio duration in seconds |
|
||||
| `confidence` | number | Overall confidence score |
|
||||
| `sentiment` | array | Sentiment analysis results |
|
||||
| ↳ `text` | string | Text that was analyzed |
|
||||
| ↳ `sentiment` | string | Sentiment \(POSITIVE, NEGATIVE, NEUTRAL\) |
|
||||
| ↳ `confidence` | number | Confidence score |
|
||||
| ↳ `start` | number | Start time in milliseconds |
|
||||
| ↳ `end` | number | End time in milliseconds |
|
||||
| `entities` | array | Detected entities |
|
||||
| ↳ `entity_type` | string | Entity type \(e.g., person_name, location, organization\) |
|
||||
| ↳ `text` | string | Entity text |
|
||||
| ↳ `start` | number | Start time in milliseconds |
|
||||
| ↳ `end` | number | End time in milliseconds |
|
||||
| `summary` | string | Auto-generated summary |
|
||||
|
||||
### `stt_gemini`
|
||||
|
||||
@@ -282,9 +282,24 @@ Introspect Supabase database schema to get table structures, columns, and relati
|
||||
| ↳ `name` | string | Table name |
|
||||
| ↳ `schema` | string | Database schema name |
|
||||
| ↳ `columns` | array | Array of column definitions |
|
||||
| ↳ `name` | string | Column name |
|
||||
| ↳ `type` | string | Column data type |
|
||||
| ↳ `nullable` | boolean | Whether the column allows null values |
|
||||
| ↳ `default` | string | Default value for the column |
|
||||
| ↳ `isPrimaryKey` | boolean | Whether the column is a primary key |
|
||||
| ↳ `isForeignKey` | boolean | Whether the column is a foreign key |
|
||||
| ↳ `references` | object | Foreign key reference details |
|
||||
| ↳ `table` | string | Referenced table name |
|
||||
| ↳ `column` | string | Referenced column name |
|
||||
| ↳ `primaryKey` | array | Array of primary key column names |
|
||||
| ↳ `foreignKeys` | array | Array of foreign key relationships |
|
||||
| ↳ `column` | string | Local column name |
|
||||
| ↳ `referencesTable` | string | Referenced table name |
|
||||
| ↳ `referencesColumn` | string | Referenced column name |
|
||||
| ↳ `indexes` | array | Array of index definitions |
|
||||
| ↳ `name` | string | Index name |
|
||||
| ↳ `columns` | array | Columns included in the index |
|
||||
| ↳ `unique` | boolean | Whether the index enforces uniqueness |
|
||||
| `schemas` | array | List of schemas found in the database |
|
||||
|
||||
### `supabase_storage_upload`
|
||||
@@ -299,7 +314,7 @@ Upload a file to a Supabase storage bucket
|
||||
| `bucket` | string | Yes | The name of the storage bucket |
|
||||
| `fileName` | string | Yes | The name of the file \(e.g., "document.pdf", "image.jpg"\) |
|
||||
| `path` | string | No | Optional folder path \(e.g., "folder/subfolder/"\) |
|
||||
| `fileContent` | string | Yes | The file content \(base64 encoded for binary files, or plain text\) |
|
||||
| `fileData` | json | Yes | File to upload - UserFile object \(basic mode\) or string content \(advanced mode: base64 or plain text\). Supports data URLs. |
|
||||
| `contentType` | string | No | MIME type of the file \(e.g., "image/jpeg", "text/plain"\) |
|
||||
| `upsert` | boolean | No | If true, overwrites existing file \(default: false\) |
|
||||
| `apiKey` | string | Yes | Your Supabase service role secret key |
|
||||
@@ -309,7 +324,10 @@ Upload a file to a Supabase storage bucket
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `results` | object | Upload result including file path and metadata |
|
||||
| `results` | object | Upload result including file path, bucket, and public URL |
|
||||
| ↳ `id` | string | Unique identifier for the uploaded file |
|
||||
| ↳ `path` | string | Path to the uploaded file within the bucket |
|
||||
| ↳ `fullPath` | string | Full path including bucket name |
|
||||
|
||||
### `supabase_storage_download`
|
||||
|
||||
@@ -355,6 +373,19 @@ List files in a Supabase storage bucket
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `results` | array | Array of file objects with metadata |
|
||||
| ↳ `id` | string | Unique file identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `bucket_id` | string | Bucket identifier the file belongs to |
|
||||
| ↳ `owner` | string | Owner identifier |
|
||||
| ↳ `created_at` | string | File creation timestamp |
|
||||
| ↳ `updated_at` | string | Last update timestamp |
|
||||
| ↳ `last_accessed_at` | string | Last access timestamp |
|
||||
| ↳ `metadata` | object | File metadata including size and MIME type |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `mimetype` | string | MIME type of the file |
|
||||
| ↳ `cacheControl` | string | Cache control header value |
|
||||
| ↳ `lastModified` | string | Last modified timestamp |
|
||||
| ↳ `eTag` | string | Entity tag for caching |
|
||||
|
||||
### `supabase_storage_delete`
|
||||
|
||||
@@ -375,6 +406,13 @@ Delete files from a Supabase storage bucket
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `results` | array | Array of deleted file objects |
|
||||
| ↳ `name` | string | Name of the deleted file |
|
||||
| ↳ `bucket_id` | string | Bucket identifier |
|
||||
| ↳ `owner` | string | Owner identifier |
|
||||
| ↳ `id` | string | Unique file identifier |
|
||||
| ↳ `updated_at` | string | Last update timestamp |
|
||||
| ↳ `created_at` | string | File creation timestamp |
|
||||
| ↳ `last_accessed_at` | string | Last access timestamp |
|
||||
|
||||
### `supabase_storage_move`
|
||||
|
||||
@@ -396,6 +434,7 @@ Move a file within a Supabase storage bucket
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `results` | object | Move operation result |
|
||||
| ↳ `message` | string | Operation status message |
|
||||
|
||||
### `supabase_storage_copy`
|
||||
|
||||
@@ -417,6 +456,7 @@ Copy a file within a Supabase storage bucket
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `results` | object | Copy operation result |
|
||||
| ↳ `message` | string | Operation status message |
|
||||
|
||||
### `supabase_storage_create_bucket`
|
||||
|
||||
@@ -439,6 +479,7 @@ Create a new storage bucket in Supabase
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `results` | object | Created bucket information |
|
||||
| ↳ `name` | string | Created bucket name |
|
||||
|
||||
### `supabase_storage_list_buckets`
|
||||
|
||||
@@ -457,6 +498,14 @@ List all storage buckets in Supabase
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `results` | array | Array of bucket objects |
|
||||
| ↳ `id` | string | Unique bucket identifier |
|
||||
| ↳ `name` | string | Bucket name |
|
||||
| ↳ `owner` | string | Owner identifier |
|
||||
| ↳ `public` | boolean | Whether the bucket is publicly accessible |
|
||||
| ↳ `created_at` | string | Bucket creation timestamp |
|
||||
| ↳ `updated_at` | string | Last update timestamp |
|
||||
| ↳ `file_size_limit` | number | Maximum file size allowed in bytes |
|
||||
| ↳ `allowed_mime_types` | array | List of allowed MIME types for uploads |
|
||||
|
||||
### `supabase_storage_delete_bucket`
|
||||
|
||||
@@ -476,6 +525,7 @@ Delete a storage bucket in Supabase
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `results` | object | Delete operation result |
|
||||
| ↳ `message` | string | Operation status message |
|
||||
|
||||
### `supabase_storage_get_public_url`
|
||||
|
||||
|
||||
@@ -65,9 +65,17 @@ Perform AI-powered web searches using Tavily
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `query` | string | The search query that was executed |
|
||||
| `results` | array | Search results with titles, URLs, content snippets, and optional metadata |
|
||||
| `results` | array | Ranked search results with titles, URLs, content snippets, and optional metadata |
|
||||
| ↳ `title` | string | Result title |
|
||||
| ↳ `url` | string | Result URL |
|
||||
| ↳ `content` | string | Brief description or content snippet |
|
||||
| ↳ `score` | number | Relevance score |
|
||||
| ↳ `raw_content` | string | Full parsed HTML content \(if requested\) |
|
||||
| ↳ `favicon` | string | Favicon URL for the domain |
|
||||
| `answer` | string | LLM-generated answer to the query \(if requested\) |
|
||||
| `images` | array | Query-related images \(if requested\) |
|
||||
| ↳ `url` | string | Image URL |
|
||||
| ↳ `description` | string | Image description |
|
||||
| `auto_parameters` | object | Automatically selected parameters based on query intent \(if enabled\) |
|
||||
| `response_time` | number | Time taken for the search request in seconds |
|
||||
|
||||
@@ -90,13 +98,14 @@ Extract raw content from multiple web pages simultaneously using Tavily
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | The URL that was extracted |
|
||||
| ↳ `url` | string | The URL that was extracted |
|
||||
| ↳ `raw_content` | string | The raw text content from the webpage |
|
||||
| ↳ `favicon` | string | Favicon URL \(if requested\) |
|
||||
| `failed_results` | array | The URL that failed extraction |
|
||||
| `results` | array | Successfully extracted content from URLs |
|
||||
| ↳ `url` | string | The source URL |
|
||||
| ↳ `raw_content` | string | Full extracted content from the page |
|
||||
| ↳ `images` | array | Image URLs \(when include_images is true\) |
|
||||
| ↳ `favicon` | string | Favicon URL for the result |
|
||||
| `failed_results` | array | URLs that failed to extract content |
|
||||
| ↳ `url` | string | The URL that failed extraction |
|
||||
| ↳ `error` | string | Error message for the failed extraction |
|
||||
| ↳ `error` | string | Error message describing why extraction failed |
|
||||
| `response_time` | number | Time taken for the extraction request in seconds |
|
||||
|
||||
### `tavily_crawl`
|
||||
@@ -128,10 +137,10 @@ Systematically crawl and extract content from websites using Tavily
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `base_url` | string | The base URL that was crawled |
|
||||
| `results` | array | The crawled page URL |
|
||||
| `results` | array | Array of crawled pages with extracted content |
|
||||
| ↳ `url` | string | The crawled page URL |
|
||||
| ↳ `raw_content` | string | Extracted content from the page |
|
||||
| ↳ `favicon` | string | Favicon URL \(if requested\) |
|
||||
| ↳ `raw_content` | string | Full extracted page content |
|
||||
| ↳ `favicon` | string | Favicon URL for the result |
|
||||
| `response_time` | number | Time taken for the crawl request in seconds |
|
||||
| `request_id` | string | Unique identifier for support reference |
|
||||
|
||||
@@ -160,7 +169,7 @@ Discover and visualize website structure using Tavily
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `base_url` | string | The base URL that was mapped |
|
||||
| `results` | array | Discovered URL |
|
||||
| `results` | array | Array of discovered URLs during mapping |
|
||||
| ↳ `url` | string | Discovered URL |
|
||||
| `response_time` | number | Time taken for the map request in seconds |
|
||||
| `request_id` | string | Unique identifier for support reference |
|
||||
|
||||
@@ -82,16 +82,11 @@ Send messages to Telegram channels or users through the Telegram Bot API. Enable
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Chat username \(if available\) |
|
||||
| ↳ `username` | string | Chat title \(for groups and channels\) |
|
||||
| ↳ `id` | number | Bot user ID |
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Bot first name |
|
||||
| ↳ `username` | string | Bot username |
|
||||
| ↳ `chat` | object | Information about the bot that sent the message |
|
||||
| ↳ `id` | number | Bot user ID |
|
||||
| ↳ `first_name` | string | Bot first name |
|
||||
| ↳ `username` | string | Bot username |
|
||||
| ↳ `type` | string | chat type private or channel |
|
||||
| ↳ `type` | string | chat type private or channel |
|
||||
| ↳ `date` | number | Unix timestamp when message was sent |
|
||||
| ↳ `text` | string | Text content of the sent message |
|
||||
|
||||
@@ -141,16 +136,11 @@ Send photos to Telegram channels or users through the Telegram Bot API.
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Chat username \(if available\) |
|
||||
| ↳ `username` | string | Chat title \(for groups and channels\) |
|
||||
| ↳ `id` | number | Bot user ID |
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Bot first name |
|
||||
| ↳ `username` | string | Bot username |
|
||||
| ↳ `chat` | object | Information about the bot that sent the message |
|
||||
| ↳ `id` | number | Bot user ID |
|
||||
| ↳ `first_name` | string | Bot first name |
|
||||
| ↳ `username` | string | Bot username |
|
||||
| ↳ `type` | string | Chat type \(private, group, supergroup, channel\) |
|
||||
| ↳ `type` | string | Chat type \(private, group, supergroup, channel\) |
|
||||
| ↳ `date` | number | Unix timestamp when message was sent |
|
||||
| ↳ `text` | string | Text content of the sent message \(if applicable\) |
|
||||
| ↳ `photo` | array | List of photos included in the message |
|
||||
@@ -159,11 +149,6 @@ Send photos to Telegram channels or users through the Telegram Bot API.
|
||||
| ↳ `file_size` | number | Size of the photo file in bytes |
|
||||
| ↳ `width` | number | Photo width in pixels |
|
||||
| ↳ `height` | number | Photo height in pixels |
|
||||
| ↳ `file_id` | string | Unique file ID of the photo |
|
||||
| ↳ `file_unique_id` | string | Unique identifier for this file across different bots |
|
||||
| ↳ `file_size` | number | Size of the photo file in bytes |
|
||||
| ↳ `width` | number | Photo width in pixels |
|
||||
| ↳ `height` | number | Photo height in pixels |
|
||||
|
||||
### `telegram_send_video`
|
||||
|
||||
@@ -188,27 +173,28 @@ Send videos to Telegram channels or users through the Telegram Bot API.
|
||||
| ↳ `from` | object | Information about the sender |
|
||||
| ↳ `id` | number | Sender ID |
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Sender |
|
||||
| ↳ `username` | string | Sender |
|
||||
| ↳ `id` | number | Chat ID |
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Chat first name \(if private chat\) |
|
||||
| ↳ `username` | string | Chat username \(for private or channels\) |
|
||||
| ↳ `first_name` | string | Sender's first name \(if available\) |
|
||||
| ↳ `username` | string | Sender's username \(if available\) |
|
||||
| ↳ `chat` | object | Information about the chat where message was sent |
|
||||
| ↳ `id` | number | Chat ID |
|
||||
| ↳ `first_name` | string | Chat first name \(if private chat\) |
|
||||
| ↳ `username` | string | Chat username \(for private or channels\) |
|
||||
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
|
||||
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
|
||||
| ↳ `date` | number | Unix timestamp when the message was sent |
|
||||
| ↳ `text` | string | Text content of the sent message \(if applicable\) |
|
||||
| ↳ `format` | object | Media format information \(for videos, GIFs, etc.\) |
|
||||
| ↳ `file_name` | string | Media file name |
|
||||
| ↳ `mime_type` | string | Media MIME type |
|
||||
| ↳ `duration` | number | Duration of media in seconds |
|
||||
| ↳ `width` | number | Media width in pixels |
|
||||
| ↳ `height` | number | Media height in pixels |
|
||||
| ↳ `thumbnail` | object | Thumbnail image details |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `thumbnail` | object | Thumbnail image details |
|
||||
| ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
@@ -217,32 +203,6 @@ Send videos to Telegram channels or users through the Telegram Bot API.
|
||||
| ↳ `file_id` | string | Media file ID |
|
||||
| ↳ `file_unique_id` | string | Unique media file identifier |
|
||||
| ↳ `file_size` | number | Size of media file in bytes |
|
||||
| ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `file_name` | string | Document file name |
|
||||
| ↳ `mime_type` | string | Document MIME type |
|
||||
| ↳ `duration` | number | Duration of media in seconds |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `thumbnail` | object | Document thumbnail information |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `file_id` | string | Document file ID |
|
||||
| ↳ `file_unique_id` | string | Unique document file identifier |
|
||||
| ↳ `file_size` | number | Size of document file in bytes |
|
||||
| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `document` | object | Document file details if the message contains a document |
|
||||
| ↳ `file_name` | string | Document file name |
|
||||
| ↳ `mime_type` | string | Document MIME type |
|
||||
@@ -252,17 +212,15 @@ Send videos to Telegram channels or users through the Telegram Bot API.
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `file_id` | string | Document file ID |
|
||||
| ↳ `file_unique_id` | string | Unique document file identifier |
|
||||
| ↳ `file_size` | number | Size of document file in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `file_id` | string | Document file ID |
|
||||
| ↳ `file_unique_id` | string | Unique document file identifier |
|
||||
| ↳ `file_size` | number | Size of document file in bytes |
|
||||
|
||||
### `telegram_send_audio`
|
||||
|
||||
@@ -287,18 +245,13 @@ Send audio files to Telegram channels or users through the Telegram Bot API.
|
||||
| ↳ `from` | object | Information about the sender |
|
||||
| ↳ `id` | number | Sender ID |
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Sender |
|
||||
| ↳ `username` | string | Sender |
|
||||
| ↳ `id` | number | Chat ID |
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Chat first name \(if private chat\) |
|
||||
| ↳ `username` | string | Chat username \(for private or channels\) |
|
||||
| ↳ `first_name` | string | Sender's first name \(if available\) |
|
||||
| ↳ `username` | string | Sender's username \(if available\) |
|
||||
| ↳ `chat` | object | Information about the chat where the message was sent |
|
||||
| ↳ `id` | number | Chat ID |
|
||||
| ↳ `first_name` | string | Chat first name \(if private chat\) |
|
||||
| ↳ `username` | string | Chat username \(for private or channels\) |
|
||||
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
|
||||
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
|
||||
| ↳ `date` | number | Unix timestamp when the message was sent |
|
||||
| ↳ `text` | string | Text content of the sent message \(if applicable\) |
|
||||
| ↳ `audio` | object | Audio file details |
|
||||
@@ -310,14 +263,6 @@ Send audio files to Telegram channels or users through the Telegram Bot API.
|
||||
| ↳ `file_id` | string | Unique file identifier for this audio |
|
||||
| ↳ `file_unique_id` | string | Unique identifier across different bots for this file |
|
||||
| ↳ `file_size` | number | Size of the audio file in bytes |
|
||||
| ↳ `duration` | number | Duration of the audio in seconds |
|
||||
| ↳ `performer` | string | Performer of the audio |
|
||||
| ↳ `title` | string | Title of the audio |
|
||||
| ↳ `file_name` | string | Original filename of the audio |
|
||||
| ↳ `mime_type` | string | MIME type of the audio file |
|
||||
| ↳ `file_id` | string | Unique file identifier for this audio |
|
||||
| ↳ `file_unique_id` | string | Unique identifier across different bots for this file |
|
||||
| ↳ `file_size` | number | Size of the audio file in bytes |
|
||||
|
||||
### `telegram_send_animation`
|
||||
|
||||
@@ -342,27 +287,28 @@ Send animations (GIFs) to Telegram channels or users through the Telegram Bot AP
|
||||
| ↳ `from` | object | Information about the sender |
|
||||
| ↳ `id` | number | Sender ID |
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Sender |
|
||||
| ↳ `username` | string | Sender |
|
||||
| ↳ `id` | number | Chat ID |
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Chat first name \(if private chat\) |
|
||||
| ↳ `username` | string | Chat username \(for private or channels\) |
|
||||
| ↳ `first_name` | string | Sender's first name \(if available\) |
|
||||
| ↳ `username` | string | Sender's username \(if available\) |
|
||||
| ↳ `chat` | object | Information about the chat where message was sent |
|
||||
| ↳ `id` | number | Chat ID |
|
||||
| ↳ `first_name` | string | Chat first name \(if private chat\) |
|
||||
| ↳ `username` | string | Chat username \(for private or channels\) |
|
||||
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
|
||||
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
|
||||
| ↳ `date` | number | Unix timestamp when the message was sent |
|
||||
| ↳ `text` | string | Text content of the sent message \(if applicable\) |
|
||||
| ↳ `format` | object | Media format information \(for videos, GIFs, etc.\) |
|
||||
| ↳ `file_name` | string | Media file name |
|
||||
| ↳ `mime_type` | string | Media MIME type |
|
||||
| ↳ `duration` | number | Duration of media in seconds |
|
||||
| ↳ `width` | number | Media width in pixels |
|
||||
| ↳ `height` | number | Media height in pixels |
|
||||
| ↳ `thumbnail` | object | Thumbnail image details |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `thumbnail` | object | Thumbnail image details |
|
||||
| ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
@@ -371,32 +317,6 @@ Send animations (GIFs) to Telegram channels or users through the Telegram Bot AP
|
||||
| ↳ `file_id` | string | Media file ID |
|
||||
| ↳ `file_unique_id` | string | Unique media file identifier |
|
||||
| ↳ `file_size` | number | Size of media file in bytes |
|
||||
| ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `file_name` | string | Document file name |
|
||||
| ↳ `mime_type` | string | Document MIME type |
|
||||
| ↳ `duration` | number | Duration of media in seconds |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `thumbnail` | object | Document thumbnail information |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `file_id` | string | Document file ID |
|
||||
| ↳ `file_unique_id` | string | Unique document file identifier |
|
||||
| ↳ `file_size` | number | Size of document file in bytes |
|
||||
| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `document` | object | Document file details if the message contains a document |
|
||||
| ↳ `file_name` | string | Document file name |
|
||||
| ↳ `mime_type` | string | Document MIME type |
|
||||
@@ -406,17 +326,15 @@ Send animations (GIFs) to Telegram channels or users through the Telegram Bot AP
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `file_id` | string | Document file ID |
|
||||
| ↳ `file_unique_id` | string | Unique document file identifier |
|
||||
| ↳ `file_size` | number | Size of document file in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) |
|
||||
| ↳ `file_id` | string | Thumbnail file ID |
|
||||
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
|
||||
| ↳ `file_size` | number | Thumbnail file size in bytes |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `file_id` | string | Document file ID |
|
||||
| ↳ `file_unique_id` | string | Unique document file identifier |
|
||||
| ↳ `file_size` | number | Size of document file in bytes |
|
||||
|
||||
### `telegram_send_document`
|
||||
|
||||
@@ -441,18 +359,13 @@ Send documents (PDF, ZIP, DOC, etc.) to Telegram channels or users through the T
|
||||
| ↳ `from` | object | Information about the sender |
|
||||
| ↳ `id` | number | Sender ID |
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Sender |
|
||||
| ↳ `username` | string | Sender |
|
||||
| ↳ `id` | number | Chat ID |
|
||||
| ↳ `is_bot` | boolean | Whether the chat is a bot or not |
|
||||
| ↳ `first_name` | string | Chat first name \(if private chat\) |
|
||||
| ↳ `username` | string | Chat username \(for private or channels\) |
|
||||
| ↳ `first_name` | string | Sender's first name \(if available\) |
|
||||
| ↳ `username` | string | Sender's username \(if available\) |
|
||||
| ↳ `chat` | object | Information about the chat where message was sent |
|
||||
| ↳ `id` | number | Chat ID |
|
||||
| ↳ `first_name` | string | Chat first name \(if private chat\) |
|
||||
| ↳ `username` | string | Chat username \(for private or channels\) |
|
||||
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
|
||||
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
|
||||
| ↳ `date` | number | Unix timestamp when the message was sent |
|
||||
| ↳ `document` | object | Document file details |
|
||||
| ↳ `file_name` | string | Document file name |
|
||||
@@ -460,10 +373,5 @@ Send documents (PDF, ZIP, DOC, etc.) to Telegram channels or users through the T
|
||||
| ↳ `file_id` | string | Document file ID |
|
||||
| ↳ `file_unique_id` | string | Unique document file identifier |
|
||||
| ↳ `file_size` | number | Size of document file in bytes |
|
||||
| ↳ `file_name` | string | Document file name |
|
||||
| ↳ `mime_type` | string | Document MIME type |
|
||||
| ↳ `file_id` | string | Document file ID |
|
||||
| ↳ `file_unique_id` | string | Unique document file identifier |
|
||||
| ↳ `file_size` | number | Size of document file in bytes |
|
||||
|
||||
|
||||
|
||||
@@ -63,7 +63,7 @@ Parse documents using AWS Textract OCR and document analysis
|
||||
| `blocks` | array | Array of Block objects containing detected text, tables, forms, and other elements |
|
||||
| ↳ `BlockType` | string | Type of block \(PAGE, LINE, WORD, TABLE, CELL, KEY_VALUE_SET, etc.\) |
|
||||
| ↳ `Id` | string | Unique identifier for the block |
|
||||
| ↳ `Text` | string | Query text |
|
||||
| ↳ `Text` | string | The text content \(for LINE and WORD blocks\) |
|
||||
| ↳ `TextType` | string | Type of text \(PRINTED or HANDWRITING\) |
|
||||
| ↳ `Confidence` | number | Confidence score \(0-100\) |
|
||||
| ↳ `Page` | number | Page number |
|
||||
@@ -73,34 +73,12 @@ Parse documents using AWS Textract OCR and document analysis
|
||||
| ↳ `Left` | number | Left position as ratio of document width |
|
||||
| ↳ `Top` | number | Top position as ratio of document height |
|
||||
| ↳ `Width` | number | Width as ratio of document width |
|
||||
| ↳ `Height` | number | Height as ratio of document height |
|
||||
| ↳ `Left` | number | Left position as ratio of document width |
|
||||
| ↳ `Top` | number | Top position as ratio of document height |
|
||||
| ↳ `Width` | number | Width as ratio of document width |
|
||||
| ↳ `Polygon` | array | Polygon coordinates |
|
||||
| ↳ `X` | number | X coordinate |
|
||||
| ↳ `Y` | number | Y coordinate |
|
||||
| ↳ `X` | number | X coordinate |
|
||||
| ↳ `Y` | number | Y coordinate |
|
||||
| ↳ `BoundingBox` | object | Height as ratio of document height |
|
||||
| ↳ `Height` | number | Height as ratio of document height |
|
||||
| ↳ `Left` | number | Left position as ratio of document width |
|
||||
| ↳ `Top` | number | Top position as ratio of document height |
|
||||
| ↳ `Width` | number | Width as ratio of document width |
|
||||
| ↳ `Height` | number | Height as ratio of document height |
|
||||
| ↳ `Left` | number | Left position as ratio of document width |
|
||||
| ↳ `Top` | number | Top position as ratio of document height |
|
||||
| ↳ `Width` | number | Width as ratio of document width |
|
||||
| ↳ `Polygon` | array | Polygon coordinates |
|
||||
| ↳ `X` | number | X coordinate |
|
||||
| ↳ `Y` | number | Y coordinate |
|
||||
| ↳ `X` | number | X coordinate |
|
||||
| ↳ `Y` | number | Y coordinate |
|
||||
| ↳ `Relationships` | array | Relationships to other blocks |
|
||||
| ↳ `Type` | string | Relationship type \(CHILD, VALUE, ANSWER, etc.\) |
|
||||
| ↳ `Ids` | array | IDs of related blocks |
|
||||
| ↳ `Type` | string | Relationship type \(CHILD, VALUE, ANSWER, etc.\) |
|
||||
| ↳ `Ids` | array | IDs of related blocks |
|
||||
| ↳ `EntityTypes` | array | Entity types for KEY_VALUE_SET \(KEY or VALUE\) |
|
||||
| ↳ `SelectionStatus` | string | For checkboxes: SELECTED or NOT_SELECTED |
|
||||
| ↳ `RowIndex` | number | Row index for table cells |
|
||||
@@ -111,8 +89,6 @@ Parse documents using AWS Textract OCR and document analysis
|
||||
| ↳ `Text` | string | Query text |
|
||||
| ↳ `Alias` | string | Query alias |
|
||||
| ↳ `Pages` | array | Pages to search |
|
||||
| ↳ `Alias` | string | Query alias |
|
||||
| ↳ `Pages` | array | Pages to search |
|
||||
| `documentMetadata` | object | Metadata about the analyzed document |
|
||||
| ↳ `pages` | number | Number of pages in the document |
|
||||
| `modelVersion` | string | Version of the Textract model used for processing |
|
||||
|
||||
@@ -109,12 +109,6 @@ Retrieve insights and analytics for Typeform forms
|
||||
| ↳ `responses_count` | number | Number of responses from this platform |
|
||||
| ↳ `total_visits` | number | Total visits from this platform |
|
||||
| ↳ `unique_visits` | number | Unique visits from this platform |
|
||||
| ↳ `average_time` | number | Overall average completion time |
|
||||
| ↳ `completion_rate` | number | Overall completion rate |
|
||||
| ↳ `platform` | string | Platform name \(e.g., desktop, mobile\) |
|
||||
| ↳ `responses_count` | number | Total number of responses |
|
||||
| ↳ `total_visits` | number | Total number of visits |
|
||||
| ↳ `unique_visits` | number | Total number of unique visits |
|
||||
| ↳ `summary` | object | Overall average completion time |
|
||||
| ↳ `average_time` | number | Overall average completion time |
|
||||
| ↳ `completion_rate` | number | Overall completion rate |
|
||||
|
||||
@@ -56,9 +56,6 @@ Read content from a Wealthbox note
|
||||
| ↳ `itemId` | string | ID of the note |
|
||||
| ↳ `noteId` | string | ID of the note |
|
||||
| ↳ `itemType` | string | Type of item \(note\) |
|
||||
| ↳ `itemId` | string | ID of the note |
|
||||
| ↳ `noteId` | string | ID of the note |
|
||||
| ↳ `itemType` | string | Type of item \(note\) |
|
||||
|
||||
### `wealthbox_write_note`
|
||||
|
||||
@@ -83,9 +80,6 @@ Create or update a Wealthbox note
|
||||
| ↳ `itemId` | string | ID of the created/updated note |
|
||||
| ↳ `noteId` | string | ID of the created/updated note |
|
||||
| ↳ `itemType` | string | Type of item \(note\) |
|
||||
| ↳ `itemId` | string | ID of the created/updated note |
|
||||
| ↳ `noteId` | string | ID of the created/updated note |
|
||||
| ↳ `itemType` | string | Type of item \(note\) |
|
||||
|
||||
### `wealthbox_read_contact`
|
||||
|
||||
@@ -109,9 +103,6 @@ Read content from a Wealthbox contact
|
||||
| ↳ `itemId` | string | ID of the contact |
|
||||
| ↳ `contactId` | string | ID of the contact |
|
||||
| ↳ `itemType` | string | Type of item \(contact\) |
|
||||
| ↳ `itemId` | string | ID of the contact |
|
||||
| ↳ `contactId` | string | ID of the contact |
|
||||
| ↳ `itemType` | string | Type of item \(contact\) |
|
||||
|
||||
### `wealthbox_write_contact`
|
||||
|
||||
@@ -138,9 +129,6 @@ Create a new Wealthbox contact
|
||||
| ↳ `itemId` | string | ID of the created/updated contact |
|
||||
| ↳ `contactId` | string | ID of the created/updated contact |
|
||||
| ↳ `itemType` | string | Type of item \(contact\) |
|
||||
| ↳ `itemId` | string | ID of the created/updated contact |
|
||||
| ↳ `contactId` | string | ID of the created/updated contact |
|
||||
| ↳ `itemType` | string | Type of item \(contact\) |
|
||||
|
||||
### `wealthbox_read_task`
|
||||
|
||||
@@ -164,9 +152,6 @@ Read content from a Wealthbox task
|
||||
| ↳ `itemId` | string | ID of the task |
|
||||
| ↳ `taskId` | string | ID of the task |
|
||||
| ↳ `itemType` | string | Type of item \(task\) |
|
||||
| ↳ `itemId` | string | ID of the task |
|
||||
| ↳ `taskId` | string | ID of the task |
|
||||
| ↳ `itemType` | string | Type of item \(task\) |
|
||||
|
||||
### `wealthbox_write_task`
|
||||
|
||||
@@ -193,8 +178,5 @@ Create or update a Wealthbox task
|
||||
| ↳ `itemId` | string | ID of the created/updated task |
|
||||
| ↳ `taskId` | string | ID of the created/updated task |
|
||||
| ↳ `itemType` | string | Type of item \(task\) |
|
||||
| ↳ `itemId` | string | ID of the created/updated task |
|
||||
| ↳ `taskId` | string | ID of the created/updated task |
|
||||
| ↳ `itemType` | string | Type of item \(task\) |
|
||||
|
||||
|
||||
|
||||
@@ -51,8 +51,19 @@ List all items from a Webflow CMS collection
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | json | Array of collection items |
|
||||
| `metadata` | json | Metadata about the query |
|
||||
| `items` | array | Array of collection items |
|
||||
| ↳ `id` | string | Unique item ID |
|
||||
| ↳ `cmsLocaleId` | string | CMS locale ID |
|
||||
| ↳ `lastPublished` | string | Last published date \(ISO 8601\) |
|
||||
| ↳ `lastUpdated` | string | Last updated date \(ISO 8601\) |
|
||||
| ↳ `createdOn` | string | Creation date \(ISO 8601\) |
|
||||
| ↳ `isArchived` | boolean | Whether the item is archived |
|
||||
| ↳ `isDraft` | boolean | Whether the item is a draft |
|
||||
| ↳ `fieldData` | object | Collection-specific field data \(varies by collection schema\) |
|
||||
| `metadata` | object | Metadata about the query |
|
||||
| ↳ `itemCount` | number | Number of items returned |
|
||||
| ↳ `offset` | number | Pagination offset |
|
||||
| ↳ `limit` | number | Maximum items per page |
|
||||
|
||||
### `webflow_get_item`
|
||||
|
||||
|
||||
@@ -47,12 +47,39 @@ Get a summary and metadata for a specific Wikipedia page.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `summary` | object | Wikipedia page summary and metadata |
|
||||
| ↳ `type` | string | Page type \(standard, disambiguation, etc.\) |
|
||||
| ↳ `title` | string | Page title |
|
||||
| ↳ `extract` | string | Page extract/summary text |
|
||||
| ↳ `displaytitle` | string | Display title with formatting |
|
||||
| ↳ `description` | string | Short page description |
|
||||
| ↳ `extract` | string | Page extract/summary text |
|
||||
| ↳ `extract_html` | string | Extract in HTML format |
|
||||
| ↳ `thumbnail` | object | Thumbnail image data |
|
||||
| ↳ `source` | string | Thumbnail image URL |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `originalimage` | object | Original image data |
|
||||
| ↳ `source` | string | Thumbnail image URL |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `content_urls` | object | URLs to access the page |
|
||||
| ↳ `desktop` | object | Desktop URLs |
|
||||
| ↳ `page` | string | Page URL |
|
||||
| ↳ `revisions` | string | Revisions URL |
|
||||
| ↳ `edit` | string | Edit URL |
|
||||
| ↳ `talk` | string | Talk page URL |
|
||||
| ↳ `mobile` | object | Mobile URLs |
|
||||
| ↳ `page` | string | Page URL |
|
||||
| ↳ `revisions` | string | Revisions URL |
|
||||
| ↳ `edit` | string | Edit URL |
|
||||
| ↳ `talk` | string | Talk page URL |
|
||||
| ↳ `lang` | string | Page language code |
|
||||
| ↳ `dir` | string | Text direction \(ltr or rtl\) |
|
||||
| ↳ `timestamp` | string | Last modification timestamp |
|
||||
| ↳ `pageid` | number | Wikipedia page ID |
|
||||
| ↳ `wikibase_item` | string | Wikidata item ID |
|
||||
| ↳ `coordinates` | object | Geographic coordinates |
|
||||
| ↳ `lat` | number | Latitude |
|
||||
| ↳ `lon` | number | Longitude |
|
||||
|
||||
### `wikipedia_search`
|
||||
|
||||
@@ -70,6 +97,20 @@ Search for Wikipedia pages by title or content.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `searchResults` | array | Array of matching Wikipedia pages |
|
||||
| ↳ `id` | number | Result index |
|
||||
| ↳ `key` | string | URL-friendly page key |
|
||||
| ↳ `title` | string | Page title |
|
||||
| ↳ `excerpt` | string | Search result excerpt |
|
||||
| ↳ `matched_title` | string | Matched title variant |
|
||||
| ↳ `description` | string | Page description |
|
||||
| ↳ `thumbnail` | object | Thumbnail data |
|
||||
| ↳ `mimetype` | string | Image MIME type |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `width` | number | Width in pixels |
|
||||
| ↳ `height` | number | Height in pixels |
|
||||
| ↳ `duration` | number | Duration for video |
|
||||
| ↳ `url` | string | Thumbnail URL |
|
||||
| ↳ `url` | string | Page URL |
|
||||
| `totalHits` | number | Total number of search results found |
|
||||
| `query` | string | The search query that was executed |
|
||||
|
||||
@@ -92,7 +133,10 @@ Get the full HTML content of a Wikipedia page.
|
||||
| ↳ `pageid` | number | Wikipedia page ID |
|
||||
| ↳ `html` | string | Full HTML content of the page |
|
||||
| ↳ `revision` | number | Page revision number |
|
||||
| ↳ `tid` | string | Transaction ID \(ETag\) |
|
||||
| ↳ `timestamp` | string | Last modified timestamp |
|
||||
| ↳ `content_model` | string | Content model \(wikitext\) |
|
||||
| ↳ `content_format` | string | Content format \(text/html\) |
|
||||
|
||||
### `wikipedia_random`
|
||||
|
||||
@@ -108,10 +152,22 @@ Get a random Wikipedia page.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `randomPage` | object | Random Wikipedia page data |
|
||||
| ↳ `type` | string | Page type |
|
||||
| ↳ `title` | string | Page title |
|
||||
| ↳ `extract` | string | Page extract/summary |
|
||||
| ↳ `displaytitle` | string | Display title |
|
||||
| ↳ `description` | string | Page description |
|
||||
| ↳ `extract` | string | Page extract/summary |
|
||||
| ↳ `thumbnail` | object | Thumbnail image data |
|
||||
| ↳ `source` | string | Thumbnail image URL |
|
||||
| ↳ `width` | number | Thumbnail width in pixels |
|
||||
| ↳ `height` | number | Thumbnail height in pixels |
|
||||
| ↳ `content_urls` | object | URLs to access the page |
|
||||
| ↳ `desktop` | object | Desktop URL |
|
||||
| ↳ `page` | string | Page URL |
|
||||
| ↳ `mobile` | object | Mobile URL |
|
||||
| ↳ `page` | string | Page URL |
|
||||
| ↳ `lang` | string | Language code |
|
||||
| ↳ `timestamp` | string | Timestamp |
|
||||
| ↳ `pageid` | number | Page ID |
|
||||
|
||||
|
||||
|
||||
@@ -61,8 +61,6 @@ Post new tweets, reply to tweets, or create polls on X (Twitter)
|
||||
| ↳ `attachments` | object | Media or poll attachments |
|
||||
| ↳ `mediaKeys` | array | Media attachment keys |
|
||||
| ↳ `pollId` | string | Poll ID if poll attached |
|
||||
| ↳ `mediaKeys` | array | Media attachment keys |
|
||||
| ↳ `pollId` | string | Poll ID if poll attached |
|
||||
|
||||
### `x_read`
|
||||
|
||||
@@ -139,8 +137,5 @@ Get user profile information
|
||||
| ↳ `followersCount` | number | Number of followers |
|
||||
| ↳ `followingCount` | number | Number of users following |
|
||||
| ↳ `tweetCount` | number | Total number of tweets |
|
||||
| ↳ `followersCount` | number | Number of followers |
|
||||
| ↳ `followingCount` | number | Number of users following |
|
||||
| ↳ `tweetCount` | number | Total number of tweets |
|
||||
|
||||
|
||||
|
||||
@@ -26,78 +26,15 @@ In Sim, the YouTube integration enables your agents to programmatically search a
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate YouTube into the workflow. Can search for videos, get video details, get channel information, get all videos from a channel, get channel playlists, get playlist items, find related videos, and get video comments.
|
||||
Integrate YouTube into the workflow. Can search for videos, get trending videos, get video details, get video categories, get channel information, get all videos from a channel, get channel playlists, get playlist items, and get video comments.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `youtube_search`
|
||||
|
||||
Search for videos on YouTube using the YouTube Data API. Supports advanced filtering by channel, date range, duration, category, quality, captions, and more.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Search query for YouTube videos |
|
||||
| `maxResults` | number | No | Maximum number of videos to return \(1-50\) |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
| `channelId` | string | No | Filter results to a specific YouTube channel ID |
|
||||
| `publishedAfter` | string | No | Only return videos published after this date \(RFC 3339 format: "2024-01-01T00:00:00Z"\) |
|
||||
| `publishedBefore` | string | No | Only return videos published before this date \(RFC 3339 format: "2024-01-01T00:00:00Z"\) |
|
||||
| `videoDuration` | string | No | Filter by video length: "short" \(<4 min\), "medium" \(4-20 min\), "long" \(>20 min\), "any" |
|
||||
| `order` | string | No | Sort results by: "date", "rating", "relevance" \(default\), "title", "videoCount", "viewCount" |
|
||||
| `videoCategoryId` | string | No | Filter by YouTube category ID \(e.g., "10" for Music, "20" for Gaming\) |
|
||||
| `videoDefinition` | string | No | Filter by video quality: "high" \(HD\), "standard", "any" |
|
||||
| `videoCaption` | string | No | Filter by caption availability: "closedCaption" \(has captions\), "none" \(no captions\), "any" |
|
||||
| `regionCode` | string | No | Return results relevant to a specific region \(ISO 3166-1 alpha-2 country code, e.g., "US", "GB"\) |
|
||||
| `relevanceLanguage` | string | No | Return results most relevant to a language \(ISO 639-1 code, e.g., "en", "es"\) |
|
||||
| `safeSearch` | string | No | Content filtering level: "moderate" \(default\), "none", "strict" |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array of YouTube videos matching the search query |
|
||||
| ↳ `videoId` | string | YouTube video ID |
|
||||
| ↳ `title` | string | Video title |
|
||||
| ↳ `description` | string | Video description |
|
||||
| ↳ `thumbnail` | string | Video thumbnail URL |
|
||||
| `totalResults` | number | Total number of search results available |
|
||||
| `nextPageToken` | string | Token for accessing the next page of results |
|
||||
|
||||
### `youtube_video_details`
|
||||
|
||||
Get detailed information about a specific YouTube video.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `videoId` | string | Yes | YouTube video ID |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `videoId` | string | YouTube video ID |
|
||||
| `title` | string | Video title |
|
||||
| `description` | string | Video description |
|
||||
| `channelId` | string | Channel ID |
|
||||
| `channelTitle` | string | Channel name |
|
||||
| `publishedAt` | string | Published date and time |
|
||||
| `duration` | string | Video duration in ISO 8601 format |
|
||||
| `viewCount` | number | Number of views |
|
||||
| `likeCount` | number | Number of likes |
|
||||
| `commentCount` | number | Number of comments |
|
||||
| `thumbnail` | string | Video thumbnail URL |
|
||||
| `tags` | array | Video tags |
|
||||
|
||||
### `youtube_channel_info`
|
||||
|
||||
Get detailed information about a YouTube channel.
|
||||
Get detailed information about a YouTube channel including statistics, branding, and content details.
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -114,43 +51,20 @@ Get detailed information about a YouTube channel.
|
||||
| `channelId` | string | YouTube channel ID |
|
||||
| `title` | string | Channel name |
|
||||
| `description` | string | Channel description |
|
||||
| `subscriberCount` | number | Number of subscribers |
|
||||
| `videoCount` | number | Number of videos |
|
||||
| `subscriberCount` | number | Number of subscribers \(0 if hidden\) |
|
||||
| `videoCount` | number | Number of public videos |
|
||||
| `viewCount` | number | Total channel views |
|
||||
| `publishedAt` | string | Channel creation date |
|
||||
| `thumbnail` | string | Channel thumbnail URL |
|
||||
| `customUrl` | string | Channel custom URL |
|
||||
|
||||
### `youtube_channel_videos`
|
||||
|
||||
Get all videos from a specific YouTube channel, with sorting options.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `channelId` | string | Yes | YouTube channel ID to get videos from |
|
||||
| `maxResults` | number | No | Maximum number of videos to return \(1-50\) |
|
||||
| `order` | string | No | Sort order: "date" \(newest first\), "rating", "relevance", "title", "viewCount" |
|
||||
| `pageToken` | string | No | Page token for pagination |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array of videos from the channel |
|
||||
| ↳ `videoId` | string | YouTube video ID |
|
||||
| ↳ `title` | string | Video title |
|
||||
| ↳ `description` | string | Video description |
|
||||
| ↳ `thumbnail` | string | Video thumbnail URL |
|
||||
| ↳ `publishedAt` | string | Video publish date |
|
||||
| `totalResults` | number | Total number of videos in the channel |
|
||||
| `nextPageToken` | string | Token for accessing the next page of results |
|
||||
| `thumbnail` | string | Channel thumbnail/avatar URL |
|
||||
| `customUrl` | string | Channel custom URL \(handle\) |
|
||||
| `country` | string | Country the channel is associated with |
|
||||
| `uploadsPlaylistId` | string | Playlist ID containing all channel uploads \(use with playlist_items\) |
|
||||
| `bannerImageUrl` | string | Channel banner image URL |
|
||||
| `hiddenSubscriberCount` | boolean | Whether the subscriber count is hidden |
|
||||
|
||||
### `youtube_channel_playlists`
|
||||
|
||||
Get all playlists from a specific YouTube channel.
|
||||
Get all public playlists from a specific YouTube channel.
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -172,19 +86,80 @@ Get all playlists from a specific YouTube channel.
|
||||
| ↳ `thumbnail` | string | Playlist thumbnail URL |
|
||||
| ↳ `itemCount` | number | Number of videos in playlist |
|
||||
| ↳ `publishedAt` | string | Playlist creation date |
|
||||
| ↳ `channelTitle` | string | Channel name |
|
||||
| `totalResults` | number | Total number of playlists in the channel |
|
||||
| `nextPageToken` | string | Token for accessing the next page of results |
|
||||
|
||||
### `youtube_playlist_items`
|
||||
### `youtube_channel_videos`
|
||||
|
||||
Get videos from a YouTube playlist.
|
||||
Search for videos from a specific YouTube channel with sorting options. For complete channel video list, use channel_info to get uploadsPlaylistId, then use playlist_items.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `playlistId` | string | Yes | YouTube playlist ID |
|
||||
| `maxResults` | number | No | Maximum number of videos to return |
|
||||
| `channelId` | string | Yes | YouTube channel ID to get videos from |
|
||||
| `maxResults` | number | No | Maximum number of videos to return \(1-50\) |
|
||||
| `order` | string | No | Sort order: "date" \(newest first, default\), "rating", "relevance", "title", "viewCount" |
|
||||
| `pageToken` | string | No | Page token for pagination |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array of videos from the channel |
|
||||
| ↳ `videoId` | string | YouTube video ID |
|
||||
| ↳ `title` | string | Video title |
|
||||
| ↳ `description` | string | Video description |
|
||||
| ↳ `thumbnail` | string | Video thumbnail URL |
|
||||
| ↳ `publishedAt` | string | Video publish date |
|
||||
| ↳ `channelTitle` | string | Channel name |
|
||||
| `totalResults` | number | Total number of videos in the channel |
|
||||
| `nextPageToken` | string | Token for accessing the next page of results |
|
||||
|
||||
### `youtube_comments`
|
||||
|
||||
Get top-level comments from a YouTube video with author details and engagement.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `videoId` | string | Yes | YouTube video ID |
|
||||
| `maxResults` | number | No | Maximum number of comments to return \(1-100\) |
|
||||
| `order` | string | No | Order of comments: "time" \(newest first\) or "relevance" \(most relevant first\) |
|
||||
| `pageToken` | string | No | Page token for pagination |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array of top-level comments from the video |
|
||||
| ↳ `commentId` | string | Comment ID |
|
||||
| ↳ `authorDisplayName` | string | Comment author display name |
|
||||
| ↳ `authorChannelUrl` | string | Comment author channel URL |
|
||||
| ↳ `authorProfileImageUrl` | string | Comment author profile image URL |
|
||||
| ↳ `textDisplay` | string | Comment text \(HTML formatted\) |
|
||||
| ↳ `textOriginal` | string | Comment text \(plain text\) |
|
||||
| ↳ `likeCount` | number | Number of likes on the comment |
|
||||
| ↳ `publishedAt` | string | When the comment was posted |
|
||||
| ↳ `updatedAt` | string | When the comment was last edited |
|
||||
| ↳ `replyCount` | number | Number of replies to this comment |
|
||||
| `totalResults` | number | Total number of comment threads available |
|
||||
| `nextPageToken` | string | Token for accessing the next page of results |
|
||||
|
||||
### `youtube_playlist_items`
|
||||
|
||||
Get videos from a YouTube playlist. Can be used with a channel uploads playlist to get all channel videos.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `playlistId` | string | Yes | YouTube playlist ID. Use uploadsPlaylistId from channel_info to get all channel videos. |
|
||||
| `maxResults` | number | No | Maximum number of videos to return \(1-50\) |
|
||||
| `pageToken` | string | No | Page token for pagination |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
|
||||
@@ -198,22 +173,65 @@ Get videos from a YouTube playlist.
|
||||
| ↳ `description` | string | Video description |
|
||||
| ↳ `thumbnail` | string | Video thumbnail URL |
|
||||
| ↳ `publishedAt` | string | Date added to playlist |
|
||||
| ↳ `channelTitle` | string | Channel name |
|
||||
| ↳ `position` | number | Position in playlist |
|
||||
| ↳ `channelTitle` | string | Playlist owner channel name |
|
||||
| ↳ `position` | number | Position in playlist \(0-indexed\) |
|
||||
| ↳ `videoOwnerChannelId` | string | Channel ID of the video owner |
|
||||
| ↳ `videoOwnerChannelTitle` | string | Channel name of the video owner |
|
||||
| `totalResults` | number | Total number of items in playlist |
|
||||
| `nextPageToken` | string | Token for accessing the next page of results |
|
||||
|
||||
### `youtube_comments`
|
||||
### `youtube_search`
|
||||
|
||||
Get comments from a YouTube video.
|
||||
Search for videos on YouTube using the YouTube Data API. Supports advanced filtering by channel, date range, duration, category, quality, captions, live streams, and more.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `videoId` | string | Yes | YouTube video ID |
|
||||
| `maxResults` | number | No | Maximum number of comments to return |
|
||||
| `order` | string | No | Order of comments: time or relevance |
|
||||
| `query` | string | Yes | Search query for YouTube videos |
|
||||
| `maxResults` | number | No | Maximum number of videos to return \(1-50\) |
|
||||
| `pageToken` | string | No | Page token for pagination \(use nextPageToken from previous response\) |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
| `channelId` | string | No | Filter results to a specific YouTube channel ID |
|
||||
| `publishedAfter` | string | No | Only return videos published after this date \(RFC 3339 format: "2024-01-01T00:00:00Z"\) |
|
||||
| `publishedBefore` | string | No | Only return videos published before this date \(RFC 3339 format: "2024-01-01T00:00:00Z"\) |
|
||||
| `videoDuration` | string | No | Filter by video length: "short" \(<4 min\), "medium" \(4-20 min\), "long" \(>20 min\), "any" |
|
||||
| `order` | string | No | Sort results by: "date", "rating", "relevance" \(default\), "title", "videoCount", "viewCount" |
|
||||
| `videoCategoryId` | string | No | Filter by YouTube category ID \(e.g., "10" for Music, "20" for Gaming\). Use video_categories to list IDs. |
|
||||
| `videoDefinition` | string | No | Filter by video quality: "high" \(HD\), "standard", "any" |
|
||||
| `videoCaption` | string | No | Filter by caption availability: "closedCaption" \(has captions\), "none" \(no captions\), "any" |
|
||||
| `eventType` | string | No | Filter by live broadcast status: "live" \(currently live\), "upcoming" \(scheduled\), "completed" \(past streams\) |
|
||||
| `regionCode` | string | No | Return results relevant to a specific region \(ISO 3166-1 alpha-2 country code, e.g., "US", "GB"\) |
|
||||
| `relevanceLanguage` | string | No | Return results most relevant to a language \(ISO 639-1 code, e.g., "en", "es"\) |
|
||||
| `safeSearch` | string | No | Content filtering level: "moderate" \(default\), "none", "strict" |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array of YouTube videos matching the search query |
|
||||
| ↳ `videoId` | string | YouTube video ID |
|
||||
| ↳ `title` | string | Video title |
|
||||
| ↳ `description` | string | Video description |
|
||||
| ↳ `thumbnail` | string | Video thumbnail URL |
|
||||
| ↳ `channelId` | string | Channel ID that uploaded the video |
|
||||
| ↳ `channelTitle` | string | Channel name |
|
||||
| ↳ `publishedAt` | string | Video publish date |
|
||||
| ↳ `liveBroadcastContent` | string | Live broadcast status: |
|
||||
| `totalResults` | number | Total number of search results available |
|
||||
| `nextPageToken` | string | Token for accessing the next page of results |
|
||||
|
||||
### `youtube_trending`
|
||||
|
||||
Get the most popular/trending videos on YouTube. Can filter by region and video category.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `regionCode` | string | No | ISO 3166-1 alpha-2 country code to get trending videos for \(e.g., "US", "GB", "JP"\). Defaults to US. |
|
||||
| `videoCategoryId` | string | No | Filter by video category ID \(e.g., "10" for Music, "20" for Gaming, "17" for Sports\) |
|
||||
| `maxResults` | number | No | Maximum number of trending videos to return \(1-50\) |
|
||||
| `pageToken` | string | No | Page token for pagination |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
|
||||
@@ -221,17 +239,84 @@ Get comments from a YouTube video.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array of comments from the video |
|
||||
| ↳ `commentId` | string | Comment ID |
|
||||
| ↳ `authorDisplayName` | string | Comment author name |
|
||||
| ↳ `authorChannelUrl` | string | Comment author channel URL |
|
||||
| ↳ `textDisplay` | string | Comment text \(HTML formatted\) |
|
||||
| ↳ `textOriginal` | string | Comment text \(plain text\) |
|
||||
| `items` | array | Array of trending videos |
|
||||
| ↳ `videoId` | string | YouTube video ID |
|
||||
| ↳ `title` | string | Video title |
|
||||
| ↳ `description` | string | Video description |
|
||||
| ↳ `thumbnail` | string | Video thumbnail URL |
|
||||
| ↳ `channelId` | string | Channel ID |
|
||||
| ↳ `channelTitle` | string | Channel name |
|
||||
| ↳ `publishedAt` | string | Video publish date |
|
||||
| ↳ `viewCount` | number | Number of views |
|
||||
| ↳ `likeCount` | number | Number of likes |
|
||||
| ↳ `publishedAt` | string | Comment publish date |
|
||||
| ↳ `updatedAt` | string | Comment last updated date |
|
||||
| ↳ `replyCount` | number | Number of replies |
|
||||
| `totalResults` | number | Total number of comments |
|
||||
| ↳ `commentCount` | number | Number of comments |
|
||||
| ↳ `duration` | string | Video duration in ISO 8601 format |
|
||||
| `totalResults` | number | Total number of trending videos available |
|
||||
| `nextPageToken` | string | Token for accessing the next page of results |
|
||||
|
||||
### `youtube_video_categories`
|
||||
|
||||
Get a list of video categories available on YouTube. Use this to discover valid category IDs for filtering search and trending results.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `regionCode` | string | No | ISO 3166-1 alpha-2 country code to get categories for \(e.g., "US", "GB", "JP"\). Defaults to US. |
|
||||
| `hl` | string | No | Language for category titles \(e.g., "en", "es", "fr"\). Defaults to English. |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array of video categories available in the specified region |
|
||||
| ↳ `categoryId` | string | Category ID to use in search/trending filters \(e.g., |
|
||||
| ↳ `title` | string | Human-readable category name |
|
||||
| ↳ `assignable` | boolean | Whether videos can be tagged with this category |
|
||||
| `totalResults` | number | Total number of categories available |
|
||||
|
||||
### `youtube_video_details`
|
||||
|
||||
Get detailed information about a specific YouTube video including statistics, content details, live streaming info, and metadata.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `videoId` | string | Yes | YouTube video ID |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `videoId` | string | YouTube video ID |
|
||||
| `title` | string | Video title |
|
||||
| `description` | string | Video description |
|
||||
| `channelId` | string | Channel ID |
|
||||
| `channelTitle` | string | Channel name |
|
||||
| `publishedAt` | string | Published date and time |
|
||||
| `duration` | string | Video duration in ISO 8601 format \(e.g., |
|
||||
| `viewCount` | number | Number of views |
|
||||
| `likeCount` | number | Number of likes |
|
||||
| `commentCount` | number | Number of comments |
|
||||
| `favoriteCount` | number | Number of times added to favorites |
|
||||
| `thumbnail` | string | Video thumbnail URL |
|
||||
| `tags` | array | Video tags |
|
||||
| `categoryId` | string | YouTube video category ID |
|
||||
| `definition` | string | Video definition: |
|
||||
| `caption` | string | Whether captions are available: |
|
||||
| `licensedContent` | boolean | Whether the video is licensed content |
|
||||
| `privacyStatus` | string | Video privacy status: |
|
||||
| `liveBroadcastContent` | string | Live broadcast status: |
|
||||
| `defaultLanguage` | string | Default language of the video metadata |
|
||||
| `defaultAudioLanguage` | string | Default audio language of the video |
|
||||
| `isLiveContent` | boolean | Whether this video is or was a live stream |
|
||||
| `scheduledStartTime` | string | Scheduled start time for upcoming live streams \(ISO 8601\) |
|
||||
| `actualStartTime` | string | When the live stream actually started \(ISO 8601\) |
|
||||
| `actualEndTime` | string | When the live stream ended \(ISO 8601\) |
|
||||
| `concurrentViewers` | number | Current number of viewers \(only for active live streams\) |
|
||||
| `activeLiveChatId` | string | Live chat ID for the stream \(only for active live streams\) |
|
||||
|
||||
|
||||
|
||||
@@ -77,13 +77,65 @@ Retrieve a list of tickets from Zendesk with optional filtering
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tickets` | array | Array of ticket objects |
|
||||
| ↳ `id` | number | Automatically assigned ticket ID |
|
||||
| ↳ `url` | string | API URL of the ticket |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| ↳ `via` | object | How the ticket was created |
|
||||
| ↳ `channel` | string | Channel through which the ticket was created \(e.g., email, web, api\) |
|
||||
| ↳ `source` | object | Source details for the channel |
|
||||
| ↳ `from` | object | Information about the source sender |
|
||||
| ↳ `address` | string | Email address or other identifier |
|
||||
| ↳ `name` | string | Name of the sender |
|
||||
| ↳ `to` | object | Information about the recipient |
|
||||
| ↳ `address` | string | Email address or other identifier |
|
||||
| ↳ `name` | string | Name of the recipient |
|
||||
| ↳ `rel` | string | Relationship type |
|
||||
| ↳ `created_at` | string | When the ticket was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the ticket was last updated \(ISO 8601 format\) |
|
||||
| ↳ `type` | string | Ticket type \(problem, incident, question, task\) |
|
||||
| ↳ `subject` | string | Subject of the ticket |
|
||||
| ↳ `raw_subject` | string | Subject of the ticket as entered by the requester |
|
||||
| ↳ `description` | string | Read-only first comment on the ticket |
|
||||
| ↳ `priority` | string | Priority level \(low, normal, high, urgent\) |
|
||||
| ↳ `status` | string | Ticket status \(new, open, pending, hold, solved, closed\) |
|
||||
| ↳ `recipient` | string | Original recipient email address |
|
||||
| ↳ `requester_id` | number | User ID of the ticket requester |
|
||||
| ↳ `submitter_id` | number | User ID of the ticket submitter |
|
||||
| ↳ `assignee_id` | number | User ID of the agent assigned to the ticket |
|
||||
| ↳ `organization_id` | number | Organization ID of the requester |
|
||||
| ↳ `group_id` | number | Group ID assigned to the ticket |
|
||||
| ↳ `collaborator_ids` | array | User IDs of collaborators \(CC\) |
|
||||
| ↳ `follower_ids` | array | User IDs of followers |
|
||||
| ↳ `email_cc_ids` | array | User IDs of email CCs |
|
||||
| ↳ `forum_topic_id` | number | Topic ID in the community forum |
|
||||
| ↳ `problem_id` | number | For incident tickets, the ID of the associated problem ticket |
|
||||
| ↳ `has_incidents` | boolean | Whether the ticket has incident tickets linked |
|
||||
| ↳ `is_public` | boolean | Whether the first comment is public |
|
||||
| ↳ `due_at` | string | Due date for task tickets \(ISO 8601 format\) |
|
||||
| ↳ `tags` | array | Tags associated with the ticket |
|
||||
| ↳ `custom_fields` | array | Custom ticket fields |
|
||||
| ↳ `id` | number | Custom field ID |
|
||||
| ↳ `value` | string | Custom field value |
|
||||
| ↳ `custom_status_id` | number | Custom status ID |
|
||||
| ↳ `satisfaction_rating` | object | Customer satisfaction rating |
|
||||
| ↳ `id` | number | Satisfaction rating ID |
|
||||
| ↳ `score` | string | Rating score \(e.g., good, bad, offered, unoffered\) |
|
||||
| ↳ `comment` | string | Comment left with the rating |
|
||||
| ↳ `sharing_agreement_ids` | array | Sharing agreement IDs |
|
||||
| ↳ `followup_ids` | array | IDs of follow-up tickets |
|
||||
| ↳ `brand_id` | number | Brand ID the ticket belongs to |
|
||||
| ↳ `allow_attachments` | boolean | Whether attachments are allowed |
|
||||
| ↳ `allow_channelback` | boolean | Whether channelback is enabled |
|
||||
| ↳ `from_messaging_channel` | boolean | Whether the ticket originated from a messaging channel |
|
||||
| ↳ `ticket_form_id` | number | Ticket form ID |
|
||||
| ↳ `generated_timestamp` | number | Unix timestamp of the ticket generation |
|
||||
| `paging` | object | Pagination information |
|
||||
| ↳ `next_page` | string | URL for next page of results |
|
||||
| ↳ `previous_page` | string | URL for previous page of results |
|
||||
| ↳ `count` | number | Total count of tickets |
|
||||
| ↳ `count` | number | Total count of items |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `total_returned` | number | Number of tickets returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more tickets are available |
|
||||
| ↳ `total_returned` | number | Number of items returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more items are available |
|
||||
|
||||
### `zendesk_get_ticket`
|
||||
|
||||
@@ -103,6 +155,58 @@ Get a single ticket by ID from Zendesk
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Ticket object |
|
||||
| ↳ `id` | number | Automatically assigned ticket ID |
|
||||
| ↳ `url` | string | API URL of the ticket |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| ↳ `via` | object | How the ticket was created |
|
||||
| ↳ `channel` | string | Channel through which the ticket was created \(e.g., email, web, api\) |
|
||||
| ↳ `source` | object | Source details for the channel |
|
||||
| ↳ `from` | object | Information about the source sender |
|
||||
| ↳ `address` | string | Email address or other identifier |
|
||||
| ↳ `name` | string | Name of the sender |
|
||||
| ↳ `to` | object | Information about the recipient |
|
||||
| ↳ `address` | string | Email address or other identifier |
|
||||
| ↳ `name` | string | Name of the recipient |
|
||||
| ↳ `rel` | string | Relationship type |
|
||||
| ↳ `created_at` | string | When the ticket was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the ticket was last updated \(ISO 8601 format\) |
|
||||
| ↳ `type` | string | Ticket type \(problem, incident, question, task\) |
|
||||
| ↳ `subject` | string | Subject of the ticket |
|
||||
| ↳ `raw_subject` | string | Subject of the ticket as entered by the requester |
|
||||
| ↳ `description` | string | Read-only first comment on the ticket |
|
||||
| ↳ `priority` | string | Priority level \(low, normal, high, urgent\) |
|
||||
| ↳ `status` | string | Ticket status \(new, open, pending, hold, solved, closed\) |
|
||||
| ↳ `recipient` | string | Original recipient email address |
|
||||
| ↳ `requester_id` | number | User ID of the ticket requester |
|
||||
| ↳ `submitter_id` | number | User ID of the ticket submitter |
|
||||
| ↳ `assignee_id` | number | User ID of the agent assigned to the ticket |
|
||||
| ↳ `organization_id` | number | Organization ID of the requester |
|
||||
| ↳ `group_id` | number | Group ID assigned to the ticket |
|
||||
| ↳ `collaborator_ids` | array | User IDs of collaborators \(CC\) |
|
||||
| ↳ `follower_ids` | array | User IDs of followers |
|
||||
| ↳ `email_cc_ids` | array | User IDs of email CCs |
|
||||
| ↳ `forum_topic_id` | number | Topic ID in the community forum |
|
||||
| ↳ `problem_id` | number | For incident tickets, the ID of the associated problem ticket |
|
||||
| ↳ `has_incidents` | boolean | Whether the ticket has incident tickets linked |
|
||||
| ↳ `is_public` | boolean | Whether the first comment is public |
|
||||
| ↳ `due_at` | string | Due date for task tickets \(ISO 8601 format\) |
|
||||
| ↳ `tags` | array | Tags associated with the ticket |
|
||||
| ↳ `custom_fields` | array | Custom ticket fields |
|
||||
| ↳ `id` | number | Custom field ID |
|
||||
| ↳ `value` | string | Custom field value |
|
||||
| ↳ `custom_status_id` | number | Custom status ID |
|
||||
| ↳ `satisfaction_rating` | object | Customer satisfaction rating |
|
||||
| ↳ `id` | number | Satisfaction rating ID |
|
||||
| ↳ `score` | string | Rating score \(e.g., good, bad, offered, unoffered\) |
|
||||
| ↳ `comment` | string | Comment left with the rating |
|
||||
| ↳ `sharing_agreement_ids` | array | Sharing agreement IDs |
|
||||
| ↳ `followup_ids` | array | IDs of follow-up tickets |
|
||||
| ↳ `brand_id` | number | Brand ID the ticket belongs to |
|
||||
| ↳ `allow_attachments` | boolean | Whether attachments are allowed |
|
||||
| ↳ `allow_channelback` | boolean | Whether channelback is enabled |
|
||||
| ↳ `from_messaging_channel` | boolean | Whether the ticket originated from a messaging channel |
|
||||
| ↳ `ticket_form_id` | number | Ticket form ID |
|
||||
| ↳ `generated_timestamp` | number | Unix timestamp of the ticket generation |
|
||||
| `ticket_id` | number | The ticket ID |
|
||||
|
||||
### `zendesk_create_ticket`
|
||||
@@ -132,6 +236,58 @@ Create a new ticket in Zendesk with support for custom fields
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Created ticket object |
|
||||
| ↳ `id` | number | Automatically assigned ticket ID |
|
||||
| ↳ `url` | string | API URL of the ticket |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| ↳ `via` | object | How the ticket was created |
|
||||
| ↳ `channel` | string | Channel through which the ticket was created \(e.g., email, web, api\) |
|
||||
| ↳ `source` | object | Source details for the channel |
|
||||
| ↳ `from` | object | Information about the source sender |
|
||||
| ↳ `address` | string | Email address or other identifier |
|
||||
| ↳ `name` | string | Name of the sender |
|
||||
| ↳ `to` | object | Information about the recipient |
|
||||
| ↳ `address` | string | Email address or other identifier |
|
||||
| ↳ `name` | string | Name of the recipient |
|
||||
| ↳ `rel` | string | Relationship type |
|
||||
| ↳ `created_at` | string | When the ticket was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the ticket was last updated \(ISO 8601 format\) |
|
||||
| ↳ `type` | string | Ticket type \(problem, incident, question, task\) |
|
||||
| ↳ `subject` | string | Subject of the ticket |
|
||||
| ↳ `raw_subject` | string | Subject of the ticket as entered by the requester |
|
||||
| ↳ `description` | string | Read-only first comment on the ticket |
|
||||
| ↳ `priority` | string | Priority level \(low, normal, high, urgent\) |
|
||||
| ↳ `status` | string | Ticket status \(new, open, pending, hold, solved, closed\) |
|
||||
| ↳ `recipient` | string | Original recipient email address |
|
||||
| ↳ `requester_id` | number | User ID of the ticket requester |
|
||||
| ↳ `submitter_id` | number | User ID of the ticket submitter |
|
||||
| ↳ `assignee_id` | number | User ID of the agent assigned to the ticket |
|
||||
| ↳ `organization_id` | number | Organization ID of the requester |
|
||||
| ↳ `group_id` | number | Group ID assigned to the ticket |
|
||||
| ↳ `collaborator_ids` | array | User IDs of collaborators \(CC\) |
|
||||
| ↳ `follower_ids` | array | User IDs of followers |
|
||||
| ↳ `email_cc_ids` | array | User IDs of email CCs |
|
||||
| ↳ `forum_topic_id` | number | Topic ID in the community forum |
|
||||
| ↳ `problem_id` | number | For incident tickets, the ID of the associated problem ticket |
|
||||
| ↳ `has_incidents` | boolean | Whether the ticket has incident tickets linked |
|
||||
| ↳ `is_public` | boolean | Whether the first comment is public |
|
||||
| ↳ `due_at` | string | Due date for task tickets \(ISO 8601 format\) |
|
||||
| ↳ `tags` | array | Tags associated with the ticket |
|
||||
| ↳ `custom_fields` | array | Custom ticket fields |
|
||||
| ↳ `id` | number | Custom field ID |
|
||||
| ↳ `value` | string | Custom field value |
|
||||
| ↳ `custom_status_id` | number | Custom status ID |
|
||||
| ↳ `satisfaction_rating` | object | Customer satisfaction rating |
|
||||
| ↳ `id` | number | Satisfaction rating ID |
|
||||
| ↳ `score` | string | Rating score \(e.g., good, bad, offered, unoffered\) |
|
||||
| ↳ `comment` | string | Comment left with the rating |
|
||||
| ↳ `sharing_agreement_ids` | array | Sharing agreement IDs |
|
||||
| ↳ `followup_ids` | array | IDs of follow-up tickets |
|
||||
| ↳ `brand_id` | number | Brand ID the ticket belongs to |
|
||||
| ↳ `allow_attachments` | boolean | Whether attachments are allowed |
|
||||
| ↳ `allow_channelback` | boolean | Whether channelback is enabled |
|
||||
| ↳ `from_messaging_channel` | boolean | Whether the ticket originated from a messaging channel |
|
||||
| ↳ `ticket_form_id` | number | Ticket form ID |
|
||||
| ↳ `generated_timestamp` | number | Unix timestamp of the ticket generation |
|
||||
| `ticket_id` | number | The created ticket ID |
|
||||
|
||||
### `zendesk_create_tickets_bulk`
|
||||
@@ -151,7 +307,21 @@ Create multiple tickets in Zendesk at once (max 100)
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `job_status` | object | Job status object |
|
||||
| `job_status` | object | Job status object for bulk operations |
|
||||
| ↳ `id` | string | Automatically assigned job ID |
|
||||
| ↳ `url` | string | URL to poll for status updates |
|
||||
| ↳ `status` | string | Current job status \(queued, working, failed, completed\) |
|
||||
| ↳ `job_type` | string | Category of background task |
|
||||
| ↳ `total` | number | Total number of tasks in this job |
|
||||
| ↳ `progress` | number | Number of tasks already completed |
|
||||
| ↳ `message` | string | Message from the job worker |
|
||||
| ↳ `results` | array | Array of result objects from the job |
|
||||
| ↳ `id` | number | ID of the created or updated resource |
|
||||
| ↳ `index` | number | Position of the result in the batch |
|
||||
| ↳ `action` | string | Action performed \(e.g., create, update\) |
|
||||
| ↳ `success` | boolean | Whether the operation succeeded |
|
||||
| ↳ `status` | string | Status message \(e.g., Updated, Created\) |
|
||||
| ↳ `error` | string | Error message if operation failed |
|
||||
| `job_id` | string | The bulk operation job ID |
|
||||
|
||||
### `zendesk_update_ticket`
|
||||
@@ -181,6 +351,58 @@ Update an existing ticket in Zendesk with support for custom fields
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Updated ticket object |
|
||||
| ↳ `id` | number | Automatically assigned ticket ID |
|
||||
| ↳ `url` | string | API URL of the ticket |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| ↳ `via` | object | How the ticket was created |
|
||||
| ↳ `channel` | string | Channel through which the ticket was created \(e.g., email, web, api\) |
|
||||
| ↳ `source` | object | Source details for the channel |
|
||||
| ↳ `from` | object | Information about the source sender |
|
||||
| ↳ `address` | string | Email address or other identifier |
|
||||
| ↳ `name` | string | Name of the sender |
|
||||
| ↳ `to` | object | Information about the recipient |
|
||||
| ↳ `address` | string | Email address or other identifier |
|
||||
| ↳ `name` | string | Name of the recipient |
|
||||
| ↳ `rel` | string | Relationship type |
|
||||
| ↳ `created_at` | string | When the ticket was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the ticket was last updated \(ISO 8601 format\) |
|
||||
| ↳ `type` | string | Ticket type \(problem, incident, question, task\) |
|
||||
| ↳ `subject` | string | Subject of the ticket |
|
||||
| ↳ `raw_subject` | string | Subject of the ticket as entered by the requester |
|
||||
| ↳ `description` | string | Read-only first comment on the ticket |
|
||||
| ↳ `priority` | string | Priority level \(low, normal, high, urgent\) |
|
||||
| ↳ `status` | string | Ticket status \(new, open, pending, hold, solved, closed\) |
|
||||
| ↳ `recipient` | string | Original recipient email address |
|
||||
| ↳ `requester_id` | number | User ID of the ticket requester |
|
||||
| ↳ `submitter_id` | number | User ID of the ticket submitter |
|
||||
| ↳ `assignee_id` | number | User ID of the agent assigned to the ticket |
|
||||
| ↳ `organization_id` | number | Organization ID of the requester |
|
||||
| ↳ `group_id` | number | Group ID assigned to the ticket |
|
||||
| ↳ `collaborator_ids` | array | User IDs of collaborators \(CC\) |
|
||||
| ↳ `follower_ids` | array | User IDs of followers |
|
||||
| ↳ `email_cc_ids` | array | User IDs of email CCs |
|
||||
| ↳ `forum_topic_id` | number | Topic ID in the community forum |
|
||||
| ↳ `problem_id` | number | For incident tickets, the ID of the associated problem ticket |
|
||||
| ↳ `has_incidents` | boolean | Whether the ticket has incident tickets linked |
|
||||
| ↳ `is_public` | boolean | Whether the first comment is public |
|
||||
| ↳ `due_at` | string | Due date for task tickets \(ISO 8601 format\) |
|
||||
| ↳ `tags` | array | Tags associated with the ticket |
|
||||
| ↳ `custom_fields` | array | Custom ticket fields |
|
||||
| ↳ `id` | number | Custom field ID |
|
||||
| ↳ `value` | string | Custom field value |
|
||||
| ↳ `custom_status_id` | number | Custom status ID |
|
||||
| ↳ `satisfaction_rating` | object | Customer satisfaction rating |
|
||||
| ↳ `id` | number | Satisfaction rating ID |
|
||||
| ↳ `score` | string | Rating score \(e.g., good, bad, offered, unoffered\) |
|
||||
| ↳ `comment` | string | Comment left with the rating |
|
||||
| ↳ `sharing_agreement_ids` | array | Sharing agreement IDs |
|
||||
| ↳ `followup_ids` | array | IDs of follow-up tickets |
|
||||
| ↳ `brand_id` | number | Brand ID the ticket belongs to |
|
||||
| ↳ `allow_attachments` | boolean | Whether attachments are allowed |
|
||||
| ↳ `allow_channelback` | boolean | Whether channelback is enabled |
|
||||
| ↳ `from_messaging_channel` | boolean | Whether the ticket originated from a messaging channel |
|
||||
| ↳ `ticket_form_id` | number | Ticket form ID |
|
||||
| ↳ `generated_timestamp` | number | Unix timestamp of the ticket generation |
|
||||
| `ticket_id` | number | The updated ticket ID |
|
||||
|
||||
### `zendesk_update_tickets_bulk`
|
||||
@@ -205,7 +427,21 @@ Update multiple tickets in Zendesk at once (max 100)
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `job_status` | object | Job status object |
|
||||
| `job_status` | object | Job status object for bulk operations |
|
||||
| ↳ `id` | string | Automatically assigned job ID |
|
||||
| ↳ `url` | string | URL to poll for status updates |
|
||||
| ↳ `status` | string | Current job status \(queued, working, failed, completed\) |
|
||||
| ↳ `job_type` | string | Category of background task |
|
||||
| ↳ `total` | number | Total number of tasks in this job |
|
||||
| ↳ `progress` | number | Number of tasks already completed |
|
||||
| ↳ `message` | string | Message from the job worker |
|
||||
| ↳ `results` | array | Array of result objects from the job |
|
||||
| ↳ `id` | number | ID of the created or updated resource |
|
||||
| ↳ `index` | number | Position of the result in the batch |
|
||||
| ↳ `action` | string | Action performed \(e.g., create, update\) |
|
||||
| ↳ `success` | boolean | Whether the operation succeeded |
|
||||
| ↳ `status` | string | Status message \(e.g., Updated, Created\) |
|
||||
| ↳ `error` | string | Error message if operation failed |
|
||||
| `job_id` | string | The bulk operation job ID |
|
||||
|
||||
### `zendesk_delete_ticket`
|
||||
@@ -247,7 +483,21 @@ Merge multiple tickets into a target ticket
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `job_status` | object | Job status object |
|
||||
| `job_status` | object | Job status object for bulk operations |
|
||||
| ↳ `id` | string | Automatically assigned job ID |
|
||||
| ↳ `url` | string | URL to poll for status updates |
|
||||
| ↳ `status` | string | Current job status \(queued, working, failed, completed\) |
|
||||
| ↳ `job_type` | string | Category of background task |
|
||||
| ↳ `total` | number | Total number of tasks in this job |
|
||||
| ↳ `progress` | number | Number of tasks already completed |
|
||||
| ↳ `message` | string | Message from the job worker |
|
||||
| ↳ `results` | array | Array of result objects from the job |
|
||||
| ↳ `id` | number | ID of the created or updated resource |
|
||||
| ↳ `index` | number | Position of the result in the batch |
|
||||
| ↳ `action` | string | Action performed \(e.g., create, update\) |
|
||||
| ↳ `success` | boolean | Whether the operation succeeded |
|
||||
| ↳ `status` | string | Status message \(e.g., Updated, Created\) |
|
||||
| ↳ `error` | string | Error message if operation failed |
|
||||
| `job_id` | string | The merge job ID |
|
||||
| `target_ticket_id` | string | The target ticket ID that tickets were merged into |
|
||||
|
||||
@@ -272,13 +522,54 @@ Retrieve a list of users from Zendesk with optional filtering
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array of user objects |
|
||||
| ↳ `id` | number | Automatically assigned user ID |
|
||||
| ↳ `url` | string | API URL of the user |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | Primary email address |
|
||||
| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) |
|
||||
| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) |
|
||||
| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) |
|
||||
| ↳ `phone` | string | Phone number |
|
||||
| ↳ `shared_phone_number` | boolean | Whether the phone number is shared |
|
||||
| ↳ `photo` | object | User photo details |
|
||||
| ↳ `content_url` | string | URL to the photo |
|
||||
| ↳ `file_name` | string | Photo file name |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `locale` | string | Locale \(e.g., en-US\) |
|
||||
| ↳ `locale_id` | number | Locale ID |
|
||||
| ↳ `organization_id` | number | Primary organization ID |
|
||||
| ↳ `role` | string | User role \(end-user, agent, admin\) |
|
||||
| ↳ `role_type` | number | Role type identifier |
|
||||
| ↳ `custom_role_id` | number | Custom role ID |
|
||||
| ↳ `active` | boolean | Whether the user is active \(false if deleted\) |
|
||||
| ↳ `verified` | boolean | Whether any user identity has been verified |
|
||||
| ↳ `alias` | string | Alias displayed to end users |
|
||||
| ↳ `details` | string | Details about the user |
|
||||
| ↳ `notes` | string | Notes about the user |
|
||||
| ↳ `signature` | string | User signature for email replies |
|
||||
| ↳ `default_group_id` | number | Default group ID for the user |
|
||||
| ↳ `tags` | array | Tags associated with the user |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| ↳ `restricted_agent` | boolean | Whether the agent has restrictions |
|
||||
| ↳ `suspended` | boolean | Whether the user is suspended |
|
||||
| ↳ `moderator` | boolean | Whether the user has moderator permissions |
|
||||
| ↳ `chat_only` | boolean | Whether the user is a chat-only agent |
|
||||
| ↳ `only_private_comments` | boolean | Whether the user can only create private comments |
|
||||
| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled |
|
||||
| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) |
|
||||
| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) |
|
||||
| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) |
|
||||
| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk |
|
||||
| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk |
|
||||
| ↳ `remote_photo_url` | string | URL to a remote photo |
|
||||
| `paging` | object | Pagination information |
|
||||
| ↳ `next_page` | string | URL for next page of results |
|
||||
| ↳ `previous_page` | string | URL for previous page of results |
|
||||
| ↳ `count` | number | Total count of users |
|
||||
| ↳ `count` | number | Total count of items |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `total_returned` | number | Number of users returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more users are available |
|
||||
| ↳ `total_returned` | number | Number of items returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more items are available |
|
||||
|
||||
### `zendesk_get_user`
|
||||
|
||||
@@ -298,6 +589,47 @@ Get a single user by ID from Zendesk
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | User object |
|
||||
| ↳ `id` | number | Automatically assigned user ID |
|
||||
| ↳ `url` | string | API URL of the user |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | Primary email address |
|
||||
| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) |
|
||||
| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) |
|
||||
| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) |
|
||||
| ↳ `phone` | string | Phone number |
|
||||
| ↳ `shared_phone_number` | boolean | Whether the phone number is shared |
|
||||
| ↳ `photo` | object | User photo details |
|
||||
| ↳ `content_url` | string | URL to the photo |
|
||||
| ↳ `file_name` | string | Photo file name |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `locale` | string | Locale \(e.g., en-US\) |
|
||||
| ↳ `locale_id` | number | Locale ID |
|
||||
| ↳ `organization_id` | number | Primary organization ID |
|
||||
| ↳ `role` | string | User role \(end-user, agent, admin\) |
|
||||
| ↳ `role_type` | number | Role type identifier |
|
||||
| ↳ `custom_role_id` | number | Custom role ID |
|
||||
| ↳ `active` | boolean | Whether the user is active \(false if deleted\) |
|
||||
| ↳ `verified` | boolean | Whether any user identity has been verified |
|
||||
| ↳ `alias` | string | Alias displayed to end users |
|
||||
| ↳ `details` | string | Details about the user |
|
||||
| ↳ `notes` | string | Notes about the user |
|
||||
| ↳ `signature` | string | User signature for email replies |
|
||||
| ↳ `default_group_id` | number | Default group ID for the user |
|
||||
| ↳ `tags` | array | Tags associated with the user |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| ↳ `restricted_agent` | boolean | Whether the agent has restrictions |
|
||||
| ↳ `suspended` | boolean | Whether the user is suspended |
|
||||
| ↳ `moderator` | boolean | Whether the user has moderator permissions |
|
||||
| ↳ `chat_only` | boolean | Whether the user is a chat-only agent |
|
||||
| ↳ `only_private_comments` | boolean | Whether the user can only create private comments |
|
||||
| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled |
|
||||
| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) |
|
||||
| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) |
|
||||
| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) |
|
||||
| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk |
|
||||
| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk |
|
||||
| ↳ `remote_photo_url` | string | URL to a remote photo |
|
||||
| `user_id` | number | The user ID |
|
||||
|
||||
### `zendesk_get_current_user`
|
||||
@@ -317,6 +649,47 @@ Get the currently authenticated user from Zendesk
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Current user object |
|
||||
| ↳ `id` | number | Automatically assigned user ID |
|
||||
| ↳ `url` | string | API URL of the user |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | Primary email address |
|
||||
| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) |
|
||||
| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) |
|
||||
| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) |
|
||||
| ↳ `phone` | string | Phone number |
|
||||
| ↳ `shared_phone_number` | boolean | Whether the phone number is shared |
|
||||
| ↳ `photo` | object | User photo details |
|
||||
| ↳ `content_url` | string | URL to the photo |
|
||||
| ↳ `file_name` | string | Photo file name |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `locale` | string | Locale \(e.g., en-US\) |
|
||||
| ↳ `locale_id` | number | Locale ID |
|
||||
| ↳ `organization_id` | number | Primary organization ID |
|
||||
| ↳ `role` | string | User role \(end-user, agent, admin\) |
|
||||
| ↳ `role_type` | number | Role type identifier |
|
||||
| ↳ `custom_role_id` | number | Custom role ID |
|
||||
| ↳ `active` | boolean | Whether the user is active \(false if deleted\) |
|
||||
| ↳ `verified` | boolean | Whether any user identity has been verified |
|
||||
| ↳ `alias` | string | Alias displayed to end users |
|
||||
| ↳ `details` | string | Details about the user |
|
||||
| ↳ `notes` | string | Notes about the user |
|
||||
| ↳ `signature` | string | User signature for email replies |
|
||||
| ↳ `default_group_id` | number | Default group ID for the user |
|
||||
| ↳ `tags` | array | Tags associated with the user |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| ↳ `restricted_agent` | boolean | Whether the agent has restrictions |
|
||||
| ↳ `suspended` | boolean | Whether the user is suspended |
|
||||
| ↳ `moderator` | boolean | Whether the user has moderator permissions |
|
||||
| ↳ `chat_only` | boolean | Whether the user is a chat-only agent |
|
||||
| ↳ `only_private_comments` | boolean | Whether the user can only create private comments |
|
||||
| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled |
|
||||
| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) |
|
||||
| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) |
|
||||
| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) |
|
||||
| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk |
|
||||
| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk |
|
||||
| ↳ `remote_photo_url` | string | URL to a remote photo |
|
||||
| `user_id` | number | The current user ID |
|
||||
|
||||
### `zendesk_search_users`
|
||||
@@ -340,13 +713,54 @@ Search for users in Zendesk using a query string
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array of user objects |
|
||||
| ↳ `id` | number | Automatically assigned user ID |
|
||||
| ↳ `url` | string | API URL of the user |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | Primary email address |
|
||||
| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) |
|
||||
| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) |
|
||||
| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) |
|
||||
| ↳ `phone` | string | Phone number |
|
||||
| ↳ `shared_phone_number` | boolean | Whether the phone number is shared |
|
||||
| ↳ `photo` | object | User photo details |
|
||||
| ↳ `content_url` | string | URL to the photo |
|
||||
| ↳ `file_name` | string | Photo file name |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `locale` | string | Locale \(e.g., en-US\) |
|
||||
| ↳ `locale_id` | number | Locale ID |
|
||||
| ↳ `organization_id` | number | Primary organization ID |
|
||||
| ↳ `role` | string | User role \(end-user, agent, admin\) |
|
||||
| ↳ `role_type` | number | Role type identifier |
|
||||
| ↳ `custom_role_id` | number | Custom role ID |
|
||||
| ↳ `active` | boolean | Whether the user is active \(false if deleted\) |
|
||||
| ↳ `verified` | boolean | Whether any user identity has been verified |
|
||||
| ↳ `alias` | string | Alias displayed to end users |
|
||||
| ↳ `details` | string | Details about the user |
|
||||
| ↳ `notes` | string | Notes about the user |
|
||||
| ↳ `signature` | string | User signature for email replies |
|
||||
| ↳ `default_group_id` | number | Default group ID for the user |
|
||||
| ↳ `tags` | array | Tags associated with the user |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| ↳ `restricted_agent` | boolean | Whether the agent has restrictions |
|
||||
| ↳ `suspended` | boolean | Whether the user is suspended |
|
||||
| ↳ `moderator` | boolean | Whether the user has moderator permissions |
|
||||
| ↳ `chat_only` | boolean | Whether the user is a chat-only agent |
|
||||
| ↳ `only_private_comments` | boolean | Whether the user can only create private comments |
|
||||
| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled |
|
||||
| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) |
|
||||
| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) |
|
||||
| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) |
|
||||
| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk |
|
||||
| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk |
|
||||
| ↳ `remote_photo_url` | string | URL to a remote photo |
|
||||
| `paging` | object | Pagination information |
|
||||
| ↳ `next_page` | string | URL for next page of results |
|
||||
| ↳ `previous_page` | string | URL for previous page of results |
|
||||
| ↳ `count` | number | Total count of users |
|
||||
| ↳ `count` | number | Total count of items |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `total_returned` | number | Number of users returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more users are available |
|
||||
| ↳ `total_returned` | number | Number of items returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more items are available |
|
||||
|
||||
### `zendesk_create_user`
|
||||
|
||||
@@ -373,6 +787,47 @@ Create a new user in Zendesk
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Created user object |
|
||||
| ↳ `id` | number | Automatically assigned user ID |
|
||||
| ↳ `url` | string | API URL of the user |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | Primary email address |
|
||||
| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) |
|
||||
| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) |
|
||||
| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) |
|
||||
| ↳ `phone` | string | Phone number |
|
||||
| ↳ `shared_phone_number` | boolean | Whether the phone number is shared |
|
||||
| ↳ `photo` | object | User photo details |
|
||||
| ↳ `content_url` | string | URL to the photo |
|
||||
| ↳ `file_name` | string | Photo file name |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `locale` | string | Locale \(e.g., en-US\) |
|
||||
| ↳ `locale_id` | number | Locale ID |
|
||||
| ↳ `organization_id` | number | Primary organization ID |
|
||||
| ↳ `role` | string | User role \(end-user, agent, admin\) |
|
||||
| ↳ `role_type` | number | Role type identifier |
|
||||
| ↳ `custom_role_id` | number | Custom role ID |
|
||||
| ↳ `active` | boolean | Whether the user is active \(false if deleted\) |
|
||||
| ↳ `verified` | boolean | Whether any user identity has been verified |
|
||||
| ↳ `alias` | string | Alias displayed to end users |
|
||||
| ↳ `details` | string | Details about the user |
|
||||
| ↳ `notes` | string | Notes about the user |
|
||||
| ↳ `signature` | string | User signature for email replies |
|
||||
| ↳ `default_group_id` | number | Default group ID for the user |
|
||||
| ↳ `tags` | array | Tags associated with the user |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| ↳ `restricted_agent` | boolean | Whether the agent has restrictions |
|
||||
| ↳ `suspended` | boolean | Whether the user is suspended |
|
||||
| ↳ `moderator` | boolean | Whether the user has moderator permissions |
|
||||
| ↳ `chat_only` | boolean | Whether the user is a chat-only agent |
|
||||
| ↳ `only_private_comments` | boolean | Whether the user can only create private comments |
|
||||
| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled |
|
||||
| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) |
|
||||
| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) |
|
||||
| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) |
|
||||
| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk |
|
||||
| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk |
|
||||
| ↳ `remote_photo_url` | string | URL to a remote photo |
|
||||
| `user_id` | number | The created user ID |
|
||||
|
||||
### `zendesk_create_users_bulk`
|
||||
@@ -392,7 +847,21 @@ Create multiple users in Zendesk using bulk import
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `job_status` | object | Job status object |
|
||||
| `job_status` | object | Job status object for bulk operations |
|
||||
| ↳ `id` | string | Automatically assigned job ID |
|
||||
| ↳ `url` | string | URL to poll for status updates |
|
||||
| ↳ `status` | string | Current job status \(queued, working, failed, completed\) |
|
||||
| ↳ `job_type` | string | Category of background task |
|
||||
| ↳ `total` | number | Total number of tasks in this job |
|
||||
| ↳ `progress` | number | Number of tasks already completed |
|
||||
| ↳ `message` | string | Message from the job worker |
|
||||
| ↳ `results` | array | Array of result objects from the job |
|
||||
| ↳ `id` | number | ID of the created or updated resource |
|
||||
| ↳ `index` | number | Position of the result in the batch |
|
||||
| ↳ `action` | string | Action performed \(e.g., create, update\) |
|
||||
| ↳ `success` | boolean | Whether the operation succeeded |
|
||||
| ↳ `status` | string | Status message \(e.g., Updated, Created\) |
|
||||
| ↳ `error` | string | Error message if operation failed |
|
||||
| `job_id` | string | The bulk operation job ID |
|
||||
|
||||
### `zendesk_update_user`
|
||||
@@ -420,7 +889,48 @@ Update an existing user in Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | json | Updated user object |
|
||||
| `user` | object | Updated user object |
|
||||
| ↳ `id` | number | Automatically assigned user ID |
|
||||
| ↳ `url` | string | API URL of the user |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | Primary email address |
|
||||
| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) |
|
||||
| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) |
|
||||
| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) |
|
||||
| ↳ `phone` | string | Phone number |
|
||||
| ↳ `shared_phone_number` | boolean | Whether the phone number is shared |
|
||||
| ↳ `photo` | object | User photo details |
|
||||
| ↳ `content_url` | string | URL to the photo |
|
||||
| ↳ `file_name` | string | Photo file name |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `locale` | string | Locale \(e.g., en-US\) |
|
||||
| ↳ `locale_id` | number | Locale ID |
|
||||
| ↳ `organization_id` | number | Primary organization ID |
|
||||
| ↳ `role` | string | User role \(end-user, agent, admin\) |
|
||||
| ↳ `role_type` | number | Role type identifier |
|
||||
| ↳ `custom_role_id` | number | Custom role ID |
|
||||
| ↳ `active` | boolean | Whether the user is active \(false if deleted\) |
|
||||
| ↳ `verified` | boolean | Whether any user identity has been verified |
|
||||
| ↳ `alias` | string | Alias displayed to end users |
|
||||
| ↳ `details` | string | Details about the user |
|
||||
| ↳ `notes` | string | Notes about the user |
|
||||
| ↳ `signature` | string | User signature for email replies |
|
||||
| ↳ `default_group_id` | number | Default group ID for the user |
|
||||
| ↳ `tags` | array | Tags associated with the user |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| ↳ `restricted_agent` | boolean | Whether the agent has restrictions |
|
||||
| ↳ `suspended` | boolean | Whether the user is suspended |
|
||||
| ↳ `moderator` | boolean | Whether the user has moderator permissions |
|
||||
| ↳ `chat_only` | boolean | Whether the user is a chat-only agent |
|
||||
| ↳ `only_private_comments` | boolean | Whether the user can only create private comments |
|
||||
| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled |
|
||||
| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) |
|
||||
| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) |
|
||||
| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) |
|
||||
| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk |
|
||||
| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk |
|
||||
| ↳ `remote_photo_url` | string | URL to a remote photo |
|
||||
| `user_id` | number | The updated user ID |
|
||||
|
||||
### `zendesk_update_users_bulk`
|
||||
@@ -440,7 +950,21 @@ Update multiple users in Zendesk using bulk update
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `job_status` | object | Job status object |
|
||||
| `job_status` | object | Job status object for bulk operations |
|
||||
| ↳ `id` | string | Automatically assigned job ID |
|
||||
| ↳ `url` | string | URL to poll for status updates |
|
||||
| ↳ `status` | string | Current job status \(queued, working, failed, completed\) |
|
||||
| ↳ `job_type` | string | Category of background task |
|
||||
| ↳ `total` | number | Total number of tasks in this job |
|
||||
| ↳ `progress` | number | Number of tasks already completed |
|
||||
| ↳ `message` | string | Message from the job worker |
|
||||
| ↳ `results` | array | Array of result objects from the job |
|
||||
| ↳ `id` | number | ID of the created or updated resource |
|
||||
| ↳ `index` | number | Position of the result in the batch |
|
||||
| ↳ `action` | string | Action performed \(e.g., create, update\) |
|
||||
| ↳ `success` | boolean | Whether the operation succeeded |
|
||||
| ↳ `status` | string | Status message \(e.g., Updated, Created\) |
|
||||
| ↳ `error` | string | Error message if operation failed |
|
||||
| `job_id` | string | The bulk operation job ID |
|
||||
|
||||
### `zendesk_delete_user`
|
||||
@@ -482,13 +1006,27 @@ Retrieve a list of organizations from Zendesk
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Array of organization objects |
|
||||
| ↳ `id` | number | Automatically assigned organization ID |
|
||||
| ↳ `url` | string | API URL of the organization |
|
||||
| ↳ `name` | string | Unique organization name |
|
||||
| ↳ `domain_names` | array | Domain names for automatic user assignment |
|
||||
| ↳ `details` | string | Details about the organization |
|
||||
| ↳ `notes` | string | Notes about the organization |
|
||||
| ↳ `group_id` | number | Group ID for auto-routing new tickets |
|
||||
| ↳ `shared_tickets` | boolean | Whether end users can see each others tickets |
|
||||
| ↳ `shared_comments` | boolean | Whether end users can see each others comments |
|
||||
| ↳ `tags` | array | Tags associated with the organization |
|
||||
| ↳ `organization_fields` | json | Custom organization fields \(dynamic key-value pairs\) |
|
||||
| ↳ `created_at` | string | When the organization was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the organization was last updated \(ISO 8601 format\) |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| `paging` | object | Pagination information |
|
||||
| ↳ `next_page` | string | URL for next page of results |
|
||||
| ↳ `previous_page` | string | URL for previous page of results |
|
||||
| ↳ `count` | number | Total count of organizations |
|
||||
| ↳ `count` | number | Total count of items |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `total_returned` | number | Number of organizations returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more organizations are available |
|
||||
| ↳ `total_returned` | number | Number of items returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more items are available |
|
||||
|
||||
### `zendesk_get_organization`
|
||||
|
||||
@@ -507,7 +1045,21 @@ Get a single organization by ID from Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | json | Organization object |
|
||||
| `organization` | object | Organization object |
|
||||
| ↳ `id` | number | Automatically assigned organization ID |
|
||||
| ↳ `url` | string | API URL of the organization |
|
||||
| ↳ `name` | string | Unique organization name |
|
||||
| ↳ `domain_names` | array | Domain names for automatic user assignment |
|
||||
| ↳ `details` | string | Details about the organization |
|
||||
| ↳ `notes` | string | Notes about the organization |
|
||||
| ↳ `group_id` | number | Group ID for auto-routing new tickets |
|
||||
| ↳ `shared_tickets` | boolean | Whether end users can see each others tickets |
|
||||
| ↳ `shared_comments` | boolean | Whether end users can see each others comments |
|
||||
| ↳ `tags` | array | Tags associated with the organization |
|
||||
| ↳ `organization_fields` | json | Custom organization fields \(dynamic key-value pairs\) |
|
||||
| ↳ `created_at` | string | When the organization was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the organization was last updated \(ISO 8601 format\) |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| `organization_id` | number | The organization ID |
|
||||
|
||||
### `zendesk_autocomplete_organizations`
|
||||
@@ -530,13 +1082,27 @@ Autocomplete organizations in Zendesk by name prefix (for name matching/autocomp
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Array of organization objects |
|
||||
| ↳ `id` | number | Automatically assigned organization ID |
|
||||
| ↳ `url` | string | API URL of the organization |
|
||||
| ↳ `name` | string | Unique organization name |
|
||||
| ↳ `domain_names` | array | Domain names for automatic user assignment |
|
||||
| ↳ `details` | string | Details about the organization |
|
||||
| ↳ `notes` | string | Notes about the organization |
|
||||
| ↳ `group_id` | number | Group ID for auto-routing new tickets |
|
||||
| ↳ `shared_tickets` | boolean | Whether end users can see each others tickets |
|
||||
| ↳ `shared_comments` | boolean | Whether end users can see each others comments |
|
||||
| ↳ `tags` | array | Tags associated with the organization |
|
||||
| ↳ `organization_fields` | json | Custom organization fields \(dynamic key-value pairs\) |
|
||||
| ↳ `created_at` | string | When the organization was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the organization was last updated \(ISO 8601 format\) |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| `paging` | object | Pagination information |
|
||||
| ↳ `next_page` | string | URL for next page of results |
|
||||
| ↳ `previous_page` | string | URL for previous page of results |
|
||||
| ↳ `count` | number | Total count of organizations |
|
||||
| ↳ `count` | number | Total count of items |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `total_returned` | number | Number of organizations returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more organizations are available |
|
||||
| ↳ `total_returned` | number | Number of items returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more items are available |
|
||||
|
||||
### `zendesk_create_organization`
|
||||
|
||||
@@ -560,7 +1126,21 @@ Create a new organization in Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | json | Created organization object |
|
||||
| `organization` | object | Created organization object |
|
||||
| ↳ `id` | number | Automatically assigned organization ID |
|
||||
| ↳ `url` | string | API URL of the organization |
|
||||
| ↳ `name` | string | Unique organization name |
|
||||
| ↳ `domain_names` | array | Domain names for automatic user assignment |
|
||||
| ↳ `details` | string | Details about the organization |
|
||||
| ↳ `notes` | string | Notes about the organization |
|
||||
| ↳ `group_id` | number | Group ID for auto-routing new tickets |
|
||||
| ↳ `shared_tickets` | boolean | Whether end users can see each others tickets |
|
||||
| ↳ `shared_comments` | boolean | Whether end users can see each others comments |
|
||||
| ↳ `tags` | array | Tags associated with the organization |
|
||||
| ↳ `organization_fields` | json | Custom organization fields \(dynamic key-value pairs\) |
|
||||
| ↳ `created_at` | string | When the organization was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the organization was last updated \(ISO 8601 format\) |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| `organization_id` | number | The created organization ID |
|
||||
|
||||
### `zendesk_create_organizations_bulk`
|
||||
@@ -580,7 +1160,21 @@ Create multiple organizations in Zendesk using bulk import
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `job_status` | object | Job status object |
|
||||
| `job_status` | object | Job status object for bulk operations |
|
||||
| ↳ `id` | string | Automatically assigned job ID |
|
||||
| ↳ `url` | string | URL to poll for status updates |
|
||||
| ↳ `status` | string | Current job status \(queued, working, failed, completed\) |
|
||||
| ↳ `job_type` | string | Category of background task |
|
||||
| ↳ `total` | number | Total number of tasks in this job |
|
||||
| ↳ `progress` | number | Number of tasks already completed |
|
||||
| ↳ `message` | string | Message from the job worker |
|
||||
| ↳ `results` | array | Array of result objects from the job |
|
||||
| ↳ `id` | number | ID of the created or updated resource |
|
||||
| ↳ `index` | number | Position of the result in the batch |
|
||||
| ↳ `action` | string | Action performed \(e.g., create, update\) |
|
||||
| ↳ `success` | boolean | Whether the operation succeeded |
|
||||
| ↳ `status` | string | Status message \(e.g., Updated, Created\) |
|
||||
| ↳ `error` | string | Error message if operation failed |
|
||||
| `job_id` | string | The bulk operation job ID |
|
||||
|
||||
### `zendesk_update_organization`
|
||||
@@ -606,7 +1200,21 @@ Update an existing organization in Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | json | Updated organization object |
|
||||
| `organization` | object | Updated organization object |
|
||||
| ↳ `id` | number | Automatically assigned organization ID |
|
||||
| ↳ `url` | string | API URL of the organization |
|
||||
| ↳ `name` | string | Unique organization name |
|
||||
| ↳ `domain_names` | array | Domain names for automatic user assignment |
|
||||
| ↳ `details` | string | Details about the organization |
|
||||
| ↳ `notes` | string | Notes about the organization |
|
||||
| ↳ `group_id` | number | Group ID for auto-routing new tickets |
|
||||
| ↳ `shared_tickets` | boolean | Whether end users can see each others tickets |
|
||||
| ↳ `shared_comments` | boolean | Whether end users can see each others comments |
|
||||
| ↳ `tags` | array | Tags associated with the organization |
|
||||
| ↳ `organization_fields` | json | Custom organization fields \(dynamic key-value pairs\) |
|
||||
| ↳ `created_at` | string | When the organization was created \(ISO 8601 format\) |
|
||||
| ↳ `updated_at` | string | When the organization was last updated \(ISO 8601 format\) |
|
||||
| ↳ `external_id` | string | External ID for linking to external records |
|
||||
| `organization_id` | number | The updated organization ID |
|
||||
|
||||
### `zendesk_delete_organization`
|
||||
@@ -650,14 +1258,14 @@ Unified search across tickets, users, and organizations in Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array of result objects |
|
||||
| `paging` | object | Pagination information |
|
||||
| ↳ `next_page` | string | URL for next page of results |
|
||||
| ↳ `previous_page` | string | URL for previous page of results |
|
||||
| ↳ `count` | number | Total count of results |
|
||||
| ↳ `count` | number | Total count of items |
|
||||
| `metadata` | object | Response metadata |
|
||||
| ↳ `total_returned` | number | Number of results returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more results are available |
|
||||
| ↳ `total_returned` | number | Number of items returned in this response |
|
||||
| ↳ `has_more` | boolean | Whether more items are available |
|
||||
| `results` | array | Array of result objects \(tickets, users, or organizations depending on search query\) |
|
||||
|
||||
### `zendesk_search_count`
|
||||
|
||||
|
||||
@@ -52,10 +52,10 @@ Start a new conversation thread in Zep
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `threadId` | string | The thread ID |
|
||||
| `userId` | string | The user ID |
|
||||
| `threadId` | string | Thread identifier |
|
||||
| `userId` | string | Associated user ID |
|
||||
| `uuid` | string | Internal UUID |
|
||||
| `createdAt` | string | Creation timestamp |
|
||||
| `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| `projectUuid` | string | Project UUID |
|
||||
|
||||
### `zep_get_threads`
|
||||
@@ -77,8 +77,15 @@ List all conversation threads
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `threads` | array | Array of thread objects |
|
||||
| `responseCount` | number | Number of threads in this response |
|
||||
| `totalCount` | number | Total number of threads available |
|
||||
| ↳ `threadId` | string | Thread identifier |
|
||||
| ↳ `userId` | string | Associated user ID |
|
||||
| ↳ `uuid` | string | Internal UUID |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| ↳ `projectUuid` | string | Project UUID |
|
||||
| ↳ `metadata` | object | Custom metadata \(dynamic key-value pairs\) |
|
||||
| `responseCount` | number | Number of items in this response |
|
||||
| `totalCount` | number | Total number of items available |
|
||||
|
||||
### `zep_delete_thread`
|
||||
|
||||
@@ -135,8 +142,16 @@ Retrieve messages from a thread
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `messages` | array | Array of message objects |
|
||||
| `rowCount` | number | Number of messages in this response |
|
||||
| `totalCount` | number | Total number of messages in the thread |
|
||||
| ↳ `uuid` | string | Message UUID |
|
||||
| ↳ `role` | string | Message role \(user, assistant, system, tool\) |
|
||||
| ↳ `roleType` | string | Role type \(AI, human, tool\) |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `name` | string | Sender name |
|
||||
| ↳ `createdAt` | string | Timestamp \(RFC3339 format\) |
|
||||
| ↳ `metadata` | object | Message metadata \(dynamic key-value pairs\) |
|
||||
| ↳ `processed` | boolean | Whether message has been processed |
|
||||
| `rowCount` | number | Number of rows returned |
|
||||
| `totalCount` | number | Total number of items available |
|
||||
|
||||
### `zep_add_messages`
|
||||
|
||||
@@ -154,7 +169,7 @@ Add messages to an existing thread
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `threadId` | string | The thread ID |
|
||||
| `threadId` | string | Thread identifier |
|
||||
| `added` | boolean | Whether messages were added successfully |
|
||||
| `messageIds` | array | Array of added message UUIDs |
|
||||
|
||||
@@ -177,13 +192,13 @@ Create a new user in Zep
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `userId` | string | The user ID |
|
||||
| `email` | string | User email |
|
||||
| `userId` | string | User identifier |
|
||||
| `email` | string | User email address |
|
||||
| `firstName` | string | User first name |
|
||||
| `lastName` | string | User last name |
|
||||
| `uuid` | string | Internal UUID |
|
||||
| `createdAt` | string | Creation timestamp |
|
||||
| `metadata` | object | User metadata |
|
||||
| `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| `metadata` | object | User metadata \(dynamic key-value pairs\) |
|
||||
|
||||
### `zep_get_user`
|
||||
|
||||
@@ -200,14 +215,14 @@ Retrieve user information from Zep
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `userId` | string | The user ID |
|
||||
| `email` | string | User email |
|
||||
| `userId` | string | User identifier |
|
||||
| `email` | string | User email address |
|
||||
| `firstName` | string | User first name |
|
||||
| `lastName` | string | User last name |
|
||||
| `uuid` | string | Internal UUID |
|
||||
| `createdAt` | string | Creation timestamp |
|
||||
| `updatedAt` | string | Last update timestamp |
|
||||
| `metadata` | object | User metadata |
|
||||
| `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| `metadata` | object | User metadata \(dynamic key-value pairs\) |
|
||||
|
||||
### `zep_get_user_threads`
|
||||
|
||||
@@ -225,7 +240,14 @@ List all conversation threads for a specific user
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `threads` | array | Array of thread objects for this user |
|
||||
| `totalCount` | number | Total number of threads returned |
|
||||
| `threads` | array | Array of thread objects |
|
||||
| ↳ `threadId` | string | Thread identifier |
|
||||
| ↳ `userId` | string | Associated user ID |
|
||||
| ↳ `uuid` | string | Internal UUID |
|
||||
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
|
||||
| ↳ `projectUuid` | string | Project UUID |
|
||||
| ↳ `metadata` | object | Custom metadata \(dynamic key-value pairs\) |
|
||||
| `totalCount` | number | Total number of items available |
|
||||
|
||||
|
||||
|
||||
@@ -72,19 +72,46 @@ Create a new Zoom meeting
|
||||
| ↳ `id` | number | Meeting ID |
|
||||
| ↳ `uuid` | string | Meeting UUID |
|
||||
| ↳ `host_id` | string | Host user ID |
|
||||
| ↳ `host_email` | string | Host email |
|
||||
| ↳ `host_email` | string | Host email address |
|
||||
| ↳ `topic` | string | Meeting topic |
|
||||
| ↳ `type` | number | Meeting type |
|
||||
| ↳ `status` | string | Meeting status |
|
||||
| ↳ `start_time` | string | Start time |
|
||||
| ↳ `type` | number | Meeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time |
|
||||
| ↳ `status` | string | Meeting status \(e.g., waiting, started\) |
|
||||
| ↳ `start_time` | string | Start time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `timezone` | string | Timezone |
|
||||
| ↳ `timezone` | string | Timezone \(e.g., America/Los_Angeles\) |
|
||||
| ↳ `agenda` | string | Meeting agenda |
|
||||
| ↳ `created_at` | string | Creation timestamp |
|
||||
| ↳ `start_url` | string | Host start URL |
|
||||
| ↳ `join_url` | string | Participant join URL |
|
||||
| ↳ `created_at` | string | Creation timestamp in ISO 8601 format |
|
||||
| ↳ `start_url` | string | URL for host to start the meeting |
|
||||
| ↳ `join_url` | string | URL for participants to join the meeting |
|
||||
| ↳ `password` | string | Meeting password |
|
||||
| ↳ `h323_password` | string | H.323/SIP room system password |
|
||||
| ↳ `pstn_password` | string | PSTN password for phone dial-in |
|
||||
| ↳ `encrypted_password` | string | Encrypted password for joining |
|
||||
| ↳ `settings` | object | Meeting settings |
|
||||
| ↳ `host_video` | boolean | Start with host video on |
|
||||
| ↳ `participant_video` | boolean | Start with participant video on |
|
||||
| ↳ `join_before_host` | boolean | Allow participants to join before host |
|
||||
| ↳ `mute_upon_entry` | boolean | Mute participants upon entry |
|
||||
| ↳ `watermark` | boolean | Add watermark when viewing shared screen |
|
||||
| ↳ `audio` | string | Audio options: both, telephony, or voip |
|
||||
| ↳ `auto_recording` | string | Auto recording: local, cloud, or none |
|
||||
| ↳ `waiting_room` | boolean | Enable waiting room |
|
||||
| ↳ `meeting_authentication` | boolean | Require meeting authentication |
|
||||
| ↳ `approval_type` | number | Approval type: 0=auto, 1=manual, 2=none |
|
||||
| ↳ `recurrence` | object | Recurrence settings for recurring meetings |
|
||||
| ↳ `type` | number | Recurrence type: 1=daily, 2=weekly, 3=monthly |
|
||||
| ↳ `repeat_interval` | number | Interval between recurring meetings |
|
||||
| ↳ `weekly_days` | string | Days of week for weekly recurrence \(1-7, comma-separated\) |
|
||||
| ↳ `monthly_day` | number | Day of month for monthly recurrence |
|
||||
| ↳ `monthly_week` | number | Week of month for monthly recurrence |
|
||||
| ↳ `monthly_week_day` | number | Day of week for monthly recurrence |
|
||||
| ↳ `end_times` | number | Number of occurrences |
|
||||
| ↳ `end_date_time` | string | End date time in ISO 8601 format |
|
||||
| ↳ `occurrences` | array | Meeting occurrences for recurring meetings |
|
||||
| ↳ `occurrence_id` | string | Occurrence ID |
|
||||
| ↳ `start_time` | string | Start time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `status` | string | Occurrence status |
|
||||
|
||||
### `zoom_list_meetings`
|
||||
|
||||
@@ -104,12 +131,23 @@ List all meetings for a Zoom user
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `meetings` | array | List of meetings |
|
||||
| ↳ `id` | number | Meeting ID |
|
||||
| ↳ `uuid` | string | Meeting UUID |
|
||||
| ↳ `host_id` | string | Host user ID |
|
||||
| ↳ `topic` | string | Meeting topic |
|
||||
| ↳ `type` | number | Meeting type |
|
||||
| ↳ `start_time` | string | Start time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `timezone` | string | Timezone |
|
||||
| ↳ `agenda` | string | Meeting agenda |
|
||||
| ↳ `created_at` | string | Creation timestamp |
|
||||
| ↳ `join_url` | string | URL for participants to join |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `pageCount` | number | Total number of pages |
|
||||
| ↳ `pageNumber` | number | Current page number |
|
||||
| ↳ `pageSize` | number | Number of records per page |
|
||||
| ↳ `totalRecords` | number | Total number of records |
|
||||
| ↳ `nextPageToken` | string | Token for next page |
|
||||
| ↳ `nextPageToken` | string | Token for next page of results |
|
||||
|
||||
### `zoom_get_meeting`
|
||||
|
||||
@@ -131,21 +169,46 @@ Get details of a specific Zoom meeting
|
||||
| ↳ `id` | number | Meeting ID |
|
||||
| ↳ `uuid` | string | Meeting UUID |
|
||||
| ↳ `host_id` | string | Host user ID |
|
||||
| ↳ `host_email` | string | Host email |
|
||||
| ↳ `host_email` | string | Host email address |
|
||||
| ↳ `topic` | string | Meeting topic |
|
||||
| ↳ `type` | number | Meeting type |
|
||||
| ↳ `status` | string | Meeting status |
|
||||
| ↳ `start_time` | string | Start time |
|
||||
| ↳ `type` | number | Meeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time |
|
||||
| ↳ `status` | string | Meeting status \(e.g., waiting, started\) |
|
||||
| ↳ `start_time` | string | Start time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `timezone` | string | Timezone |
|
||||
| ↳ `timezone` | string | Timezone \(e.g., America/Los_Angeles\) |
|
||||
| ↳ `agenda` | string | Meeting agenda |
|
||||
| ↳ `created_at` | string | Creation timestamp |
|
||||
| ↳ `start_url` | string | Host start URL |
|
||||
| ↳ `join_url` | string | Participant join URL |
|
||||
| ↳ `created_at` | string | Creation timestamp in ISO 8601 format |
|
||||
| ↳ `start_url` | string | URL for host to start the meeting |
|
||||
| ↳ `join_url` | string | URL for participants to join the meeting |
|
||||
| ↳ `password` | string | Meeting password |
|
||||
| ↳ `h323_password` | string | H.323/SIP room system password |
|
||||
| ↳ `pstn_password` | string | PSTN password for phone dial-in |
|
||||
| ↳ `encrypted_password` | string | Encrypted password for joining |
|
||||
| ↳ `settings` | object | Meeting settings |
|
||||
| ↳ `recurrence` | object | Recurrence settings |
|
||||
| ↳ `occurrences` | array | Meeting occurrences |
|
||||
| ↳ `host_video` | boolean | Start with host video on |
|
||||
| ↳ `participant_video` | boolean | Start with participant video on |
|
||||
| ↳ `join_before_host` | boolean | Allow participants to join before host |
|
||||
| ↳ `mute_upon_entry` | boolean | Mute participants upon entry |
|
||||
| ↳ `watermark` | boolean | Add watermark when viewing shared screen |
|
||||
| ↳ `audio` | string | Audio options: both, telephony, or voip |
|
||||
| ↳ `auto_recording` | string | Auto recording: local, cloud, or none |
|
||||
| ↳ `waiting_room` | boolean | Enable waiting room |
|
||||
| ↳ `meeting_authentication` | boolean | Require meeting authentication |
|
||||
| ↳ `approval_type` | number | Approval type: 0=auto, 1=manual, 2=none |
|
||||
| ↳ `recurrence` | object | Recurrence settings for recurring meetings |
|
||||
| ↳ `type` | number | Recurrence type: 1=daily, 2=weekly, 3=monthly |
|
||||
| ↳ `repeat_interval` | number | Interval between recurring meetings |
|
||||
| ↳ `weekly_days` | string | Days of week for weekly recurrence \(1-7, comma-separated\) |
|
||||
| ↳ `monthly_day` | number | Day of month for monthly recurrence |
|
||||
| ↳ `monthly_week` | number | Week of month for monthly recurrence |
|
||||
| ↳ `monthly_week_day` | number | Day of week for monthly recurrence |
|
||||
| ↳ `end_times` | number | Number of occurrences |
|
||||
| ↳ `end_date_time` | string | End date time in ISO 8601 format |
|
||||
| ↳ `occurrences` | array | Meeting occurrences for recurring meetings |
|
||||
| ↳ `occurrence_id` | string | Occurrence ID |
|
||||
| ↳ `start_time` | string | Start time in ISO 8601 format |
|
||||
| ↳ `duration` | number | Duration in minutes |
|
||||
| ↳ `status` | string | Occurrence status |
|
||||
|
||||
### `zoom_update_meeting`
|
||||
|
||||
@@ -231,12 +294,35 @@ List all cloud recordings for a Zoom user
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `recordings` | array | List of recordings |
|
||||
| ↳ `uuid` | string | Meeting UUID |
|
||||
| ↳ `id` | number | Meeting ID |
|
||||
| ↳ `account_id` | string | Account ID |
|
||||
| ↳ `host_id` | string | Host user ID |
|
||||
| ↳ `topic` | string | Meeting topic |
|
||||
| ↳ `type` | number | Meeting type |
|
||||
| ↳ `start_time` | string | Meeting start time |
|
||||
| ↳ `duration` | number | Meeting duration in minutes |
|
||||
| ↳ `total_size` | number | Total size of all recordings in bytes |
|
||||
| ↳ `recording_count` | number | Number of recording files |
|
||||
| ↳ `share_url` | string | URL to share recordings |
|
||||
| ↳ `recording_files` | array | List of recording files |
|
||||
| ↳ `id` | string | Recording file ID |
|
||||
| ↳ `meeting_id` | string | Meeting ID associated with the recording |
|
||||
| ↳ `recording_start` | string | Start time of the recording |
|
||||
| ↳ `recording_end` | string | End time of the recording |
|
||||
| ↳ `file_type` | string | Type of recording file \(MP4, M4A, etc.\) |
|
||||
| ↳ `file_extension` | string | File extension |
|
||||
| ↳ `file_size` | number | File size in bytes |
|
||||
| ↳ `play_url` | string | URL to play the recording |
|
||||
| ↳ `download_url` | string | URL to download the recording |
|
||||
| ↳ `status` | string | Recording status |
|
||||
| ↳ `recording_type` | string | Type of recording \(shared_screen, audio_only, etc.\) |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `from` | string | Start date of query range |
|
||||
| ↳ `to` | string | End date of query range |
|
||||
| ↳ `pageSize` | number | Number of records per page |
|
||||
| ↳ `totalRecords` | number | Total number of records |
|
||||
| ↳ `nextPageToken` | string | Token for next page |
|
||||
| ↳ `nextPageToken` | string | Token for next page of results |
|
||||
|
||||
### `zoom_get_meeting_recordings`
|
||||
|
||||
@@ -257,12 +343,27 @@ Get all recordings for a specific Zoom meeting
|
||||
| `recording` | object | The meeting recording with all files |
|
||||
| ↳ `uuid` | string | Meeting UUID |
|
||||
| ↳ `id` | number | Meeting ID |
|
||||
| ↳ `account_id` | string | Account ID |
|
||||
| ↳ `host_id` | string | Host user ID |
|
||||
| ↳ `topic` | string | Meeting topic |
|
||||
| ↳ `type` | number | Meeting type |
|
||||
| ↳ `start_time` | string | Meeting start time |
|
||||
| ↳ `duration` | number | Meeting duration in minutes |
|
||||
| ↳ `total_size` | number | Total size of recordings in bytes |
|
||||
| ↳ `total_size` | number | Total size of all recordings in bytes |
|
||||
| ↳ `recording_count` | number | Number of recording files |
|
||||
| ↳ `share_url` | string | URL to share recordings |
|
||||
| ↳ `recording_files` | array | List of recording files |
|
||||
| ↳ `id` | string | Recording file ID |
|
||||
| ↳ `meeting_id` | string | Meeting ID associated with the recording |
|
||||
| ↳ `recording_start` | string | Start time of the recording |
|
||||
| ↳ `recording_end` | string | End time of the recording |
|
||||
| ↳ `file_type` | string | Type of recording file \(MP4, M4A, etc.\) |
|
||||
| ↳ `file_extension` | string | File extension |
|
||||
| ↳ `file_size` | number | File size in bytes |
|
||||
| ↳ `play_url` | string | URL to play the recording |
|
||||
| ↳ `download_url` | string | URL to download the recording |
|
||||
| ↳ `status` | string | Recording status |
|
||||
| ↳ `recording_type` | string | Type of recording \(shared_screen, audio_only, etc.\) |
|
||||
|
||||
### `zoom_delete_recording`
|
||||
|
||||
@@ -299,9 +400,19 @@ List participants from a past Zoom meeting
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `participants` | array | List of meeting participants |
|
||||
| ↳ `id` | string | Participant unique identifier |
|
||||
| ↳ `user_id` | string | User ID if registered Zoom user |
|
||||
| ↳ `name` | string | Participant display name |
|
||||
| ↳ `user_email` | string | Participant email address |
|
||||
| ↳ `join_time` | string | Time when participant joined \(ISO 8601\) |
|
||||
| ↳ `leave_time` | string | Time when participant left \(ISO 8601\) |
|
||||
| ↳ `duration` | number | Duration in seconds participant was in meeting |
|
||||
| ↳ `attentiveness_score` | string | Attentiveness score \(deprecated\) |
|
||||
| ↳ `failover` | boolean | Whether participant failed over to another data center |
|
||||
| ↳ `status` | string | Participant status |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
| ↳ `pageSize` | number | Number of records per page |
|
||||
| ↳ `totalRecords` | number | Total number of records |
|
||||
| ↳ `nextPageToken` | string | Token for next page |
|
||||
| ↳ `nextPageToken` | string | Token for next page of results |
|
||||
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ Los servidores MCP agrupan tus herramientas de flujo de trabajo. Créalos y gest
|
||||
<Video src="mcp/mcp-server.mp4" width={700} height={450} />
|
||||
</div>
|
||||
|
||||
1. Navega a **Configuración → MCP implementados**
|
||||
1. Navega a **Configuración → Servidores MCP**
|
||||
2. Haz clic en **Crear servidor**
|
||||
3. Introduce un nombre y una descripción opcional
|
||||
4. Copia la URL del servidor para usarla en tus clientes MCP
|
||||
@@ -79,7 +79,7 @@ Incluye tu encabezado de clave API (`X-API-Key`) para acceso autenticado al usar
|
||||
|
||||
## Gestión del servidor
|
||||
|
||||
Desde la vista de detalles del servidor en **Configuración → MCP implementados**, puedes:
|
||||
Desde la vista de detalles del servidor en **Configuración → Servidores MCP**, puedes:
|
||||
|
||||
- **Ver herramientas**: consulta todos los flujos de trabajo añadidos a un servidor
|
||||
- **Copiar URL**: obtén la URL del servidor para clientes MCP
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user