mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-31 01:37:58 -05:00
Compare commits
91 Commits
fix/s-tool
...
fix/visibi
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b5fcb573fd | ||
|
|
cc22cbff52 | ||
|
|
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 | ||
|
|
bcf6dc8828 | ||
|
|
841cb638fb | ||
|
|
c7db48e3a2 | ||
|
|
4d844651c2 |
@@ -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
|
||||
|
||||
35
.github/workflows/ci.yml
vendored
35
.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
|
||||
@@ -27,10 +30,11 @@ jobs:
|
||||
steps:
|
||||
- name: Extract version from commit message
|
||||
id: extract
|
||||
env:
|
||||
COMMIT_MSG: ${{ github.event.head_commit.message }}
|
||||
run: |
|
||||
COMMIT_MSG="${{ github.event.head_commit.message }}"
|
||||
# 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
|
||||
@@ -277,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
|
||||
{/* Title at top */}
|
||||
<span
|
||||
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',
|
||||
fontSize: getTitleFontSize(title),
|
||||
fontWeight: 500,
|
||||
color: '#fafafa', // Light text matching docs
|
||||
lineHeight: 1.2,
|
||||
letterSpacing: '-0.02em',
|
||||
}}
|
||||
>
|
||||
{/* Logo */}
|
||||
<img src={`${baseUrl}/static/logo.png`} alt='sim' height={32} />
|
||||
{title}
|
||||
</span>
|
||||
|
||||
{/* Title */}
|
||||
<span
|
||||
style={{
|
||||
fontSize: getTitleFontSize(title),
|
||||
fontWeight: 600,
|
||||
color: '#ffffff',
|
||||
lineHeight: 1.1,
|
||||
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>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -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,29 +109,37 @@ 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]) => (
|
||||
<button
|
||||
key={code}
|
||||
onClick={(e) => {
|
||||
e.preventDefault()
|
||||
e.stopPropagation()
|
||||
handleLanguageChange(code)
|
||||
}}
|
||||
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' />
|
||||
)}
|
||||
</button>
|
||||
))}
|
||||
{languageEntries.map(([code, lang], index) => {
|
||||
const isSelected = currentLang === code
|
||||
const isHovered = hoveredIndex === index
|
||||
|
||||
return (
|
||||
<button
|
||||
key={code}
|
||||
onClick={(e) => {
|
||||
e.preventDefault()
|
||||
e.stopPropagation()
|
||||
handleLanguageChange(code)
|
||||
}}
|
||||
onMouseEnter={() => setHoveredIndex(index)}
|
||||
onMouseLeave={() => setHoveredIndex(-1)}
|
||||
role='option'
|
||||
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 |
|
||||
|
||||
|
||||
|
||||
@@ -60,11 +60,11 @@ Get a list of backlinks pointing to a target domain or URL. Returns details abou
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain or URL to analyze |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
|
||||
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
@@ -88,8 +88,8 @@ Get backlink statistics for a target domain or URL. Returns totals for different
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain or URL to analyze |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
|
||||
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
@@ -98,12 +98,12 @@ Get backlink statistics for a target domain or URL. Returns totals for different
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stats` | object | Backlink statistics summary |
|
||||
| ↳ `total` | number | Total number of live backlinks |
|
||||
| ↳ `dofollow` | number | Number of dofollow backlinks |
|
||||
| ↳ `nofollow` | number | Number of nofollow backlinks |
|
||||
| ↳ `text` | number | Number of text backlinks |
|
||||
| ↳ `image` | number | Number of image backlinks |
|
||||
| ↳ `redirect` | number | Number of redirect backlinks |
|
||||
| ↳ `total` | number | Total number of live backlinks |
|
||||
| ↳ `dofollow` | number | Number of dofollow backlinks |
|
||||
| ↳ `nofollow` | number | Number of nofollow backlinks |
|
||||
| ↳ `text` | number | Number of text backlinks |
|
||||
| ↳ `image` | number | Number of image backlinks |
|
||||
| ↳ `redirect` | number | Number of redirect backlinks |
|
||||
|
||||
### `ahrefs_referring_domains`
|
||||
|
||||
@@ -113,11 +113,11 @@ Get a list of domains that link to a target domain or URL. Returns unique referr
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain or URL to analyze |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
|
||||
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
@@ -140,12 +140,12 @@ Get organic keywords that a target domain or URL ranks for in Google search resu
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain or URL to analyze |
|
||||
| `country` | string | No | Country code for search results \(e.g., us, gb, de\). Default: us |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
|
||||
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
|
||||
| `country` | string | No | Country code for search results. Example: "us", "gb", "de" \(default: "us"\) |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
@@ -168,12 +168,12 @@ Get the top pages of a target domain sorted by organic traffic. Returns page URL
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain to analyze |
|
||||
| `country` | string | No | Country code for traffic data \(e.g., us, gb, de\). Default: us |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\) |
|
||||
| `target` | string | Yes | The target domain to analyze. Example: "example.com" |
|
||||
| `country` | string | No | Country code for traffic data. Example: "us", "gb", "de" \(default: "us"\) |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\). Example: "domain" |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
|
||||
| `select` | string | No | Comma-separated list of fields to return \(e.g., url,traffic,keywords,top_keyword,value\). Default: url,traffic,keywords,top_keyword,value |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
@@ -197,7 +197,7 @@ Get detailed metrics for a keyword including search volume, keyword difficulty,
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyword` | string | Yes | The keyword to analyze |
|
||||
| `country` | string | No | Country code for keyword data \(e.g., us, gb, de\). Default: us |
|
||||
| `country` | string | No | Country code for keyword data. Example: "us", "gb", "de" \(default: "us"\) |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
@@ -205,14 +205,14 @@ Get detailed metrics for a keyword including search volume, keyword difficulty,
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `overview` | object | Keyword metrics overview |
|
||||
| ↳ `keyword` | string | The analyzed keyword |
|
||||
| ↳ `searchVolume` | number | Monthly search volume |
|
||||
| ↳ `keywordDifficulty` | number | Keyword difficulty score \(0-100\) |
|
||||
| ↳ `cpc` | number | Cost per click in USD |
|
||||
| ↳ `clicks` | number | Estimated clicks per month |
|
||||
| ↳ `clicksPercentage` | number | Percentage of searches that result in clicks |
|
||||
| ↳ `parentTopic` | string | The parent topic for this keyword |
|
||||
| ↳ `trafficPotential` | number | Estimated traffic potential if ranking #1 |
|
||||
| ↳ `keyword` | string | The analyzed keyword |
|
||||
| ↳ `searchVolume` | number | Monthly search volume |
|
||||
| ↳ `keywordDifficulty` | number | Keyword difficulty score \(0-100\) |
|
||||
| ↳ `cpc` | number | Cost per click in USD |
|
||||
| ↳ `clicks` | number | Estimated clicks per month |
|
||||
| ↳ `clicksPercentage` | number | Percentage of searches that result in clicks |
|
||||
| ↳ `parentTopic` | string | The parent topic for this keyword |
|
||||
| ↳ `trafficPotential` | number | Estimated traffic potential if ranking #1 |
|
||||
|
||||
### `ahrefs_broken_backlinks`
|
||||
|
||||
@@ -222,11 +222,11 @@ Get a list of broken backlinks pointing to a target domain or URL. Useful for id
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain or URL to analyze |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
|
||||
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -40,9 +40,9 @@ Read records from an Airtable table
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `baseId` | string | Yes | ID of the Airtable base |
|
||||
| `tableId` | string | Yes | ID of the table |
|
||||
| `maxRecords` | number | No | Maximum number of records to return |
|
||||
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
|
||||
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
|
||||
| `maxRecords` | number | No | Maximum number of records to return \(default: all records\) |
|
||||
| `filterFormula` | string | No | Formula to filter records \(e.g., "\(\{Field Name\} = \'Value\'\)"\) |
|
||||
|
||||
#### Output
|
||||
@@ -60,9 +60,9 @@ Retrieve a single record from an Airtable table by its ID
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `baseId` | string | Yes | ID of the Airtable base |
|
||||
| `tableId` | string | Yes | ID or name of the table |
|
||||
| `recordId` | string | Yes | ID of the record to retrieve |
|
||||
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
|
||||
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
|
||||
| `recordId` | string | Yes | Record ID to retrieve \(starts with "rec", e.g., "recXXXXXXXXXXXXXX"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -79,8 +79,8 @@ Write new records to an Airtable table
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `baseId` | string | Yes | ID of the Airtable base |
|
||||
| `tableId` | string | Yes | ID or name of the table |
|
||||
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
|
||||
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
|
||||
| `records` | json | Yes | Array of records to create, each with a `fields` object |
|
||||
| `fields` | string | No | No description |
|
||||
|
||||
@@ -99,9 +99,9 @@ Update an existing record in an Airtable table by ID
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `baseId` | string | Yes | ID of the Airtable base |
|
||||
| `tableId` | string | Yes | ID or name of the table |
|
||||
| `recordId` | string | Yes | ID of the record to update |
|
||||
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
|
||||
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
|
||||
| `recordId` | string | Yes | Record ID to update \(starts with "rec", e.g., "recXXXXXXXXXXXXXX"\) |
|
||||
| `fields` | json | Yes | An object containing the field names and their new values |
|
||||
|
||||
#### Output
|
||||
@@ -119,8 +119,8 @@ Update multiple existing records in an Airtable table
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `baseId` | string | Yes | ID of the Airtable base |
|
||||
| `tableId` | string | Yes | ID or name of the table |
|
||||
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
|
||||
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
|
||||
| `records` | json | Yes | Array of records to update, each with an `id` and a `fields` object |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -45,10 +45,12 @@ Run an APIFY actor synchronously and get results (max 5 minutes)
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations |
|
||||
| `actorId` | string | Yes | Actor ID or username/actor-name \(e.g., "janedoe/my-actor" or actor ID\) |
|
||||
| `input` | string | No | Actor input as JSON string. See actor documentation for required fields. |
|
||||
| `timeout` | number | No | Timeout in seconds \(default: actor default\) |
|
||||
| `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) |
|
||||
| `actorId` | string | Yes | Actor ID or username/actor-name. Examples: "apify/web-scraper", "janedoe/my-actor", "moJRLRc85AitArpNN" |
|
||||
| `input` | string | No | Actor input as JSON string. Example: \{"startUrls": \[\{"url": "https://example.com"\}\], "maxPages": 10\} |
|
||||
| `Example` | string | No | No description |
|
||||
| `memory` | number | No | Memory in megabytes allocated for the actor run \(128-32768\). Example: 1024 for 1GB, 2048 for 2GB |
|
||||
| `timeout` | number | No | Timeout in seconds for the actor run. Example: 300 for 5 minutes, 3600 for 1 hour |
|
||||
| `build` | string | No | Actor build to run. Examples: "latest", "beta", "1.2.3", "build-tag-name" |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -68,12 +70,14 @@ Run an APIFY actor asynchronously with polling for long-running tasks
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations |
|
||||
| `actorId` | string | Yes | Actor ID or username/actor-name \(e.g., "janedoe/my-actor" or actor ID\) |
|
||||
| `input` | string | No | Actor input as JSON string |
|
||||
| `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts |
|
||||
| `itemLimit` | number | No | Max dataset items to fetch \(1-250000, default 100\) |
|
||||
| `timeout` | number | No | Timeout in seconds \(default: actor default\) |
|
||||
| `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) |
|
||||
| `actorId` | string | Yes | Actor ID or username/actor-name. Examples: "apify/web-scraper", "janedoe/my-actor", "moJRLRc85AitArpNN" |
|
||||
| `input` | string | No | Actor input as JSON string. Example: \{"startUrls": \[\{"url": "https://example.com"\}\], "maxPages": 10\} |
|
||||
| `Example` | string | No | No description |
|
||||
| `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts. Example: 30 |
|
||||
| `itemLimit` | number | No | Max dataset items to fetch \(1-250000\). Default: 100. Example: 500 |
|
||||
| `memory` | number | No | Memory in megabytes allocated for the actor run \(128-32768\). Example: 1024 for 1GB, 2048 for 2GB |
|
||||
| `timeout` | number | No | Timeout in seconds for the actor run. Example: 300 for 5 minutes, 3600 for 1 hour |
|
||||
| `build` | string | No | Actor build to run. Examples: "latest", "beta", "1.2.3", "build-tag-name" |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -53,8 +53,8 @@ Search Apollo
|
||||
| `person_seniorities` | array | No | Seniority levels \(e.g., \["senior", "executive", "manager"\]\) |
|
||||
| `organization_names` | array | No | Company names to search within |
|
||||
| `q_keywords` | string | No | Keywords to search for |
|
||||
| `page` | number | No | Page number for pagination \(default: 1\) |
|
||||
| `per_page` | number | No | Results per page \(default: 25, max: 100\) |
|
||||
| `page` | number | No | Page number for pagination, default 1 \(e.g., 1, 2, 3\) |
|
||||
| `per_page` | number | No | Results per page, default 25, max 100 \(e.g., 25, 50, 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -78,7 +78,7 @@ Enrich data for a single person using Apollo
|
||||
| `last_name` | string | No | Last name of the person |
|
||||
| `email` | string | No | Email address of the person |
|
||||
| `organization_name` | string | No | Company name where the person works |
|
||||
| `domain` | string | No | Company domain \(e.g., apollo.io\) |
|
||||
| `domain` | string | No | Company domain \(e.g., "apollo.io", "acme.com"\) |
|
||||
| `linkedin_url` | string | No | LinkedIn profile URL |
|
||||
| `reveal_personal_emails` | boolean | No | Reveal personal email addresses \(uses credits\) |
|
||||
| `reveal_phone_number` | boolean | No | Reveal phone numbers \(uses credits\) |
|
||||
@@ -123,9 +123,9 @@ Search Apollo
|
||||
| `organization_locations` | array | No | Company locations to search |
|
||||
| `organization_num_employees_ranges` | array | No | Employee count ranges \(e.g., \["1-10", "11-50"\]\) |
|
||||
| `q_organization_keyword_tags` | array | No | Industry or keyword tags |
|
||||
| `q_organization_name` | string | No | Organization name to search for |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
||||
| `q_organization_name` | string | No | Organization name to search for \(e.g., "Acme", "TechCorp"\) |
|
||||
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -145,8 +145,8 @@ Enrich data for a single organization using Apollo
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key |
|
||||
| `organization_name` | string | No | Name of the organization \(at least one of organization_name or domain is required\) |
|
||||
| `domain` | string | No | Company domain \(e.g., apollo.io\) \(at least one of domain or organization_name is required\) |
|
||||
| `organization_name` | string | No | Name of the organization \(e.g., "Acme Corporation"\) - at least one of organization_name or domain is required |
|
||||
| `domain` | string | No | Company domain \(e.g., "apollo.io", "acme.com"\) - at least one of domain or organization_name is required |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -186,8 +186,8 @@ Create a new contact in your Apollo database
|
||||
| `first_name` | string | Yes | First name of the contact |
|
||||
| `last_name` | string | Yes | Last name of the contact |
|
||||
| `email` | string | No | Email address of the contact |
|
||||
| `title` | string | No | Job title |
|
||||
| `account_id` | string | No | Apollo account ID to associate with |
|
||||
| `title` | string | No | Job title \(e.g., "VP of Sales", "Software Engineer"\) |
|
||||
| `account_id` | string | No | Apollo account ID to associate with \(e.g., "acc_abc123"\) |
|
||||
| `owner_id` | string | No | User ID of the contact owner |
|
||||
|
||||
#### Output
|
||||
@@ -206,12 +206,12 @@ Update an existing contact in your Apollo database
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key |
|
||||
| `contact_id` | string | Yes | ID of the contact to update |
|
||||
| `contact_id` | string | Yes | ID of the contact to update \(e.g., "con_abc123"\) |
|
||||
| `first_name` | string | No | First name of the contact |
|
||||
| `last_name` | string | No | Last name of the contact |
|
||||
| `email` | string | No | Email address |
|
||||
| `title` | string | No | Job title |
|
||||
| `account_id` | string | No | Apollo account ID |
|
||||
| `title` | string | No | Job title \(e.g., "VP of Sales", "Software Engineer"\) |
|
||||
| `account_id` | string | No | Apollo account ID \(e.g., "acc_abc123"\) |
|
||||
| `owner_id` | string | No | User ID of the contact owner |
|
||||
|
||||
#### Output
|
||||
@@ -232,8 +232,8 @@ Search your team
|
||||
| `apiKey` | string | Yes | Apollo API key |
|
||||
| `q_keywords` | string | No | Keywords to search for |
|
||||
| `contact_stage_ids` | array | No | Filter by contact stage IDs |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
||||
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -294,7 +294,7 @@ Create a new account (company) in your Apollo database
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key |
|
||||
| `name` | string | Yes | Company name |
|
||||
| `name` | string | Yes | Company name \(e.g., "Acme Corporation"\) |
|
||||
| `website_url` | string | No | Company website URL |
|
||||
| `phone` | string | No | Company phone number |
|
||||
| `owner_id` | string | No | User ID of the account owner |
|
||||
@@ -315,8 +315,8 @@ Update an existing account in your Apollo database
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key |
|
||||
| `account_id` | string | Yes | ID of the account to update |
|
||||
| `name` | string | No | Company name |
|
||||
| `account_id` | string | Yes | ID of the account to update \(e.g., "acc_abc123"\) |
|
||||
| `name` | string | No | Company name \(e.g., "Acme Corporation"\) |
|
||||
| `website_url` | string | No | Company website URL |
|
||||
| `phone` | string | No | Company phone number |
|
||||
| `owner_id` | string | No | User ID of the account owner |
|
||||
@@ -340,8 +340,8 @@ Search your team
|
||||
| `q_keywords` | string | No | Keywords to search for in account data |
|
||||
| `owner_id` | string | No | Filter by account owner user ID |
|
||||
| `account_stage_ids` | array | No | Filter by account stage IDs |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
||||
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -401,8 +401,8 @@ Create a new deal for an account in your Apollo database (master key required)
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
||||
| `name` | string | Yes | Name of the opportunity/deal |
|
||||
| `account_id` | string | Yes | ID of the account this opportunity belongs to |
|
||||
| `name` | string | Yes | Name of the opportunity/deal \(e.g., "Enterprise License - Q1"\) |
|
||||
| `account_id` | string | Yes | ID of the account this opportunity belongs to \(e.g., "acc_abc123"\) |
|
||||
| `amount` | number | No | Monetary value of the opportunity |
|
||||
| `stage_id` | string | No | ID of the deal stage |
|
||||
| `owner_id` | string | No | User ID of the opportunity owner |
|
||||
@@ -426,11 +426,11 @@ Search and list all deals/opportunities in your team
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key |
|
||||
| `q_keywords` | string | No | Keywords to search for in opportunity names |
|
||||
| `account_ids` | array | No | Filter by specific account IDs |
|
||||
| `account_ids` | array | No | Filter by specific account IDs \(e.g., \["acc_123", "acc_456"\]\) |
|
||||
| `stage_ids` | array | No | Filter by deal stage IDs |
|
||||
| `owner_ids` | array | No | Filter by opportunity owner IDs |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
||||
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -450,7 +450,7 @@ Retrieve complete details of a specific deal/opportunity by ID
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key |
|
||||
| `opportunity_id` | string | Yes | ID of the opportunity to retrieve |
|
||||
| `opportunity_id` | string | Yes | ID of the opportunity to retrieve \(e.g., "opp_abc123"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -468,8 +468,8 @@ Update an existing deal/opportunity in your Apollo database
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key |
|
||||
| `opportunity_id` | string | Yes | ID of the opportunity to update |
|
||||
| `name` | string | No | Name of the opportunity/deal |
|
||||
| `opportunity_id` | string | Yes | ID of the opportunity to update \(e.g., "opp_abc123"\) |
|
||||
| `name` | string | No | Name of the opportunity/deal \(e.g., "Enterprise License - Q1"\) |
|
||||
| `amount` | number | No | Monetary value of the opportunity |
|
||||
| `stage_id` | string | No | ID of the deal stage |
|
||||
| `owner_id` | string | No | User ID of the opportunity owner |
|
||||
@@ -492,10 +492,10 @@ Search for sequences/campaigns in your team
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
||||
| `q_name` | string | No | Search sequences by name |
|
||||
| `q_name` | string | No | Search sequences by name \(e.g., "Outbound Q1", "Follow-up"\) |
|
||||
| `active` | boolean | No | Filter by active status \(true for active sequences, false for inactive\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
||||
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -515,8 +515,8 @@ Add contacts to an Apollo sequence
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
||||
| `sequence_id` | string | Yes | ID of the sequence to add contacts to |
|
||||
| `contact_ids` | array | Yes | Array of contact IDs to add to the sequence |
|
||||
| `sequence_id` | string | Yes | ID of the sequence to add contacts to \(e.g., "seq_abc123"\) |
|
||||
| `contact_ids` | array | Yes | Array of contact IDs to add to the sequence \(e.g., \["con_abc123", "con_def456"\]\) |
|
||||
| `emailer_campaign_id` | string | No | Optional emailer campaign ID |
|
||||
| `send_email_from_user_id` | string | No | User ID to send emails from |
|
||||
|
||||
@@ -538,8 +538,8 @@ Create a new task in Apollo
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
||||
| `note` | string | Yes | Task note/description |
|
||||
| `contact_id` | string | No | Contact ID to associate with |
|
||||
| `account_id` | string | No | Account ID to associate with |
|
||||
| `contact_id` | string | No | Contact ID to associate with \(e.g., "con_abc123"\) |
|
||||
| `account_id` | string | No | Account ID to associate with \(e.g., "acc_abc123"\) |
|
||||
| `due_at` | string | No | Due date in ISO format |
|
||||
| `priority` | string | No | Task priority |
|
||||
| `type` | string | No | Task type |
|
||||
@@ -560,11 +560,11 @@ Search for tasks in Apollo
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
||||
| `contact_id` | string | No | Filter by contact ID |
|
||||
| `account_id` | string | No | Filter by account ID |
|
||||
| `contact_id` | string | No | Filter by contact ID \(e.g., "con_abc123"\) |
|
||||
| `account_id` | string | No | Filter by account ID \(e.g., "acc_abc123"\) |
|
||||
| `completed` | boolean | No | Filter by completion status |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
||||
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -42,8 +42,8 @@ Retrieve a single task by GID or get multiple tasks with filters
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `taskGid` | string | No | The globally unique identifier \(GID\) of the task. If not provided, will get multiple tasks. |
|
||||
| `workspace` | string | No | Workspace GID to filter tasks \(required when not using taskGid\) |
|
||||
| `project` | string | No | Project GID to filter tasks |
|
||||
| `workspace` | string | No | Asana workspace GID \(numeric string\) to filter tasks \(required when not using taskGid\) |
|
||||
| `project` | string | No | Asana project GID \(numeric string\) to filter tasks |
|
||||
| `limit` | number | No | Maximum number of tasks to return \(default: 50\) |
|
||||
|
||||
#### Output
|
||||
@@ -59,11 +59,11 @@ Retrieve a single task by GID or get multiple tasks with filters
|
||||
| `notes` | string | Task notes or description |
|
||||
| `completed` | boolean | Whether the task is completed |
|
||||
| `assignee` | object | Assignee details |
|
||||
| ↳ `gid` | string | Assignee GID |
|
||||
| ↳ `name` | string | Assignee name |
|
||||
| ↳ `gid` | string | Assignee GID |
|
||||
| ↳ `name` | string | Assignee name |
|
||||
| `created_by` | object | Creator details |
|
||||
| ↳ `gid` | string | Creator GID |
|
||||
| ↳ `name` | string | Creator name |
|
||||
| ↳ `gid` | string | Creator GID |
|
||||
| ↳ `name` | string | Creator name |
|
||||
| `due_on` | string | Due date \(YYYY-MM-DD\) |
|
||||
| `created_at` | string | Task creation timestamp |
|
||||
| `modified_at` | string | Task last modified timestamp |
|
||||
@@ -80,7 +80,7 @@ Create a new task in Asana
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `workspace` | string | Yes | Workspace GID where the task will be created |
|
||||
| `workspace` | string | Yes | Asana workspace GID \(numeric string\) where the task will be created |
|
||||
| `name` | string | Yes | Name of the task |
|
||||
| `notes` | string | No | Notes or description for the task |
|
||||
| `assignee` | string | No | User GID to assign the task to |
|
||||
@@ -107,7 +107,7 @@ Update an existing task in Asana
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `taskGid` | string | Yes | The globally unique identifier \(GID\) of the task to update |
|
||||
| `taskGid` | string | Yes | Asana task GID \(numeric string\) of the task to update |
|
||||
| `name` | string | No | Updated name for the task |
|
||||
| `notes` | string | No | Updated notes or description for the task |
|
||||
| `assignee` | string | No | Updated assignee user GID |
|
||||
@@ -134,7 +134,7 @@ Retrieve all projects from an Asana workspace
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `workspace` | string | Yes | Workspace GID to retrieve projects from |
|
||||
| `workspace` | string | Yes | Asana workspace GID \(numeric string\) to retrieve projects from |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -155,10 +155,10 @@ Search for tasks in an Asana workspace
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `workspace` | string | Yes | Workspace GID to search tasks in |
|
||||
| `workspace` | string | Yes | Asana workspace GID \(numeric string\) to search tasks in |
|
||||
| `text` | string | No | Text to search for in task names |
|
||||
| `assignee` | string | No | Filter tasks by assignee user GID |
|
||||
| `projects` | array | No | Array of project GIDs to filter tasks by |
|
||||
| `projects` | array | No | Array of Asana project GIDs \(numeric strings\) to filter tasks by |
|
||||
| `completed` | boolean | No | Filter by completion status |
|
||||
|
||||
#### Output
|
||||
@@ -168,22 +168,22 @@ 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 |
|
||||
| ↳ `gid` | string | Assignee GID |
|
||||
| ↳ `name` | string | Assignee name |
|
||||
| ↳ `gid` | string | Assignee GID |
|
||||
| ↳ `name` | string | Assignee name |
|
||||
| ↳ `due_on` | string | Due date |
|
||||
| ↳ `created_at` | string | Creation timestamp |
|
||||
| ↳ `modified_at` | string | Modified timestamp |
|
||||
| `next_page` | object | Pagination info |
|
||||
| ↳ `offset` | string | Offset token |
|
||||
| ↳ `path` | string | API path |
|
||||
| ↳ `uri` | string | Full URI |
|
||||
| ↳ `offset` | string | Offset token |
|
||||
| ↳ `path` | string | API path |
|
||||
| ↳ `uri` | string | Full URI |
|
||||
|
||||
### `asana_add_comment`
|
||||
|
||||
@@ -193,7 +193,7 @@ Add a comment (story) to an Asana task
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `taskGid` | string | Yes | The globally unique identifier \(GID\) of the task |
|
||||
| `taskGid` | string | Yes | Asana task GID \(numeric string\) |
|
||||
| `text` | string | Yes | The text content of the comment |
|
||||
|
||||
#### Output
|
||||
@@ -206,7 +206,7 @@ Add a comment (story) to an Asana task
|
||||
| `text` | string | Comment text content |
|
||||
| `created_at` | string | Comment creation timestamp |
|
||||
| `created_by` | object | Comment author details |
|
||||
| ↳ `gid` | string | Author GID |
|
||||
| ↳ `name` | string | Author name |
|
||||
| ↳ `gid` | string | Author GID |
|
||||
| ↳ `name` | string | Author name |
|
||||
|
||||
|
||||
|
||||
@@ -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 \(e.g., 12345\) |
|
||||
| `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. |
|
||||
|
||||
|
||||
@@ -47,16 +47,16 @@ Get information about the currently authenticated Calendly user
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `resource` | object | Current user information |
|
||||
| ↳ `uri` | string | Canonical reference to the 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 |
|
||||
| ↳ `timezone` | string | User timezone |
|
||||
| ↳ `avatar_url` | string | URL to user avatar image |
|
||||
| ↳ `created_at` | string | ISO timestamp when user was created |
|
||||
| ↳ `updated_at` | string | ISO timestamp when user was last updated |
|
||||
| ↳ `current_organization` | string | URI of current organization |
|
||||
| ↳ `uri` | string | Canonical reference to the 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's scheduling page |
|
||||
| ↳ `timezone` | string | User timezone |
|
||||
| ↳ `avatar_url` | string | URL to user avatar image |
|
||||
| ↳ `created_at` | string | ISO timestamp when user was created |
|
||||
| ↳ `updated_at` | string | ISO timestamp when user was last updated |
|
||||
| ↳ `current_organization` | string | URI of current organization |
|
||||
|
||||
### `calendly_list_event_types`
|
||||
|
||||
@@ -67,11 +67,11 @@ Retrieve a list of all event types for a user or organization
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
||||
| `user` | string | No | Return only event types that belong to this user \(URI format\) |
|
||||
| `organization` | string | No | Return only event types that belong to this organization \(URI format\) |
|
||||
| `count` | number | No | Number of results per page \(default: 20, max: 100\) |
|
||||
| `pageToken` | string | No | Page token for pagination |
|
||||
| `sort` | string | No | Sort order for results \(e.g., "name:asc", "name:desc"\) |
|
||||
| `user` | string | No | Return only event types that belong to this user. Format: URI \(e.g., "https://api.calendly.com/users/abc123-def456"\) |
|
||||
| `organization` | string | No | Return only event types that belong to this organization. Format: URI \(e.g., "https://api.calendly.com/organizations/abc123-def456"\) |
|
||||
| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) |
|
||||
| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token |
|
||||
| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "name:asc", "name:desc"\) |
|
||||
| `active` | boolean | No | When true, show only active event types. When false or unchecked, show all event types \(both active and inactive\). |
|
||||
|
||||
#### Output
|
||||
@@ -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 |
|
||||
@@ -93,11 +93,11 @@ Retrieve a list of all event types for a user or organization
|
||||
| ↳ `type` | string | Event type classification |
|
||||
| ↳ `updated_at` | string | ISO timestamp of last update |
|
||||
| `pagination` | object | Pagination information |
|
||||
| ↳ `count` | number | Number of results in this page |
|
||||
| ↳ `next_page` | string | URL to next page \(if available\) |
|
||||
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
||||
| ↳ `next_page_token` | string | Token for next page |
|
||||
| ↳ `previous_page_token` | string | Token for previous page |
|
||||
| ↳ `count` | number | Number of results in this page |
|
||||
| ↳ `next_page` | string | URL to next page \(if available\) |
|
||||
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
||||
| ↳ `next_page_token` | string | Token for next page |
|
||||
| ↳ `previous_page_token` | string | Token for previous page |
|
||||
|
||||
### `calendly_get_event_type`
|
||||
|
||||
@@ -108,37 +108,33 @@ Get detailed information about a specific event type
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
||||
| `eventTypeUuid` | string | Yes | Event type UUID \(can be full URI or just the UUID\) |
|
||||
| `eventTypeUuid` | string | Yes | Event type UUID. Format: UUID \(e.g., "abc123-def456"\) or full URI \(e.g., "https://api.calendly.com/event_types/abc123-def456"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `resource` | object | Event type details |
|
||||
| ↳ `uri` | string | Canonical reference to the event type |
|
||||
| ↳ `name` | string | Question text |
|
||||
| ↳ `active` | boolean | Whether the event type is active |
|
||||
| ↳ `booking_method` | string | Booking method |
|
||||
| ↳ `color` | string | Hex color code |
|
||||
| ↳ `created_at` | string | ISO timestamp of creation |
|
||||
| ↳ `custom_questions` | array | Custom questions for invitees |
|
||||
| ↳ `name` | string | Question text |
|
||||
| ↳ `type` | string | Question type \(text, single_select, multi_select, etc.\) |
|
||||
| ↳ `position` | number | Question order |
|
||||
| ↳ `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 |
|
||||
| ↳ `updated_at` | string | ISO timestamp of last update |
|
||||
| ↳ `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 |
|
||||
| ↳ `color` | string | Hex color code |
|
||||
| ↳ `created_at` | string | ISO timestamp of creation |
|
||||
| ↳ `custom_questions` | array | Custom questions for invitees |
|
||||
| ↳ `name` | string | Question text |
|
||||
| ↳ `type` | string | Question type \(text, single_select, multi_select, etc.\) |
|
||||
| ↳ `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`
|
||||
|
||||
@@ -149,15 +145,15 @@ Retrieve a list of scheduled events for a user or organization
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
||||
| `user` | string | No | Return events that belong to this user \(URI format\). Either "user" or "organization" must be provided. |
|
||||
| `organization` | string | No | Return events that belong to this organization \(URI format\). Either "user" or "organization" must be provided. |
|
||||
| `user` | string | No | Return events that belong to this user. Either "user" or "organization" must be provided. Format: URI \(e.g., "https://api.calendly.com/users/abc123-def456"\) |
|
||||
| `organization` | string | No | Return events that belong to this organization. Either "user" or "organization" must be provided. Format: URI \(e.g., "https://api.calendly.com/organizations/abc123-def456"\) |
|
||||
| `invitee_email` | string | No | Return events where invitee has this email |
|
||||
| `count` | number | No | Number of results per page \(default: 20, max: 100\) |
|
||||
| `max_start_time` | string | No | Return events with start time before this time \(ISO 8601 format\) |
|
||||
| `min_start_time` | string | No | Return events with start time after this time \(ISO 8601 format\) |
|
||||
| `pageToken` | string | No | Page token for pagination |
|
||||
| `sort` | string | No | Sort order for results \(e.g., "start_time:asc", "start_time:desc"\) |
|
||||
| `status` | string | No | Filter by status \("active" or "canceled"\) |
|
||||
| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) |
|
||||
| `max_start_time` | string | No | Return events with start time before this time. Format: ISO 8601 \(e.g., "2024-01-15T09:00:00Z"\) |
|
||||
| `min_start_time` | string | No | Return events with start time after this time. Format: ISO 8601 \(e.g., "2024-01-01T00:00:00Z"\) |
|
||||
| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token |
|
||||
| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "start_time:asc", "start_time:desc"\) |
|
||||
| `status` | string | No | Filter by status. Format: "active" or "canceled" |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -170,24 +166,22 @@ 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` | string | Location description |
|
||||
| ↳ `type` | string | Location type \(e.g., |
|
||||
| ↳ `join_url` | string | URL to join online meeting \(if applicable\) |
|
||||
| ↳ `location` | object | Event location details |
|
||||
| ↳ `type` | string | Location type \(e.g., "zoom", "google_meet", "physical"\) |
|
||||
| ↳ `location` | string | Location description |
|
||||
| ↳ `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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `count` | number | Number of results in this page |
|
||||
| ↳ `next_page` | string | URL to next page \(if available\) |
|
||||
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
||||
| ↳ `next_page_token` | string | Token for next page |
|
||||
| ↳ `previous_page_token` | string | Token for previous page |
|
||||
| ↳ `count` | number | Number of results in this page |
|
||||
| ↳ `next_page` | string | URL to next page \(if available\) |
|
||||
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
||||
| ↳ `next_page_token` | string | Token for next page |
|
||||
| ↳ `previous_page_token` | string | Token for previous page |
|
||||
|
||||
### `calendly_get_scheduled_event`
|
||||
|
||||
@@ -198,43 +192,37 @@ Get detailed information about a specific scheduled event
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
||||
| `eventUuid` | string | Yes | Scheduled event UUID \(can be full URI or just the UUID\) |
|
||||
| `eventUuid` | string | Yes | Scheduled event UUID. Format: UUID \(e.g., "abc123-def456"\) or full URI \(e.g., "https://api.calendly.com/scheduled_events/abc123-def456"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `resource` | object | Scheduled event details |
|
||||
| ↳ `uri` | string | Canonical reference to the event |
|
||||
| ↳ `name` | string | Event name |
|
||||
| ↳ `status` | string | Event status \(active or canceled\) |
|
||||
| ↳ `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 |
|
||||
| ↳ `type` | string | Location type |
|
||||
| ↳ `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 |
|
||||
| ↳ `uri` | string | Canonical reference to the event |
|
||||
| ↳ `name` | string | Event name |
|
||||
| ↳ `status` | string | Event status \(active or canceled\) |
|
||||
| ↳ `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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `event_memberships` | array | Event hosts/members |
|
||||
| ↳ `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 |
|
||||
| ↳ `created_at` | string | ISO timestamp of event creation |
|
||||
| ↳ `updated_at` | string | ISO timestamp of last update |
|
||||
|
||||
### `calendly_list_event_invitees`
|
||||
|
||||
@@ -245,12 +233,12 @@ Retrieve a list of invitees for a scheduled event
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
||||
| `eventUuid` | string | Yes | Scheduled event UUID \(can be full URI or just the UUID\) |
|
||||
| `count` | number | No | Number of results per page \(default: 20, max: 100\) |
|
||||
| `eventUuid` | string | Yes | Scheduled event UUID. Format: UUID \(e.g., "abc123-def456"\) or full URI \(e.g., "https://api.calendly.com/scheduled_events/abc123-def456"\) |
|
||||
| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) |
|
||||
| `email` | string | No | Filter invitees by email address |
|
||||
| `pageToken` | string | No | Page token for pagination |
|
||||
| `sort` | string | No | Sort order for results \(e.g., "created_at:asc", "created_at:desc"\) |
|
||||
| `status` | string | No | Filter by status \("active" or "canceled"\) |
|
||||
| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token |
|
||||
| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "created_at:asc", "created_at:desc"\) |
|
||||
| `status` | string | No | Filter by status. Format: "active" or "canceled" |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -264,12 +252,9 @@ Retrieve a list of invitees for a scheduled event
|
||||
| ↳ `last_name` | string | Invitee last name |
|
||||
| ↳ `status` | string | Invitee status \(active or canceled\) |
|
||||
| ↳ `questions_and_answers` | array | Responses to custom questions |
|
||||
| ↳ `question` | string | Question text |
|
||||
| ↳ `answer` | string | Invitee answer |
|
||||
| ↳ `position` | number | Question order |
|
||||
| ↳ `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 |
|
||||
@@ -278,11 +263,11 @@ Retrieve a list of invitees for a scheduled event
|
||||
| ↳ `reschedule_url` | string | URL to reschedule the booking |
|
||||
| ↳ `rescheduled` | boolean | Whether invitee rescheduled |
|
||||
| `pagination` | object | Pagination information |
|
||||
| ↳ `count` | number | Number of results in this page |
|
||||
| ↳ `next_page` | string | URL to next page \(if available\) |
|
||||
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
||||
| ↳ `next_page_token` | string | Token for next page |
|
||||
| ↳ `previous_page_token` | string | Token for previous page |
|
||||
| ↳ `count` | number | Number of results in this page |
|
||||
| ↳ `next_page` | string | URL to next page \(if available\) |
|
||||
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
||||
| ↳ `next_page_token` | string | Token for next page |
|
||||
| ↳ `previous_page_token` | string | Token for previous page |
|
||||
|
||||
### `calendly_cancel_event`
|
||||
|
||||
@@ -293,7 +278,7 @@ Cancel a scheduled event
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
||||
| `eventUuid` | string | Yes | Scheduled event UUID to cancel \(can be full URI or just the UUID\) |
|
||||
| `eventUuid` | string | Yes | Scheduled event UUID to cancel. Format: UUID \(e.g., "abc123-def456"\) or full URI \(e.g., "https://api.calendly.com/scheduled_events/abc123-def456"\) |
|
||||
| `reason` | string | No | Reason for cancellation \(will be sent to invitees\) |
|
||||
|
||||
#### Output
|
||||
@@ -301,9 +286,9 @@ Cancel a scheduled event
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `resource` | object | Cancellation details |
|
||||
| ↳ `canceler_type` | string | Type of canceler \(host or invitee\) |
|
||||
| ↳ `canceled_by` | string | Name of person who canceled |
|
||||
| ↳ `reason` | string | Cancellation reason |
|
||||
| ↳ `created_at` | string | ISO timestamp when event was canceled |
|
||||
| ↳ `canceler_type` | string | Type of canceler \(host or invitee\) |
|
||||
| ↳ `canceled_by` | string | Name of person who canceled |
|
||||
| ↳ `reason` | string | Cancellation reason |
|
||||
| ↳ `created_at` | string | ISO timestamp when event was canceled |
|
||||
|
||||
|
||||
|
||||
@@ -51,10 +51,10 @@ Populate Clay with data from a JSON file. Enables direct communication and notif
|
||||
| --------- | ---- | ----------- |
|
||||
| `data` | json | Response data from Clay webhook |
|
||||
| `metadata` | object | Webhook response metadata |
|
||||
| ↳ `status` | number | HTTP status code |
|
||||
| ↳ `statusText` | string | HTTP status text |
|
||||
| ↳ `headers` | object | Response headers from Clay |
|
||||
| ↳ `timestamp` | string | ISO timestamp when webhook was received |
|
||||
| ↳ `contentType` | string | Content type of the response |
|
||||
| ↳ `status` | number | HTTP status code |
|
||||
| ↳ `statusText` | string | HTTP status text |
|
||||
| ↳ `headers` | object | Response headers from Clay |
|
||||
| ↳ `timestamp` | string | ISO timestamp when webhook was received |
|
||||
| ↳ `contentType` | string | Content type of the response |
|
||||
|
||||
|
||||
|
||||
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 \(e.g., 10, 50, 100; range: 1-500, default: 10\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) |
|
||||
| `orderBy` | string | No | Sort field with optional +/- prefix for direction \(default: -created_at\) |
|
||||
| `emailAddress` | string | No | Filter by email address \(e.g., user@example.com or user1@example.com,user2@example.com\) |
|
||||
| `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 \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC or comma-separated for multiple\) |
|
||||
| `query` | string | No | Search query to match across email, phone, username, and names \(e.g., john or john@example.com\) |
|
||||
|
||||
#### 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 \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||
|
||||
#### 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 \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||
| `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 \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||
|
||||
#### 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 \(e.g., 10, 50, 100; range: 1-500, default: 10\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) |
|
||||
| `includeMembersCount` | boolean | No | Include member count for each organization |
|
||||
| `query` | string | No | Search by organization ID, name, or slug \(e.g., Acme Corp or acme-corp\) |
|
||||
| `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 \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC or my-org-slug\) |
|
||||
|
||||
#### 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 who will become admin \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||
| `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 \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC; 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 \(e.g., 10, 50, 100; range: 1-500, default: 10\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) |
|
||||
|
||||
#### 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 \(e.g., sess_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||
|
||||
#### 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 \(e.g., sess_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||
|
||||
#### 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 |
|
||||
|
||||
|
||||
@@ -42,7 +42,7 @@ Retrieve content from Confluence pages using the Confluence API.
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `pageId` | string | Yes | Confluence page ID to retrieve |
|
||||
| `pageId` | string | Yes | Confluence page ID to retrieve \(numeric ID from page URL or API\) |
|
||||
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
#### Output
|
||||
@@ -63,7 +63,7 @@ Update a Confluence page using the Confluence API.
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `pageId` | string | Yes | Confluence page ID to update |
|
||||
| `pageId` | string | Yes | Confluence page ID to update \(numeric ID from page URL or API\) |
|
||||
| `title` | string | No | New title for the page |
|
||||
| `content` | string | No | New content for the page in Confluence storage format |
|
||||
| `version` | number | No | Version number of the page \(required for preventing conflicts\) |
|
||||
@@ -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\) |
|
||||
|
||||
|
||||
|
||||
@@ -60,9 +60,9 @@ Query metric timeseries data from Datadog. Use for analyzing trends, creating re
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Datadog metrics query \(e.g., "avg:system.cpu.user\{*\}"\) |
|
||||
| `from` | number | Yes | Start time as Unix timestamp in seconds |
|
||||
| `to` | number | Yes | End time as Unix timestamp in seconds |
|
||||
| `query` | string | Yes | Datadog metrics query \(e.g., "avg:system.cpu.user\{*\}", "sum:nginx.requests\{env:prod\}.as_count\(\)"\) |
|
||||
| `from` | number | Yes | Start time as Unix timestamp in seconds \(e.g., 1705320000\) |
|
||||
| `to` | number | Yes | End time as Unix timestamp in seconds \(e.g., 1705323600\) |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
@@ -86,11 +86,11 @@ Post an event to the Datadog event stream. Use for deployment notifications, ale
|
||||
| `text` | string | Yes | Event body/description. Supports markdown. |
|
||||
| `alertType` | string | No | Alert type: error, warning, info, success, user_update, recommendation, or snapshot |
|
||||
| `priority` | string | No | Event priority: normal or low |
|
||||
| `host` | string | No | Host name to associate with this event |
|
||||
| `tags` | string | No | Comma-separated list of tags \(e.g., "env:production,service:api"\) |
|
||||
| `host` | string | No | Host name to associate with this event \(e.g., "web-server-01", "prod-api-1"\) |
|
||||
| `tags` | string | No | Comma-separated list of tags \(e.g., "env:production,service:api", "team:backend,priority:high"\) |
|
||||
| `aggregationKey` | string | No | Key to aggregate events together |
|
||||
| `sourceTypeName` | string | No | Source type name for the event |
|
||||
| `dateHappened` | number | No | Unix timestamp when the event occurred \(defaults to now\) |
|
||||
| `dateHappened` | number | No | Unix timestamp in seconds when the event occurred \(e.g., 1705320000, defaults to now\) |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
@@ -99,15 +99,15 @@ Post an event to the Datadog event stream. Use for deployment notifications, ale
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | The created event details |
|
||||
| ↳ `id` | number | Event ID |
|
||||
| ↳ `title` | string | Event title |
|
||||
| ↳ `text` | string | Event text |
|
||||
| ↳ `date_happened` | number | Unix timestamp when event occurred |
|
||||
| ↳ `priority` | string | Event priority |
|
||||
| ↳ `alert_type` | string | Alert type |
|
||||
| ↳ `host` | string | Associated host |
|
||||
| ↳ `tags` | array | Event tags |
|
||||
| ↳ `url` | string | URL to view the event in Datadog |
|
||||
| ↳ `id` | number | Event ID |
|
||||
| ↳ `title` | string | Event title |
|
||||
| ↳ `text` | string | Event text |
|
||||
| ↳ `date_happened` | number | Unix timestamp when event occurred |
|
||||
| ↳ `priority` | string | Event priority |
|
||||
| ↳ `alert_type` | string | Alert type |
|
||||
| ↳ `host` | string | Associated host |
|
||||
| ↳ `tags` | array | Event tags |
|
||||
| ↳ `url` | string | URL to view the event in Datadog |
|
||||
|
||||
### `datadog_create_monitor`
|
||||
|
||||
@@ -119,7 +119,7 @@ Create a new monitor/alert in Datadog. Monitors can track metrics, service check
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `name` | string | Yes | Monitor name |
|
||||
| `type` | string | Yes | Monitor type: metric alert, service check, event alert, process alert, log alert, query alert, composite, synthetics alert, slo alert |
|
||||
| `query` | string | Yes | Monitor query \(e.g., "avg\(last_5m\):avg:system.cpu.idle\{*\} < 20"\) |
|
||||
| `query` | string | Yes | Monitor query \(e.g., "avg\(last_5m\):avg:system.cpu.idle\{*\} < 20", "logs\(\"status:error\"\).index\(\"main\"\).rollup\(\"count\"\).last\(\"5m\"\) > 100"\) |
|
||||
| `message` | string | No | Message to include with notifications. Can include @-mentions and markdown. |
|
||||
| `tags` | string | No | Comma-separated list of tags |
|
||||
| `priority` | number | No | Monitor priority \(1-5, where 1 is highest\) |
|
||||
@@ -133,16 +133,16 @@ Create a new monitor/alert in Datadog. Monitors can track metrics, service check
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitor` | object | The created monitor details |
|
||||
| ↳ `id` | number | Monitor ID |
|
||||
| ↳ `name` | string | Monitor name |
|
||||
| ↳ `type` | string | Monitor type |
|
||||
| ↳ `query` | string | Monitor query |
|
||||
| ↳ `message` | string | Notification message |
|
||||
| ↳ `tags` | array | Monitor tags |
|
||||
| ↳ `priority` | number | Monitor priority |
|
||||
| ↳ `overall_state` | string | Current monitor state |
|
||||
| ↳ `created` | string | Creation timestamp |
|
||||
| ↳ `modified` | string | Last modification timestamp |
|
||||
| ↳ `id` | number | Monitor ID |
|
||||
| ↳ `name` | string | Monitor name |
|
||||
| ↳ `type` | string | Monitor type |
|
||||
| ↳ `query` | string | Monitor query |
|
||||
| ↳ `message` | string | Notification message |
|
||||
| ↳ `tags` | array | Monitor tags |
|
||||
| ↳ `priority` | number | Monitor priority |
|
||||
| ↳ `overall_state` | string | Current monitor state |
|
||||
| ↳ `created` | string | Creation timestamp |
|
||||
| ↳ `modified` | string | Last modification timestamp |
|
||||
|
||||
### `datadog_get_monitor`
|
||||
|
||||
@@ -152,8 +152,8 @@ Retrieve details of a specific monitor by ID.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `monitorId` | string | Yes | The ID of the monitor to retrieve |
|
||||
| `groupStates` | string | No | Comma-separated group states to include: alert, warn, no data, ok |
|
||||
| `monitorId` | string | Yes | The ID of the monitor to retrieve \(e.g., "12345678"\) |
|
||||
| `groupStates` | string | No | Comma-separated group states to include \(e.g., "alert,warn", "alert,warn,no data,ok"\) |
|
||||
| `withDowntimes` | boolean | No | Include downtime data with the monitor |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
@@ -164,16 +164,16 @@ Retrieve details of a specific monitor by ID.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitor` | object | The monitor details |
|
||||
| ↳ `id` | number | Monitor ID |
|
||||
| ↳ `name` | string | Monitor name |
|
||||
| ↳ `type` | string | Monitor type |
|
||||
| ↳ `query` | string | Monitor query |
|
||||
| ↳ `message` | string | Notification message |
|
||||
| ↳ `tags` | array | Monitor tags |
|
||||
| ↳ `priority` | number | Monitor priority |
|
||||
| ↳ `overall_state` | string | Current monitor state |
|
||||
| ↳ `created` | string | Creation timestamp |
|
||||
| ↳ `modified` | string | Last modification timestamp |
|
||||
| ↳ `id` | number | Monitor ID |
|
||||
| ↳ `name` | string | Monitor name |
|
||||
| ↳ `type` | string | Monitor type |
|
||||
| ↳ `query` | string | Monitor query |
|
||||
| ↳ `message` | string | Notification message |
|
||||
| ↳ `tags` | array | Monitor tags |
|
||||
| ↳ `priority` | number | Monitor priority |
|
||||
| ↳ `overall_state` | string | Current monitor state |
|
||||
| ↳ `created` | string | Creation timestamp |
|
||||
| ↳ `modified` | string | Last modification timestamp |
|
||||
|
||||
### `datadog_list_monitors`
|
||||
|
||||
@@ -183,13 +183,13 @@ List all monitors in Datadog with optional filtering by name, tags, or state.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupStates` | string | No | Comma-separated group states to filter by: alert, warn, no data, ok |
|
||||
| `name` | string | No | Filter monitors by name \(partial match\) |
|
||||
| `tags` | string | No | Comma-separated list of tags to filter by |
|
||||
| `monitorTags` | string | No | Comma-separated list of monitor tags to filter by |
|
||||
| `groupStates` | string | No | Comma-separated group states to filter by \(e.g., "alert,warn", "alert,warn,no data,ok"\) |
|
||||
| `name` | string | No | Filter monitors by name with partial match \(e.g., "CPU", "Production"\) |
|
||||
| `tags` | string | No | Comma-separated list of tags to filter by \(e.g., "env:prod,team:backend"\) |
|
||||
| `monitorTags` | string | No | Comma-separated list of monitor tags to filter by \(e.g., "service:api,priority:high"\) |
|
||||
| `withDowntimes` | boolean | No | Include downtime data with monitors |
|
||||
| `page` | number | No | Page number for pagination \(0-indexed\) |
|
||||
| `pageSize` | number | No | Number of monitors per page \(max 1000\) |
|
||||
| `page` | number | No | Page number for pagination \(0-indexed, e.g., 0, 1, 2\) |
|
||||
| `pageSize` | number | No | Number of monitors per page \(e.g., 50, max: 1000\) |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
@@ -214,9 +214,9 @@ Mute a monitor to temporarily suppress notifications.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `monitorId` | string | Yes | The ID of the monitor to mute |
|
||||
| `scope` | string | No | Scope to mute \(e.g., "host:myhost"\). If not specified, mutes all scopes. |
|
||||
| `end` | number | No | Unix timestamp when the mute should end. If not specified, mutes indefinitely. |
|
||||
| `monitorId` | string | Yes | The ID of the monitor to mute \(e.g., "12345678"\) |
|
||||
| `scope` | string | No | Scope to mute \(e.g., "host:myhost", "env:prod"\). If not specified, mutes all scopes. |
|
||||
| `end` | number | No | Unix timestamp in seconds when the mute should end \(e.g., 1705323600\). If not specified, mutes indefinitely. |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
@@ -235,11 +235,11 @@ Search and retrieve logs from Datadog. Use for troubleshooting, analysis, or mon
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Log search query \(e.g., "service:web-app status:error"\) |
|
||||
| `from` | string | Yes | Start time in ISO-8601 format or relative \(e.g., "now-1h"\) |
|
||||
| `to` | string | Yes | End time in ISO-8601 format or relative \(e.g., "now"\) |
|
||||
| `limit` | number | No | Maximum number of logs to return \(default: 50, max: 1000\) |
|
||||
| `sort` | string | No | Sort order: timestamp \(oldest first\) or -timestamp \(newest first\) |
|
||||
| `query` | string | Yes | Log search query using Datadog query syntax \(e.g., "service:web-app status:error", "host:prod-* @http.status_code:500"\) |
|
||||
| `from` | string | Yes | Start time in ISO-8601 format or relative time \(e.g., "now-1h", "now-15m", "2024-01-15T10:00:00Z"\) |
|
||||
| `to` | string | Yes | End time in ISO-8601 format or relative time \(e.g., "now", "now-5m", "2024-01-15T12:00:00Z"\) |
|
||||
| `limit` | number | No | Maximum number of logs to return \(e.g., 50, 100, max: 1000\) |
|
||||
| `sort` | string | No | Sort order: "timestamp" for oldest first, "-timestamp" for newest first |
|
||||
| `indexes` | string | No | Comma-separated list of log indexes to search |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
@@ -252,16 +252,11 @@ Search and retrieve logs from Datadog. Use for troubleshooting, analysis, or mon
|
||||
| `logs` | array | List of log entries |
|
||||
| ↳ `id` | string | Log ID |
|
||||
| ↳ `content` | object | Log content |
|
||||
| ↳ `timestamp` | string | Log timestamp |
|
||||
| ↳ `host` | string | Host name |
|
||||
| ↳ `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 |
|
||||
| ↳ `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`
|
||||
@@ -292,10 +287,10 @@ Schedule a downtime to suppress monitor notifications during maintenance windows
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `scope` | string | Yes | Scope to apply downtime to \(e.g., "host:myhost", "env:production", or "*" for all\) |
|
||||
| `message` | string | No | Message to display during downtime |
|
||||
| `start` | number | No | Unix timestamp for downtime start \(defaults to now\) |
|
||||
| `end` | number | No | Unix timestamp for downtime end |
|
||||
| `timezone` | string | No | Timezone for the downtime \(e.g., "America/New_York"\) |
|
||||
| `monitorId` | string | No | Specific monitor ID to mute |
|
||||
| `start` | number | No | Unix timestamp for downtime start in seconds \(e.g., 1705320000, defaults to now\) |
|
||||
| `end` | number | No | Unix timestamp for downtime end in seconds \(e.g., 1705323600\) |
|
||||
| `timezone` | string | No | Timezone for the downtime \(e.g., "America/New_York", "UTC", "Europe/London"\) |
|
||||
| `monitorId` | string | No | Specific monitor ID to mute \(e.g., "12345678"\) |
|
||||
| `monitorTags` | string | No | Comma-separated monitor tags to match \(e.g., "team:backend,priority:high"\) |
|
||||
| `muteFirstRecoveryNotification` | boolean | No | Mute the first recovery notification |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
@@ -307,12 +302,12 @@ Schedule a downtime to suppress monitor notifications during maintenance windows
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `downtime` | object | The created downtime details |
|
||||
| ↳ `id` | number | Downtime ID |
|
||||
| ↳ `scope` | array | Downtime scope |
|
||||
| ↳ `message` | string | Downtime message |
|
||||
| ↳ `start` | number | Start time \(Unix timestamp\) |
|
||||
| ↳ `end` | number | End time \(Unix timestamp\) |
|
||||
| ↳ `active` | boolean | Whether downtime is currently active |
|
||||
| ↳ `id` | number | Downtime ID |
|
||||
| ↳ `scope` | array | Downtime scope |
|
||||
| ↳ `message` | string | Downtime message |
|
||||
| ↳ `start` | number | Start time \(Unix timestamp\) |
|
||||
| ↳ `end` | number | End time \(Unix timestamp\) |
|
||||
| ↳ `active` | boolean | Whether downtime is currently active |
|
||||
|
||||
### `datadog_list_downtimes`
|
||||
|
||||
@@ -323,7 +318,7 @@ List all scheduled downtimes in Datadog.
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `currentOnly` | boolean | No | Only return currently active downtimes |
|
||||
| `monitorId` | string | No | Filter by monitor ID |
|
||||
| `monitorId` | string | No | Filter by monitor ID \(e.g., "12345678"\) |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
@@ -348,7 +343,7 @@ Cancel a scheduled downtime.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `downtimeId` | string | Yes | The ID of the downtime to cancel |
|
||||
| `downtimeId` | string | Yes | The ID of the downtime to cancel \(e.g., "abc123def456"\) |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
@@ -53,9 +53,9 @@ Send a message to a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID to send the message to |
|
||||
| `channelId` | string | Yes | The Discord channel ID to send the message to, e.g., 123456789012345678 |
|
||||
| `content` | string | No | The text content of the message |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `files` | file[] | No | Files to attach to the message |
|
||||
|
||||
#### Output
|
||||
@@ -64,24 +64,21 @@ Send a message to a Discord channel
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Discord message data |
|
||||
| ↳ `id` | string | Author user ID |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `channel_id` | string | Channel ID where message was sent |
|
||||
| ↳ `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 |
|
||||
| ↳ `id` | string | Message ID |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `channel_id` | string | Channel ID where message was sent |
|
||||
| ↳ `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 |
|
||||
| ↳ `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_messages`
|
||||
|
||||
@@ -92,7 +89,7 @@ Retrieve messages from a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID to retrieve messages from |
|
||||
| `channelId` | string | Yes | The Discord channel ID to retrieve messages from, e.g., 123456789012345678 |
|
||||
| `limit` | number | No | Maximum number of messages to retrieve \(default: 10, max: 100\) |
|
||||
|
||||
#### Output
|
||||
@@ -101,43 +98,23 @@ 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 |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `messages` | array | Array of Discord messages with full metadata |
|
||||
| ↳ `id` | string | Message 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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `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`
|
||||
|
||||
@@ -148,7 +125,7 @@ Retrieve information about a Discord server (guild)
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -156,14 +133,14 @@ Retrieve information about a Discord server (guild)
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Discord server \(guild\) information |
|
||||
| ↳ `id` | string | Server ID |
|
||||
| ↳ `name` | string | Server name |
|
||||
| ↳ `icon` | string | Server icon hash |
|
||||
| ↳ `description` | string | Server description |
|
||||
| ↳ `owner_id` | string | Server owner user ID |
|
||||
| ↳ `roles` | array | Server roles |
|
||||
| ↳ `channels` | array | Server channels |
|
||||
| ↳ `member_count` | number | Number of members in server |
|
||||
| ↳ `id` | string | Server ID |
|
||||
| ↳ `name` | string | Server name |
|
||||
| ↳ `icon` | string | Server icon hash |
|
||||
| ↳ `description` | string | Server description |
|
||||
| ↳ `owner_id` | string | Server owner user ID |
|
||||
| ↳ `roles` | array | Server roles |
|
||||
| ↳ `channels` | array | Server channels |
|
||||
| ↳ `member_count` | number | Number of members in server |
|
||||
|
||||
### `discord_get_user`
|
||||
|
||||
@@ -174,7 +151,7 @@ Retrieve information about a Discord user
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | Discord bot token for authentication |
|
||||
| `userId` | string | Yes | The Discord user ID |
|
||||
| `userId` | string | Yes | The Discord user ID, e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -182,14 +159,14 @@ Retrieve information about a Discord user
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Discord user information |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `username` | string | Username |
|
||||
| ↳ `discriminator` | string | User discriminator \(4-digit number\) |
|
||||
| ↳ `avatar` | string | User avatar hash |
|
||||
| ↳ `bot` | boolean | Whether user is a bot |
|
||||
| ↳ `system` | boolean | Whether user is a system user |
|
||||
| ↳ `email` | string | User email \(if available\) |
|
||||
| ↳ `verified` | boolean | Whether user email is verified |
|
||||
| ↳ `id` | string | User ID |
|
||||
| ↳ `username` | string | Username |
|
||||
| ↳ `discriminator` | string | User discriminator \(4-digit number\) |
|
||||
| ↳ `avatar` | string | User avatar hash |
|
||||
| ↳ `bot` | boolean | Whether user is a bot |
|
||||
| ↳ `system` | boolean | Whether user is a system user |
|
||||
| ↳ `email` | string | User email \(if available\) |
|
||||
| ↳ `verified` | boolean | Whether user email is verified |
|
||||
|
||||
### `discord_edit_message`
|
||||
|
||||
@@ -200,10 +177,10 @@ Edit an existing message in a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
||||
| `messageId` | string | Yes | The ID of the message to edit |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||
| `messageId` | string | Yes | The ID of the message to edit, e.g., 123456789012345678 |
|
||||
| `content` | string | No | The new text content for the message |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -211,10 +188,10 @@ Edit an existing message in a Discord channel
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Updated Discord message data |
|
||||
| ↳ `id` | string | Message ID |
|
||||
| ↳ `content` | string | Updated message content |
|
||||
| ↳ `channel_id` | string | Channel ID |
|
||||
| ↳ `edited_timestamp` | string | Message edited timestamp |
|
||||
| ↳ `id` | string | Message ID |
|
||||
| ↳ `content` | string | Updated message content |
|
||||
| ↳ `channel_id` | string | Channel ID |
|
||||
| ↳ `edited_timestamp` | string | Message edited timestamp |
|
||||
|
||||
### `discord_delete_message`
|
||||
|
||||
@@ -225,9 +202,9 @@ Delete a message from a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
||||
| `messageId` | string | Yes | The ID of the message to delete |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||
| `messageId` | string | Yes | The ID of the message to delete, e.g., 123456789012345678 |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -244,10 +221,10 @@ Add a reaction emoji to a Discord message
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
||||
| `messageId` | string | Yes | The ID of the message to react to |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||
| `messageId` | string | Yes | The ID of the message to react to, e.g., 123456789012345678 |
|
||||
| `emoji` | string | Yes | The emoji to react with \(unicode emoji or custom emoji in name:id format\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -264,11 +241,11 @@ Remove a reaction from a Discord message
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
||||
| `messageId` | string | Yes | The ID of the message with the reaction |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||
| `messageId` | string | Yes | The ID of the message with the reaction, e.g., 123456789012345678 |
|
||||
| `emoji` | string | Yes | The emoji to remove \(unicode emoji or custom emoji in name:id format\) |
|
||||
| `userId` | string | No | The user ID whose reaction to remove \(omit to remove bot's own reaction\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `userId` | string | No | The user ID whose reaction to remove \(omit to remove bot's own reaction\), e.g., 123456789012345678 |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -285,9 +262,9 @@ Pin a message in a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
||||
| `messageId` | string | Yes | The ID of the message to pin |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||
| `messageId` | string | Yes | The ID of the message to pin, e.g., 123456789012345678 |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -304,9 +281,9 @@ Unpin a message in a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
||||
| `messageId` | string | Yes | The ID of the message to unpin |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||
| `messageId` | string | Yes | The ID of the message to unpin, e.g., 123456789012345678 |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -323,11 +300,11 @@ Create a thread in a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID to create the thread in |
|
||||
| `channelId` | string | Yes | The Discord channel ID to create the thread in, e.g., 123456789012345678 |
|
||||
| `name` | string | Yes | The name of the thread \(1-100 characters\) |
|
||||
| `messageId` | string | No | The message ID to create a thread from \(if creating from existing message\) |
|
||||
| `messageId` | string | No | The message ID to create a thread from \(if creating from existing message\), e.g., 123456789012345678 |
|
||||
| `autoArchiveDuration` | number | No | Duration in minutes to auto-archive the thread \(60, 1440, 4320, 10080\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -335,11 +312,11 @@ Create a thread in a Discord channel
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Created thread data |
|
||||
| ↳ `id` | string | Thread ID |
|
||||
| ↳ `name` | string | Thread name |
|
||||
| ↳ `type` | number | Thread channel type |
|
||||
| ↳ `guild_id` | string | Server ID |
|
||||
| ↳ `parent_id` | string | Parent channel ID |
|
||||
| ↳ `id` | string | Thread ID |
|
||||
| ↳ `name` | string | Thread name |
|
||||
| ↳ `type` | number | Thread channel type |
|
||||
| ↳ `guild_id` | string | Server ID |
|
||||
| ↳ `parent_id` | string | Parent channel ID |
|
||||
|
||||
### `discord_join_thread`
|
||||
|
||||
@@ -350,8 +327,8 @@ Join a thread in Discord
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `threadId` | string | Yes | The thread ID to join |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `threadId` | string | Yes | The thread ID to join, e.g., 123456789012345678 |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -368,8 +345,8 @@ Leave a thread in Discord
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `threadId` | string | Yes | The thread ID to leave |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `threadId` | string | Yes | The thread ID to leave, e.g., 123456789012345678 |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -386,9 +363,9 @@ Archive or unarchive a thread in Discord
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `threadId` | string | Yes | The thread ID to archive/unarchive |
|
||||
| `threadId` | string | Yes | The thread ID to archive/unarchive, e.g., 123456789012345678 |
|
||||
| `archived` | boolean | Yes | Whether to archive \(true\) or unarchive \(false\) the thread |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -396,8 +373,8 @@ Archive or unarchive a thread in Discord
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Updated thread data |
|
||||
| ↳ `id` | string | Thread ID |
|
||||
| ↳ `archived` | boolean | Whether thread is archived |
|
||||
| ↳ `id` | string | Thread ID |
|
||||
| ↳ `archived` | boolean | Whether thread is archived |
|
||||
|
||||
### `discord_create_channel`
|
||||
|
||||
@@ -408,11 +385,11 @@ Create a new channel in a Discord server
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `name` | string | Yes | The name of the channel \(1-100 characters\) |
|
||||
| `type` | number | No | Channel type \(0=text, 2=voice, 4=category, 5=announcement, 13=stage\) |
|
||||
| `topic` | string | No | Channel topic \(0-1024 characters\) |
|
||||
| `parentId` | string | No | Parent category ID for the channel |
|
||||
| `parentId` | string | No | Parent category ID for the channel, e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -420,10 +397,10 @@ Create a new channel in a Discord server
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Created channel data |
|
||||
| ↳ `id` | string | Channel ID |
|
||||
| ↳ `name` | string | Channel name |
|
||||
| ↳ `type` | number | Channel type |
|
||||
| ↳ `guild_id` | string | Server ID |
|
||||
| ↳ `id` | string | Channel ID |
|
||||
| ↳ `name` | string | Channel name |
|
||||
| ↳ `type` | number | Channel type |
|
||||
| ↳ `guild_id` | string | Server ID |
|
||||
|
||||
### `discord_update_channel`
|
||||
|
||||
@@ -434,10 +411,10 @@ Update a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID to update |
|
||||
| `channelId` | string | Yes | The Discord channel ID to update, e.g., 123456789012345678 |
|
||||
| `name` | string | No | The new name for the channel |
|
||||
| `topic` | string | No | The new topic for the channel |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -445,10 +422,10 @@ Update a Discord channel
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Updated channel data |
|
||||
| ↳ `id` | string | Channel ID |
|
||||
| ↳ `name` | string | Channel name |
|
||||
| ↳ `type` | number | Channel type |
|
||||
| ↳ `topic` | string | Channel topic |
|
||||
| ↳ `id` | string | Channel ID |
|
||||
| ↳ `name` | string | Channel name |
|
||||
| ↳ `type` | number | Channel type |
|
||||
| ↳ `topic` | string | Channel topic |
|
||||
|
||||
### `discord_delete_channel`
|
||||
|
||||
@@ -459,8 +436,8 @@ Delete a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID to delete |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `channelId` | string | Yes | The Discord channel ID to delete, e.g., 123456789012345678 |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -477,8 +454,8 @@ Get information about a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID to retrieve |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `channelId` | string | Yes | The Discord channel ID to retrieve, e.g., 123456789012345678 |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -486,11 +463,11 @@ Get information about a Discord channel
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Channel data |
|
||||
| ↳ `id` | string | Channel ID |
|
||||
| ↳ `name` | string | Channel name |
|
||||
| ↳ `type` | number | Channel type |
|
||||
| ↳ `topic` | string | Channel topic |
|
||||
| ↳ `guild_id` | string | Server ID |
|
||||
| ↳ `id` | string | Channel ID |
|
||||
| ↳ `name` | string | Channel name |
|
||||
| ↳ `type` | number | Channel type |
|
||||
| ↳ `topic` | string | Channel topic |
|
||||
| ↳ `guild_id` | string | Server ID |
|
||||
|
||||
### `discord_create_role`
|
||||
|
||||
@@ -501,7 +478,7 @@ Create a new role in a Discord server
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `name` | string | Yes | The name of the role |
|
||||
| `color` | number | No | RGB color value as integer \(e.g., 0xFF0000 for red\) |
|
||||
| `hoist` | boolean | No | Whether to display role members separately from online members |
|
||||
@@ -513,11 +490,11 @@ Create a new role in a Discord server
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Created role data |
|
||||
| ↳ `id` | string | Role ID |
|
||||
| ↳ `name` | string | Role name |
|
||||
| ↳ `color` | number | Role color |
|
||||
| ↳ `hoist` | boolean | Whether role is hoisted |
|
||||
| ↳ `mentionable` | boolean | Whether role is mentionable |
|
||||
| ↳ `id` | string | Role ID |
|
||||
| ↳ `name` | string | Role name |
|
||||
| ↳ `color` | number | Role color |
|
||||
| ↳ `hoist` | boolean | Whether role is hoisted |
|
||||
| ↳ `mentionable` | boolean | Whether role is mentionable |
|
||||
|
||||
### `discord_update_role`
|
||||
|
||||
@@ -528,8 +505,8 @@ Update a role in a Discord server
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `roleId` | string | Yes | The role ID to update |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `roleId` | string | Yes | The role ID to update, e.g., 123456789012345678 |
|
||||
| `name` | string | No | The new name for the role |
|
||||
| `color` | number | No | RGB color value as integer |
|
||||
| `hoist` | boolean | No | Whether to display role members separately |
|
||||
@@ -541,9 +518,9 @@ Update a role in a Discord server
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Updated role data |
|
||||
| ↳ `id` | string | Role ID |
|
||||
| ↳ `name` | string | Role name |
|
||||
| ↳ `color` | number | Role color |
|
||||
| ↳ `id` | string | Role ID |
|
||||
| ↳ `name` | string | Role name |
|
||||
| ↳ `color` | number | Role color |
|
||||
|
||||
### `discord_delete_role`
|
||||
|
||||
@@ -554,8 +531,8 @@ Delete a role from a Discord server
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `roleId` | string | Yes | The role ID to delete |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `roleId` | string | Yes | The role ID to delete, e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -572,9 +549,9 @@ Assign a role to a member in a Discord server
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `userId` | string | Yes | The user ID to assign the role to |
|
||||
| `roleId` | string | Yes | The role ID to assign |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `userId` | string | Yes | The user ID to assign the role to, e.g., 123456789012345678 |
|
||||
| `roleId` | string | Yes | The role ID to assign, e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -591,9 +568,9 @@ Remove a role from a member in a Discord server
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `userId` | string | Yes | The user ID to remove the role from |
|
||||
| `roleId` | string | Yes | The role ID to remove |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `userId` | string | Yes | The user ID to remove the role from, e.g., 123456789012345678 |
|
||||
| `roleId` | string | Yes | The role ID to remove, e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -610,8 +587,8 @@ Kick a member from a Discord server
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `userId` | string | Yes | The user ID to kick |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `userId` | string | Yes | The user ID to kick, e.g., 123456789012345678 |
|
||||
| `reason` | string | No | Reason for kicking the member |
|
||||
|
||||
#### Output
|
||||
@@ -629,8 +606,8 @@ Ban a member from a Discord server
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `userId` | string | Yes | The user ID to ban |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `userId` | string | Yes | The user ID to ban, e.g., 123456789012345678 |
|
||||
| `reason` | string | No | Reason for banning the member |
|
||||
| `deleteMessageDays` | number | No | Number of days to delete messages for \(0-7\) |
|
||||
|
||||
@@ -649,8 +626,8 @@ Unban a member from a Discord server
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `userId` | string | Yes | The user ID to unban |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `userId` | string | Yes | The user ID to unban, e.g., 123456789012345678 |
|
||||
| `reason` | string | No | Reason for unbanning the member |
|
||||
|
||||
#### Output
|
||||
@@ -668,8 +645,8 @@ Get information about a member in a Discord server
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `userId` | string | Yes | The user ID to retrieve |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `userId` | string | Yes | The user ID to retrieve, e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -677,16 +654,13 @@ Get information about a member in a Discord server
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Member data |
|
||||
| ↳ `user` | object | User information |
|
||||
| ↳ `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 |
|
||||
| ↳ `user` | object | User information |
|
||||
| ↳ `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 |
|
||||
|
||||
### `discord_update_member`
|
||||
|
||||
@@ -697,8 +671,8 @@ Update a member in a Discord server (e.g., change nickname)
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `userId` | string | Yes | The user ID to update |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
| `userId` | string | Yes | The user ID to update, e.g., 123456789012345678 |
|
||||
| `nick` | string | No | New nickname for the member \(null to remove\) |
|
||||
| `mute` | boolean | No | Whether to mute the member in voice channels |
|
||||
| `deaf` | boolean | No | Whether to deafen the member in voice channels |
|
||||
@@ -709,9 +683,9 @@ Update a member in a Discord server (e.g., change nickname)
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Updated member data |
|
||||
| ↳ `nick` | string | Server nickname |
|
||||
| ↳ `mute` | boolean | Voice mute status |
|
||||
| ↳ `deaf` | boolean | Voice deaf status |
|
||||
| ↳ `nick` | string | Server nickname |
|
||||
| ↳ `mute` | boolean | Voice mute status |
|
||||
| ↳ `deaf` | boolean | Voice deaf status |
|
||||
|
||||
### `discord_create_invite`
|
||||
|
||||
@@ -722,11 +696,11 @@ Create an invite link for a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID to create an invite for |
|
||||
| `channelId` | string | Yes | The Discord channel ID to create an invite for, e.g., 123456789012345678 |
|
||||
| `maxAge` | number | No | Duration of invite in seconds \(0 = never expires, default 86400\) |
|
||||
| `maxUses` | number | No | Max number of uses \(0 = unlimited, default 0\) |
|
||||
| `temporary` | boolean | No | Whether invite grants temporary membership |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -734,11 +708,11 @@ Create an invite link for a Discord channel
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Created invite data |
|
||||
| ↳ `code` | string | Invite code |
|
||||
| ↳ `url` | string | Full invite URL |
|
||||
| ↳ `max_age` | number | Max age in seconds |
|
||||
| ↳ `max_uses` | number | Max uses |
|
||||
| ↳ `temporary` | boolean | Whether temporary |
|
||||
| ↳ `code` | string | Invite code |
|
||||
| ↳ `url` | string | Full invite URL |
|
||||
| ↳ `max_age` | number | Max age in seconds |
|
||||
| ↳ `max_uses` | number | Max uses |
|
||||
| ↳ `temporary` | boolean | Whether temporary |
|
||||
|
||||
### `discord_get_invite`
|
||||
|
||||
@@ -750,7 +724,7 @@ Get information about a Discord invite
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `inviteCode` | string | Yes | The invite code to retrieve |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -758,11 +732,11 @@ Get information about a Discord invite
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Invite data |
|
||||
| ↳ `code` | string | Invite code |
|
||||
| ↳ `guild` | object | Server information |
|
||||
| ↳ `channel` | object | Channel information |
|
||||
| ↳ `approximate_member_count` | number | Approximate member count |
|
||||
| ↳ `approximate_presence_count` | number | Approximate online count |
|
||||
| ↳ `code` | string | Invite code |
|
||||
| ↳ `guild` | object | Server information |
|
||||
| ↳ `channel` | object | Channel information |
|
||||
| ↳ `approximate_member_count` | number | Approximate member count |
|
||||
| ↳ `approximate_presence_count` | number | Approximate online count |
|
||||
|
||||
### `discord_delete_invite`
|
||||
|
||||
@@ -774,7 +748,7 @@ Delete a Discord invite
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `inviteCode` | string | Yes | The invite code to delete |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -791,9 +765,9 @@ Create a webhook in a Discord channel
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `channelId` | string | Yes | The Discord channel ID to create the webhook in |
|
||||
| `channelId` | string | Yes | The Discord channel ID to create the webhook in, e.g., 123456789012345678 |
|
||||
| `name` | string | Yes | Name of the webhook \(1-80 characters\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -801,11 +775,11 @@ Create a webhook in a Discord channel
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Created webhook data |
|
||||
| ↳ `id` | string | Webhook ID |
|
||||
| ↳ `name` | string | Webhook name |
|
||||
| ↳ `token` | string | Webhook token |
|
||||
| ↳ `url` | string | Webhook URL |
|
||||
| ↳ `channel_id` | string | Channel ID |
|
||||
| ↳ `id` | string | Webhook ID |
|
||||
| ↳ `name` | string | Webhook name |
|
||||
| ↳ `token` | string | Webhook token |
|
||||
| ↳ `url` | string | Webhook URL |
|
||||
| ↳ `channel_id` | string | Channel ID |
|
||||
|
||||
### `discord_execute_webhook`
|
||||
|
||||
@@ -815,11 +789,11 @@ Execute a Discord webhook to send a message
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `webhookId` | string | Yes | The webhook ID |
|
||||
| `webhookId` | string | Yes | The webhook ID, e.g., 123456789012345678 |
|
||||
| `webhookToken` | string | Yes | The webhook token |
|
||||
| `content` | string | Yes | The message content to send |
|
||||
| `username` | string | No | Override the default username of the webhook |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -827,10 +801,10 @@ Execute a Discord webhook to send a message
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Message sent via webhook |
|
||||
| ↳ `id` | string | Message ID |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `channel_id` | string | Channel ID |
|
||||
| ↳ `timestamp` | string | Message timestamp |
|
||||
| ↳ `id` | string | Message ID |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `channel_id` | string | Channel ID |
|
||||
| ↳ `timestamp` | string | Message timestamp |
|
||||
|
||||
### `discord_get_webhook`
|
||||
|
||||
@@ -841,8 +815,8 @@ Get information about a Discord webhook
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `webhookId` | string | Yes | The webhook ID to retrieve |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `webhookId` | string | Yes | The webhook ID to retrieve, e.g., 123456789012345678 |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -850,11 +824,11 @@ Get information about a Discord webhook
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success or error message |
|
||||
| `data` | object | Webhook data |
|
||||
| ↳ `id` | string | Webhook ID |
|
||||
| ↳ `name` | string | Webhook name |
|
||||
| ↳ `channel_id` | string | Channel ID |
|
||||
| ↳ `guild_id` | string | Server ID |
|
||||
| ↳ `token` | string | Webhook token |
|
||||
| ↳ `id` | string | Webhook ID |
|
||||
| ↳ `name` | string | Webhook name |
|
||||
| ↳ `channel_id` | string | Channel ID |
|
||||
| ↳ `guild_id` | string | Server ID |
|
||||
| ↳ `token` | string | Webhook token |
|
||||
|
||||
### `discord_delete_webhook`
|
||||
|
||||
@@ -865,8 +839,8 @@ Delete a Discord webhook
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `botToken` | string | Yes | The bot token for authentication |
|
||||
| `webhookId` | string | Yes | The webhook ID to delete |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
||||
| `webhookId` | string | Yes | The webhook ID to delete, e.g., 123456789012345678 |
|
||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -54,15 +54,15 @@ Upload a file to Dropbox
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | The uploaded file metadata |
|
||||
| ↳ `id` | string | Unique identifier for the file |
|
||||
| ↳ `name` | string | Name of the file |
|
||||
| ↳ `path_display` | string | Display path of the file |
|
||||
| ↳ `path_lower` | string | Lowercase path of the file |
|
||||
| ↳ `size` | number | Size of the file in bytes |
|
||||
| ↳ `client_modified` | string | Client modification time |
|
||||
| ↳ `server_modified` | string | Server modification time |
|
||||
| ↳ `rev` | string | Revision identifier |
|
||||
| ↳ `content_hash` | string | Content hash for the file |
|
||||
| ↳ `id` | string | Unique identifier for the file |
|
||||
| ↳ `name` | string | Name of the file |
|
||||
| ↳ `path_display` | string | Display path of the file |
|
||||
| ↳ `path_lower` | string | Lowercase path of the file |
|
||||
| ↳ `size` | number | Size of the file in bytes |
|
||||
| ↳ `client_modified` | string | Client modification time |
|
||||
| ↳ `server_modified` | string | Server modification time |
|
||||
| ↳ `rev` | string | Revision identifier |
|
||||
| ↳ `content_hash` | string | Content hash for the file |
|
||||
|
||||
### `dropbox_download`
|
||||
|
||||
@@ -79,10 +79,10 @@ Download a file from Dropbox and get a temporary link
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | The file metadata |
|
||||
| ↳ `id` | string | Unique identifier for the file |
|
||||
| ↳ `name` | string | Name of the file |
|
||||
| ↳ `path_display` | string | Display path of the file |
|
||||
| ↳ `size` | number | Size of the file in bytes |
|
||||
| ↳ `id` | string | Unique identifier for the file |
|
||||
| ↳ `name` | string | Name of the file |
|
||||
| ↳ `path_display` | string | Display path of the file |
|
||||
| ↳ `size` | number | Size of the file in bytes |
|
||||
| `temporaryLink` | string | Temporary link to download the file \(valid for ~4 hours\) |
|
||||
| `content` | string | Base64 encoded file content \(if fetched\) |
|
||||
|
||||
@@ -128,10 +128,10 @@ Create a new folder in Dropbox
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `folder` | object | The created folder metadata |
|
||||
| ↳ `id` | string | Unique identifier for the folder |
|
||||
| ↳ `name` | string | Name of the folder |
|
||||
| ↳ `path_display` | string | Display path of the folder |
|
||||
| ↳ `path_lower` | string | Lowercase path of the folder |
|
||||
| ↳ `id` | string | Unique identifier for the folder |
|
||||
| ↳ `name` | string | Name of the folder |
|
||||
| ↳ `path_display` | string | Display path of the folder |
|
||||
| ↳ `path_lower` | string | Lowercase path of the folder |
|
||||
|
||||
### `dropbox_delete`
|
||||
|
||||
@@ -148,8 +148,8 @@ Delete a file or folder in Dropbox (moves to trash)
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadata of the deleted item |
|
||||
| ↳ `name` | string | Name of the deleted item |
|
||||
| ↳ `path_display` | string | Display path |
|
||||
| ↳ `name` | string | Name of the deleted item |
|
||||
| ↳ `path_display` | string | Display path |
|
||||
| `deleted` | boolean | Whether the deletion was successful |
|
||||
|
||||
### `dropbox_copy`
|
||||
@@ -169,10 +169,10 @@ Copy a file or folder in Dropbox
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadata of the copied item |
|
||||
| ↳ `id` | string | Unique identifier |
|
||||
| ↳ `name` | string | Name of the copied item |
|
||||
| ↳ `path_display` | string | Display path |
|
||||
| ↳ `size` | number | Size in bytes \(files only\) |
|
||||
| ↳ `id` | string | Unique identifier |
|
||||
| ↳ `name` | string | Name of the copied item |
|
||||
| ↳ `path_display` | string | Display path |
|
||||
| ↳ `size` | number | Size in bytes \(files only\) |
|
||||
|
||||
### `dropbox_move`
|
||||
|
||||
@@ -191,10 +191,10 @@ Move or rename a file or folder in Dropbox
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadata of the moved item |
|
||||
| ↳ `id` | string | Unique identifier |
|
||||
| ↳ `name` | string | Name of the moved item |
|
||||
| ↳ `path_display` | string | Display path |
|
||||
| ↳ `size` | number | Size in bytes \(files only\) |
|
||||
| ↳ `id` | string | Unique identifier |
|
||||
| ↳ `name` | string | Name of the moved item |
|
||||
| ↳ `path_display` | string | Display path |
|
||||
| ↳ `size` | number | Size in bytes \(files only\) |
|
||||
|
||||
### `dropbox_get_metadata`
|
||||
|
||||
@@ -213,15 +213,15 @@ Get metadata for a file or folder in Dropbox
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadata for the file or folder |
|
||||
| ↳ `id` | string | Unique identifier |
|
||||
| ↳ `name` | string | Name of the item |
|
||||
| ↳ `path_display` | string | Display path |
|
||||
| ↳ `path_lower` | string | Lowercase path |
|
||||
| ↳ `size` | number | Size in bytes \(files only\) |
|
||||
| ↳ `client_modified` | string | Client modification time |
|
||||
| ↳ `server_modified` | string | Server modification time |
|
||||
| ↳ `rev` | string | Revision identifier |
|
||||
| ↳ `content_hash` | string | Content hash |
|
||||
| ↳ `id` | string | Unique identifier |
|
||||
| ↳ `name` | string | Name of the item |
|
||||
| ↳ `path_display` | string | Display path |
|
||||
| ↳ `path_lower` | string | Lowercase path |
|
||||
| ↳ `size` | number | Size in bytes \(files only\) |
|
||||
| ↳ `client_modified` | string | Client modification time |
|
||||
| ↳ `server_modified` | string | Server modification time |
|
||||
| ↳ `rev` | string | Revision identifier |
|
||||
| ↳ `content_hash` | string | Content hash |
|
||||
|
||||
### `dropbox_create_shared_link`
|
||||
|
||||
@@ -241,11 +241,11 @@ Create a shareable link for a file or folder in Dropbox
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `sharedLink` | object | The created shared link |
|
||||
| ↳ `url` | string | The shared link URL |
|
||||
| ↳ `name` | string | Name of the shared item |
|
||||
| ↳ `path_lower` | string | Lowercase path of the shared item |
|
||||
| ↳ `expires` | string | Expiration date if set |
|
||||
| ↳ `link_permissions` | object | Permissions for the shared link |
|
||||
| ↳ `url` | string | The shared link URL |
|
||||
| ↳ `name` | string | Name of the shared item |
|
||||
| ↳ `path_lower` | string | Lowercase path of the shared item |
|
||||
| ↳ `expires` | string | Expiration date if set |
|
||||
| ↳ `link_permissions` | object | Permissions for the shared link |
|
||||
|
||||
### `dropbox_search`
|
||||
|
||||
@@ -256,7 +256,7 @@ Search for files and folders in Dropbox
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | The search query |
|
||||
| `path` | string | No | Limit search to a specific folder path |
|
||||
| `path` | string | No | Dropbox folder path to limit search scope \(e.g., /folder/subfolder\) |
|
||||
| `fileExtensions` | string | No | Comma-separated list of file extensions to filter by \(e.g., pdf,xlsx\) |
|
||||
| `maxResults` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
|
||||
|
||||
@@ -54,8 +54,8 @@ Get an item from a DynamoDB table by primary key
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `key` | object | Yes | Primary key of the item to retrieve |
|
||||
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||
| `key` | object | Yes | Primary key of the item to retrieve \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) |
|
||||
| `consistentRead` | boolean | No | Use strongly consistent read |
|
||||
|
||||
#### Output
|
||||
@@ -76,8 +76,8 @@ Put an item into a DynamoDB table
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `item` | object | Yes | Item to put into the table |
|
||||
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||
| `item` | object | Yes | Item to put into the table \(e.g., \{"pk": "USER#123", "name": "John", "email": "john@example.com"\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -97,13 +97,13 @@ Query items from a DynamoDB table using key conditions
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `keyConditionExpression` | string | Yes | Key condition expression \(e.g., "pk = :pk"\) |
|
||||
| `filterExpression` | string | No | Filter expression for results |
|
||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
|
||||
| `expressionAttributeValues` | object | No | Expression attribute values |
|
||||
| `indexName` | string | No | Secondary index name to query |
|
||||
| `limit` | number | No | Maximum number of items to return |
|
||||
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||
| `keyConditionExpression` | string | Yes | Key condition expression \(e.g., "pk = :pk" or "pk = :pk AND sk BEGINS_WITH :prefix"\) |
|
||||
| `filterExpression` | string | No | Filter expression for results \(e.g., "age > :minAge AND #status = :status"\) |
|
||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#status": "status"\}\) |
|
||||
| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":pk": "USER#123", ":minAge": 18\}\) |
|
||||
| `indexName` | string | No | Secondary index name to query \(e.g., "GSI1", "email-index"\) |
|
||||
| `limit` | number | No | Maximum number of items to return \(e.g., 10, 50, 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -124,12 +124,12 @@ Scan all items in a DynamoDB table
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `filterExpression` | string | No | Filter expression for results |
|
||||
| `projectionExpression` | string | No | Attributes to retrieve |
|
||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
|
||||
| `expressionAttributeValues` | object | No | Expression attribute values |
|
||||
| `limit` | number | No | Maximum number of items to return |
|
||||
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||
| `filterExpression` | string | No | Filter expression for results \(e.g., "age > :minAge AND #status = :status"\) |
|
||||
| `projectionExpression` | string | No | Attributes to retrieve \(e.g., "pk, sk, #name, email"\) |
|
||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#name": "name", "#status": "status"\}\) |
|
||||
| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":minAge": 18, ":status": "active"\}\) |
|
||||
| `limit` | number | No | Maximum number of items to return \(e.g., 10, 50, 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -150,12 +150,12 @@ Update an item in a DynamoDB table
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `key` | object | Yes | Primary key of the item to update |
|
||||
| `updateExpression` | string | Yes | Update expression \(e.g., "SET #name = :name"\) |
|
||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
|
||||
| `expressionAttributeValues` | object | No | Expression attribute values |
|
||||
| `conditionExpression` | string | No | Condition that must be met for the update to succeed |
|
||||
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||
| `key` | object | Yes | Primary key of the item to update \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) |
|
||||
| `updateExpression` | string | Yes | Update expression \(e.g., "SET #name = :name, age = :age" or "SET #count = #count + :inc"\) |
|
||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#name": "name", "#count": "count"\}\) |
|
||||
| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":name": "John", ":age": 30, ":inc": 1\}\) |
|
||||
| `conditionExpression` | string | No | Condition that must be met for the update to succeed \(e.g., "attribute_exists\(pk\)" or "version = :expectedVersion"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -175,9 +175,9 @@ Delete an item from a DynamoDB table
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `key` | object | Yes | Primary key of the item to delete |
|
||||
| `conditionExpression` | string | No | Condition that must be met for the delete to succeed |
|
||||
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||
| `key` | object | Yes | Primary key of the item to delete \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) |
|
||||
| `conditionExpression` | string | No | Condition that must be met for the delete to succeed \(e.g., "attribute_exists\(pk\)"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -196,7 +196,7 @@ Introspect DynamoDB to list tables or get detailed schema information for a spec
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | No | Optional table name to get detailed schema. If not provided, lists all tables. |
|
||||
| `tableName` | string | No | Optional table name to get detailed schema \(e.g., "Users", "Orders"\). If not provided, lists all tables. |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -49,11 +49,12 @@ Search documents in Elasticsearch using Query DSL. Returns matching documents wi
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name to search |
|
||||
| `query` | string | No | Query DSL as JSON string |
|
||||
| `from` | number | No | Starting offset for pagination \(default: 0\) |
|
||||
| `size` | number | No | Number of results to return \(default: 10\) |
|
||||
| `sort` | string | No | Sort specification as JSON string |
|
||||
| `index` | string | Yes | Index name to search \(e.g., "products", "logs-2024"\) |
|
||||
| `query` | string | No | Query DSL as JSON string. Example: \{"match":\{"title":"search term"\}\} or \{"bool":\{"must":\[...\]\}\} |
|
||||
| `Example` | string | No | No description |
|
||||
| `from` | number | No | Starting offset for pagination \(e.g., 0, 10, 20\). Default: 0 |
|
||||
| `size` | number | No | Number of results to return \(e.g., 10, 25, 100\). Default: 10 |
|
||||
| `sort` | string | No | Sort specification as JSON string. Example: \[\{"created_at":"desc"\}\] or \[\{"_score":"desc"\},\{"name":"asc"\}\] |
|
||||
| `sourceIncludes` | string | No | Comma-separated list of fields to include in _source |
|
||||
| `sourceExcludes` | string | No | Comma-separated list of fields to exclude from _source |
|
||||
| `trackTotalHits` | boolean | No | Track accurate total hit count \(default: true\) |
|
||||
@@ -82,8 +83,8 @@ Index (create or update) a document in Elasticsearch.
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Target index name |
|
||||
| `documentId` | string | No | Document ID \(auto-generated if not provided\) |
|
||||
| `index` | string | Yes | Target index name \(e.g., "products", "logs-2024"\) |
|
||||
| `documentId` | string | No | Document ID \(e.g., "abc123", "user_456"\). Auto-generated if not provided |
|
||||
| `document` | string | Yes | Document body as JSON string |
|
||||
| `refresh` | string | No | Refresh policy: true, false, or wait_for |
|
||||
|
||||
@@ -111,8 +112,8 @@ Retrieve a document by ID from Elasticsearch.
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name |
|
||||
| `documentId` | string | Yes | Document ID to retrieve |
|
||||
| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) |
|
||||
| `documentId` | string | Yes | Document ID to retrieve \(e.g., "abc123", "user_456"\) |
|
||||
| `sourceIncludes` | string | No | Comma-separated list of fields to include |
|
||||
| `sourceExcludes` | string | No | Comma-separated list of fields to exclude |
|
||||
|
||||
@@ -141,8 +142,8 @@ Partially update a document in Elasticsearch using doc merge.
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name |
|
||||
| `documentId` | string | Yes | Document ID to update |
|
||||
| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) |
|
||||
| `documentId` | string | Yes | Document ID to update \(e.g., "abc123", "user_456"\) |
|
||||
| `document` | string | Yes | Partial document to merge as JSON string |
|
||||
| `retryOnConflict` | number | No | Number of retries on version conflict |
|
||||
|
||||
@@ -170,8 +171,8 @@ Delete a document from Elasticsearch by ID.
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name |
|
||||
| `documentId` | string | Yes | Document ID to delete |
|
||||
| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) |
|
||||
| `documentId` | string | Yes | Document ID to delete \(e.g., "abc123", "user_456"\) |
|
||||
| `refresh` | string | No | Refresh policy: true, false, or wait_for |
|
||||
|
||||
#### Output
|
||||
@@ -198,8 +199,9 @@ Perform multiple index, create, delete, or update operations in a single request
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | No | Default index for operations that do not specify one |
|
||||
| `operations` | string | Yes | Bulk operations as NDJSON string \(newline-delimited JSON\) |
|
||||
| `index` | string | No | Default index for operations \(e.g., "products", "logs-2024"\) |
|
||||
| `operations` | string | Yes | Bulk operations as NDJSON string. Each operation is two lines: action metadata and optional document. Example: \{"index":\{"_index":"products","_id":"1"\}\}\\n\{"name":"Widget"\}\\n |
|
||||
| `Example` | string | No | No description |
|
||||
| `refresh` | string | No | Refresh policy: true, false, or wait_for |
|
||||
|
||||
#### Output
|
||||
@@ -225,8 +227,9 @@ Count documents matching a query in Elasticsearch.
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name to count documents in |
|
||||
| `query` | string | No | Optional query to filter documents \(JSON string\) |
|
||||
| `index` | string | Yes | Index name to count documents in \(e.g., "products", "logs-2024"\) |
|
||||
| `query` | string | No | Query DSL to filter documents \(JSON string\). Example: \{"match":\{"status":"active"\}\} |
|
||||
| `Example` | string | No | No description |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -250,7 +253,7 @@ Create a new index with optional settings and mappings.
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name to create |
|
||||
| `index` | string | Yes | Index name to create \(e.g., "products", "logs-2024"\) |
|
||||
| `settings` | string | No | Index settings as JSON string |
|
||||
| `mappings` | string | No | Index mappings as JSON string |
|
||||
|
||||
@@ -277,7 +280,7 @@ Delete an index and all its documents. This operation is irreversible.
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name to delete |
|
||||
| `index` | string | Yes | Index name to delete \(e.g., "products", "logs-2024"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -300,7 +303,7 @@ Retrieve index information including settings, mappings, and aliases.
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name to retrieve info for |
|
||||
| `index` | string | Yes | Index name to retrieve info for \(e.g., "products", "logs-2024"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -41,9 +41,11 @@ Convert TTS using ElevenLabs voices
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `text` | string | Yes | The text to convert to speech |
|
||||
| `voiceId` | string | Yes | The ID of the voice to use |
|
||||
| `modelId` | string | No | The ID of the model to use \(defaults to eleven_monolingual_v1\) |
|
||||
| `text` | string | Yes | The text to convert to speech \(e.g., "Hello, welcome to our service!"\) |
|
||||
| `voiceId` | string | Yes | The ID of the voice to use \(e.g., "21m00Tcm4TlvDq8ikWAM" for Rachel\) |
|
||||
| `modelId` | string | No | The ID of the model to use \(e.g., "eleven_multilingual_v2", "eleven_turbo_v2"\). Defaults to eleven_monolingual_v1 |
|
||||
| `stability` | number | No | Voice stability setting from 0.0 to 1.0 \(e.g., 0.5 for balanced, 0.75 for more stable\). Higher values produce more consistent output |
|
||||
| `similarity` | number | No | Similarity boost setting from 0.0 to 1.0 \(e.g., 0.75 for natural, 1.0 for maximum similarity\). Higher values make the voice more similar to the original |
|
||||
| `apiKey` | string | Yes | Your ElevenLabs API key |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -44,11 +44,11 @@ Search the web using Exa AI. Returns relevant search results with titles, URLs,
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | The search query to execute |
|
||||
| `numResults` | number | No | Number of results to return \(default: 10, max: 25\) |
|
||||
| `useAutoprompt` | boolean | No | Whether to use autoprompt to improve the query \(default: false\) |
|
||||
| `type` | string | No | Search type: neural, keyword, auto or fast \(default: auto\) |
|
||||
| `includeDomains` | string | No | Comma-separated list of domains to include in results |
|
||||
| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results |
|
||||
| `numResults` | number | No | Number of results to return \(e.g., 5, 10, 25\). Default: 10, max: 25 |
|
||||
| `useAutoprompt` | boolean | No | Whether to use autoprompt to improve the query \(true or false\). Default: false |
|
||||
| `type` | string | No | Search type: "neural", "keyword", "auto", or "fast". Default: "auto" |
|
||||
| `includeDomains` | string | No | Comma-separated list of domains to include in results \(e.g., "github.com, stackoverflow.com"\) |
|
||||
| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results \(e.g., "reddit.com, pinterest.com"\) |
|
||||
| `category` | string | No | Filter by category: company, research paper, news, pdf, github, tweet, personal site, linkedin profile, financial report |
|
||||
| `text` | boolean | No | Include full text content in results \(default: false\) |
|
||||
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
|
||||
@@ -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 |
|
||||
@@ -107,10 +107,10 @@ Find webpages similar to a given URL using Exa AI. Returns a list of similar lin
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `url` | string | Yes | The URL to find similar links for |
|
||||
| `numResults` | number | No | Number of similar links to return \(default: 10, max: 25\) |
|
||||
| `numResults` | number | No | Number of similar links to return \(e.g., 5, 10, 25\). Default: 10, max: 25 |
|
||||
| `text` | boolean | No | Whether to include the full text of the similar pages |
|
||||
| `includeDomains` | string | No | Comma-separated list of domains to include in results |
|
||||
| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results |
|
||||
| `includeDomains` | string | No | Comma-separated list of domains to include in results \(e.g., "github.com, stackoverflow.com"\) |
|
||||
| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results \(e.g., "reddit.com, pinterest.com"\) |
|
||||
| `excludeSourceDomain` | boolean | No | Exclude the source domain from results \(default: false\) |
|
||||
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
|
||||
| `summary` | boolean | No | Include AI-generated summaries in results \(default: false\) |
|
||||
|
||||
@@ -50,7 +50,7 @@ Extract structured content from web pages with comprehensive metadata support. C
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `url` | string | Yes | The URL to scrape content from |
|
||||
| `url` | string | Yes | The URL to scrape content from \(e.g., "https://example.com/page"\) |
|
||||
| `scrapeOptions` | json | No | Options for content scraping |
|
||||
| `apiKey` | string | Yes | Firecrawl API key |
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -87,8 +115,12 @@ Crawl entire websites and extract structured content from all accessible pages
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `url` | string | Yes | The website URL to crawl |
|
||||
| `limit` | number | No | Maximum number of pages to crawl \(default: 100\) |
|
||||
| `url` | string | Yes | The website URL to crawl \(e.g., "https://example.com" or "https://docs.example.com/guide"\) |
|
||||
| `limit` | number | No | Maximum number of pages to crawl \(e.g., 50, 100, 500\). Default: 100 |
|
||||
| `maxDepth` | number | No | Maximum depth to crawl from the starting URL \(e.g., 1, 2, 3\). Controls how many levels deep to follow links |
|
||||
| `formats` | json | No | Output formats for scraped content \(e.g., \["markdown"\], \["markdown", "html"\], \["markdown", "links"\]\) |
|
||||
| `excludePaths` | json | No | URL paths to exclude from crawling \(e.g., \["/blog/*", "/admin/*", "/*.pdf"\]\) |
|
||||
| `includePaths` | json | No | URL paths to include in crawling \(e.g., \["/docs/*", "/api/*"\]\). Only these paths will be crawled |
|
||||
| `onlyMainContent` | boolean | No | Extract only main content from pages |
|
||||
| `apiKey` | string | Yes | Firecrawl API Key |
|
||||
|
||||
@@ -98,18 +130,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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `statusCode` | number | HTTP status code |
|
||||
| ↳ `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 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 |
|
||||
|
||||
@@ -121,12 +152,12 @@ Get a complete list of URLs from any website quickly and reliably. Useful for di
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `url` | string | Yes | The base URL to map and discover links from |
|
||||
| `url` | string | Yes | The base URL to map and discover links from \(e.g., "https://example.com"\) |
|
||||
| `search` | string | No | Filter results by relevance to a search term \(e.g., "blog"\) |
|
||||
| `sitemap` | string | No | Controls sitemap usage: "skip", "include" \(default\), or "only" |
|
||||
| `includeSubdomains` | boolean | No | Whether to include URLs from subdomains \(default: true\) |
|
||||
| `ignoreQueryParameters` | boolean | No | Exclude URLs containing query strings \(default: true\) |
|
||||
| `limit` | number | No | Maximum number of links to return \(max: 100,000, default: 5,000\) |
|
||||
| `limit` | number | No | Maximum number of links to return \(e.g., 100, 1000, 5000\). Max: 100,000, default: 5,000 |
|
||||
| `timeout` | number | No | Request timeout in milliseconds |
|
||||
| `location` | json | No | Geographic context for proxying \(country, languages\) |
|
||||
| `apiKey` | string | Yes | Firecrawl API key |
|
||||
@@ -146,7 +177,7 @@ Extract structured data from entire webpages using natural language prompts and
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `urls` | json | Yes | Array of URLs to extract data from \(supports glob format\) |
|
||||
| `urls` | json | Yes | Array of URLs to extract data from \(e.g., \["https://example.com/page1", "https://example.com/page2"\] or \["https://example.com/*"\]\) |
|
||||
| `prompt` | string | No | Natural language guidance for the extraction process |
|
||||
| `schema` | json | No | JSON Schema defining the structure of data to extract |
|
||||
| `enableWebSearch` | boolean | No | Enable web search to find supplementary information \(default: false\) |
|
||||
@@ -173,7 +204,7 @@ Autonomous web data extraction agent. Searches and gathers information based on
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `prompt` | string | Yes | Natural language description of the data to extract \(max 10,000 characters\) |
|
||||
| `urls` | json | No | Optional array of URLs to focus the agent on |
|
||||
| `urls` | json | No | Optional array of URLs to focus the agent on \(e.g., \["https://example.com", "https://docs.example.com"\]\) |
|
||||
| `schema` | json | No | JSON Schema defining the structure of data to extract |
|
||||
| `maxCredits` | number | No | Maximum credits to spend on this agent task |
|
||||
| `strictConstrainToURLs` | boolean | No | If true, agent will only visit URLs provided in the urls array |
|
||||
|
||||
@@ -44,13 +44,13 @@ List meeting transcripts from Fireflies.ai with optional filtering
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Fireflies API key |
|
||||
| `keyword` | string | No | Search keyword in meeting title or transcript |
|
||||
| `keyword` | string | No | Search keyword in meeting title or transcript \(e.g., "quarterly review"\) |
|
||||
| `fromDate` | string | No | Filter transcripts from this date \(ISO 8601 format\) |
|
||||
| `toDate` | string | No | Filter transcripts until this date \(ISO 8601 format\) |
|
||||
| `hostEmail` | string | No | Filter by meeting host email |
|
||||
| `participants` | string | No | Filter by participant emails \(comma-separated\) |
|
||||
| `limit` | number | No | Maximum number of transcripts to return \(max 50\) |
|
||||
| `skip` | number | No | Number of transcripts to skip for pagination |
|
||||
| `limit` | number | No | Maximum number of transcripts to return \(e.g., 10, max 50\) |
|
||||
| `skip` | number | No | Number of transcripts to skip for pagination \(e.g., 0, 10, 20\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -68,25 +68,25 @@ Get a single transcript with full details including summary, action items, and a
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Fireflies API key |
|
||||
| `transcriptId` | string | Yes | The transcript ID to retrieve |
|
||||
| `transcriptId` | string | Yes | The transcript ID to retrieve \(e.g., "abc123def456"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `transcript` | object | The transcript with full details |
|
||||
| ↳ `id` | string | Transcript ID |
|
||||
| ↳ `title` | string | Meeting title |
|
||||
| ↳ `date` | number | Meeting timestamp |
|
||||
| ↳ `duration` | number | Meeting duration in seconds |
|
||||
| ↳ `transcript_url` | string | URL to view transcript |
|
||||
| ↳ `audio_url` | string | URL to audio recording |
|
||||
| ↳ `host_email` | string | Host email address |
|
||||
| ↳ `participants` | array | List of participant emails |
|
||||
| ↳ `speakers` | array | List of speakers |
|
||||
| ↳ `sentences` | array | Transcript sentences |
|
||||
| ↳ `summary` | object | Meeting summary and action items |
|
||||
| ↳ `analytics` | object | Meeting analytics and sentiment |
|
||||
| ↳ `id` | string | Transcript ID |
|
||||
| ↳ `title` | string | Meeting title |
|
||||
| ↳ `date` | number | Meeting timestamp |
|
||||
| ↳ `duration` | number | Meeting duration in seconds |
|
||||
| ↳ `transcript_url` | string | URL to view transcript |
|
||||
| ↳ `audio_url` | string | URL to audio recording |
|
||||
| ↳ `host_email` | string | Host email address |
|
||||
| ↳ `participants` | array | List of participant emails |
|
||||
| ↳ `speakers` | array | List of speakers |
|
||||
| ↳ `sentences` | array | Transcript sentences |
|
||||
| ↳ `summary` | object | Meeting summary and action items |
|
||||
| ↳ `analytics` | object | Meeting analytics and sentiment |
|
||||
|
||||
### `fireflies_get_user`
|
||||
|
||||
@@ -97,22 +97,22 @@ Get user information from Fireflies.ai. Returns current user if no ID specified.
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Fireflies API key |
|
||||
| `userId` | string | No | User ID to retrieve \(optional, defaults to API key owner\) |
|
||||
| `userId` | string | No | User ID to retrieve \(e.g., "user_abc123", defaults to API key owner\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | User information |
|
||||
| ↳ `user_id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `integrations` | array | Connected integrations |
|
||||
| ↳ `is_admin` | boolean | Whether user is admin |
|
||||
| ↳ `minutes_consumed` | number | Total minutes transcribed |
|
||||
| ↳ `num_transcripts` | number | Number of transcripts |
|
||||
| ↳ `recent_transcript` | string | Most recent transcript ID |
|
||||
| ↳ `recent_meeting` | string | Most recent meeting date |
|
||||
| ↳ `user_id` | string | User ID |
|
||||
| ↳ `name` | string | User name |
|
||||
| ↳ `email` | string | User email |
|
||||
| ↳ `integrations` | array | Connected integrations |
|
||||
| ↳ `is_admin` | boolean | Whether user is admin |
|
||||
| ↳ `minutes_consumed` | number | Total minutes transcribed |
|
||||
| ↳ `num_transcripts` | number | Number of transcripts |
|
||||
| ↳ `recent_transcript` | string | Most recent transcript ID |
|
||||
| ↳ `recent_meeting` | string | Most recent meeting date |
|
||||
|
||||
### `fireflies_list_users`
|
||||
|
||||
@@ -164,7 +164,7 @@ Delete a transcript from Fireflies.ai
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Fireflies API key |
|
||||
| `transcriptId` | string | Yes | The transcript ID to delete |
|
||||
| `transcriptId` | string | Yes | The transcript ID to delete \(e.g., "abc123def456"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -202,7 +202,7 @@ Create a soundbite/highlight from a specific time range in a transcript
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Fireflies API key |
|
||||
| `transcriptId` | string | Yes | ID of the transcript to create the bite from |
|
||||
| `transcriptId` | string | Yes | ID of the transcript to create the bite from \(e.g., "abc123def456"\) |
|
||||
| `startTime` | number | Yes | Start time of the bite in seconds |
|
||||
| `endTime` | number | Yes | End time of the bite in seconds |
|
||||
| `name` | string | No | Name for the bite \(max 256 characters\) |
|
||||
@@ -214,9 +214,9 @@ Create a soundbite/highlight from a specific time range in a transcript
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `bite` | object | Created bite details |
|
||||
| ↳ `id` | string | Bite ID |
|
||||
| ↳ `name` | string | Bite name |
|
||||
| ↳ `status` | string | Processing status |
|
||||
| ↳ `id` | string | Bite ID |
|
||||
| ↳ `name` | string | Bite name |
|
||||
| ↳ `status` | string | Processing status |
|
||||
|
||||
### `fireflies_list_bites`
|
||||
|
||||
@@ -227,10 +227,10 @@ List soundbites/highlights from Fireflies.ai
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Fireflies API key |
|
||||
| `transcriptId` | string | No | Filter bites for a specific transcript |
|
||||
| `transcriptId` | string | No | Filter bites for a specific transcript \(e.g., "abc123def456"\) |
|
||||
| `mine` | boolean | No | Only return bites owned by the API key owner \(default: true\) |
|
||||
| `limit` | number | No | Maximum number of bites to return \(max 50\) |
|
||||
| `skip` | number | No | Number of bites to skip for pagination |
|
||||
| `limit` | number | No | Maximum number of bites to return \(e.g., 10, max 50\) |
|
||||
| `skip` | number | No | Number of bites to skip for pagination \(e.g., 0, 10, 20\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -96,11 +96,11 @@ Read emails from Gmail. Returns API-aligned fields only.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `messageId` | string | No | ID of the message to read |
|
||||
| `folder` | string | No | Folder/label to read emails from |
|
||||
| `unreadOnly` | boolean | No | Only retrieve unread messages |
|
||||
| `messageId` | string | No | Gmail message ID to read \(e.g., 18f1a2b3c4d5e6f7\) |
|
||||
| `folder` | string | No | Folder/label to read emails from \(e.g., INBOX, SENT, DRAFT, TRASH, SPAM, or custom label name\) |
|
||||
| `unreadOnly` | boolean | No | Set to true to only retrieve unread messages |
|
||||
| `maxResults` | number | No | Maximum number of messages to retrieve \(default: 1, max: 10\) |
|
||||
| `includeAttachments` | boolean | No | Download and include email attachments |
|
||||
| `includeAttachments` | boolean | No | Set to true to download and include email attachments |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -128,7 +128,7 @@ Search emails in Gmail. Returns API-aligned fields only.
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Search query for emails |
|
||||
| `maxResults` | number | No | Maximum number of results to return |
|
||||
| `maxResults` | number | No | Maximum number of results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -44,7 +44,7 @@ Create a new event in Google Calendar. Returns API-aligned fields only.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `calendarId` | string | No | Calendar ID \(defaults to primary\) |
|
||||
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) |
|
||||
| `summary` | string | Yes | Event title/summary |
|
||||
| `description` | string | No | Event description |
|
||||
| `location` | string | No | Event location |
|
||||
@@ -78,7 +78,7 @@ List events from Google Calendar. Returns API-aligned fields only.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `calendarId` | string | No | Calendar ID \(defaults to primary\) |
|
||||
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) |
|
||||
| `timeMin` | string | No | Lower bound for events \(RFC3339 timestamp, e.g., 2025-06-03T00:00:00Z\) |
|
||||
| `timeMax` | string | No | Upper bound for events \(RFC3339 timestamp, e.g., 2025-06-04T00:00:00Z\) |
|
||||
| `orderBy` | string | No | Order of events returned \(startTime or updated\) |
|
||||
@@ -100,8 +100,8 @@ Get a specific event from Google Calendar. Returns API-aligned fields only.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `calendarId` | string | No | Calendar ID \(defaults to primary\) |
|
||||
| `eventId` | string | Yes | Event ID to retrieve |
|
||||
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) |
|
||||
| `eventId` | string | Yes | Google Calendar event ID to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -127,8 +127,8 @@ Update an existing event in Google Calendar. Returns API-aligned fields only.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `calendarId` | string | No | Calendar ID \(defaults to primary\) |
|
||||
| `eventId` | string | Yes | Event ID to update |
|
||||
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) |
|
||||
| `eventId` | string | Yes | Google Calendar event ID to update |
|
||||
| `summary` | string | No | New event title/summary |
|
||||
| `description` | string | No | New event description |
|
||||
| `location` | string | No | New event location |
|
||||
@@ -162,8 +162,8 @@ Delete an event from Google Calendar. Returns API-aligned fields only.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `calendarId` | string | No | Calendar ID \(defaults to primary\) |
|
||||
| `eventId` | string | Yes | Event ID to delete |
|
||||
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) |
|
||||
| `eventId` | string | Yes | Google Calendar event ID to delete |
|
||||
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
|
||||
|
||||
#### Output
|
||||
@@ -181,9 +181,9 @@ Move an event to a different calendar. Returns API-aligned fields only.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `calendarId` | string | No | Source calendar ID \(defaults to primary\) |
|
||||
| `eventId` | string | Yes | Event ID to move |
|
||||
| `destinationCalendarId` | string | Yes | Destination calendar ID |
|
||||
| `calendarId` | string | No | Source Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) |
|
||||
| `eventId` | string | Yes | Google Calendar event ID to move |
|
||||
| `destinationCalendarId` | string | Yes | Destination Google Calendar ID |
|
||||
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
|
||||
|
||||
#### Output
|
||||
@@ -210,7 +210,7 @@ Get instances of a recurring event from Google Calendar. Returns API-aligned fie
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `calendarId` | string | No | Calendar ID \(defaults to primary\) |
|
||||
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) |
|
||||
| `eventId` | string | Yes | Recurring event ID to get instances of |
|
||||
| `timeMin` | string | No | Lower bound for instances \(RFC3339 timestamp, e.g., 2025-06-03T00:00:00Z\) |
|
||||
| `timeMax` | string | No | Upper bound for instances \(RFC3339 timestamp, e.g., 2025-06-04T00:00:00Z\) |
|
||||
@@ -266,7 +266,7 @@ Create events from natural language text. Returns API-aligned fields only.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `calendarId` | string | No | Calendar ID \(defaults to primary\) |
|
||||
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) |
|
||||
| `text` | string | Yes | Natural language text describing the event \(e.g., "Meeting with John tomorrow at 3pm"\) |
|
||||
| `attendees` | array | No | Array of attendee email addresses \(comma-separated string also accepted\) |
|
||||
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
|
||||
@@ -295,8 +295,8 @@ Invite attendees to an existing Google Calendar event. Returns API-aligned field
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `calendarId` | string | No | Calendar ID \(defaults to primary\) |
|
||||
| `eventId` | string | Yes | Event ID to invite attendees to |
|
||||
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) |
|
||||
| `eventId` | string | Yes | Google Calendar event ID to invite attendees to |
|
||||
| `attendees` | array | Yes | Array of attendee email addresses to invite |
|
||||
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
|
||||
| `replaceExisting` | boolean | No | Whether to replace existing attendees or add to them \(defaults to false\) |
|
||||
|
||||
@@ -79,7 +79,7 @@ Read content from a Google Docs document
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `documentId` | string | Yes | The ID of the document to read |
|
||||
| `documentId` | string | Yes | Google Docs document ID |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -87,10 +87,10 @@ Read content from a Google Docs document
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Extracted document text content |
|
||||
| `metadata` | json | Document metadata including ID, title, and URL |
|
||||
| ↳ `documentId` | string | Google Docs document ID |
|
||||
| ↳ `title` | string | Document title |
|
||||
| ↳ `mimeType` | string | Document MIME type |
|
||||
| ↳ `url` | string | Document URL |
|
||||
| ↳ `documentId` | string | Google Docs document ID |
|
||||
| ↳ `title` | string | Document title |
|
||||
| ↳ `mimeType` | string | Document MIME type |
|
||||
| ↳ `url` | string | Document URL |
|
||||
|
||||
### `google_docs_write`
|
||||
|
||||
@@ -109,10 +109,10 @@ Write or update content in a Google Docs document
|
||||
| --------- | ---- | ----------- |
|
||||
| `updatedContent` | boolean | Indicates if document content was updated successfully |
|
||||
| `metadata` | json | Updated document metadata including ID, title, and URL |
|
||||
| ↳ `documentId` | string | Google Docs document ID |
|
||||
| ↳ `title` | string | Document title |
|
||||
| ↳ `mimeType` | string | Document MIME type |
|
||||
| ↳ `url` | string | Document URL |
|
||||
| ↳ `documentId` | string | Google Docs document ID |
|
||||
| ↳ `title` | string | Document title |
|
||||
| ↳ `mimeType` | string | Document MIME type |
|
||||
| ↳ `url` | string | Document URL |
|
||||
|
||||
### `google_docs_create`
|
||||
|
||||
@@ -124,7 +124,7 @@ Create a new Google Docs document
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `title` | string | Yes | The title of the document to create |
|
||||
| `content` | string | No | The content of the document to create |
|
||||
| `folderSelector` | string | No | Select the folder to create the document in |
|
||||
| `folderSelector` | string | No | Google Drive folder ID to create the document in \(e.g., 1ABCxyz...\) |
|
||||
| `folderId` | string | No | The ID of the folder to create the document in \(internal use\) |
|
||||
|
||||
#### Output
|
||||
@@ -132,9 +132,9 @@ Create a new Google Docs document
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | json | Created document metadata including ID, title, and URL |
|
||||
| ↳ `documentId` | string | Google Docs document ID |
|
||||
| ↳ `title` | string | Document title |
|
||||
| ↳ `mimeType` | string | Document MIME type |
|
||||
| ↳ `url` | string | Document URL |
|
||||
| ↳ `documentId` | string | Google Docs document ID |
|
||||
| ↳ `title` | string | Document title |
|
||||
| ↳ `mimeType` | string | Document MIME type |
|
||||
| ↳ `url` | string | Document URL |
|
||||
|
||||
|
||||
|
||||
@@ -54,7 +54,7 @@ List files and folders in Google Drive with complete metadata
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `folderSelector` | string | No | Select the folder to list files from |
|
||||
| `folderSelector` | string | No | Google Drive folder ID to list files from \(e.g., 1ABCxyz...\) |
|
||||
| `folderId` | string | No | The ID of the folder to list files from \(internal use\) |
|
||||
| `query` | string | No | Search term to filter files by name \(e.g. "budget" finds files with "budget" in the name\). Do NOT use Google Drive query syntax here - just provide a plain search term. |
|
||||
| `pageSize` | number | No | The maximum number of files to return \(default: 100\) |
|
||||
@@ -134,29 +134,29 @@ Get metadata for a specific file in Google Drive by its ID
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | json | The file metadata |
|
||||
| ↳ `id` | string | Google Drive file ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `description` | string | File description |
|
||||
| ↳ `size` | string | File size in bytes |
|
||||
| ↳ `starred` | boolean | Whether file is starred |
|
||||
| ↳ `trashed` | boolean | Whether file is in trash |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `webContentLink` | string | Direct download URL |
|
||||
| ↳ `iconLink` | string | URL to file icon |
|
||||
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `owners` | json | List of file owners |
|
||||
| ↳ `permissions` | json | File permissions |
|
||||
| ↳ `createdTime` | string | File creation time |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
||||
| ↳ `shared` | boolean | Whether file is shared |
|
||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||
| ↳ `capabilities` | json | User capabilities on file |
|
||||
| ↳ `md5Checksum` | string | MD5 hash |
|
||||
| ↳ `version` | string | Version number |
|
||||
| ↳ `id` | string | Google Drive file ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `description` | string | File description |
|
||||
| ↳ `size` | string | File size in bytes |
|
||||
| ↳ `starred` | boolean | Whether file is starred |
|
||||
| ↳ `trashed` | boolean | Whether file is in trash |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `webContentLink` | string | Direct download URL |
|
||||
| ↳ `iconLink` | string | URL to file icon |
|
||||
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `owners` | json | List of file owners |
|
||||
| ↳ `permissions` | json | File permissions |
|
||||
| ↳ `createdTime` | string | File creation time |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
||||
| ↳ `shared` | boolean | Whether file is shared |
|
||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||
| ↳ `capabilities` | json | User capabilities on file |
|
||||
| ↳ `md5Checksum` | string | MD5 hash |
|
||||
| ↳ `version` | string | Version number |
|
||||
|
||||
### `google_drive_create_folder`
|
||||
|
||||
@@ -167,7 +167,7 @@ Create a new folder in Google Drive with complete metadata returned
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `fileName` | string | Yes | Name of the folder to create |
|
||||
| `folderSelector` | string | No | Select the parent folder to create the folder in |
|
||||
| `folderSelector` | string | No | Google Drive parent folder ID to create the folder in \(e.g., 1ABCxyz...\) |
|
||||
| `folderId` | string | No | ID of the parent folder \(internal use\) |
|
||||
|
||||
#### Output
|
||||
@@ -175,43 +175,43 @@ Create a new folder in Google Drive with complete metadata returned
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | Complete created folder metadata from Google Drive |
|
||||
| ↳ `id` | string | Google Drive folder ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | Folder name |
|
||||
| ↳ `mimeType` | string | MIME type \(application/vnd.google-apps.folder\) |
|
||||
| ↳ `description` | string | Folder description |
|
||||
| ↳ `owners` | json | List of folder owners |
|
||||
| ↳ `permissions` | json | Folder permissions |
|
||||
| ↳ `permissionIds` | json | Permission IDs |
|
||||
| ↳ `shared` | boolean | Whether folder is shared |
|
||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
||||
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
||||
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
||||
| ↳ `sharingUser` | json | User who shared the folder |
|
||||
| ↳ `starred` | boolean | Whether folder is starred |
|
||||
| ↳ `trashed` | boolean | Whether folder is in trash |
|
||||
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
||||
| ↳ `appProperties` | json | App-specific properties |
|
||||
| ↳ `folderColorRgb` | string | Folder color |
|
||||
| ↳ `createdTime` | string | Folder creation time |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
||||
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
||||
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
||||
| ↳ `lastModifyingUser` | json | User who last modified the folder |
|
||||
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
||||
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `iconLink` | string | URL to folder icon |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `spaces` | json | Spaces containing folder |
|
||||
| ↳ `driveId` | string | Shared drive ID |
|
||||
| ↳ `capabilities` | json | User capabilities on folder |
|
||||
| ↳ `version` | string | Version number |
|
||||
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
||||
| ↳ `contentRestrictions` | json | Content restrictions |
|
||||
| ↳ `linkShareMetadata` | json | Link share metadata |
|
||||
| ↳ `id` | string | Google Drive folder ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | Folder name |
|
||||
| ↳ `mimeType` | string | MIME type \(application/vnd.google-apps.folder\) |
|
||||
| ↳ `description` | string | Folder description |
|
||||
| ↳ `owners` | json | List of folder owners |
|
||||
| ↳ `permissions` | json | Folder permissions |
|
||||
| ↳ `permissionIds` | json | Permission IDs |
|
||||
| ↳ `shared` | boolean | Whether folder is shared |
|
||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
||||
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
||||
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
||||
| ↳ `sharingUser` | json | User who shared the folder |
|
||||
| ↳ `starred` | boolean | Whether folder is starred |
|
||||
| ↳ `trashed` | boolean | Whether folder is in trash |
|
||||
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
||||
| ↳ `appProperties` | json | App-specific properties |
|
||||
| ↳ `folderColorRgb` | string | Folder color |
|
||||
| ↳ `createdTime` | string | Folder creation time |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
||||
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
||||
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
||||
| ↳ `lastModifyingUser` | json | User who last modified the folder |
|
||||
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
||||
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `iconLink` | string | URL to folder icon |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `spaces` | json | Spaces containing folder |
|
||||
| ↳ `driveId` | string | Shared drive ID |
|
||||
| ↳ `capabilities` | json | User capabilities on folder |
|
||||
| ↳ `version` | string | Version number |
|
||||
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
||||
| ↳ `contentRestrictions` | json | Content restrictions |
|
||||
| ↳ `linkShareMetadata` | json | Link share metadata |
|
||||
|
||||
### `google_drive_upload`
|
||||
|
||||
@@ -225,7 +225,7 @@ Upload a file to Google Drive with complete metadata returned
|
||||
| `file` | file | No | Binary file to upload \(UserFile object\) |
|
||||
| `content` | string | No | Text content to upload \(use this OR file, not both\) |
|
||||
| `mimeType` | string | No | The MIME type of the file to upload \(auto-detected from file if not provided\) |
|
||||
| `folderSelector` | string | No | Select the folder to upload the file to |
|
||||
| `folderSelector` | string | No | Google Drive folder ID to upload the file to \(e.g., 1ABCxyz...\) |
|
||||
| `folderId` | string | No | The ID of the folder to upload the file to \(internal use\) |
|
||||
|
||||
#### Output
|
||||
@@ -233,58 +233,58 @@ Upload a file to Google Drive with complete metadata returned
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | Complete uploaded file metadata from Google Drive |
|
||||
| ↳ `id` | string | Google Drive file ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `description` | string | File description |
|
||||
| ↳ `originalFilename` | string | Original uploaded filename |
|
||||
| ↳ `fullFileExtension` | string | Full file extension |
|
||||
| ↳ `fileExtension` | string | File extension |
|
||||
| ↳ `owners` | json | List of file owners |
|
||||
| ↳ `permissions` | json | File permissions |
|
||||
| ↳ `permissionIds` | json | Permission IDs |
|
||||
| ↳ `shared` | boolean | Whether file is shared |
|
||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
||||
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
||||
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
||||
| ↳ `sharingUser` | json | User who shared the file |
|
||||
| ↳ `starred` | boolean | Whether file is starred |
|
||||
| ↳ `trashed` | boolean | Whether file is in trash |
|
||||
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
||||
| ↳ `appProperties` | json | App-specific properties |
|
||||
| ↳ `createdTime` | string | File creation time |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
||||
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
||||
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
||||
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
||||
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
||||
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `webContentLink` | string | Direct download URL |
|
||||
| ↳ `iconLink` | string | URL to file icon |
|
||||
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
||||
| ↳ `exportLinks` | json | Export format links |
|
||||
| ↳ `size` | string | File size in bytes |
|
||||
| ↳ `quotaBytesUsed` | string | Storage quota used |
|
||||
| ↳ `md5Checksum` | string | MD5 hash |
|
||||
| ↳ `sha1Checksum` | string | SHA-1 hash |
|
||||
| ↳ `sha256Checksum` | string | SHA-256 hash |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `spaces` | json | Spaces containing file |
|
||||
| ↳ `driveId` | string | Shared drive ID |
|
||||
| ↳ `capabilities` | json | User capabilities on file |
|
||||
| ↳ `version` | string | Version number |
|
||||
| ↳ `headRevisionId` | string | Head revision ID |
|
||||
| ↳ `hasThumbnail` | boolean | Whether has thumbnail |
|
||||
| ↳ `thumbnailVersion` | string | Thumbnail version |
|
||||
| ↳ `imageMediaMetadata` | json | Image-specific metadata |
|
||||
| ↳ `videoMediaMetadata` | json | Video-specific metadata |
|
||||
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
||||
| ↳ `contentRestrictions` | json | Content restrictions |
|
||||
| ↳ `linkShareMetadata` | json | Link share metadata |
|
||||
| ↳ `id` | string | Google Drive file ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `description` | string | File description |
|
||||
| ↳ `originalFilename` | string | Original uploaded filename |
|
||||
| ↳ `fullFileExtension` | string | Full file extension |
|
||||
| ↳ `fileExtension` | string | File extension |
|
||||
| ↳ `owners` | json | List of file owners |
|
||||
| ↳ `permissions` | json | File permissions |
|
||||
| ↳ `permissionIds` | json | Permission IDs |
|
||||
| ↳ `shared` | boolean | Whether file is shared |
|
||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
||||
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
||||
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
||||
| ↳ `sharingUser` | json | User who shared the file |
|
||||
| ↳ `starred` | boolean | Whether file is starred |
|
||||
| ↳ `trashed` | boolean | Whether file is in trash |
|
||||
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
||||
| ↳ `appProperties` | json | App-specific properties |
|
||||
| ↳ `createdTime` | string | File creation time |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
||||
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
||||
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
||||
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
||||
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
||||
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `webContentLink` | string | Direct download URL |
|
||||
| ↳ `iconLink` | string | URL to file icon |
|
||||
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
||||
| ↳ `exportLinks` | json | Export format links |
|
||||
| ↳ `size` | string | File size in bytes |
|
||||
| ↳ `quotaBytesUsed` | string | Storage quota used |
|
||||
| ↳ `md5Checksum` | string | MD5 hash |
|
||||
| ↳ `sha1Checksum` | string | SHA-1 hash |
|
||||
| ↳ `sha256Checksum` | string | SHA-256 hash |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `spaces` | json | Spaces containing file |
|
||||
| ↳ `driveId` | string | Shared drive ID |
|
||||
| ↳ `capabilities` | json | User capabilities on file |
|
||||
| ↳ `version` | string | Version number |
|
||||
| ↳ `headRevisionId` | string | Head revision ID |
|
||||
| ↳ `hasThumbnail` | boolean | Whether has thumbnail |
|
||||
| ↳ `thumbnailVersion` | string | Thumbnail version |
|
||||
| ↳ `imageMediaMetadata` | json | Image-specific metadata |
|
||||
| ↳ `videoMediaMetadata` | json | Video-specific metadata |
|
||||
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
||||
| ↳ `contentRestrictions` | json | Content restrictions |
|
||||
| ↳ `linkShareMetadata` | json | Link share metadata |
|
||||
|
||||
### `google_drive_download`
|
||||
|
||||
@@ -304,64 +304,64 @@ Download a file from Google Drive with complete metadata (exports Google Workspa
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | Downloaded file data |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type of the file |
|
||||
| ↳ `data` | string | File content as base64-encoded string |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type of the file |
|
||||
| ↳ `data` | string | File content as base64-encoded string |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| `metadata` | object | Complete file metadata from Google Drive |
|
||||
| ↳ `id` | string | Google Drive file ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `description` | string | File description |
|
||||
| ↳ `originalFilename` | string | Original uploaded filename |
|
||||
| ↳ `fullFileExtension` | string | Full file extension |
|
||||
| ↳ `fileExtension` | string | File extension |
|
||||
| ↳ `owners` | json | List of file owners |
|
||||
| ↳ `permissions` | json | File permissions |
|
||||
| ↳ `permissionIds` | json | Permission IDs |
|
||||
| ↳ `shared` | boolean | Whether file is shared |
|
||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
||||
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
||||
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
||||
| ↳ `sharingUser` | json | User who shared the file |
|
||||
| ↳ `starred` | boolean | Whether file is starred |
|
||||
| ↳ `trashed` | boolean | Whether file is in trash |
|
||||
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
||||
| ↳ `appProperties` | json | App-specific properties |
|
||||
| ↳ `createdTime` | string | File creation time |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
||||
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
||||
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
||||
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
||||
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
||||
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `webContentLink` | string | Direct download URL |
|
||||
| ↳ `iconLink` | string | URL to file icon |
|
||||
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
||||
| ↳ `exportLinks` | json | Export format links |
|
||||
| ↳ `size` | string | File size in bytes |
|
||||
| ↳ `quotaBytesUsed` | string | Storage quota used |
|
||||
| ↳ `md5Checksum` | string | MD5 hash |
|
||||
| ↳ `sha1Checksum` | string | SHA-1 hash |
|
||||
| ↳ `sha256Checksum` | string | SHA-256 hash |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `spaces` | json | Spaces containing file |
|
||||
| ↳ `driveId` | string | Shared drive ID |
|
||||
| ↳ `capabilities` | json | User capabilities on file |
|
||||
| ↳ `version` | string | Version number |
|
||||
| ↳ `headRevisionId` | string | Head revision ID |
|
||||
| ↳ `hasThumbnail` | boolean | Whether has thumbnail |
|
||||
| ↳ `thumbnailVersion` | string | Thumbnail version |
|
||||
| ↳ `imageMediaMetadata` | json | Image-specific metadata |
|
||||
| ↳ `videoMediaMetadata` | json | Video-specific metadata |
|
||||
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
||||
| ↳ `contentRestrictions` | json | Content restrictions |
|
||||
| ↳ `linkShareMetadata` | json | Link share metadata |
|
||||
| ↳ `revisions` | json | File revision history \(first 100 revisions only\) |
|
||||
| ↳ `id` | string | Google Drive file ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `description` | string | File description |
|
||||
| ↳ `originalFilename` | string | Original uploaded filename |
|
||||
| ↳ `fullFileExtension` | string | Full file extension |
|
||||
| ↳ `fileExtension` | string | File extension |
|
||||
| ↳ `owners` | json | List of file owners |
|
||||
| ↳ `permissions` | json | File permissions |
|
||||
| ↳ `permissionIds` | json | Permission IDs |
|
||||
| ↳ `shared` | boolean | Whether file is shared |
|
||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
||||
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
||||
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
||||
| ↳ `sharingUser` | json | User who shared the file |
|
||||
| ↳ `starred` | boolean | Whether file is starred |
|
||||
| ↳ `trashed` | boolean | Whether file is in trash |
|
||||
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
||||
| ↳ `appProperties` | json | App-specific properties |
|
||||
| ↳ `createdTime` | string | File creation time |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
||||
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
||||
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
||||
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
||||
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
||||
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `webContentLink` | string | Direct download URL |
|
||||
| ↳ `iconLink` | string | URL to file icon |
|
||||
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
||||
| ↳ `exportLinks` | json | Export format links |
|
||||
| ↳ `size` | string | File size in bytes |
|
||||
| ↳ `quotaBytesUsed` | string | Storage quota used |
|
||||
| ↳ `md5Checksum` | string | MD5 hash |
|
||||
| ↳ `sha1Checksum` | string | SHA-1 hash |
|
||||
| ↳ `sha256Checksum` | string | SHA-256 hash |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `spaces` | json | Spaces containing file |
|
||||
| ↳ `driveId` | string | Shared drive ID |
|
||||
| ↳ `capabilities` | json | User capabilities on file |
|
||||
| ↳ `version` | string | Version number |
|
||||
| ↳ `headRevisionId` | string | Head revision ID |
|
||||
| ↳ `hasThumbnail` | boolean | Whether has thumbnail |
|
||||
| ↳ `thumbnailVersion` | string | Thumbnail version |
|
||||
| ↳ `imageMediaMetadata` | json | Image-specific metadata |
|
||||
| ↳ `videoMediaMetadata` | json | Video-specific metadata |
|
||||
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
||||
| ↳ `contentRestrictions` | json | Content restrictions |
|
||||
| ↳ `linkShareMetadata` | json | Link share metadata |
|
||||
| ↳ `revisions` | json | File revision history \(first 100 revisions only\) |
|
||||
|
||||
### `google_drive_copy`
|
||||
|
||||
@@ -380,16 +380,16 @@ Create a copy of a file in Google Drive
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | json | The copied file metadata |
|
||||
| ↳ `id` | string | Google Drive file ID of the copy |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `createdTime` | string | File creation time |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `owners` | json | List of file owners |
|
||||
| ↳ `size` | string | File size in bytes |
|
||||
| ↳ `id` | string | Google Drive file ID of the copy |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `createdTime` | string | File creation time |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `owners` | json | List of file owners |
|
||||
| ↳ `size` | string | File size in bytes |
|
||||
|
||||
### `google_drive_update`
|
||||
|
||||
@@ -411,15 +411,15 @@ Update file metadata in Google Drive (rename, move, star, add description)
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | json | The updated file metadata |
|
||||
| ↳ `id` | string | Google Drive file ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `description` | string | File description |
|
||||
| ↳ `starred` | boolean | Whether file is starred |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
| ↳ `id` | string | Google Drive file ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `description` | string | File description |
|
||||
| ↳ `starred` | boolean | Whether file is starred |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `parents` | json | Parent folder IDs |
|
||||
| ↳ `modifiedTime` | string | Last modification time |
|
||||
|
||||
### `google_drive_trash`
|
||||
|
||||
@@ -436,13 +436,13 @@ Move a file to the trash in Google Drive (can be restored later)
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | json | The trashed file metadata |
|
||||
| ↳ `id` | string | Google Drive file ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `trashed` | boolean | Whether file is in trash \(should be true\) |
|
||||
| ↳ `trashedTime` | string | When file was trashed |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
| ↳ `id` | string | Google Drive file ID |
|
||||
| ↳ `kind` | string | Resource type identifier |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `trashed` | boolean | Whether file is in trash \(should be true\) |
|
||||
| ↳ `trashedTime` | string | When file was trashed |
|
||||
| ↳ `webViewLink` | string | URL to view in browser |
|
||||
|
||||
### `google_drive_delete`
|
||||
|
||||
@@ -484,14 +484,14 @@ Share a file with a user, group, domain, or make it public
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `permission` | json | The created permission details |
|
||||
| ↳ `id` | string | Permission ID |
|
||||
| ↳ `type` | string | Grantee type \(user, group, domain, anyone\) |
|
||||
| ↳ `role` | string | Permission role |
|
||||
| ↳ `emailAddress` | string | Email of the grantee |
|
||||
| ↳ `displayName` | string | Display name of the grantee |
|
||||
| ↳ `domain` | string | Domain of the grantee |
|
||||
| ↳ `expirationTime` | string | Expiration time |
|
||||
| ↳ `deleted` | boolean | Whether grantee is deleted |
|
||||
| ↳ `id` | string | Permission ID |
|
||||
| ↳ `type` | string | Grantee type \(user, group, domain, anyone\) |
|
||||
| ↳ `role` | string | Permission role |
|
||||
| ↳ `emailAddress` | string | Email of the grantee |
|
||||
| ↳ `displayName` | string | Display name of the grantee |
|
||||
| ↳ `domain` | string | Domain of the grantee |
|
||||
| ↳ `expirationTime` | string | Expiration time |
|
||||
| ↳ `deleted` | boolean | Whether grantee is deleted |
|
||||
|
||||
### `google_drive_unshare`
|
||||
|
||||
@@ -555,16 +555,16 @@ Get information about the user and their Google Drive (storage quota, capabiliti
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | json | Information about the authenticated user |
|
||||
| ↳ `displayName` | string | User display name |
|
||||
| ↳ `emailAddress` | string | User email address |
|
||||
| ↳ `photoLink` | string | URL to user profile photo |
|
||||
| ↳ `permissionId` | string | User permission ID |
|
||||
| ↳ `me` | boolean | Whether this is the authenticated user |
|
||||
| ↳ `displayName` | string | User display name |
|
||||
| ↳ `emailAddress` | string | User email address |
|
||||
| ↳ `photoLink` | string | URL to user profile photo |
|
||||
| ↳ `permissionId` | string | User permission ID |
|
||||
| ↳ `me` | boolean | Whether this is the authenticated user |
|
||||
| `storageQuota` | json | Storage quota information in bytes |
|
||||
| ↳ `limit` | string | Total storage limit in bytes \(null for unlimited\) |
|
||||
| ↳ `usage` | string | Total storage used in bytes |
|
||||
| ↳ `usageInDrive` | string | Storage used by Drive files in bytes |
|
||||
| ↳ `usageInDriveTrash` | string | Storage used by trashed files in bytes |
|
||||
| ↳ `limit` | string | Total storage limit in bytes \(null for unlimited\) |
|
||||
| ↳ `usage` | string | Total storage used in bytes |
|
||||
| ↳ `usageInDrive` | string | Storage used by Drive files in bytes |
|
||||
| ↳ `usageInDriveTrash` | string | Storage used by trashed files in bytes |
|
||||
| `canCreateDrives` | boolean | Whether user can create shared drives |
|
||||
| `importFormats` | json | Map of MIME types that can be imported and their target formats |
|
||||
| `exportFormats` | json | Map of Google Workspace MIME types and their exportable formats |
|
||||
|
||||
@@ -43,8 +43,8 @@ Retrieve a single response or list responses from a Google Form
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `formId` | string | Yes | The ID of the Google Form |
|
||||
| `responseId` | string | No | If provided, returns this specific response |
|
||||
| `formId` | string | Yes | Google Forms form ID |
|
||||
| `responseId` | string | No | Response ID - if provided, returns this specific response |
|
||||
| `pageSize` | number | No | Maximum number of responses to return \(service may return fewer\). Defaults to 5000. |
|
||||
|
||||
#### Output
|
||||
@@ -57,10 +57,10 @@ Retrieve a single response or list responses from a Google Form
|
||||
| ↳ `lastSubmittedTime` | string | When the response was last submitted |
|
||||
| ↳ `answers` | json | Map of question IDs to answer values |
|
||||
| `response` | object | Single form response \(when responseId is provided\) |
|
||||
| ↳ `responseId` | string | Unique response ID |
|
||||
| ↳ `createTime` | string | When the response was created |
|
||||
| ↳ `lastSubmittedTime` | string | When the response was last submitted |
|
||||
| ↳ `answers` | json | Map of question IDs to answer values |
|
||||
| ↳ `responseId` | string | Unique response ID |
|
||||
| ↳ `createTime` | string | When the response was created |
|
||||
| ↳ `lastSubmittedTime` | string | When the response was last submitted |
|
||||
| ↳ `answers` | json | Map of question IDs to answer values |
|
||||
| `raw` | json | Raw API response data |
|
||||
|
||||
### `google_forms_get_form`
|
||||
@@ -71,7 +71,7 @@ Retrieve a form structure including its items, settings, and metadata
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `formId` | string | Yes | The ID of the Google Form to retrieve |
|
||||
| `formId` | string | Yes | Google Forms form ID to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -121,7 +121,7 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `formId` | string | Yes | The ID of the Google Form to update |
|
||||
| `formId` | string | Yes | Google Forms form ID |
|
||||
| `requests` | json | Yes | Array of update requests \(updateFormInfo, updateSettings, createItem, updateItem, moveItem, deleteItem\) |
|
||||
| `includeFormInResponse` | boolean | No | Whether to return the updated form in the response |
|
||||
|
||||
@@ -131,47 +131,25 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
|
||||
| --------- | ---- | ----------- |
|
||||
| `replies` | array | The replies from each update request |
|
||||
| `writeControl` | object | Write control information with revision IDs |
|
||||
| ↳ `requiredRevisionId` | string | Required revision ID for conflict detection |
|
||||
| ↳ `targetRevisionId` | string | Target revision ID |
|
||||
| ↳ `requiredRevisionId` | string | Required revision ID for conflict detection |
|
||||
| ↳ `targetRevisionId` | string | Target revision ID |
|
||||
| `form` | object | The updated form \(if includeFormInResponse was true\) |
|
||||
| ↳ `formId` | string | The form ID |
|
||||
| ↳ `info` | object | Form info containing title and description |
|
||||
| ↳ `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 |
|
||||
| ↳ `publishSettings` | object | Form publish settings |
|
||||
| ↳ `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 |
|
||||
| ↳ `formId` | string | The form ID |
|
||||
| ↳ `info` | object | Form info containing title and description |
|
||||
| ↳ `title` | string | The form title visible to responders |
|
||||
| ↳ `description` | string | The form 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 |
|
||||
| ↳ `emailCollectionType` | string | Email collection type |
|
||||
| ↳ `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 |
|
||||
| ↳ `publishSettings` | object | Form publish settings |
|
||||
| ↳ `publishState` | object | Current publish state |
|
||||
| ↳ `isPublished` | boolean | Whether the form is published |
|
||||
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
|
||||
|
||||
### `google_forms_set_publish_settings`
|
||||
|
||||
@@ -181,7 +159,7 @@ Update the publish settings of a form (publish/unpublish, accept responses)
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `formId` | string | Yes | The ID of the Google Form |
|
||||
| `formId` | string | Yes | Google Forms form ID |
|
||||
| `isPublished` | boolean | Yes | Whether the form is published and visible to others |
|
||||
| `isAcceptingResponses` | boolean | No | Whether the form accepts responses \(forced to false if isPublished is false\) |
|
||||
|
||||
@@ -191,11 +169,9 @@ Update the publish settings of a form (publish/unpublish, accept responses)
|
||||
| --------- | ---- | ----------- |
|
||||
| `formId` | string | The form ID |
|
||||
| `publishSettings` | json | The updated publish settings |
|
||||
| ↳ `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 |
|
||||
| ↳ `publishState` | object | The publish state |
|
||||
| ↳ `isPublished` | boolean | Whether the form is published |
|
||||
| ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses |
|
||||
|
||||
### `google_forms_create_watch`
|
||||
|
||||
@@ -205,7 +181,7 @@ Create a notification watch for form changes (schema changes or new responses)
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `formId` | string | Yes | The ID of the Google Form to watch |
|
||||
| `formId` | string | Yes | Google Forms form ID to watch |
|
||||
| `eventType` | string | Yes | Event type to watch: SCHEMA \(form changes\) or RESPONSES \(new submissions\) |
|
||||
| `topicName` | string | Yes | The Cloud Pub/Sub topic name \(format: projects/\{project\}/topics/\{topic\}\) |
|
||||
| `watchId` | string | No | Custom watch ID \(4-63 chars, lowercase letters, numbers, hyphens\) |
|
||||
@@ -229,7 +205,7 @@ List all notification watches for a form
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `formId` | string | Yes | The ID of the Google Form |
|
||||
| `formId` | string | Yes | Google Forms form ID |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -250,8 +226,8 @@ Delete a notification watch from a form
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `formId` | string | Yes | The ID of the Google Form |
|
||||
| `watchId` | string | Yes | The ID of the watch to delete |
|
||||
| `formId` | string | Yes | Google Forms form ID |
|
||||
| `watchId` | string | Yes | Watch ID to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -267,8 +243,8 @@ Renew a notification watch for another 7 days
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `formId` | string | Yes | The ID of the Google Form |
|
||||
| `watchId` | string | Yes | The ID of the watch to renew |
|
||||
| `formId` | string | Yes | Google Forms form ID |
|
||||
| `watchId` | string | Yes | Watch ID to renew |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -28,8 +28,8 @@ List all groups in a Google Workspace domain
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `customer` | string | No | Customer ID or "my_customer" for the authenticated user\'s domain |
|
||||
| `domain` | string | No | Domain name to filter groups by |
|
||||
| `maxResults` | number | No | Maximum number of results to return \(1-200\) |
|
||||
| `pageToken` | string | No | Token for pagination |
|
||||
| `maxResults` | number | No | Maximum number of results to return \(1-200\). Example: 50 |
|
||||
| `pageToken` | string | No | Token for fetching the next page of results |
|
||||
| `query` | string | No | Search query to filter groups \(e.g., "email:admin*"\) |
|
||||
|
||||
#### Output
|
||||
@@ -47,7 +47,7 @@ Get details of a specific Google Group by email or group ID
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -63,8 +63,8 @@ Create a new Google Group in the domain
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `email` | string | Yes | Email address for the new group \(e.g., team@yourdomain.com\) |
|
||||
| `name` | string | Yes | Display name for the group |
|
||||
| `email` | string | Yes | Email address for the new group \(e.g., team@example.com\) |
|
||||
| `name` | string | Yes | Display name for the group \(e.g., Engineering Team\) |
|
||||
| `description` | string | No | Description of the group |
|
||||
|
||||
#### Output
|
||||
@@ -81,10 +81,10 @@ Update an existing Google Group
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `name` | string | No | New display name for the group |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
| `name` | string | No | New display name for the group \(e.g., Engineering Team\) |
|
||||
| `description` | string | No | New description for the group |
|
||||
| `email` | string | No | New email address for the group |
|
||||
| `email` | string | No | New email address for the group \(e.g., newteam@example.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -100,7 +100,7 @@ Delete a Google Group
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID to delete |
|
||||
| `groupKey` | string | Yes | Group identifier to delete. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -116,9 +116,9 @@ List all members of a Google Group
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `maxResults` | number | No | Maximum number of results to return \(1-200\) |
|
||||
| `pageToken` | string | No | Token for pagination |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
| `maxResults` | number | No | Maximum number of results to return \(1-200\). Example: 50 |
|
||||
| `pageToken` | string | No | Token for fetching the next page of results |
|
||||
| `roles` | string | No | Filter by roles \(comma-separated: OWNER, MANAGER, MEMBER\) |
|
||||
|
||||
#### Output
|
||||
@@ -136,8 +136,8 @@ Get details of a specific member in a Google Group
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `memberKey` | string | Yes | Member email address or unique member ID |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
| `memberKey` | string | Yes | Member identifier. Can be the member email address \(e.g., user@example.com\) or the unique member ID |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -153,9 +153,9 @@ Add a new member to a Google Group
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `email` | string | Yes | Email address of the member to add |
|
||||
| `role` | string | No | Role for the member \(MEMBER, MANAGER, or OWNER\). Defaults to MEMBER. |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
| `email` | string | Yes | Email address of the member to add \(e.g., user@example.com\) |
|
||||
| `role` | string | No | Role for the member: MEMBER, MANAGER, or OWNER. Defaults to MEMBER |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -171,8 +171,8 @@ Remove a member from a Google Group
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `memberKey` | string | Yes | Email address or unique ID of the member to remove |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
| `memberKey` | string | Yes | Member identifier to remove. Can be the member email address \(e.g., user@example.com\) or the unique member ID |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -188,9 +188,9 @@ Update a member
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `memberKey` | string | Yes | Member email address or unique member ID |
|
||||
| `role` | string | Yes | New role for the member \(MEMBER, MANAGER, or OWNER\) |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
| `memberKey` | string | Yes | Member identifier. Can be the member email address \(e.g., user@example.com\) or the unique member ID |
|
||||
| `role` | string | Yes | New role for the member: MEMBER, MANAGER, or OWNER |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -206,8 +206,8 @@ Check if a user is a member of a Google Group
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `memberKey` | string | Yes | Member email address or unique member ID to check |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
| `memberKey` | string | Yes | Member identifier to check. Can be the member email address \(e.g., user@example.com\) or the unique member ID |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -223,7 +223,7 @@ List all email aliases for a Google Group
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -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 |
|
||||
@@ -244,7 +244,7 @@ Add an email alias to a Google Group
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
| `alias` | string | Yes | The email alias to add to the group |
|
||||
|
||||
#### Output
|
||||
@@ -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 |
|
||||
@@ -265,7 +265,7 @@ Remove an email alias from a Google Group
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupKey` | string | Yes | Group email address or unique group ID |
|
||||
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID |
|
||||
| `alias` | string | Yes | The email alias to remove from the group |
|
||||
|
||||
#### Output
|
||||
@@ -282,13 +282,13 @@ Get the settings for a Google Group including access permissions, moderation, an
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupEmail` | string | Yes | The email address of the group |
|
||||
| `groupEmail` | string | Yes | The email address of the group \(e.g., team@example.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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 |
|
||||
@@ -330,7 +330,7 @@ Update the settings for a Google Group including access permissions, moderation,
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupEmail` | string | Yes | The email address of the group |
|
||||
| `groupEmail` | string | Yes | The email address of the group \(e.g., team@example.com\) |
|
||||
| `name` | string | No | The group name \(max 75 characters\) |
|
||||
| `description` | string | No | The group description \(max 4096 characters\) |
|
||||
| `whoCanJoin` | string | No | Who can join: ANYONE_CAN_JOIN, ALL_IN_DOMAIN_CAN_JOIN, INVITED_CAN_JOIN, CAN_REQUEST_TO_JOIN |
|
||||
@@ -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,12 +66,12 @@ 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 |
|
||||
| ↳ `formattedSearchTime` | string | Formatted search time for display |
|
||||
| ↳ `formattedTotalResults` | string | Formatted total results count for display |
|
||||
| ↳ `totalResults` | string | Total number of search results available |
|
||||
| ↳ `searchTime` | number | Time taken to perform the search in seconds |
|
||||
| ↳ `formattedSearchTime` | string | Formatted search time for display |
|
||||
| ↳ `formattedTotalResults` | string | Formatted total results count for display |
|
||||
|
||||
|
||||
|
||||
@@ -53,8 +53,8 @@ Read data from a specific sheet in a Google Sheets spreadsheet
|
||||
| `range` | string | The range of cells that was read |
|
||||
| `values` | array | The cell values as a 2D array |
|
||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
|
||||
### `google_sheets_write`
|
||||
|
||||
@@ -79,8 +79,8 @@ Write data to a specific sheet in a Google Sheets spreadsheet
|
||||
| `updatedColumns` | number | Number of columns updated |
|
||||
| `updatedCells` | number | Number of cells updated |
|
||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
|
||||
### `google_sheets_update`
|
||||
|
||||
@@ -105,8 +105,8 @@ Update data in a specific sheet in a Google Sheets spreadsheet
|
||||
| `updatedColumns` | number | Number of columns updated |
|
||||
| `updatedCells` | number | Number of cells updated |
|
||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
|
||||
### `google_sheets_append`
|
||||
|
||||
@@ -133,8 +133,8 @@ Append data to the end of a specific sheet in a Google Sheets spreadsheet
|
||||
| `updatedColumns` | number | Number of columns updated |
|
||||
| `updatedCells` | number | Number of cells updated |
|
||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
|
||||
### `google_sheets_clear`
|
||||
|
||||
@@ -144,7 +144,7 @@ Clear values from a specific range in a Google Sheets spreadsheet
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet |
|
||||
| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID |
|
||||
| `sheetName` | string | Yes | The name of the sheet/tab to clear |
|
||||
| `cellRange` | string | No | The cell range to clear \(e.g. "A1:D10"\). Clears entire sheet if not specified. |
|
||||
|
||||
@@ -155,8 +155,8 @@ Clear values from a specific range in a Google Sheets spreadsheet
|
||||
| `clearedRange` | string | The range that was cleared |
|
||||
| `sheetName` | string | Name of the sheet that was cleared |
|
||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
|
||||
### `google_sheets_get_spreadsheet`
|
||||
|
||||
@@ -166,7 +166,7 @@ Get metadata about a Google Sheets spreadsheet including title and sheet list
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet |
|
||||
| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID |
|
||||
| `includeGridData` | boolean | No | Whether to include grid data \(cell values\). Defaults to false. |
|
||||
|
||||
#### Output
|
||||
@@ -219,7 +219,7 @@ Read multiple ranges from a Google Sheets spreadsheet in a single request
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet |
|
||||
| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID |
|
||||
| `ranges` | json | Yes | Array of ranges to read \(e.g., \["Sheet1!A1:D10", "Sheet2!A1:B5"\]\). Each range should include sheet name. |
|
||||
| `majorDimension` | string | No | The major dimension of values: "ROWS" \(default\) or "COLUMNS" |
|
||||
| `valueRenderOption` | string | No | How values should be rendered: "FORMATTED_VALUE" \(default\), "UNFORMATTED_VALUE", or "FORMULA" |
|
||||
@@ -234,8 +234,8 @@ Read multiple ranges from a Google Sheets spreadsheet in a single request
|
||||
| ↳ `majorDimension` | string | Major dimension \(ROWS or COLUMNS\) |
|
||||
| ↳ `values` | array | The cell values as a 2D array |
|
||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
|
||||
### `google_sheets_batch_update`
|
||||
|
||||
@@ -245,7 +245,7 @@ Update multiple ranges in a Google Sheets spreadsheet in a single request
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet |
|
||||
| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID |
|
||||
| `data` | json | Yes | Array of value ranges to update. Each item should have "range" \(e.g., "Sheet1!A1:D10"\) and "values" \(2D array\). |
|
||||
| `valueInputOption` | string | No | How input data should be interpreted: "RAW" or "USER_ENTERED" \(default\). USER_ENTERED parses formulas. |
|
||||
|
||||
@@ -265,8 +265,8 @@ Update multiple ranges in a Google Sheets spreadsheet in a single request
|
||||
| ↳ `updatedColumns` | number | Number of columns updated in this range |
|
||||
| ↳ `updatedCells` | number | Number of cells updated in this range |
|
||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
|
||||
### `google_sheets_batch_clear`
|
||||
|
||||
@@ -276,7 +276,7 @@ Clear multiple ranges in a Google Sheets spreadsheet in a single request
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet |
|
||||
| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID |
|
||||
| `ranges` | json | Yes | Array of ranges to clear \(e.g., \["Sheet1!A1:D10", "Sheet2!A1:B5"\]\). Each range should include sheet name. |
|
||||
|
||||
#### Output
|
||||
@@ -286,8 +286,8 @@ Clear multiple ranges in a Google Sheets spreadsheet in a single request
|
||||
| `spreadsheetId` | string | The spreadsheet ID |
|
||||
| `clearedRanges` | array | Array of ranges that were cleared |
|
||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
|
||||
### `google_sheets_copy_sheet`
|
||||
|
||||
@@ -297,7 +297,7 @@ Copy a sheet from one spreadsheet to another
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `sourceSpreadsheetId` | string | Yes | The ID of the source spreadsheet |
|
||||
| `sourceSpreadsheetId` | string | Yes | Source Google Sheets spreadsheet ID |
|
||||
| `sheetId` | number | Yes | The ID of the sheet to copy \(numeric ID, not the sheet name\). Use Get Spreadsheet to find sheet IDs. |
|
||||
| `destinationSpreadsheetId` | string | Yes | The ID of the destination spreadsheet where the sheet will be copied |
|
||||
|
||||
|
||||
@@ -44,7 +44,7 @@ Read content from a Google Slides presentation
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation to read |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -52,15 +52,13 @@ Read content from a Google Slides presentation
|
||||
| --------- | ---- | ----------- |
|
||||
| `slides` | json | Array of slides with their content |
|
||||
| `metadata` | json | Presentation metadata including ID, title, and URL |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `title` | string | The presentation title |
|
||||
| ↳ `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 |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `title` | string | The presentation title |
|
||||
| ↳ `pageSize` | object | Presentation page size |
|
||||
| ↳ `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 |
|
||||
|
||||
### `google_slides_write`
|
||||
|
||||
@@ -70,7 +68,7 @@ Write or update content in a Google Slides presentation
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation to write to |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `content` | string | Yes | The content to write to the slide |
|
||||
| `slideIndex` | number | No | The index of the slide to write to \(defaults to first slide\) |
|
||||
|
||||
@@ -80,10 +78,10 @@ Write or update content in a Google Slides presentation
|
||||
| --------- | ---- | ----------- |
|
||||
| `updatedContent` | boolean | Indicates if presentation content was updated successfully |
|
||||
| `metadata` | json | Updated presentation metadata including ID, title, and URL |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `title` | string | The presentation title |
|
||||
| ↳ `mimeType` | string | The mime type of the presentation |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `title` | string | The presentation title |
|
||||
| ↳ `mimeType` | string | The mime type of the presentation |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
|
||||
### `google_slides_create`
|
||||
|
||||
@@ -95,7 +93,7 @@ Create a new Google Slides presentation
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `title` | string | Yes | The title of the presentation to create |
|
||||
| `content` | string | No | The content to add to the first slide |
|
||||
| `folderSelector` | string | No | Select the folder to create the presentation in |
|
||||
| `folderSelector` | string | No | Google Drive folder ID to create the presentation in \(e.g., 1ABCxyz...\) |
|
||||
| `folderId` | string | No | The ID of the folder to create the presentation in \(internal use\) |
|
||||
|
||||
#### Output
|
||||
@@ -103,10 +101,10 @@ Create a new Google Slides presentation
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | json | Created presentation metadata including ID, title, and URL |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `title` | string | The presentation title |
|
||||
| ↳ `mimeType` | string | The mime type of the presentation |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `title` | string | The presentation title |
|
||||
| ↳ `mimeType` | string | The mime type of the presentation |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
|
||||
### `google_slides_replace_all_text`
|
||||
|
||||
@@ -116,7 +114,7 @@ Find and replace all occurrences of text throughout a Google Slides presentation
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `findText` | string | Yes | The text to find \(e.g., \{\{placeholder\}\}\) |
|
||||
| `replaceText` | string | Yes | The text to replace with |
|
||||
| `matchCase` | boolean | No | Whether the search should be case-sensitive \(default: true\) |
|
||||
@@ -128,10 +126,10 @@ Find and replace all occurrences of text throughout a Google Slides presentation
|
||||
| --------- | ---- | ----------- |
|
||||
| `occurrencesChanged` | number | Number of text occurrences that were replaced |
|
||||
| `metadata` | json | Operation metadata including presentation ID and URL |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `findText` | string | The text that was searched for |
|
||||
| ↳ `replaceText` | string | The text that replaced the matches |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `findText` | string | The text that was searched for |
|
||||
| ↳ `replaceText` | string | The text that replaced the matches |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
|
||||
### `google_slides_add_slide`
|
||||
|
||||
@@ -141,7 +139,7 @@ Add a new slide to a Google Slides presentation with a specified layout
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `layout` | string | No | The predefined layout for the slide \(BLANK, TITLE, TITLE_AND_BODY, TITLE_ONLY, SECTION_HEADER, etc.\). Defaults to BLANK. |
|
||||
| `insertionIndex` | number | No | The optional zero-based index indicating where to insert the slide. If not specified, the slide is added at the end. |
|
||||
| `placeholderIdMappings` | string | No | JSON array of placeholder mappings to assign custom object IDs to placeholders. Format: \[\{"layoutPlaceholder":\{"type":"TITLE"\},"objectId":"custom_title_id"\}\] |
|
||||
@@ -152,10 +150,10 @@ Add a new slide to a Google Slides presentation with a specified layout
|
||||
| --------- | ---- | ----------- |
|
||||
| `slideId` | string | The object ID of the newly created slide |
|
||||
| `metadata` | json | Operation metadata including presentation ID, layout, and URL |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `layout` | string | The layout used for the new slide |
|
||||
| ↳ `insertionIndex` | number | The zero-based index where the slide was inserted |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `layout` | string | The layout used for the new slide |
|
||||
| ↳ `insertionIndex` | number | The zero-based index where the slide was inserted |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
|
||||
### `google_slides_add_image`
|
||||
|
||||
@@ -165,7 +163,7 @@ Insert an image into a specific slide in a Google Slides presentation
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `pageObjectId` | string | Yes | The object ID of the slide/page to add the image to |
|
||||
| `imageUrl` | string | Yes | The publicly accessible URL of the image \(must be PNG, JPEG, or GIF, max 50MB\) |
|
||||
| `width` | number | No | Width of the image in points \(default: 300\) |
|
||||
@@ -179,10 +177,10 @@ Insert an image into a specific slide in a Google Slides presentation
|
||||
| --------- | ---- | ----------- |
|
||||
| `imageId` | string | The object ID of the newly created image |
|
||||
| `metadata` | json | Operation metadata including presentation ID and image URL |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `pageObjectId` | string | The page object ID where the image was inserted |
|
||||
| ↳ `imageUrl` | string | The source image URL |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `pageObjectId` | string | The page object ID where the image was inserted |
|
||||
| ↳ `imageUrl` | string | The source image URL |
|
||||
| ↳ `url` | string | URL to open the presentation |
|
||||
|
||||
### `google_slides_get_thumbnail`
|
||||
|
||||
@@ -192,7 +190,7 @@ Generate a thumbnail image of a specific slide in a Google Slides presentation
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `pageObjectId` | string | Yes | The object ID of the slide/page to get a thumbnail for |
|
||||
| `thumbnailSize` | string | No | The size of the thumbnail: SMALL \(200px\), MEDIUM \(800px\), or LARGE \(1600px\). Defaults to MEDIUM. |
|
||||
| `mimeType` | string | No | The MIME type of the thumbnail image: PNG or GIF. Defaults to PNG. |
|
||||
@@ -205,10 +203,10 @@ Generate a thumbnail image of a specific slide in a Google Slides presentation
|
||||
| `width` | number | Width of the thumbnail in pixels |
|
||||
| `height` | number | Height of the thumbnail in pixels |
|
||||
| `metadata` | json | Operation metadata including presentation ID and page object ID |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `pageObjectId` | string | The page object ID for the thumbnail |
|
||||
| ↳ `thumbnailSize` | string | The requested thumbnail size |
|
||||
| ↳ `mimeType` | string | The thumbnail MIME type |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `pageObjectId` | string | The page object ID for the thumbnail |
|
||||
| ↳ `thumbnailSize` | string | The requested thumbnail size |
|
||||
| ↳ `mimeType` | string | The thumbnail MIME type |
|
||||
|
||||
### `google_slides_get_page`
|
||||
|
||||
@@ -218,7 +216,7 @@ Get detailed information about a specific slide/page in a Google Slides presenta
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `pageObjectId` | string | Yes | The object ID of the slide/page to retrieve |
|
||||
|
||||
#### Output
|
||||
@@ -229,12 +227,12 @@ Get detailed information about a specific slide/page in a Google Slides presenta
|
||||
| `pageType` | string | The type of page \(SLIDE, MASTER, LAYOUT, NOTES, NOTES_MASTER\) |
|
||||
| `pageElements` | array | Array of page elements \(shapes, images, tables, etc.\) on this page |
|
||||
| `slideProperties` | object | Properties specific to slides \(layout, master, notes\) |
|
||||
| ↳ `layoutObjectId` | string | Object ID of the layout this slide is based on |
|
||||
| ↳ `masterObjectId` | string | Object ID of the master this slide is based on |
|
||||
| ↳ `notesPage` | json | The notes page associated with the slide |
|
||||
| ↳ `layoutObjectId` | string | Object ID of the layout this slide is based on |
|
||||
| ↳ `masterObjectId` | string | Object ID of the master this slide is based on |
|
||||
| ↳ `notesPage` | json | The notes page associated with the slide |
|
||||
| `metadata` | object | Operation metadata including presentation ID and URL |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
|
||||
### `google_slides_delete_object`
|
||||
|
||||
@@ -244,7 +242,7 @@ Delete a page element (shape, image, table, etc.) or an entire slide from a Goog
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `objectId` | string | Yes | The object ID of the element or slide to delete |
|
||||
|
||||
#### Output
|
||||
@@ -254,8 +252,8 @@ Delete a page element (shape, image, table, etc.) or an entire slide from a Goog
|
||||
| `deleted` | boolean | Whether the object was successfully deleted |
|
||||
| `objectId` | string | The object ID that was deleted |
|
||||
| `metadata` | object | Operation metadata including presentation ID and URL |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
|
||||
### `google_slides_duplicate_object`
|
||||
|
||||
@@ -265,7 +263,7 @@ Duplicate an object (slide, shape, image, table, etc.) in a Google Slides presen
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `objectId` | string | Yes | The object ID of the element or slide to duplicate |
|
||||
| `objectIds` | string | No | Optional JSON object mapping source object IDs \(within the slide being duplicated\) to new object IDs for the duplicates. Format: \{"sourceId1":"newId1","sourceId2":"newId2"\} |
|
||||
| `Format` | string | No | No description |
|
||||
@@ -276,9 +274,9 @@ Duplicate an object (slide, shape, image, table, etc.) in a Google Slides presen
|
||||
| --------- | ---- | ----------- |
|
||||
| `duplicatedObjectId` | string | The object ID of the newly created duplicate |
|
||||
| `metadata` | object | Operation metadata including presentation ID and source object ID |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `sourceObjectId` | string | The original object ID that was duplicated |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `sourceObjectId` | string | The original object ID that was duplicated |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
|
||||
### `google_slides_update_slides_position`
|
||||
|
||||
@@ -288,7 +286,7 @@ Move one or more slides to a new position in a Google Slides presentation
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `slideObjectIds` | string | Yes | Comma-separated list of slide object IDs to move. The slides will maintain their relative order. |
|
||||
| `insertionIndex` | number | Yes | The zero-based index where the slides should be moved. All slides with indices greater than or equal to this will be shifted right. |
|
||||
|
||||
@@ -300,8 +298,8 @@ Move one or more slides to a new position in a Google Slides presentation
|
||||
| `slideObjectIds` | array | The slide object IDs that were moved |
|
||||
| `insertionIndex` | number | The index where the slides were moved to |
|
||||
| `metadata` | object | Operation metadata including presentation ID and URL |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
|
||||
### `google_slides_create_table`
|
||||
|
||||
@@ -311,7 +309,7 @@ Create a new table on a slide in a Google Slides presentation
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `pageObjectId` | string | Yes | The object ID of the slide/page to add the table to |
|
||||
| `rows` | number | Yes | Number of rows in the table \(minimum 1\) |
|
||||
| `columns` | number | Yes | Number of columns in the table \(minimum 1\) |
|
||||
@@ -328,9 +326,9 @@ Create a new table on a slide in a Google Slides presentation
|
||||
| `rows` | number | Number of rows in the table |
|
||||
| `columns` | number | Number of columns in the table |
|
||||
| `metadata` | object | Operation metadata including presentation ID and page object ID |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `pageObjectId` | string | The page object ID where the table was created |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `pageObjectId` | string | The page object ID where the table was created |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
|
||||
### `google_slides_create_shape`
|
||||
|
||||
@@ -340,7 +338,7 @@ Create a shape (rectangle, ellipse, text box, arrow, etc.) on a slide in a Googl
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `pageObjectId` | string | Yes | The object ID of the slide/page to add the shape to |
|
||||
| `shapeType` | string | Yes | The type of shape to create. Common types: TEXT_BOX, RECTANGLE, ROUND_RECTANGLE, ELLIPSE, TRIANGLE, DIAMOND, STAR_5, ARROW_EAST, HEART, CLOUD |
|
||||
| `width` | number | No | Width of the shape in points \(default: 200\) |
|
||||
@@ -355,9 +353,9 @@ Create a shape (rectangle, ellipse, text box, arrow, etc.) on a slide in a Googl
|
||||
| `shapeId` | string | The object ID of the newly created shape |
|
||||
| `shapeType` | string | The type of shape that was created |
|
||||
| `metadata` | object | Operation metadata including presentation ID and page object ID |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `pageObjectId` | string | The page object ID where the shape was created |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `pageObjectId` | string | The page object ID where the shape was created |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
|
||||
### `google_slides_insert_text`
|
||||
|
||||
@@ -367,7 +365,7 @@ Insert text into a shape or table cell in a Google Slides presentation. Use this
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `presentationId` | string | Yes | The ID of the presentation |
|
||||
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||
| `objectId` | string | Yes | The object ID of the shape or table cell to insert text into. For table cells, use the cell object ID. |
|
||||
| `text` | string | Yes | The text to insert |
|
||||
| `insertionIndex` | number | No | The zero-based index at which to insert the text. If not specified, text is inserted at the beginning \(index 0\). |
|
||||
@@ -380,7 +378,7 @@ Insert text into a shape or table cell in a Google Slides presentation. Use this
|
||||
| `objectId` | string | The object ID where text was inserted |
|
||||
| `text` | string | The text that was inserted |
|
||||
| `metadata` | object | Operation metadata including presentation ID and URL |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
| ↳ `presentationId` | string | The presentation ID |
|
||||
| ↳ `url` | string | URL to the presentation |
|
||||
|
||||
|
||||
|
||||
@@ -42,14 +42,14 @@ Create an export in a matter
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `matterId` | string | Yes | The matter ID |
|
||||
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) |
|
||||
| `exportName` | string | Yes | Name for the export \(avoid special characters\) |
|
||||
| `corpus` | string | Yes | Data corpus to export \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) |
|
||||
| `accountEmails` | string | No | Comma-separated list of user emails to scope export |
|
||||
| `orgUnitId` | string | No | Organization unit ID to scope export \(alternative to emails\) |
|
||||
| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, e.g., 2024-01-01T00:00:00Z\) |
|
||||
| `endTime` | string | No | End time for date filtering \(ISO 8601 format, e.g., 2024-12-31T23:59:59Z\) |
|
||||
| `terms` | string | No | Search query terms to filter exported content |
|
||||
| `accountEmails` | string | No | Comma-separated list of user emails to scope export \(e.g., "user1@example.com, user2@example.com"\) |
|
||||
| `orgUnitId` | string | No | Organization unit ID to scope export \(e.g., "id:03ph8a2z1enx5q0", alternative to emails\) |
|
||||
| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, e.g., "2024-01-01T00:00:00Z"\) |
|
||||
| `endTime` | string | No | End time for date filtering \(ISO 8601 format, e.g., "2024-12-31T23:59:59Z"\) |
|
||||
| `terms` | string | No | Search query terms to filter exported content \(e.g., "from:sender@example.com subject:invoice"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -65,10 +65,10 @@ List exports for a matter
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `matterId` | string | Yes | The matter ID |
|
||||
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) |
|
||||
| `pageSize` | number | No | Number of exports to return per page |
|
||||
| `pageToken` | string | No | Token for pagination |
|
||||
| `exportId` | string | No | Optional export ID to fetch a specific export |
|
||||
| `exportId` | string | No | Optional export ID to fetch a specific export \(e.g., "exportId123456"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -86,7 +86,7 @@ Download a single file from a Google Vault export (GCS object)
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `matterId` | string | Yes | The matter ID |
|
||||
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) |
|
||||
| `bucketName` | string | Yes | GCS bucket name from cloudStorageSink.files.bucketName |
|
||||
| `objectName` | string | Yes | GCS object name from cloudStorageSink.files.objectName |
|
||||
| `fileName` | string | No | Optional filename override for the downloaded file |
|
||||
@@ -105,14 +105,14 @@ Create a hold in a matter
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `matterId` | string | Yes | The matter ID |
|
||||
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) |
|
||||
| `holdName` | string | Yes | Name for the hold |
|
||||
| `corpus` | string | Yes | Data corpus to hold \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) |
|
||||
| `accountEmails` | string | No | Comma-separated list of user emails to put on hold |
|
||||
| `orgUnitId` | string | No | Organization unit ID to put on hold \(alternative to accounts\) |
|
||||
| `terms` | string | No | Search terms to filter held content \(for MAIL and GROUPS corpus\) |
|
||||
| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, for MAIL and GROUPS corpus\) |
|
||||
| `endTime` | string | No | End time for date filtering \(ISO 8601 format, for MAIL and GROUPS corpus\) |
|
||||
| `accountEmails` | string | No | Comma-separated list of user emails to put on hold \(e.g., "user1@example.com, user2@example.com"\) |
|
||||
| `orgUnitId` | string | No | Organization unit ID to put on hold \(e.g., "id:03ph8a2z1enx5q0", alternative to accounts\) |
|
||||
| `terms` | string | No | Search terms to filter held content \(e.g., "from:sender@example.com subject:invoice", for MAIL and GROUPS corpus\) |
|
||||
| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, e.g., "2024-01-01T00:00:00Z", for MAIL and GROUPS corpus\) |
|
||||
| `endTime` | string | No | End time for date filtering \(ISO 8601 format, e.g., "2024-12-31T23:59:59Z", for MAIL and GROUPS corpus\) |
|
||||
| `includeSharedDrives` | boolean | No | Include files in shared drives \(for DRIVE corpus\) |
|
||||
|
||||
#### Output
|
||||
@@ -129,10 +129,10 @@ List holds for a matter
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `matterId` | string | Yes | The matter ID |
|
||||
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) |
|
||||
| `pageSize` | number | No | Number of holds to return per page |
|
||||
| `pageToken` | string | No | Token for pagination |
|
||||
| `holdId` | string | No | Optional hold ID to fetch a specific hold |
|
||||
| `holdId` | string | No | Optional hold ID to fetch a specific hold \(e.g., "holdId123456"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -169,7 +169,7 @@ List matters, or get a specific matter if matterId is provided
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `pageSize` | number | No | Number of matters to return per page |
|
||||
| `pageToken` | string | No | Token for pagination |
|
||||
| `matterId` | string | No | Optional matter ID to fetch a specific matter |
|
||||
| `matterId` | string | No | Optional matter ID to fetch a specific matter \(e.g., "12345678901234567890"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -48,8 +48,8 @@ Get a dashboard by its UID
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `dashboardUid` | string | Yes | The UID of the dashboard to retrieve |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `dashboardUid` | string | Yes | The UID of the dashboard to retrieve \(e.g., abc123def\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -68,10 +68,10 @@ Search and list all dashboards
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `query` | string | No | Search query to filter dashboards by title |
|
||||
| `tag` | string | No | Filter by tag \(comma-separated for multiple tags\) |
|
||||
| `folderIds` | string | No | Filter by folder IDs \(comma-separated\) |
|
||||
| `folderIds` | string | No | Filter by folder IDs \(comma-separated, e.g., 1,2,3\) |
|
||||
| `starred` | boolean | No | Only return starred dashboards |
|
||||
| `limit` | number | No | Maximum number of dashboards to return |
|
||||
|
||||
@@ -97,9 +97,9 @@ Create a new dashboard
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `title` | string | Yes | The title of the new dashboard |
|
||||
| `folderUid` | string | No | The UID of the folder to create the dashboard in |
|
||||
| `folderUid` | string | No | The UID of the folder to create the dashboard in \(e.g., folder-abc123\) |
|
||||
| `tags` | string | No | Comma-separated list of tags |
|
||||
| `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) |
|
||||
| `refresh` | string | No | Auto-refresh interval \(e.g., 5s, 1m, 5m\) |
|
||||
@@ -128,10 +128,10 @@ Update an existing dashboard. Fetches the current dashboard and merges your chan
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `dashboardUid` | string | Yes | The UID of the dashboard to update |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `dashboardUid` | string | Yes | The UID of the dashboard to update \(e.g., abc123def\) |
|
||||
| `title` | string | No | New title for the dashboard |
|
||||
| `folderUid` | string | No | New folder UID to move the dashboard to |
|
||||
| `folderUid` | string | No | New folder UID to move the dashboard to \(e.g., folder-abc123\) |
|
||||
| `tags` | string | No | Comma-separated list of new tags |
|
||||
| `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) |
|
||||
| `refresh` | string | No | Auto-refresh interval \(e.g., 5s, 1m, 5m\) |
|
||||
@@ -160,8 +160,8 @@ Delete a dashboard by its UID
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `dashboardUid` | string | Yes | The UID of the dashboard to delete |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `dashboardUid` | string | Yes | The UID of the dashboard to delete \(e.g., abc123def\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -181,7 +181,7 @@ List all alert rules in the Grafana instance
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -206,7 +206,7 @@ Get a specific alert rule by its UID
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `alertRuleUid` | string | Yes | The UID of the alert rule to retrieve |
|
||||
|
||||
#### Output
|
||||
@@ -234,9 +234,9 @@ Create a new alert rule
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `title` | string | Yes | The title of the alert rule |
|
||||
| `folderUid` | string | Yes | The UID of the folder to create the alert in |
|
||||
| `folderUid` | string | Yes | The UID of the folder to create the alert in \(e.g., folder-abc123\) |
|
||||
| `ruleGroup` | string | Yes | The name of the rule group |
|
||||
| `condition` | string | Yes | The refId of the query or expression to use as the alert condition |
|
||||
| `data` | string | Yes | JSON array of query/expression data objects |
|
||||
@@ -265,10 +265,10 @@ Update an existing alert rule. Fetches the current rule and merges your changes.
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `alertRuleUid` | string | Yes | The UID of the alert rule to update |
|
||||
| `title` | string | No | New title for the alert rule |
|
||||
| `folderUid` | string | No | New folder UID to move the alert to |
|
||||
| `folderUid` | string | No | New folder UID to move the alert to \(e.g., folder-abc123\) |
|
||||
| `ruleGroup` | string | No | New rule group name |
|
||||
| `condition` | string | No | New condition refId |
|
||||
| `data` | string | No | New JSON array of query/expression data objects |
|
||||
@@ -297,7 +297,7 @@ Delete an alert rule by its UID
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `alertRuleUid` | string | Yes | The UID of the alert rule to delete |
|
||||
|
||||
#### Output
|
||||
@@ -316,7 +316,7 @@ List all alert notification contact points
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -338,13 +338,13 @@ Create an annotation on a dashboard or as a global annotation
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `text` | string | Yes | The text content of the annotation |
|
||||
| `tags` | string | No | Comma-separated list of tags |
|
||||
| `dashboardUid` | string | Yes | UID of the dashboard to add the annotation to |
|
||||
| `panelId` | number | No | ID of the panel to add the annotation to |
|
||||
| `time` | number | No | Start time in epoch milliseconds \(defaults to now\) |
|
||||
| `timeEnd` | number | No | End time in epoch milliseconds \(for range annotations\) |
|
||||
| `dashboardUid` | string | Yes | UID of the dashboard to add the annotation to \(e.g., abc123def\) |
|
||||
| `panelId` | number | No | ID of the panel to add the annotation to \(e.g., 1, 2\) |
|
||||
| `time` | number | No | Start time in epoch milliseconds \(e.g., 1704067200000, defaults to now\) |
|
||||
| `timeEnd` | number | No | End time in epoch milliseconds for range annotations \(e.g., 1704153600000\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -363,11 +363,11 @@ Query annotations by time range, dashboard, or tags
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `from` | number | No | Start time in epoch milliseconds |
|
||||
| `to` | number | No | End time in epoch milliseconds |
|
||||
| `dashboardUid` | string | Yes | Dashboard UID to query annotations from |
|
||||
| `panelId` | number | No | Filter by panel ID |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `from` | number | No | Start time in epoch milliseconds \(e.g., 1704067200000\) |
|
||||
| `to` | number | No | End time in epoch milliseconds \(e.g., 1704153600000\) |
|
||||
| `dashboardUid` | string | Yes | Dashboard UID to query annotations from \(e.g., abc123def\) |
|
||||
| `panelId` | number | No | Filter by panel ID \(e.g., 1, 2\) |
|
||||
| `tags` | string | No | Comma-separated list of tags to filter by |
|
||||
| `type` | string | No | Filter by type \(alert or annotation\) |
|
||||
| `limit` | number | No | Maximum number of annotations to return |
|
||||
@@ -401,12 +401,12 @@ Update an existing annotation
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `annotationId` | number | Yes | The ID of the annotation to update |
|
||||
| `text` | string | Yes | New text content for the annotation |
|
||||
| `tags` | string | No | Comma-separated list of new tags |
|
||||
| `time` | number | No | New start time in epoch milliseconds |
|
||||
| `timeEnd` | number | No | New end time in epoch milliseconds |
|
||||
| `time` | number | No | New start time in epoch milliseconds \(e.g., 1704067200000\) |
|
||||
| `timeEnd` | number | No | New end time in epoch milliseconds \(e.g., 1704153600000\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -425,7 +425,7 @@ Delete an annotation by its ID
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `annotationId` | number | Yes | The ID of the annotation to delete |
|
||||
|
||||
#### Output
|
||||
@@ -444,7 +444,7 @@ List all data sources configured in Grafana
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -468,8 +468,8 @@ Get a data source by its ID or UID
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `dataSourceId` | string | Yes | The ID or UID of the data source to retrieve |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `dataSourceId` | string | Yes | The ID or UID of the data source to retrieve \(e.g., prometheus, P1234AB5678\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -494,7 +494,7 @@ List all folders in Grafana
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `limit` | number | No | Maximum number of folders to return |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
|
||||
@@ -527,7 +527,7 @@ Create a new folder in Grafana
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) |
|
||||
| `title` | string | Yes | The title of the new folder |
|
||||
| `uid` | string | No | Optional UID for the folder \(auto-generated if not provided\) |
|
||||
|
||||
|
||||
@@ -48,13 +48,13 @@ List recordings from Grain with optional filters and pagination
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
| `beforeDatetime` | string | No | Only recordings before this ISO8601 timestamp |
|
||||
| `afterDatetime` | string | No | Only recordings after this ISO8601 timestamp |
|
||||
| `cursor` | string | No | Pagination cursor for next page \(returned from previous response\) |
|
||||
| `beforeDatetime` | string | No | Only recordings before this ISO8601 timestamp \(e.g., "2024-01-15T00:00:00Z"\) |
|
||||
| `afterDatetime` | string | No | Only recordings after this ISO8601 timestamp \(e.g., "2024-01-01T00:00:00Z"\) |
|
||||
| `participantScope` | string | No | Filter: "internal" or "external" |
|
||||
| `titleSearch` | string | No | Search term to filter by recording title |
|
||||
| `teamId` | string | No | Filter by team UUID |
|
||||
| `meetingTypeId` | string | No | Filter by meeting type UUID |
|
||||
| `titleSearch` | string | No | Search term to filter by recording title \(e.g., "weekly standup"\) |
|
||||
| `teamId` | string | No | Filter by team UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||
| `meetingTypeId` | string | No | Filter by meeting type UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||
| `includeHighlights` | boolean | No | Include highlights/clips in response |
|
||||
| `includeParticipants` | boolean | No | Include participant list in response |
|
||||
| `includeAiSummary` | boolean | No | Include AI-generated summary |
|
||||
@@ -87,7 +87,7 @@ Get details of a single recording by ID
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
||||
| `recordingId` | string | Yes | The recording UUID |
|
||||
| `recordingId` | string | Yes | The recording UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||
| `includeHighlights` | boolean | No | Include highlights/clips |
|
||||
| `includeParticipants` | boolean | No | Include participant list |
|
||||
| `includeAiSummary` | boolean | No | Include AI summary |
|
||||
@@ -125,7 +125,7 @@ Get the full transcript of a recording
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
||||
| `recordingId` | string | Yes | The recording UUID |
|
||||
| `recordingId` | string | Yes | The recording UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -184,13 +184,13 @@ Create a webhook to receive recording events
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
||||
| `hookUrl` | string | Yes | Webhook endpoint URL \(must respond 2xx\) |
|
||||
| `hookUrl` | string | Yes | Webhook endpoint URL \(e.g., "https://example.com/webhooks/grain"\) |
|
||||
| `hookType` | string | Yes | Type of webhook: "recording_added" or "upload_status" |
|
||||
| `filterBeforeDatetime` | string | No | Filter: recordings before this date |
|
||||
| `filterAfterDatetime` | string | No | Filter: recordings after this date |
|
||||
| `filterBeforeDatetime` | string | No | Filter: recordings before this ISO8601 date \(e.g., "2024-01-15T00:00:00Z"\) |
|
||||
| `filterAfterDatetime` | string | No | Filter: recordings after this ISO8601 date \(e.g., "2024-01-01T00:00:00Z"\) |
|
||||
| `filterParticipantScope` | string | No | Filter: "internal" or "external" |
|
||||
| `filterTeamId` | string | No | Filter: specific team UUID |
|
||||
| `filterMeetingTypeId` | string | No | Filter: specific meeting type |
|
||||
| `filterTeamId` | string | No | Filter: specific team UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||
| `filterMeetingTypeId` | string | No | Filter: specific meeting type UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||
| `includeHighlights` | boolean | No | Include highlights in webhook payload |
|
||||
| `includeParticipants` | boolean | No | Include participants in webhook payload |
|
||||
| `includeAiSummary` | boolean | No | Include AI summary in webhook payload |
|
||||
@@ -239,7 +239,7 @@ Delete a webhook by ID
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
||||
| `hookId` | string | Yes | The hook UUID to delete |
|
||||
| `hookId` | string | Yes | The hook UUID to delete \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -46,9 +46,9 @@ Query repositories in natural language and get answers with relevant code refere
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Natural language question about the codebase |
|
||||
| `repositories` | string | Yes | Comma-separated list of repositories. Format: "github:branch:owner/repo" or just "owner/repo" \(defaults to github:main\) |
|
||||
| `sessionId` | string | No | Session ID for conversation continuity |
|
||||
| `query` | string | Yes | Natural language question about the codebase. Example: "How does authentication work?" or "Where is the payment processing logic?" |
|
||||
| `repositories` | string | Yes | Comma-separated list of repositories. Format: "github:branch:owner/repo" or just "owner/repo" \(defaults to github:main\). Example: "facebook/react" or "github:main:facebook/react,github:main:facebook/relay" |
|
||||
| `sessionId` | string | No | Session ID for conversation continuity. Use the same sessionId across multiple queries to maintain context. Example: "session-abc123" |
|
||||
| `genius` | boolean | No | Enable genius mode for more thorough analysis \(slower but more accurate\) |
|
||||
| `apiKey` | string | Yes | Greptile API key |
|
||||
| `githubToken` | string | Yes | GitHub Personal Access Token with repo read access |
|
||||
@@ -76,9 +76,9 @@ Search repositories in natural language and get relevant code references without
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Natural language search query to find relevant code |
|
||||
| `repositories` | string | Yes | Comma-separated list of repositories. Format: "github:branch:owner/repo" or just "owner/repo" \(defaults to github:main\) |
|
||||
| `sessionId` | string | No | Session ID for conversation continuity |
|
||||
| `query` | string | Yes | Natural language search query to find relevant code. Example: "authentication middleware" or "database connection handling" |
|
||||
| `repositories` | string | Yes | Comma-separated list of repositories. Format: "github:branch:owner/repo" or just "owner/repo" \(defaults to github:main\). Example: "facebook/react" or "github:main:facebook/react,github:main:facebook/relay" |
|
||||
| `sessionId` | string | No | Session ID for conversation continuity. Use the same sessionId across multiple searches to maintain context. Example: "session-abc123" |
|
||||
| `genius` | boolean | No | Enable genius mode for more thorough search \(slower but more accurate\) |
|
||||
| `apiKey` | string | Yes | Greptile API key |
|
||||
| `githubToken` | string | Yes | GitHub Personal Access Token with repo read access |
|
||||
@@ -106,7 +106,7 @@ Submit a repository to be indexed by Greptile. Indexing must complete before the
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `remote` | string | Yes | Git remote type: github or gitlab |
|
||||
| `repository` | string | Yes | Repository in owner/repo format \(e.g., "facebook/react"\) |
|
||||
| `repository` | string | Yes | Repository in owner/repo format. Example: "facebook/react" or "vercel/next.js" |
|
||||
| `branch` | string | Yes | Branch to index \(e.g., "main" or "master"\) |
|
||||
| `reload` | boolean | No | Force re-indexing even if already indexed |
|
||||
| `notify` | boolean | No | Send email notification when indexing completes |
|
||||
@@ -130,7 +130,7 @@ Check the indexing status of a repository. Use this to verify if a repository is
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `remote` | string | Yes | Git remote type: github or gitlab |
|
||||
| `repository` | string | Yes | Repository in owner/repo format \(e.g., "facebook/react"\) |
|
||||
| `repository` | string | Yes | Repository in owner/repo format. Example: "facebook/react" or "vercel/next.js" |
|
||||
| `branch` | string | Yes | Branch name \(e.g., "main" or "master"\) |
|
||||
| `apiKey` | string | Yes | Greptile API key |
|
||||
| `githubToken` | string | Yes | GitHub Personal Access Token with repo read access |
|
||||
|
||||
@@ -44,13 +44,19 @@ Retrieve all users from HubSpot account
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Number of results to return \(default: 100\) |
|
||||
| `limit` | string | No | Number of results to return \(default: 100, max: 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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 |
|
||||
|
||||
@@ -63,17 +69,41 @@ Retrieve all contacts from HubSpot account with pagination support
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
|
||||
| `after` | string | No | Pagination cursor for next page of results |
|
||||
| `properties` | string | No | Comma-separated list of properties to return \(e.g., "email,firstname,lastname"\) |
|
||||
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for |
|
||||
| `after` | string | No | Pagination cursor for next page of results \(from previous response\) |
|
||||
| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "email,firstname,lastname,phone"\) |
|
||||
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "companies,deals"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
@@ -84,16 +114,36 @@ Retrieve a single contact by ID or email from HubSpot
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `contactId` | string | Yes | The ID or email of the contact to retrieve |
|
||||
| `contactId` | string | Yes | The HubSpot contact ID \(numeric string\) or email address to retrieve |
|
||||
| `idProperty` | string | No | Property to use as unique identifier \(e.g., "email"\). If not specified, uses record ID |
|
||||
| `properties` | string | No | Comma-separated list of properties to return |
|
||||
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for |
|
||||
| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "email,firstname,lastname,phone"\) |
|
||||
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "companies,deals"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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 |
|
||||
|
||||
@@ -105,14 +155,34 @@ Create a new contact in HubSpot. Requires at least one of: email, firstname, or
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `properties` | object | Yes | Contact properties as JSON object. Must include at least one of: email, firstname, or lastname |
|
||||
| `associations` | array | No | Array of associations to create with the contact \(e.g., companies, deals\). Each object should have "to" \(with "id"\) and "types" \(with "associationCategory" and "associationTypeId"\) |
|
||||
| `properties` | object | Yes | Contact properties as JSON object. Must include at least one of: email, firstname, or lastname \(e.g., \{"email": "john@example.com", "firstname": "John", "lastname": "Doe"\}\) |
|
||||
| `associations` | array | No | Array of associations to create with the contact as JSON. Each object should have "to.id" \(company/deal ID\) and "types" array with "associationCategory" and "associationTypeId" |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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 |
|
||||
|
||||
@@ -124,15 +194,35 @@ Update an existing contact in HubSpot by ID or email
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `contactId` | string | Yes | The ID or email of the contact to update |
|
||||
| `contactId` | string | Yes | The HubSpot contact ID \(numeric string\) or email of the contact to update |
|
||||
| `idProperty` | string | No | Property to use as unique identifier \(e.g., "email"\). If not specified, uses record ID |
|
||||
| `properties` | object | Yes | Contact properties to update as JSON object |
|
||||
| `properties` | object | Yes | Contact properties to update as JSON object \(e.g., \{"firstname": "John", "phone": "+1234567890"\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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 |
|
||||
|
||||
@@ -144,21 +234,45 @@ Search for contacts in HubSpot using filters, sorting, and queries
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `filterGroups` | array | No | Array of filter groups. Each group contains filters with propertyName, operator, and value |
|
||||
| `sorts` | array | No | Array of sort objects with propertyName and direction \("ASCENDING" or "DESCENDING"\) |
|
||||
| `query` | string | No | Search query string |
|
||||
| `properties` | array | No | Array of property names to return |
|
||||
| `filterGroups` | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" \(e.g., "EQ", "CONTAINS"\), and "value" |
|
||||
| `sorts` | array | No | Array of sort objects as JSON with "propertyName" and "direction" \("ASCENDING" or "DESCENDING"\) |
|
||||
| `query` | string | No | Search query string to match against contact name, email, and other text fields |
|
||||
| `properties` | array | No | Array of HubSpot property names to return \(e.g., \["email", "firstname", "lastname", "phone"\]\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(max 100\) |
|
||||
| `after` | string | No | Pagination cursor for next page |
|
||||
| `after` | string | No | Pagination cursor for next page \(from previous response\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
@@ -170,17 +284,42 @@ Retrieve all companies from HubSpot account with pagination support
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
|
||||
| `after` | string | No | Pagination cursor for next page of results |
|
||||
| `properties` | string | No | Comma-separated list of properties to return |
|
||||
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for |
|
||||
| `after` | string | No | Pagination cursor for next page of results \(from previous response\) |
|
||||
| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "name,domain,industry"\) |
|
||||
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,deals"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
@@ -191,16 +330,37 @@ Retrieve a single company by ID or domain from HubSpot
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `companyId` | string | Yes | The ID or domain of the company to retrieve |
|
||||
| `companyId` | string | Yes | The HubSpot company ID \(numeric string\) or domain to retrieve |
|
||||
| `idProperty` | string | No | Property to use as unique identifier \(e.g., "domain"\). If not specified, uses record ID |
|
||||
| `properties` | string | No | Comma-separated list of properties to return |
|
||||
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for |
|
||||
| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "name,domain,industry"\) |
|
||||
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,deals"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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 |
|
||||
|
||||
@@ -212,14 +372,35 @@ Create a new company in HubSpot
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `properties` | object | Yes | Company properties as JSON object \(e.g., name, domain, city, industry\) |
|
||||
| `associations` | array | No | Array of associations to create with the company |
|
||||
| `properties` | object | Yes | Company properties as JSON object \(e.g., \{"name": "Acme Inc", "domain": "acme.com", "industry": "Technology"\}\) |
|
||||
| `associations` | array | No | Array of associations to create with the company as JSON \(each with "to.id" and "types" containing "associationCategory" and "associationTypeId"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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 |
|
||||
|
||||
@@ -231,15 +412,36 @@ Update an existing company in HubSpot by ID or domain
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `companyId` | string | Yes | The ID or domain of the company to update |
|
||||
| `companyId` | string | Yes | The HubSpot company ID \(numeric string\) or domain of the company to update |
|
||||
| `idProperty` | string | No | Property to use as unique identifier \(e.g., "domain"\). If not specified, uses record ID |
|
||||
| `properties` | object | Yes | Company properties to update as JSON object |
|
||||
| `properties` | object | Yes | Company properties to update as JSON object \(e.g., \{"name": "New Name", "industry": "Finance"\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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 |
|
||||
|
||||
@@ -251,21 +453,46 @@ Search for companies in HubSpot using filters, sorting, and queries
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `filterGroups` | array | No | Array of filter groups. Each group contains filters with propertyName, operator, and value |
|
||||
| `sorts` | array | No | Array of sort objects with propertyName and direction \("ASCENDING" or "DESCENDING"\) |
|
||||
| `query` | string | No | Search query string |
|
||||
| `properties` | array | No | Array of property names to return |
|
||||
| `filterGroups` | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" \(e.g., "EQ", "CONTAINS"\), and "value" |
|
||||
| `sorts` | array | No | Array of sort objects as JSON with "propertyName" and "direction" \("ASCENDING" or "DESCENDING"\) |
|
||||
| `query` | string | No | Search query string to match against company name, domain, and other text fields |
|
||||
| `properties` | array | No | Array of HubSpot property names to return \(e.g., \["name", "domain", "industry"\]\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(max 100\) |
|
||||
| `after` | string | No | Pagination cursor for next page |
|
||||
| `after` | string | No | Pagination cursor for next page \(from previous response\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
@@ -277,17 +504,33 @@ Retrieve all deals from HubSpot account with pagination support
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
|
||||
| `after` | string | No | Pagination cursor for next page of results |
|
||||
| `properties` | string | No | Comma-separated list of properties to return |
|
||||
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for |
|
||||
| `after` | string | No | Pagination cursor for next page of results \(from previous response\) |
|
||||
| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "dealname,amount,dealstage"\) |
|
||||
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,companies"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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 |
|
||||
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ Generate completions using Hugging Face Inference API
|
||||
| `systemPrompt` | string | No | System prompt to guide the model behavior |
|
||||
| `content` | string | Yes | The user message content to send to the model |
|
||||
| `provider` | string | Yes | The provider to use for the API request \(e.g., novita, cerebras, etc.\) |
|
||||
| `model` | string | Yes | Model to use for chat completions \(e.g., deepseek/deepseek-v3-0324\) |
|
||||
| `model` | string | Yes | Model to use for chat completions \(e.g., "deepseek/deepseek-v3-0324", "meta-llama/Llama-3.3-70B-Instruct"\) |
|
||||
| `maxTokens` | number | No | Maximum number of tokens to generate |
|
||||
| `temperature` | number | No | Sampling temperature \(0-2\). Higher values make output more random |
|
||||
| `apiKey` | string | Yes | Hugging Face API token |
|
||||
@@ -54,14 +54,11 @@ Generate completions using Hugging Face Inference API
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Chat completion results |
|
||||
| ↳ `content` | string | Generated text content |
|
||||
| ↳ `model` | string | Model used for generation |
|
||||
| ↳ `usage` | object | Token usage information |
|
||||
| ↳ `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 |
|
||||
| ↳ `content` | string | Generated text content |
|
||||
| ↳ `model` | string | Model used for generation |
|
||||
| ↳ `usage` | object | Token usage information |
|
||||
| ↳ `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 |
|
||||
|
||||
|
||||
|
||||
@@ -42,7 +42,7 @@ Returns companies matching a set of criteria using Hunter.io AI-powered search.
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | No | Natural language search query for companies |
|
||||
| `domain` | string | No | Company domain names to filter by |
|
||||
| `domain` | string | No | Company domain name to filter by \(e.g., "stripe.com", "company.io"\) |
|
||||
| `headcount` | string | No | Company size filter \(e.g., "1-10", "11-50"\) |
|
||||
| `company_type` | string | No | Type of organization |
|
||||
| `technology` | string | No | Technology used by companies |
|
||||
@@ -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`
|
||||
|
||||
@@ -62,38 +67,58 @@ Returns all the email addresses found using one given domain name, with sources.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Domain name to search for email addresses |
|
||||
| `limit` | number | No | Maximum email addresses to return \(default: 10\) |
|
||||
| `offset` | number | No | Number of email addresses to skip |
|
||||
| `type` | string | No | Filter for personal or generic emails |
|
||||
| `seniority` | string | No | Filter by seniority level: junior, senior, or executive |
|
||||
| `department` | string | No | Filter by specific departments \(e.g., sales, marketing\) |
|
||||
| `domain` | string | Yes | Domain name to search for email addresses \(e.g., "stripe.com", "company.io"\) |
|
||||
| `limit` | number | No | Maximum email addresses to return \(e.g., 10, 25, 50\). Default: 10 |
|
||||
| `offset` | number | No | Number of email addresses to skip for pagination \(e.g., 0, 10, 20\) |
|
||||
| `type` | string | No | Filter for personal or generic emails \(e.g., "personal", "generic", "all"\) |
|
||||
| `seniority` | string | No | Filter by seniority level \(e.g., "junior", "senior", "executive"\) |
|
||||
| `department` | string | No | Filter by specific department \(e.g., "sales", "marketing", "engineering", "hr"\) |
|
||||
| `apiKey` | string | Yes | Hunter.io API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
|
||||
@@ -103,20 +128,27 @@ Finds the most likely email address for a person given their name and company do
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Company domain name |
|
||||
| `first_name` | string | Yes | Person's first name |
|
||||
| `last_name` | string | Yes | Person's last name |
|
||||
| `company` | string | No | Company name |
|
||||
| `domain` | string | Yes | Company domain name \(e.g., "stripe.com", "company.io"\) |
|
||||
| `first_name` | string | Yes | Person\'s first name \(e.g., "John", "Sarah"\) |
|
||||
| `last_name` | string | Yes | Person\'s last name \(e.g., "Smith", "Johnson"\) |
|
||||
| `company` | string | No | Company name \(e.g., "Stripe", "Acme Inc"\) |
|
||||
| `apiKey` | string | Yes | Hunter.io API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
|
||||
@@ -156,15 +193,22 @@ Enriches company data using domain name.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Domain to find company data for |
|
||||
| `domain` | string | Yes | Domain to find company data for \(e.g., "stripe.com", "company.io"\) |
|
||||
| `apiKey` | string | Yes | Hunter.io API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
|
||||
@@ -174,19 +218,36 @@ Returns the total number of email addresses found for a domain or company.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | No | Domain to count emails for \(required if company not provided\) |
|
||||
| `company` | string | No | Company name to count emails for \(required if domain not provided\) |
|
||||
| `type` | string | No | Filter for personal or generic emails only |
|
||||
| `domain` | string | No | Domain to count emails for \(e.g., "stripe.com"\). Required if company not provided |
|
||||
| `company` | string | No | Company name to count emails for \(e.g., "Stripe", "Acme Inc"\). Required if domain not provided |
|
||||
| `type` | string | No | Filter for personal or generic emails only \(e.g., "personal", "generic", "all"\) |
|
||||
| `apiKey` | string | Yes | Hunter.io API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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@\) |
|
||||
|
||||
|
||||
|
||||
@@ -58,10 +58,9 @@ Generate images using OpenAI
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Generated image data |
|
||||
| ↳ `content` | string | Image URL or identifier |
|
||||
| ↳ `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 |
|
||||
| ↳ `content` | string | Image URL or identifier |
|
||||
| ↳ `image` | string | Base64 encoded image data |
|
||||
| ↳ `metadata` | object | Image generation metadata |
|
||||
| ↳ `model` | string | Model used for image generation |
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -61,59 +61,50 @@ Create a new contact in Intercom with email, external_id, or role. Returns API-a
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contact` | object | Created contact object |
|
||||
| ↳ `id` | string | Unique identifier for the contact |
|
||||
| ↳ `type` | string | List type |
|
||||
| ↳ `role` | string | Role of the contact \(user or lead\) |
|
||||
| ↳ `email` | string | Email address 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 |
|
||||
| ↳ `created_at` | number | Unix timestamp when contact was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when contact was last updated |
|
||||
| ↳ `signed_up_at` | number | Unix timestamp when user signed up |
|
||||
| ↳ `last_seen_at` | number | Unix timestamp when user was last seen |
|
||||
| ↳ `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 |
|
||||
| ↳ `type` | string | List type |
|
||||
| ↳ `url` | string | URL to fetch tags |
|
||||
| ↳ `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 |
|
||||
| ↳ `data` | array | Array of note objects |
|
||||
| ↳ `has_more` | boolean | Whether there are more notes |
|
||||
| ↳ `total_count` | number | Total number of notes |
|
||||
| ↳ `companies` | object | Companies associated with the contact |
|
||||
| ↳ `type` | string | List type |
|
||||
| ↳ `url` | string | URL to fetch companies |
|
||||
| ↳ `data` | array | Array of company objects |
|
||||
| ↳ `has_more` | boolean | Whether there are more companies |
|
||||
| ↳ `total_count` | number | Total number of companies |
|
||||
| ↳ `location` | object | Location information for the contact |
|
||||
| ↳ `type` | string | Location type |
|
||||
| ↳ `city` | string | City |
|
||||
| ↳ `region` | string | Region/State |
|
||||
| ↳ `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 |
|
||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
||||
| ↳ `id` | string | Unique identifier for the contact |
|
||||
| ↳ `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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `created_at` | number | Unix timestamp when contact was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when contact was last updated |
|
||||
| ↳ `signed_up_at` | number | Unix timestamp when user signed up |
|
||||
| ↳ `last_seen_at` | number | Unix timestamp when user was last seen |
|
||||
| ↳ `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 |
|
||||
| ↳ `type` | string | List type |
|
||||
| ↳ `url` | string | URL to fetch tags |
|
||||
| ↳ `data` | array | Array of tag objects |
|
||||
| ↳ `has_more` | boolean | Whether there are more tags |
|
||||
| ↳ `total_count` | number | Total number of tags |
|
||||
| ↳ `notes` | object | Notes associated with the contact |
|
||||
| ↳ `type` | string | List type |
|
||||
| ↳ `url` | string | URL to fetch notes |
|
||||
| ↳ `data` | array | Array of note objects |
|
||||
| ↳ `has_more` | boolean | Whether there are more notes |
|
||||
| ↳ `total_count` | number | Total number of notes |
|
||||
| ↳ `companies` | object | Companies associated with the contact |
|
||||
| ↳ `type` | string | List type |
|
||||
| ↳ `url` | string | URL to fetch companies |
|
||||
| ↳ `data` | array | Array of company objects |
|
||||
| ↳ `has_more` | boolean | Whether there are more companies |
|
||||
| ↳ `total_count` | number | Total number of companies |
|
||||
| ↳ `location` | object | Location information for the contact |
|
||||
| ↳ `type` | string | Location type |
|
||||
| ↳ `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 |
|
||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
||||
| `contactId` | string | ID of the created contact |
|
||||
|
||||
### `intercom_get_contact`
|
||||
@@ -131,25 +122,65 @@ Get a single contact by ID from Intercom. Returns API-aligned fields only.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contact` | object | Contact object |
|
||||
| ↳ `id` | string | Unique identifier for the contact |
|
||||
| ↳ `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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
||||
| ↳ `id` | string | Unique identifier for the contact |
|
||||
| ↳ `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 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 |
|
||||
| ↳ `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`
|
||||
|
||||
@@ -178,25 +209,25 @@ Update an existing contact in Intercom. Returns API-aligned fields only.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contact` | object | Updated contact object |
|
||||
| ↳ `id` | string | Unique identifier for the contact |
|
||||
| ↳ `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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
||||
| ↳ `id` | string | Unique identifier for the contact |
|
||||
| ↳ `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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `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 |
|
||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
||||
| `contactId` | string | ID of the updated contact |
|
||||
|
||||
### `intercom_list_contacts`
|
||||
@@ -229,10 +260,10 @@ List all contacts from Intercom with pagination support
|
||||
| ↳ `tags` | object | Tags associated with the contact |
|
||||
| ↳ `companies` | object | Companies associated with the contact |
|
||||
| `pages` | object | Pagination information |
|
||||
| ↳ `type` | string | Pages type identifier |
|
||||
| ↳ `page` | number | Current page number |
|
||||
| ↳ `per_page` | number | Number of results per page |
|
||||
| ↳ `total_pages` | number | Total number of pages |
|
||||
| ↳ `type` | string | Pages type identifier |
|
||||
| ↳ `page` | number | Current page number |
|
||||
| ↳ `per_page` | number | Number of results per page |
|
||||
| ↳ `total_pages` | number | Total number of pages |
|
||||
| `total_count` | number | Total number of contacts |
|
||||
|
||||
### `intercom_search_contacts`
|
||||
@@ -276,10 +307,10 @@ Search for contacts in Intercom using a query
|
||||
| ↳ `social_profiles` | object | Social profiles of the contact |
|
||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
||||
| `pages` | object | Pagination information |
|
||||
| ↳ `type` | string | Pages type identifier |
|
||||
| ↳ `page` | number | Current page number |
|
||||
| ↳ `per_page` | number | Number of results per page |
|
||||
| ↳ `total_pages` | number | Total number of pages |
|
||||
| ↳ `type` | string | Pages type identifier |
|
||||
| ↳ `page` | number | Current page number |
|
||||
| ↳ `per_page` | number | Number of results per page |
|
||||
| ↳ `total_pages` | number | Total number of pages |
|
||||
| `total_count` | number | Total number of matching contacts |
|
||||
|
||||
### `intercom_delete_contact`
|
||||
@@ -322,24 +353,28 @@ Create or update a company in Intercom
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `company` | object | Created or updated company object |
|
||||
| ↳ `id` | string | Unique identifier for the company |
|
||||
| ↳ `type` | string | Segment list type |
|
||||
| ↳ `app_id` | string | Intercom app ID |
|
||||
| ↳ `company_id` | string | Your unique identifier for the company |
|
||||
| ↳ `name` | string | Name of the company |
|
||||
| ↳ `website` | string | Company website URL |
|
||||
| ↳ `plan` | object | Company plan information |
|
||||
| ↳ `size` | number | Number of employees |
|
||||
| ↳ `industry` | string | Industry the company operates in |
|
||||
| ↳ `monthly_spend` | number | Monthly revenue from this company |
|
||||
| ↳ `session_count` | number | Number of sessions |
|
||||
| ↳ `user_count` | number | Number of users in the company |
|
||||
| ↳ `created_at` | number | Unix timestamp when company was created |
|
||||
| ↳ `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` | array | Array of tag objects |
|
||||
| ↳ `segments` | array | Array of segment objects |
|
||||
| ↳ `id` | string | Unique identifier for the company |
|
||||
| ↳ `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 |
|
||||
| ↳ `website` | string | Company website URL |
|
||||
| ↳ `plan` | object | Company plan information |
|
||||
| ↳ `size` | number | Number of employees |
|
||||
| ↳ `industry` | string | Industry the company operates in |
|
||||
| ↳ `monthly_spend` | number | Monthly revenue from this company |
|
||||
| ↳ `session_count` | number | Number of sessions |
|
||||
| ↳ `user_count` | number | Number of users in the company |
|
||||
| ↳ `created_at` | number | Unix timestamp when company was created |
|
||||
| ↳ `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 |
|
||||
|
||||
### `intercom_get_company`
|
||||
@@ -357,23 +392,23 @@ Retrieve a single company by ID from Intercom
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `company` | object | Company object |
|
||||
| ↳ `id` | string | Unique identifier for the company |
|
||||
| ↳ `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 |
|
||||
| ↳ `website` | string | Company website URL |
|
||||
| ↳ `plan` | object | Company plan information |
|
||||
| ↳ `size` | number | Number of employees |
|
||||
| ↳ `industry` | string | Industry the company operates in |
|
||||
| ↳ `monthly_spend` | number | Monthly revenue from this company |
|
||||
| ↳ `session_count` | number | Number of sessions |
|
||||
| ↳ `user_count` | number | Number of users in the company |
|
||||
| ↳ `created_at` | number | Unix timestamp when company was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when company was last updated |
|
||||
| ↳ `custom_attributes` | object | Custom attributes set on the company |
|
||||
| ↳ `tags` | object | Tags associated with the company |
|
||||
| ↳ `segments` | object | Segments the company belongs to |
|
||||
| ↳ `id` | string | Unique identifier for the company |
|
||||
| ↳ `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 |
|
||||
| ↳ `website` | string | Company website URL |
|
||||
| ↳ `plan` | object | Company plan information |
|
||||
| ↳ `size` | number | Number of employees |
|
||||
| ↳ `industry` | string | Industry the company operates in |
|
||||
| ↳ `monthly_spend` | number | Monthly revenue from this company |
|
||||
| ↳ `session_count` | number | Number of sessions |
|
||||
| ↳ `user_count` | number | Number of users in the company |
|
||||
| ↳ `created_at` | number | Unix timestamp when company was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when company was last updated |
|
||||
| ↳ `custom_attributes` | object | Custom attributes set on the company |
|
||||
| ↳ `tags` | object | Tags associated with the company |
|
||||
| ↳ `segments` | object | Segments the company belongs to |
|
||||
|
||||
### `intercom_list_companies`
|
||||
|
||||
@@ -408,10 +443,10 @@ List all companies from Intercom with pagination support. Note: This endpoint ha
|
||||
| ↳ `tags` | object | Tags associated with the company |
|
||||
| ↳ `segments` | object | Segments the company belongs to |
|
||||
| `pages` | object | Pagination information |
|
||||
| ↳ `type` | string | Pages type identifier |
|
||||
| ↳ `page` | number | Current page number |
|
||||
| ↳ `per_page` | number | Number of results per page |
|
||||
| ↳ `total_pages` | number | Total number of pages |
|
||||
| ↳ `type` | string | Pages type identifier |
|
||||
| ↳ `page` | number | Current page number |
|
||||
| ↳ `per_page` | number | Number of results per page |
|
||||
| ↳ `total_pages` | number | Total number of pages |
|
||||
| `total_count` | number | Total number of companies |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -432,25 +467,25 @@ Retrieve a single conversation by ID from Intercom
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `conversation` | object | Conversation object |
|
||||
| ↳ `id` | string | Unique identifier for the conversation |
|
||||
| ↳ `type` | string | Object type \(conversation\) |
|
||||
| ↳ `title` | string | Title of the conversation |
|
||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||
| ↳ `waiting_since` | number | Unix timestamp when waiting for reply |
|
||||
| ↳ `snoozed_until` | number | Unix timestamp when snooze ends |
|
||||
| ↳ `open` | boolean | Whether the conversation is open |
|
||||
| ↳ `state` | string | State of the conversation |
|
||||
| ↳ `read` | boolean | Whether the conversation has been read |
|
||||
| ↳ `priority` | string | Priority of the conversation |
|
||||
| ↳ `admin_assignee_id` | number | ID of assigned admin |
|
||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||
| ↳ `tags` | object | Tags on the conversation |
|
||||
| ↳ `source` | object | Source of the conversation |
|
||||
| ↳ `contacts` | object | Contacts in the conversation |
|
||||
| ↳ `teammates` | object | Teammates in the conversation |
|
||||
| ↳ `conversation_parts` | object | Parts of the conversation |
|
||||
| ↳ `statistics` | object | Conversation statistics |
|
||||
| ↳ `id` | string | Unique identifier for the conversation |
|
||||
| ↳ `type` | string | Object type \(conversation\) |
|
||||
| ↳ `title` | string | Title of the conversation |
|
||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||
| ↳ `waiting_since` | number | Unix timestamp when waiting for reply |
|
||||
| ↳ `snoozed_until` | number | Unix timestamp when snooze ends |
|
||||
| ↳ `open` | boolean | Whether the conversation is open |
|
||||
| ↳ `state` | string | State of the conversation |
|
||||
| ↳ `read` | boolean | Whether the conversation has been read |
|
||||
| ↳ `priority` | string | Priority of the conversation |
|
||||
| ↳ `admin_assignee_id` | number | ID of assigned admin |
|
||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||
| ↳ `tags` | object | Tags on the conversation |
|
||||
| ↳ `source` | object | Source of the conversation |
|
||||
| ↳ `contacts` | object | Contacts in the conversation |
|
||||
| ↳ `teammates` | object | Teammates in the conversation |
|
||||
| ↳ `conversation_parts` | object | Parts of the conversation |
|
||||
| ↳ `statistics` | object | Conversation statistics |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
### `intercom_list_conversations`
|
||||
@@ -487,10 +522,10 @@ List all conversations from Intercom with pagination support
|
||||
| ↳ `source` | object | Source of the conversation |
|
||||
| ↳ `contacts` | object | Contacts in the conversation |
|
||||
| `pages` | object | Pagination information |
|
||||
| ↳ `type` | string | Pages type identifier |
|
||||
| ↳ `page` | number | Current page number |
|
||||
| ↳ `per_page` | number | Number of results per page |
|
||||
| ↳ `total_pages` | number | Total number of pages |
|
||||
| ↳ `type` | string | Pages type identifier |
|
||||
| ↳ `page` | number | Current page number |
|
||||
| ↳ `per_page` | number | Number of results per page |
|
||||
| ↳ `total_pages` | number | Total number of pages |
|
||||
| `total_count` | number | Total number of conversations |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -514,22 +549,22 @@ Reply to a conversation as an admin in Intercom
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `conversation` | object | Updated conversation object |
|
||||
| ↳ `id` | string | Unique identifier for the conversation |
|
||||
| ↳ `type` | string | Object type \(conversation\) |
|
||||
| ↳ `title` | string | Title of the conversation |
|
||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||
| ↳ `waiting_since` | number | Unix timestamp when waiting for reply |
|
||||
| ↳ `open` | boolean | Whether the conversation is open |
|
||||
| ↳ `state` | string | State of the conversation |
|
||||
| ↳ `read` | boolean | Whether the conversation has been read |
|
||||
| ↳ `priority` | string | Priority of the conversation |
|
||||
| ↳ `admin_assignee_id` | number | ID of assigned admin |
|
||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||
| ↳ `tags` | object | Tags on the conversation |
|
||||
| ↳ `source` | object | Source of the conversation |
|
||||
| ↳ `contacts` | object | Contacts in the conversation |
|
||||
| ↳ `conversation_parts` | object | Parts of the conversation |
|
||||
| ↳ `id` | string | Unique identifier for the conversation |
|
||||
| ↳ `type` | string | Object type \(conversation\) |
|
||||
| ↳ `title` | string | Title of the conversation |
|
||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||
| ↳ `waiting_since` | number | Unix timestamp when waiting for reply |
|
||||
| ↳ `open` | boolean | Whether the conversation is open |
|
||||
| ↳ `state` | string | State of the conversation |
|
||||
| ↳ `read` | boolean | Whether the conversation has been read |
|
||||
| ↳ `priority` | string | Priority of the conversation |
|
||||
| ↳ `admin_assignee_id` | number | ID of assigned admin |
|
||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||
| ↳ `tags` | object | Tags on the conversation |
|
||||
| ↳ `source` | object | Source of the conversation |
|
||||
| ↳ `contacts` | object | Contacts in the conversation |
|
||||
| ↳ `conversation_parts` | object | Parts of the conversation |
|
||||
| `conversationId` | string | ID of the conversation |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -568,10 +603,10 @@ Search for conversations in Intercom using a query. Returns API-aligned fields o
|
||||
| ↳ `source` | object | Source of the conversation |
|
||||
| ↳ `contacts` | object | Contacts in the conversation |
|
||||
| `pages` | object | Pagination information |
|
||||
| ↳ `type` | string | Pages type identifier |
|
||||
| ↳ `page` | number | Current page number |
|
||||
| ↳ `per_page` | number | Number of results per page |
|
||||
| ↳ `total_pages` | number | Total number of pages |
|
||||
| ↳ `type` | string | Pages type identifier |
|
||||
| ↳ `page` | number | Current page number |
|
||||
| ↳ `per_page` | number | Number of results per page |
|
||||
| ↳ `total_pages` | number | Total number of pages |
|
||||
| `total_count` | number | Total number of matching conversations |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -596,21 +631,21 @@ Create a new ticket in Intercom. Returns API-aligned fields only.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Created ticket object |
|
||||
| ↳ `id` | string | Unique identifier for the ticket |
|
||||
| ↳ `type` | string | Object type \(ticket\) |
|
||||
| ↳ `ticket_id` | string | Ticket ID |
|
||||
| ↳ `ticket_type` | object | Type of the ticket |
|
||||
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
||||
| ↳ `ticket_state` | string | State of the ticket |
|
||||
| ↳ `ticket_state_internal_label` | string | Internal label for ticket state |
|
||||
| ↳ `ticket_state_external_label` | string | External label for ticket state |
|
||||
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
||||
| ↳ `contacts` | object | Contacts associated with the ticket |
|
||||
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||
| ↳ `is_shared` | boolean | Whether the ticket is shared |
|
||||
| ↳ `open` | boolean | Whether the ticket is open |
|
||||
| ↳ `id` | string | Unique identifier for the ticket |
|
||||
| ↳ `type` | string | Object type \(ticket\) |
|
||||
| ↳ `ticket_id` | string | Ticket ID |
|
||||
| ↳ `ticket_type` | object | Type of the ticket |
|
||||
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
||||
| ↳ `ticket_state` | string | State of the ticket |
|
||||
| ↳ `ticket_state_internal_label` | string | Internal label for ticket state |
|
||||
| ↳ `ticket_state_external_label` | string | External label for ticket state |
|
||||
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
||||
| ↳ `contacts` | object | Contacts associated with the ticket |
|
||||
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||
| ↳ `is_shared` | boolean | Whether the ticket is shared |
|
||||
| ↳ `open` | boolean | Whether the ticket is open |
|
||||
| `ticketId` | string | ID of the created ticket |
|
||||
| `success` | boolean | Operation success status |
|
||||
|
||||
@@ -629,24 +664,60 @@ Retrieve a single ticket by ID from Intercom. Returns API-aligned fields only.
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Ticket object |
|
||||
| ↳ `id` | string | Unique identifier for the ticket |
|
||||
| ↳ `type` | string | Object type \(ticket\) |
|
||||
| ↳ `ticket_id` | string | Ticket ID |
|
||||
| ↳ `ticket_type` | object | Type of the ticket |
|
||||
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
||||
| ↳ `ticket_state` | string | State of the ticket |
|
||||
| ↳ `ticket_state_internal_label` | string | Internal label for ticket state |
|
||||
| ↳ `ticket_state_external_label` | string | External label for ticket state |
|
||||
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
||||
| ↳ `contacts` | object | Contacts associated with the ticket |
|
||||
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||
| ↳ `is_shared` | boolean | Whether the ticket is shared |
|
||||
| ↳ `open` | boolean | Whether the ticket is open |
|
||||
| ↳ `id` | string | Unique identifier for the ticket |
|
||||
| ↳ `type` | string | Object type \(ticket\) |
|
||||
| ↳ `ticket_id` | string | Ticket ID |
|
||||
| ↳ `ticket_type` | object | Type of the ticket |
|
||||
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
||||
| ↳ `ticket_state` | string | State of the ticket |
|
||||
| ↳ `ticket_state_internal_label` | string | Internal label for ticket state |
|
||||
| ↳ `ticket_state_external_label` | string | External label for ticket state |
|
||||
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
||||
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
||||
| ↳ `contacts` | object | Contacts associated with the ticket |
|
||||
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||
| ↳ `is_shared` | boolean | Whether the ticket is shared |
|
||||
| ↳ `open` | boolean | Whether the ticket is open |
|
||||
| `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.
|
||||
@@ -670,14 +741,350 @@ Create and send a new admin-initiated message in Intercom. Returns API-aligned f
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | object | Created message object |
|
||||
| ↳ `id` | string | Unique identifier for the message |
|
||||
| ↳ `type` | string | Object type \(message\) |
|
||||
| ↳ `created_at` | number | Unix timestamp when message was created |
|
||||
| ↳ `body` | string | Body of the message |
|
||||
| ↳ `message_type` | string | Type of the message \(in_app or email\) |
|
||||
| ↳ `conversation_id` | string | ID of the conversation created |
|
||||
| ↳ `owner` | object | Owner of the message |
|
||||
| ↳ `id` | string | Unique identifier for the message |
|
||||
| ↳ `type` | string | Object type \(message\) |
|
||||
| ↳ `created_at` | number | Unix timestamp when message was created |
|
||||
| ↳ `body` | string | Body of the message |
|
||||
| ↳ `message_type` | string | Type of the message \(in_app or email\) |
|
||||
| ↳ `conversation_id` | string | ID of the conversation created |
|
||||
| ↳ `owner` | object | Owner of the message |
|
||||
| `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 |
|
||||
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ Extract and process web content into clean, LLM-friendly text using Jina AI Read
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `url` | string | Yes | The URL to read and convert to markdown |
|
||||
| `url` | string | Yes | The URL to read and convert to markdown \(e.g., "https://example.com/page"\) |
|
||||
| `useReaderLMv2` | boolean | No | Whether to use ReaderLM-v2 for better quality \(3x token cost\) |
|
||||
| `gatherLinks` | boolean | No | Whether to gather all links at the end |
|
||||
| `jsonResponse` | boolean | No | Whether to return response in JSON format |
|
||||
@@ -73,7 +73,7 @@ Search the web and return top 5 results with LLM-friendly content. Each result i
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `q` | string | Yes | Search query string |
|
||||
| `q` | string | Yes | Search query string \(e.g., "machine learning tutorials"\) |
|
||||
| `apiKey` | string | Yes | Your Jina AI API key |
|
||||
| `num` | number | No | Maximum number of results per page \(default: 5\) |
|
||||
| `site` | string | No | Restrict results to specific domain\(s\). Can be comma-separated for multiple sites \(e.g., "jina.ai,github.com"\) |
|
||||
@@ -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 |
|
||||
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ Retrieve detailed information about a specific Jira issue
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `projectId` | string | No | Jira project ID \(optional; not required to retrieve a single issue\). |
|
||||
| `projectId` | string | No | Jira project key \(e.g., PROJ\). Optional when retrieving a single issue. |
|
||||
| `issueKey` | string | Yes | Jira issue key to retrieve \(e.g., PROJ-123\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
@@ -68,8 +68,8 @@ Update a Jira issue
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `projectId` | string | No | Jira project ID to update issues in. If not provided, all issues will be retrieved. |
|
||||
| `issueKey` | string | Yes | Jira issue key to update |
|
||||
| `projectId` | string | No | Jira project key \(e.g., PROJ\). Optional when updating a single issue. |
|
||||
| `issueKey` | string | Yes | Jira issue key to update \(e.g., PROJ-123\) |
|
||||
| `summary` | string | No | New summary for the issue |
|
||||
| `description` | string | No | New description for the issue |
|
||||
| `status` | string | No | New status for the issue |
|
||||
@@ -94,7 +94,7 @@ Write a Jira issue
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `projectId` | string | Yes | Project ID for the issue |
|
||||
| `projectId` | string | Yes | Jira project key \(e.g., PROJ\) |
|
||||
| `summary` | string | Yes | Summary for the issue |
|
||||
| `description` | string | No | Description for the issue |
|
||||
| `priority` | string | No | Priority ID or name for the issue \(e.g., "10000" or "High"\) |
|
||||
@@ -127,8 +127,8 @@ Retrieve multiple Jira issues in bulk
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `projectId` | string | Yes | Jira project ID |
|
||||
| `cloudId` | string | No | Jira cloud ID |
|
||||
| `projectId` | string | Yes | Jira project key \(e.g., PROJ\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -46,8 +46,8 @@ Get all service desks from Jira Service Management
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -68,9 +68,9 @@ Get request types for a service desk in Jira Service Management
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID to get request types for |
|
||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -91,8 +91,8 @@ Create a new service request in Jira Service Management
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID to create the request in |
|
||||
| `requestTypeId` | string | Yes | Request Type ID for the new request |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||
| `requestTypeId` | string | Yes | Request Type ID \(e.g., "10", "15"\) |
|
||||
| `summary` | string | Yes | Summary/title for the service request |
|
||||
| `description` | string | No | Description for the service request |
|
||||
| `raiseOnBehalfOf` | string | No | Account ID of customer to raise request on behalf of |
|
||||
@@ -138,12 +138,12 @@ Get multiple service requests from Jira Service Management
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | No | Filter by service desk ID |
|
||||
| `serviceDeskId` | string | No | Filter by service desk ID \(e.g., "1", "2"\) |
|
||||
| `requestOwnership` | string | No | Filter by ownership: OWNED_REQUESTS, PARTICIPATED_REQUESTS, ORGANIZATION, ALL_REQUESTS |
|
||||
| `requestStatus` | string | No | Filter by status: OPEN, CLOSED, ALL |
|
||||
| `searchTerm` | string | No | Search term to filter requests |
|
||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
||||
| `searchTerm` | string | No | Search term to filter requests \(e.g., "password reset", "laptop"\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -166,7 +166,7 @@ Add a comment (public or internal) to a service request in Jira Service Manageme
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||
| `body` | string | Yes | Comment body text |
|
||||
| `isPublic` | boolean | Yes | Whether the comment is public \(visible to customer\) or internal |
|
||||
| `isPublic` | boolean | Yes | Whether the comment is public \(visible to customer\) or internal \(true/false\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -190,10 +190,10 @@ Get comments for a service request in Jira Service Management
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||
| `isPublic` | boolean | No | Filter to only public comments |
|
||||
| `internal` | boolean | No | Filter to only internal comments |
|
||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
||||
| `isPublic` | boolean | No | Filter to only public comments \(true/false\) |
|
||||
| `internal` | boolean | No | Filter to only internal comments \(true/false\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -215,10 +215,10 @@ Get customers for a service desk in Jira Service Management
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID to get customers for |
|
||||
| `query` | string | No | Search query to filter customers |
|
||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||
| `query` | string | No | Search query to filter customers \(e.g., "john", "acme"\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -239,7 +239,7 @@ Add customers to a service desk in Jira Service Management
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID to add customers to |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||
| `emails` | string | Yes | Comma-separated email addresses to add as customers |
|
||||
|
||||
#### Output
|
||||
@@ -260,9 +260,9 @@ Get organizations for a service desk in Jira Service Management
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID to get organizations for |
|
||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -304,7 +304,7 @@ Add an organization to a service desk in Jira Service Management
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID to add the organization to |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||
| `organizationId` | string | Yes | Organization ID to add to the service desk |
|
||||
|
||||
#### Output
|
||||
@@ -326,10 +326,10 @@ Get queues for a service desk in Jira Service Management
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID to get queues for |
|
||||
| `includeCount` | boolean | No | Include issue count for each queue |
|
||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||
| `includeCount` | boolean | No | Include issue count for each queue \(true/false\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -351,8 +351,8 @@ Get SLA information for a service request in Jira Service Management
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -418,8 +418,8 @@ Get participants for a request in Jira Service Management
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -464,8 +464,8 @@ Get approvals for a request in Jira Service Management
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -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,82 +36,185 @@ 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
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `status` | string | No | Filter by status \(unopened, open, closed, settled\) |
|
||||
| `seriesTicker` | string | No | Filter by series ticker |
|
||||
| `eventTicker` | string | No | Filter by event ticker |
|
||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
| `status` | string | No | Filter by market status: "unopened", "open", "closed", or "settled" |
|
||||
| `seriesTicker` | string | No | Filter by series ticker \(e.g., "KXBTC", "INX", "FED-RATE"\) |
|
||||
| `eventTicker` | string | No | Filter by event ticker \(e.g., "KXBTC-24DEC31", "INX-25JAN03"\) |
|
||||
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticker` | string | Yes | The market ticker \(e.g., "KXBTC-24DEC31"\) |
|
||||
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `status` | string | No | Filter by status \(open, closed, settled\) |
|
||||
| `seriesTicker` | string | No | Filter by series ticker |
|
||||
| `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) |
|
||||
| `limit` | string | No | Number of results \(1-200, default: 200\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
| `status` | string | No | Filter by event status: "open", "closed", or "settled" |
|
||||
| `seriesTicker` | string | No | Filter by series ticker \(e.g., "KXBTC", "INX", "FED-RATE"\) |
|
||||
| `withNestedMarkets` | string | No | Include nested markets in response: "true" or "false" |
|
||||
| `limit` | string | No | Number of results to return \(1-200, default: 200\) |
|
||||
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventTicker` | string | Yes | The event ticker |
|
||||
| `eventTicker` | string | Yes | Event ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03"\) |
|
||||
| `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
@@ -137,22 +241,37 @@ Retrieve your open positions from Kalshi
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
| `ticker` | string | No | Filter by market ticker |
|
||||
| `eventTicker` | string | No | Filter by event ticker \(max 10 comma-separated\) |
|
||||
| `settlementStatus` | string | No | Filter by settlement status \(all, unsettled, settled\). Default: unsettled |
|
||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) |
|
||||
| `eventTicker` | string | No | Filter by event ticker, max 10 comma-separated \(e.g., "KXBTC-24DEC31,INX-25JAN03"\) |
|
||||
| `settlementStatus` | string | No | Filter by settlement status: "all", "unsettled", or "settled" \(default: "unsettled"\) |
|
||||
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
@@ -160,22 +279,40 @@ Retrieve your orders from Kalshi with optional filtering
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
| `ticker` | string | No | Filter by market ticker |
|
||||
| `eventTicker` | string | No | Filter by event ticker \(max 10 comma-separated\) |
|
||||
| `status` | string | No | Filter by status \(resting, canceled, executed\) |
|
||||
| `limit` | string | No | Number of results \(1-200, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) |
|
||||
| `eventTicker` | string | No | Filter by event ticker, max 10 comma-separated \(e.g., "KXBTC-24DEC31,INX-25JAN03"\) |
|
||||
| `status` | string | No | Filter by order status: "resting", "canceled", or "executed" |
|
||||
| `limit` | string | No | Number of results to return \(1-200, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
@@ -183,67 +320,114 @@ Retrieve details of a specific order by ID from Kalshi
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
| `orderId` | string | Yes | The order ID to retrieve |
|
||||
| `orderId` | string | Yes | Order ID to retrieve \(e.g., "abc123-def456-ghi789"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) |
|
||||
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesTicker` | string | Yes | Series ticker |
|
||||
| `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) |
|
||||
| `startTs` | number | Yes | Start timestamp \(Unix seconds\) |
|
||||
| `endTs` | number | Yes | End timestamp \(Unix seconds\) |
|
||||
| `periodInterval` | number | Yes | Period interval: 1 \(1min\), 60 \(1hour\), or 1440 \(1day\) |
|
||||
| `seriesTicker` | string | Yes | Series ticker identifier \(e.g., "KXBTC", "INX", "FED-RATE"\) |
|
||||
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) |
|
||||
| `startTs` | number | Yes | Start timestamp in Unix seconds \(e.g., 1704067200\) |
|
||||
| `endTs` | number | Yes | End timestamp in Unix seconds \(e.g., 1704153600\) |
|
||||
| `periodInterval` | number | Yes | Period interval: 1 \(1 minute\), 60 \(1 hour\), or 1440 \(1 day\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
|
||||
@@ -255,39 +439,63 @@ Retrieve your portfolio
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
| `ticker` | string | No | Filter by market ticker |
|
||||
| `orderId` | string | No | Filter by order ID |
|
||||
| `minTs` | number | No | Minimum timestamp \(Unix milliseconds\) |
|
||||
| `maxTs` | number | No | Maximum timestamp \(Unix milliseconds\) |
|
||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) |
|
||||
| `orderId` | string | No | Filter by order ID \(e.g., "abc123-def456-ghi789"\) |
|
||||
| `minTs` | number | No | Minimum timestamp in Unix milliseconds \(e.g., 1704067200000\) |
|
||||
| `maxTs` | number | No | Maximum timestamp in Unix milliseconds \(e.g., 1704153600000\) |
|
||||
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesTicker` | string | Yes | Series ticker |
|
||||
| `seriesTicker` | string | Yes | Series ticker identifier \(e.g., "KXBTC", "INX", "FED-RATE"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
@@ -310,11 +520,11 @@ Create a new order on a Kalshi prediction market
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
| `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) |
|
||||
| `side` | string | Yes | Side of the order: 'yes' or 'no' |
|
||||
| `action` | string | Yes | Action type: 'buy' or 'sell' |
|
||||
| `count` | string | Yes | Number of contracts \(minimum 1\) |
|
||||
| `type` | string | No | Order type: 'limit' or 'market' \(default: limit\) |
|
||||
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) |
|
||||
| `side` | string | Yes | Side of the order: "yes" or "no" |
|
||||
| `action` | string | Yes | Action type: "buy" or "sell" |
|
||||
| `count` | string | Yes | Number of contracts to trade \(e.g., "10", "100"\) |
|
||||
| `type` | string | No | Order type: "limit" or "market" \(default: "limit"\) |
|
||||
| `yesPrice` | string | No | Yes price in cents \(1-99\) |
|
||||
| `noPrice` | string | No | No price in cents \(1-99\) |
|
||||
| `yesPriceDollars` | string | No | Yes price in dollars \(e.g., "0.56"\) |
|
||||
@@ -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
|
||||
|
||||
@@ -344,18 +587,52 @@ Cancel an existing order on Kalshi
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
| `orderId` | string | Yes | The order ID to cancel |
|
||||
| `orderId` | string | Yes | Order ID to cancel \(e.g., "abc123-def456-ghi789"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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
|
||||
|
||||
@@ -363,13 +640,13 @@ Modify the price or quantity of an existing order on Kalshi
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
| `orderId` | string | Yes | The order ID to amend |
|
||||
| `ticker` | string | Yes | Market ticker |
|
||||
| `side` | string | Yes | Side of the order: 'yes' or 'no' |
|
||||
| `action` | string | Yes | Action type: 'buy' or 'sell' |
|
||||
| `clientOrderId` | string | Yes | The original client-specified order ID |
|
||||
| `updatedClientOrderId` | string | Yes | The new client-specified order ID after amendment |
|
||||
| `count` | string | No | Updated quantity for the order |
|
||||
| `orderId` | string | Yes | Order ID to amend \(e.g., "abc123-def456-ghi789"\) |
|
||||
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) |
|
||||
| `side` | string | Yes | Side of the order: "yes" or "no" |
|
||||
| `action` | string | Yes | Action type: "buy" or "sell" |
|
||||
| `clientOrderId` | string | Yes | Original client-specified order ID |
|
||||
| `updatedClientOrderId` | string | Yes | New client-specified order ID after amendment |
|
||||
| `count` | string | No | Updated quantity for the order \(e.g., "10", "100"\) |
|
||||
| `yesPrice` | string | No | Updated yes price in cents \(1-99\) |
|
||||
| `noPrice` | string | No | Updated no price in cents \(1-99\) |
|
||||
| `yesPriceDollars` | string | No | Updated yes price in dollars \(e.g., "0.56"\) |
|
||||
@@ -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 |
|
||||
|
||||
|
||||
|
||||
@@ -85,14 +85,14 @@ Upload a new chunk to a document in a knowledge base
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `data` | object | Information about the uploaded chunk |
|
||||
| ↳ `chunkId` | string | Chunk ID |
|
||||
| ↳ `chunkIndex` | number | Index of the chunk within the document |
|
||||
| ↳ `content` | string | Content of the chunk |
|
||||
| ↳ `contentLength` | number | Length of the content in characters |
|
||||
| ↳ `tokenCount` | number | Number of tokens in the chunk |
|
||||
| ↳ `enabled` | boolean | Whether the chunk is enabled |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| ↳ `chunkId` | string | Chunk ID |
|
||||
| ↳ `chunkIndex` | number | Index of the chunk within the document |
|
||||
| ↳ `content` | string | Content of the chunk |
|
||||
| ↳ `contentLength` | number | Length of the content in characters |
|
||||
| ↳ `tokenCount` | number | Number of tokens in the chunk |
|
||||
| ↳ `enabled` | boolean | Whether the chunk is enabled |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| `message` | string | Success or error message describing the operation result |
|
||||
| `documentId` | string | ID of the document the chunk was added to |
|
||||
| `documentName` | string | Name of the document the chunk was added to |
|
||||
@@ -117,12 +117,12 @@ Create a new document in a knowledge base
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `data` | object | Information about the created document |
|
||||
| ↳ `documentId` | string | Document ID |
|
||||
| ↳ `documentName` | string | Document name |
|
||||
| ↳ `type` | string | Document type |
|
||||
| ↳ `enabled` | boolean | Whether the document is enabled |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| ↳ `documentId` | string | Document ID |
|
||||
| ↳ `documentName` | string | Document name |
|
||||
| ↳ `type` | string | Document type |
|
||||
| ↳ `enabled` | boolean | Whether the document is enabled |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| `message` | string | Success or error message describing the operation result |
|
||||
| `documentId` | string | ID of the created document |
|
||||
|
||||
|
||||
@@ -46,11 +46,11 @@ Retrieves campaign activities and steps performed, including email opens, clicks
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Lemlist API key |
|
||||
| `type` | string | No | Filter by activity type \(e.g., emailOpened, emailClicked, emailReplied, paused\) |
|
||||
| `campaignId` | string | No | Filter by campaign ID |
|
||||
| `leadId` | string | No | Filter by lead ID |
|
||||
| `campaignId` | string | No | Filter by campaign ID \(e.g., "cam_abc123def456"\) |
|
||||
| `leadId` | string | No | Filter by lead ID \(e.g., "lea_abc123def456"\) |
|
||||
| `isFirst` | boolean | No | Filter for first activity only |
|
||||
| `limit` | number | No | Number of results per request \(max 100, default 100\) |
|
||||
| `offset` | number | No | Number of records to skip for pagination |
|
||||
| `limit` | number | No | Number of results per request \(e.g., 50\). Max 100, default 100 |
|
||||
| `offset` | number | No | Number of records to skip for pagination \(e.g., 0, 100, 200\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -75,7 +75,7 @@ Retrieves lead information by email address or lead ID.
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Lemlist API key |
|
||||
| `leadIdentifier` | string | Yes | Lead email address or lead ID |
|
||||
| `leadIdentifier` | string | Yes | Lead email address \(e.g., "john@example.com"\) or lead ID \(e.g., "lea_abc123def456"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -102,11 +102,11 @@ Sends an email to a contact through the Lemlist inbox.
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Lemlist API key |
|
||||
| `sendUserId` | string | Yes | Identifier for the user sending the message |
|
||||
| `sendUserEmail` | string | Yes | Email address of the sender |
|
||||
| `sendUserMailboxId` | string | Yes | Mailbox identifier for the sender |
|
||||
| `contactId` | string | Yes | Recipient contact identifier |
|
||||
| `leadId` | string | Yes | Associated lead identifier |
|
||||
| `sendUserId` | string | Yes | Identifier for the user sending the message \(e.g., "usr_abc123def456"\) |
|
||||
| `sendUserEmail` | string | Yes | Email address of the sender \(e.g., "sales@company.com"\) |
|
||||
| `sendUserMailboxId` | string | Yes | Mailbox identifier for the sender \(e.g., "mbx_abc123def456"\) |
|
||||
| `contactId` | string | Yes | Recipient contact identifier \(e.g., "con_abc123def456"\) |
|
||||
| `leadId` | string | Yes | Associated lead identifier \(e.g., "lea_abc123def456"\) |
|
||||
| `subject` | string | Yes | Email subject line |
|
||||
| `message` | string | Yes | Email message body in HTML format |
|
||||
| `cc` | json | No | Array of CC email addresses |
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -40,9 +40,9 @@ Search the web for information using Linkup
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `q` | string | Yes | The search query |
|
||||
| `depth` | string | Yes | Search depth \(has to either be "standard" or "deep"\) |
|
||||
| `outputType` | string | Yes | Type of output to return \(has to be "sourcedAnswer" or "searchResults"\) |
|
||||
| `q` | string | Yes | The search query \(e.g., "latest AI research papers 2024"\) |
|
||||
| `depth` | string | Yes | Search depth: "standard" for quick results, "deep" for comprehensive search |
|
||||
| `outputType` | string | Yes | Output format: "sourcedAnswer" for AI-generated answer with citations, "searchResults" for raw results |
|
||||
| `apiKey` | string | Yes | Enter your Linkup API key |
|
||||
| `includeImages` | boolean | No | Whether to include images in search results |
|
||||
| `fromDate` | string | No | Start date for filtering results \(YYYY-MM-DD format\) |
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -45,14 +45,14 @@ Send an email using Mailgun API
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `domain` | string | Yes | Mailgun domain \(e.g., mg.example.com\) |
|
||||
| `from` | string | Yes | Sender email address |
|
||||
| `to` | string | Yes | Recipient email address \(comma-separated for multiple\) |
|
||||
| `subject` | string | Yes | Email subject |
|
||||
| `domain` | string | Yes | Mailgun sending domain \(e.g., mg.example.com\) |
|
||||
| `from` | string | Yes | Sender email address \(e.g., sender@example.com or "Name <sender@example.com>"\) |
|
||||
| `to` | string | Yes | Recipient email address \(e.g., user@example.com\). Use comma-separated values for multiple recipients |
|
||||
| `subject` | string | Yes | Email subject line |
|
||||
| `text` | string | No | Plain text body of the email |
|
||||
| `html` | string | No | HTML body of the email |
|
||||
| `cc` | string | No | CC email address \(comma-separated for multiple\) |
|
||||
| `bcc` | string | No | BCC email address \(comma-separated for multiple\) |
|
||||
| `html` | string | No | HTML body of the email \(e.g., "<h1>Hello</h1><p>Message content</p>"\) |
|
||||
| `cc` | string | No | CC recipient email address \(e.g., cc@example.com\). Use comma-separated values for multiple recipients |
|
||||
| `bcc` | string | No | BCC recipient email address \(e.g., bcc@example.com\). Use comma-separated values for multiple recipients |
|
||||
| `tags` | string | No | Tags for the email \(comma-separated\) |
|
||||
|
||||
#### Output
|
||||
@@ -72,7 +72,7 @@ Retrieve a stored message by its key
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `domain` | string | Yes | Mailgun domain |
|
||||
| `domain` | string | Yes | Mailgun domain for retrieving messages \(e.g., mg.example.com\) |
|
||||
| `messageKey` | string | Yes | Message storage key |
|
||||
|
||||
#### Output
|
||||
@@ -102,7 +102,7 @@ List events (logs) for messages sent through Mailgun
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `domain` | string | Yes | Mailgun domain |
|
||||
| `domain` | string | Yes | Mailgun domain for listing events \(e.g., mg.example.com\) |
|
||||
| `event` | string | No | Filter by event type \(accepted, delivered, failed, opened, clicked, etc.\) |
|
||||
| `limit` | number | No | Maximum number of events to return \(default: 100\) |
|
||||
|
||||
@@ -123,7 +123,7 @@ Create a new mailing list
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `address` | string | Yes | Mailing list address \(e.g., list@example.com\) |
|
||||
| `address` | string | Yes | Mailing list address \(e.g., newsletter@mg.example.com\) |
|
||||
| `name` | string | No | Mailing list name |
|
||||
| `description` | string | No | Mailing list description |
|
||||
| `accessLevel` | string | No | Access level: readonly, members, or everyone |
|
||||
@@ -145,7 +145,7 @@ Get details of a mailing list
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `address` | string | Yes | Mailing list address |
|
||||
| `address` | string | Yes | Mailing list address to retrieve \(e.g., newsletter@mg.example.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -163,8 +163,8 @@ Add a member to a mailing list
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `listAddress` | string | Yes | Mailing list address |
|
||||
| `address` | string | Yes | Member email address |
|
||||
| `listAddress` | string | Yes | Mailing list address \(e.g., list@mg.example.com\) |
|
||||
| `address` | string | Yes | Member email address to add \(e.g., user@example.com\) |
|
||||
| `name` | string | No | Member name |
|
||||
| `vars` | string | No | JSON string of custom variables |
|
||||
| `subscribed` | boolean | No | Whether the member is subscribed |
|
||||
@@ -204,7 +204,7 @@ Get details of a specific domain
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `domain` | string | Yes | Domain name |
|
||||
| `domain` | string | Yes | Domain name to retrieve details for \(e.g., mg.example.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -42,8 +42,8 @@ Add memories to Mem0 for persistent storage and retrieval
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Yes | User ID associated with the memory |
|
||||
| `messages` | json | Yes | Array of message objects with role and content |
|
||||
| `userId` | string | Yes | User ID associated with the memory \(e.g., "user_123", "alice@example.com"\) |
|
||||
| `messages` | json | Yes | Array of message objects with role and content \(e.g., \[\{"role": "user", "content": "Hello"\}\]\) |
|
||||
| `apiKey` | string | Yes | Your Mem0 API key |
|
||||
|
||||
#### Output
|
||||
@@ -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`
|
||||
|
||||
@@ -61,16 +65,28 @@ Search for memories in Mem0 using semantic search
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Yes | User ID to search memories for |
|
||||
| `query` | string | Yes | Search query to find relevant memories |
|
||||
| `limit` | number | No | Maximum number of results to return |
|
||||
| `userId` | string | Yes | User ID to search memories for \(e.g., "user_123", "alice@example.com"\) |
|
||||
| `query` | string | Yes | Search query to find relevant memories \(e.g., "What are my favorite foods?"\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(e.g., 10, 50, 100\) |
|
||||
| `apiKey` | string | Yes | Your Mem0 API key |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
@@ -81,11 +97,11 @@ Retrieve memories from Mem0 by ID or filter criteria
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Yes | User ID to retrieve memories for |
|
||||
| `memoryId` | string | No | Specific memory ID to retrieve |
|
||||
| `startDate` | string | No | Start date for filtering by created_at \(format: YYYY-MM-DD\) |
|
||||
| `endDate` | string | No | End date for filtering by created_at \(format: YYYY-MM-DD\) |
|
||||
| `limit` | number | No | Maximum number of results to return |
|
||||
| `userId` | string | Yes | User ID to retrieve memories for \(e.g., "user_123", "alice@example.com"\) |
|
||||
| `memoryId` | string | No | Specific memory ID to retrieve \(e.g., "mem_abc123"\) |
|
||||
| `startDate` | string | No | Start date for filtering by created_at \(e.g., "2024-01-15"\) |
|
||||
| `endDate` | string | No | End date for filtering by created_at \(e.g., "2024-12-31"\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(e.g., 10, 50, 100\) |
|
||||
| `apiKey` | string | Yes | Your Mem0 API key |
|
||||
|
||||
#### Output
|
||||
@@ -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",
|
||||
|
||||
@@ -44,7 +44,7 @@ Read data from a specific sheet in a Microsoft Excel spreadsheet
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet to read from |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet/workbook to read from \(e.g., "01ABC123DEF456"\) |
|
||||
| `range` | string | No | The range of cells to read from. Accepts "SheetName!A1:B2" for explicit ranges or just "SheetName" to read the used range of that sheet. If omitted, reads the used range of the first sheet. |
|
||||
|
||||
#### Output
|
||||
@@ -55,8 +55,8 @@ Read data from a specific sheet in a Microsoft Excel spreadsheet
|
||||
| `range` | string | The range that was read |
|
||||
| `values` | array | Array of rows containing cell values |
|
||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||
| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
|
||||
### `microsoft_excel_write`
|
||||
|
||||
@@ -66,9 +66,9 @@ Write data to a specific sheet in a Microsoft Excel spreadsheet
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet to write to |
|
||||
| `range` | string | No | The range of cells to write to |
|
||||
| `values` | array | Yes | The data to write to the spreadsheet |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet/workbook to write to \(e.g., "01ABC123DEF456"\) |
|
||||
| `range` | string | No | The range of cells to write to \(e.g., "Sheet1!A1:B2"\) |
|
||||
| `values` | array | Yes | The data to write as a 2D array \(e.g., \[\["Name", "Age"\], \["Alice", 30\]\]\) or array of objects |
|
||||
| `valueInputOption` | string | No | The format of the data to write |
|
||||
| `includeValuesInResponse` | boolean | No | Whether to include the written values in the response |
|
||||
|
||||
@@ -81,7 +81,7 @@ Write data to a specific sheet in a Microsoft Excel spreadsheet
|
||||
| `updatedColumns` | number | Number of columns updated |
|
||||
| `updatedCells` | number | Number of cells updated |
|
||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||
| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID |
|
||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||
|
||||
|
||||
|
||||
@@ -40,8 +40,8 @@ Read tasks from Microsoft Planner - get all user tasks or all tasks from a speci
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `planId` | string | No | The ID of the plan to get tasks from \(if not provided, gets all user tasks\) |
|
||||
| `taskId` | string | No | The ID of the task to get |
|
||||
| `planId` | string | No | The ID of the plan to get tasks from, if not provided gets all user tasks \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) |
|
||||
| `taskId` | string | No | The ID of the task to get \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -50,9 +50,9 @@ Read tasks from Microsoft Planner - get all user tasks or all tasks from a speci
|
||||
| `success` | boolean | Whether tasks were retrieved successfully |
|
||||
| `tasks` | array | Array of task objects with filtered properties |
|
||||
| `metadata` | object | Metadata including planId, userId, and planUrl |
|
||||
| ↳ `planId` | string | Plan ID |
|
||||
| ↳ `userId` | string | User ID |
|
||||
| ↳ `planUrl` | string | Microsoft Graph API URL for the plan |
|
||||
| ↳ `planId` | string | Plan ID |
|
||||
| ↳ `userId` | string | User ID |
|
||||
| ↳ `planUrl` | string | Microsoft Graph API URL for the plan |
|
||||
|
||||
### `microsoft_planner_create_task`
|
||||
|
||||
@@ -62,12 +62,12 @@ Create a new task in Microsoft Planner
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `planId` | string | Yes | The ID of the plan where the task will be created |
|
||||
| `title` | string | Yes | The title of the task |
|
||||
| `planId` | string | Yes | The ID of the plan where the task will be created \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) |
|
||||
| `title` | string | Yes | The title of the task \(e.g., "Review quarterly report"\) |
|
||||
| `description` | string | No | The description of the task |
|
||||
| `dueDateTime` | string | No | The due date and time for the task \(ISO 8601 format\) |
|
||||
| `assigneeUserId` | string | No | The user ID to assign the task to |
|
||||
| `bucketId` | string | No | The bucket ID to place the task in |
|
||||
| `dueDateTime` | string | No | The due date and time for the task in ISO 8601 format \(e.g., "2025-03-15T17:00:00Z"\) |
|
||||
| `assigneeUserId` | string | No | The user ID to assign the task to \(e.g., "e82f74c3-4d8a-4b5c-9f1e-2a6b8c9d0e3f"\) |
|
||||
| `bucketId` | string | No | The bucket ID to place the task in \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -76,9 +76,9 @@ Create a new task in Microsoft Planner
|
||||
| `success` | boolean | Whether the task was created successfully |
|
||||
| `task` | object | The created task object with all properties |
|
||||
| `metadata` | object | Metadata including planId, taskId, and taskUrl |
|
||||
| ↳ `planId` | string | Parent plan ID |
|
||||
| ↳ `taskId` | string | Created task ID |
|
||||
| ↳ `taskUrl` | string | Microsoft Graph API URL for the task |
|
||||
| ↳ `planId` | string | Parent plan ID |
|
||||
| ↳ `taskId` | string | Created task ID |
|
||||
| ↳ `taskUrl` | string | Microsoft Graph API URL for the task |
|
||||
|
||||
### `microsoft_planner_update_task`
|
||||
|
||||
@@ -88,15 +88,15 @@ Update a task in Microsoft Planner
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `taskId` | string | Yes | The ID of the task to update |
|
||||
| `taskId` | string | Yes | The ID of the task to update \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) |
|
||||
| `etag` | string | Yes | The ETag value from the task to update \(If-Match header\) |
|
||||
| `title` | string | No | The new title of the task |
|
||||
| `bucketId` | string | No | The bucket ID to move the task to |
|
||||
| `dueDateTime` | string | No | The due date and time for the task \(ISO 8601 format\) |
|
||||
| `title` | string | No | The new title of the task \(e.g., "Review quarterly report"\) |
|
||||
| `bucketId` | string | No | The bucket ID to move the task to \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) |
|
||||
| `dueDateTime` | string | No | The due date and time for the task in ISO 8601 format \(e.g., "2025-03-15T17:00:00Z"\) |
|
||||
| `startDateTime` | string | No | The start date and time for the task \(ISO 8601 format\) |
|
||||
| `percentComplete` | number | No | The percentage of task completion \(0-100\) |
|
||||
| `priority` | number | No | The priority of the task \(0-10\) |
|
||||
| `assigneeUserId` | string | No | The user ID to assign the task to |
|
||||
| `assigneeUserId` | string | No | The user ID to assign the task to \(e.g., "e82f74c3-4d8a-4b5c-9f1e-2a6b8c9d0e3f"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -108,9 +108,9 @@ Update a task in Microsoft Planner
|
||||
| `taskId` | string | ID of the updated task |
|
||||
| `etag` | string | New ETag after update - use this for subsequent operations |
|
||||
| `metadata` | object | Metadata including taskId, planId, and taskUrl |
|
||||
| ↳ `taskId` | string | Updated task ID |
|
||||
| ↳ `planId` | string | Parent plan ID |
|
||||
| ↳ `taskUrl` | string | Microsoft Graph API URL for the task |
|
||||
| ↳ `taskId` | string | Updated task ID |
|
||||
| ↳ `planId` | string | Parent plan ID |
|
||||
| ↳ `taskUrl` | string | Microsoft Graph API URL for the task |
|
||||
|
||||
### `microsoft_planner_delete_task`
|
||||
|
||||
@@ -120,7 +120,7 @@ Delete a task from Microsoft Planner
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `taskId` | string | Yes | The ID of the task to delete |
|
||||
| `taskId` | string | Yes | The ID of the task to delete \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) |
|
||||
| `etag` | string | Yes | The ETag value from the task to delete \(If-Match header\) |
|
||||
|
||||
#### Output
|
||||
@@ -147,8 +147,8 @@ List all plans shared with the current user
|
||||
| `success` | boolean | Whether plans were retrieved successfully |
|
||||
| `plans` | array | Array of plan objects shared with the current user |
|
||||
| `metadata` | object | Metadata including userId and count |
|
||||
| ↳ `count` | number | Number of plans returned |
|
||||
| ↳ `userId` | string | User ID |
|
||||
| ↳ `count` | number | Number of plans returned |
|
||||
| ↳ `userId` | string | User ID |
|
||||
|
||||
### `microsoft_planner_read_plan`
|
||||
|
||||
@@ -158,7 +158,7 @@ Get details of a specific Microsoft Planner plan
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `planId` | string | Yes | The ID of the plan to retrieve |
|
||||
| `planId` | string | Yes | The ID of the plan to retrieve \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -167,8 +167,8 @@ Get details of a specific Microsoft Planner plan
|
||||
| `success` | boolean | Whether the plan was retrieved successfully |
|
||||
| `plan` | object | The plan object with all properties |
|
||||
| `metadata` | object | Metadata including planId and planUrl |
|
||||
| ↳ `planId` | string | Plan ID |
|
||||
| ↳ `planUrl` | string | Microsoft Graph API URL for the plan |
|
||||
| ↳ `planId` | string | Plan ID |
|
||||
| ↳ `planUrl` | string | Microsoft Graph API URL for the plan |
|
||||
|
||||
### `microsoft_planner_list_buckets`
|
||||
|
||||
@@ -178,7 +178,7 @@ List all buckets in a Microsoft Planner plan
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `planId` | string | Yes | The ID of the plan |
|
||||
| `planId` | string | Yes | The ID of the plan \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -187,8 +187,8 @@ List all buckets in a Microsoft Planner plan
|
||||
| `success` | boolean | Whether buckets were retrieved successfully |
|
||||
| `buckets` | array | Array of bucket objects |
|
||||
| `metadata` | object | Metadata including planId and count |
|
||||
| ↳ `planId` | string | Plan ID |
|
||||
| ↳ `count` | number | Number of buckets returned |
|
||||
| ↳ `planId` | string | Plan ID |
|
||||
| ↳ `count` | number | Number of buckets returned |
|
||||
|
||||
### `microsoft_planner_read_bucket`
|
||||
|
||||
@@ -198,7 +198,7 @@ Get details of a specific bucket
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `bucketId` | string | Yes | The ID of the bucket to retrieve |
|
||||
| `bucketId` | string | Yes | The ID of the bucket to retrieve \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -207,8 +207,8 @@ Get details of a specific bucket
|
||||
| `success` | boolean | Whether the bucket was retrieved successfully |
|
||||
| `bucket` | object | The bucket object with all properties |
|
||||
| `metadata` | object | Metadata including bucketId and planId |
|
||||
| ↳ `bucketId` | string | Bucket ID |
|
||||
| ↳ `planId` | string | Parent plan ID |
|
||||
| ↳ `bucketId` | string | Bucket ID |
|
||||
| ↳ `planId` | string | Parent plan ID |
|
||||
|
||||
### `microsoft_planner_create_bucket`
|
||||
|
||||
@@ -218,7 +218,7 @@ Create a new bucket in a Microsoft Planner plan
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `planId` | string | Yes | The ID of the plan where the bucket will be created |
|
||||
| `planId` | string | Yes | The ID of the plan where the bucket will be created \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) |
|
||||
| `name` | string | Yes | The name of the bucket |
|
||||
|
||||
#### Output
|
||||
@@ -228,8 +228,8 @@ Create a new bucket in a Microsoft Planner plan
|
||||
| `success` | boolean | Whether the bucket was created successfully |
|
||||
| `bucket` | object | The created bucket object with all properties |
|
||||
| `metadata` | object | Metadata including bucketId and planId |
|
||||
| ↳ `bucketId` | string | Created bucket ID |
|
||||
| ↳ `planId` | string | Parent plan ID |
|
||||
| ↳ `bucketId` | string | Created bucket ID |
|
||||
| ↳ `planId` | string | Parent plan ID |
|
||||
|
||||
### `microsoft_planner_update_bucket`
|
||||
|
||||
@@ -239,7 +239,7 @@ Update a bucket in Microsoft Planner
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `bucketId` | string | Yes | The ID of the bucket to update |
|
||||
| `bucketId` | string | Yes | The ID of the bucket to update \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) |
|
||||
| `name` | string | No | The new name of the bucket |
|
||||
| `etag` | string | Yes | The ETag value from the bucket to update \(If-Match header\) |
|
||||
|
||||
@@ -250,8 +250,8 @@ Update a bucket in Microsoft Planner
|
||||
| `success` | boolean | Whether the bucket was updated successfully |
|
||||
| `bucket` | object | The updated bucket object with all properties |
|
||||
| `metadata` | object | Metadata including bucketId and planId |
|
||||
| ↳ `bucketId` | string | Updated bucket ID |
|
||||
| ↳ `planId` | string | Parent plan ID |
|
||||
| ↳ `bucketId` | string | Updated bucket ID |
|
||||
| ↳ `planId` | string | Parent plan ID |
|
||||
|
||||
### `microsoft_planner_delete_bucket`
|
||||
|
||||
@@ -261,7 +261,7 @@ Delete a bucket from Microsoft Planner
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `bucketId` | string | Yes | The ID of the bucket to delete |
|
||||
| `bucketId` | string | Yes | The ID of the bucket to delete \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) |
|
||||
| `etag` | string | Yes | The ETag value from the bucket to delete \(If-Match header\) |
|
||||
|
||||
#### Output
|
||||
@@ -280,7 +280,7 @@ Get detailed information about a task including checklist and references
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `taskId` | string | Yes | The ID of the task |
|
||||
| `taskId` | string | Yes | The ID of the task \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -290,7 +290,7 @@ Get detailed information about a task including checklist and references
|
||||
| `taskDetails` | object | The task details including description, checklist, and references |
|
||||
| `etag` | string | The ETag value for this task details - use this for update operations |
|
||||
| `metadata` | object | Metadata including taskId |
|
||||
| ↳ `taskId` | string | Task ID |
|
||||
| ↳ `taskId` | string | Task ID |
|
||||
|
||||
### `microsoft_planner_update_task_details`
|
||||
|
||||
@@ -300,7 +300,7 @@ Update task details including description, checklist items, and references in Mi
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `taskId` | string | Yes | The ID of the task |
|
||||
| `taskId` | string | Yes | The ID of the task \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) |
|
||||
| `etag` | string | Yes | The ETag value from the task details to update \(If-Match header\) |
|
||||
| `description` | string | No | The description of the task |
|
||||
| `checklist` | object | No | Checklist items as a JSON object |
|
||||
@@ -314,6 +314,6 @@ Update task details including description, checklist items, and references in Mi
|
||||
| `success` | boolean | Whether the task details were updated successfully |
|
||||
| `taskDetails` | object | The updated task details object with all properties |
|
||||
| `metadata` | object | Metadata including taskId |
|
||||
| ↳ `taskId` | string | Task ID |
|
||||
| ↳ `taskId` | string | Task ID |
|
||||
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ Read content from a Microsoft Teams chat
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `chatId` | string | Yes | The ID of the chat to read from |
|
||||
| `chatId` | string | Yes | The ID of the chat to read from \(e.g., "19:abc123def456@thread.v2" - from chat listings\) |
|
||||
| `includeAttachments` | boolean | No | Download and include message attachments \(hosted contents\) into storage |
|
||||
|
||||
#### Output
|
||||
@@ -67,8 +67,8 @@ Write or update content in a Microsoft Teams chat
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `chatId` | string | Yes | The ID of the chat to write to |
|
||||
| `content` | string | Yes | The content to write to the message |
|
||||
| `chatId` | string | Yes | The ID of the chat to write to \(e.g., "19:abc123def456@thread.v2" - from chat listings\) |
|
||||
| `content` | string | Yes | The content to write to the message \(plain text or HTML formatted, supports @mentions\) |
|
||||
| `files` | file[] | No | Files to attach to the message |
|
||||
|
||||
#### Output
|
||||
@@ -90,8 +90,8 @@ Read content from a Microsoft Teams channel
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `teamId` | string | Yes | The ID of the team to read from |
|
||||
| `channelId` | string | Yes | The ID of the channel to read from |
|
||||
| `teamId` | string | Yes | The ID of the team to read from \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) |
|
||||
| `channelId` | string | Yes | The ID of the channel to read from \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) |
|
||||
| `includeAttachments` | boolean | No | Download and include message attachments \(hosted contents\) into storage |
|
||||
|
||||
#### Output
|
||||
@@ -116,9 +116,9 @@ Write or send a message to a Microsoft Teams channel
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `teamId` | string | Yes | The ID of the team to write to |
|
||||
| `channelId` | string | Yes | The ID of the channel to write to |
|
||||
| `content` | string | Yes | The content to write to the channel |
|
||||
| `teamId` | string | Yes | The ID of the team to write to \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) |
|
||||
| `channelId` | string | Yes | The ID of the channel to write to \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) |
|
||||
| `content` | string | Yes | The content to write to the channel \(plain text or HTML formatted, supports @mentions\) |
|
||||
| `files` | file[] | No | Files to attach to the message |
|
||||
|
||||
#### Output
|
||||
@@ -141,9 +141,9 @@ Update an existing message in a Microsoft Teams chat
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `chatId` | string | Yes | The ID of the chat containing the message |
|
||||
| `messageId` | string | Yes | The ID of the message to update |
|
||||
| `content` | string | Yes | The new content for the message |
|
||||
| `chatId` | string | Yes | The ID of the chat containing the message \(e.g., "19:abc123def456@thread.v2" - from chat listings\) |
|
||||
| `messageId` | string | Yes | The ID of the message to update \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||
| `content` | string | Yes | The new content for the message \(plain text or HTML formatted\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -161,10 +161,10 @@ Update an existing message in a Microsoft Teams channel
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `teamId` | string | Yes | The ID of the team |
|
||||
| `channelId` | string | Yes | The ID of the channel containing the message |
|
||||
| `messageId` | string | Yes | The ID of the message to update |
|
||||
| `content` | string | Yes | The new content for the message |
|
||||
| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings or channel info\) |
|
||||
| `channelId` | string | Yes | The ID of the channel containing the message \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) |
|
||||
| `messageId` | string | Yes | The ID of the message to update \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||
| `content` | string | Yes | The new content for the message \(plain text or HTML formatted\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -182,8 +182,8 @@ Soft delete a message in a Microsoft Teams chat
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `chatId` | string | Yes | The ID of the chat containing the message |
|
||||
| `messageId` | string | Yes | The ID of the message to delete |
|
||||
| `chatId` | string | Yes | The ID of the chat containing the message \(e.g., "19:abc123def456@thread.v2" - from chat listings\) |
|
||||
| `messageId` | string | Yes | The ID of the message to delete \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -201,9 +201,9 @@ Soft delete a message in a Microsoft Teams channel
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `teamId` | string | Yes | The ID of the team |
|
||||
| `channelId` | string | Yes | The ID of the channel containing the message |
|
||||
| `messageId` | string | Yes | The ID of the message to delete |
|
||||
| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings or channel info\) |
|
||||
| `channelId` | string | Yes | The ID of the channel containing the message \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) |
|
||||
| `messageId` | string | Yes | The ID of the message to delete \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -221,10 +221,10 @@ Reply to an existing message in a Microsoft Teams channel
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `teamId` | string | Yes | The ID of the team |
|
||||
| `channelId` | string | Yes | The ID of the channel |
|
||||
| `messageId` | string | Yes | The ID of the message to reply to |
|
||||
| `content` | string | Yes | The reply content |
|
||||
| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings or channel info\) |
|
||||
| `channelId` | string | Yes | The ID of the channel \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) |
|
||||
| `messageId` | string | Yes | The ID of the message to reply to \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||
| `content` | string | Yes | The reply content \(plain text or HTML formatted message\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -242,10 +242,10 @@ Get a specific message from a Microsoft Teams chat or channel
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `teamId` | string | No | The ID of the team \(for channel messages\) |
|
||||
| `channelId` | string | No | The ID of the channel \(for channel messages\) |
|
||||
| `chatId` | string | No | The ID of the chat \(for chat messages\) |
|
||||
| `messageId` | string | Yes | The ID of the message to retrieve |
|
||||
| `teamId` | string | No | The ID of the team for channel messages \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID\) |
|
||||
| `channelId` | string | No | The ID of the channel for channel messages \(e.g., "19:abc123def456@thread.tacv2"\) |
|
||||
| `chatId` | string | No | The ID of the chat for chat messages \(e.g., "19:abc123def456@thread.v2"\) |
|
||||
| `messageId` | string | Yes | The ID of the message to retrieve \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -254,15 +254,15 @@ Get a specific message from a Microsoft Teams chat or channel
|
||||
| `success` | boolean | Whether the retrieval was successful |
|
||||
| `content` | string | The message content |
|
||||
| `metadata` | object | Message metadata including sender, timestamp, etc. |
|
||||
| ↳ `messageId` | string | Message ID |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `createdTime` | string | Message creation timestamp |
|
||||
| ↳ `url` | string | Web URL to the message |
|
||||
| ↳ `teamId` | string | Team ID |
|
||||
| ↳ `channelId` | string | Channel ID |
|
||||
| ↳ `chatId` | string | Chat ID |
|
||||
| ↳ `messages` | array | Array of message details |
|
||||
| ↳ `messageCount` | number | Number of messages |
|
||||
| ↳ `messageId` | string | Message ID |
|
||||
| ↳ `content` | string | Message content |
|
||||
| ↳ `createdTime` | string | Message creation timestamp |
|
||||
| ↳ `url` | string | Web URL to the message |
|
||||
| ↳ `teamId` | string | Team ID |
|
||||
| ↳ `channelId` | string | Channel ID |
|
||||
| ↳ `chatId` | string | Chat ID |
|
||||
| ↳ `messages` | array | Array of message details |
|
||||
| ↳ `messageCount` | number | Number of messages |
|
||||
|
||||
### `microsoft_teams_set_reaction`
|
||||
|
||||
@@ -272,10 +272,10 @@ Add an emoji reaction to a message in Microsoft Teams
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `teamId` | string | No | The ID of the team \(for channel messages\) |
|
||||
| `channelId` | string | No | The ID of the channel \(for channel messages\) |
|
||||
| `chatId` | string | No | The ID of the chat \(for chat messages\) |
|
||||
| `messageId` | string | Yes | The ID of the message to react to |
|
||||
| `teamId` | string | No | The ID of the team for channel messages \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID\) |
|
||||
| `channelId` | string | No | The ID of the channel for channel messages \(e.g., "19:abc123def456@thread.tacv2"\) |
|
||||
| `chatId` | string | No | The ID of the chat for chat messages \(e.g., "19:abc123def456@thread.v2"\) |
|
||||
| `messageId` | string | Yes | The ID of the message to react to \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||
| `reactionType` | string | Yes | The emoji reaction \(e.g., ❤️, 👍, 😊\) |
|
||||
|
||||
#### Output
|
||||
@@ -294,10 +294,10 @@ Remove an emoji reaction from a message in Microsoft Teams
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `teamId` | string | No | The ID of the team \(for channel messages\) |
|
||||
| `channelId` | string | No | The ID of the channel \(for channel messages\) |
|
||||
| `chatId` | string | No | The ID of the chat \(for chat messages\) |
|
||||
| `messageId` | string | Yes | The ID of the message |
|
||||
| `teamId` | string | No | The ID of the team for channel messages \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID\) |
|
||||
| `channelId` | string | No | The ID of the channel for channel messages \(e.g., "19:abc123def456@thread.tacv2"\) |
|
||||
| `chatId` | string | No | The ID of the chat for chat messages \(e.g., "19:abc123def456@thread.v2"\) |
|
||||
| `messageId` | string | Yes | The ID of the message \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||
| `reactionType` | string | Yes | The emoji reaction to remove \(e.g., ❤️, 👍, 😊\) |
|
||||
|
||||
#### Output
|
||||
@@ -316,7 +316,7 @@ List all members of a Microsoft Teams team
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `teamId` | string | Yes | The ID of the team |
|
||||
| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -334,8 +334,8 @@ List all members of a Microsoft Teams channel
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `teamId` | string | Yes | The ID of the team |
|
||||
| `channelId` | string | Yes | The ID of the channel |
|
||||
| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) |
|
||||
| `channelId` | string | Yes | The ID of the channel \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -58,33 +58,24 @@ Parse PDF documents using Mistral OCR API
|
||||
| ↳ `index` | number | Page index \(zero-based\) |
|
||||
| ↳ `markdown` | string | Extracted markdown content |
|
||||
| ↳ `images` | array | Images extracted from this page with bounding boxes |
|
||||
| ↳ `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\) |
|
||||
| ↳ `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\) |
|
||||
| ↳ `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 |
|
||||
| ↳ `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\) |
|
||||
| `usage_info` | object | Usage and processing statistics |
|
||||
| ↳ `pages_processed` | number | Total number of pages processed |
|
||||
| ↳ `doc_size_bytes` | number | Document file size in bytes |
|
||||
| ↳ `pages_processed` | number | Total number of pages processed |
|
||||
| ↳ `doc_size_bytes` | number | Document file size in bytes |
|
||||
| `document_annotation` | string | Structured annotation data as JSON string \(when applicable\) |
|
||||
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ Execute find operation on MongoDB collection
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) |
|
||||
| `username` | string | No | MongoDB username |
|
||||
| `password` | string | No | MongoDB password |
|
||||
| `authSource` | string | No | Authentication database |
|
||||
@@ -71,7 +71,7 @@ Insert documents into MongoDB collection
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) |
|
||||
| `username` | string | No | MongoDB username |
|
||||
| `password` | string | No | MongoDB password |
|
||||
| `authSource` | string | No | Authentication database |
|
||||
@@ -98,7 +98,7 @@ Update documents in MongoDB collection
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) |
|
||||
| `username` | string | No | MongoDB username |
|
||||
| `password` | string | No | MongoDB password |
|
||||
| `authSource` | string | No | Authentication database |
|
||||
@@ -129,7 +129,7 @@ Delete documents from MongoDB collection
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) |
|
||||
| `username` | string | No | MongoDB username |
|
||||
| `password` | string | No | MongoDB password |
|
||||
| `authSource` | string | No | Authentication database |
|
||||
@@ -156,7 +156,7 @@ Execute MongoDB aggregation pipeline
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) |
|
||||
| `username` | string | No | MongoDB username |
|
||||
| `password` | string | No | MongoDB password |
|
||||
| `authSource` | string | No | Authentication database |
|
||||
@@ -182,7 +182,7 @@ Introspect MongoDB database to list databases, collections, and indexes
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
||||
| `database` | string | No | Database name to introspect \(optional - if not provided, lists all databases\) |
|
||||
| `database` | string | No | Database name to introspect \(e.g., "mydb"\). If not provided, lists all databases |
|
||||
| `username` | string | No | MongoDB username |
|
||||
| `password` | string | No | MongoDB password |
|
||||
| `authSource` | string | No | Authentication database |
|
||||
|
||||
@@ -43,11 +43,11 @@ Execute SELECT query on MySQL database
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
|
||||
| `username` | string | Yes | Database username |
|
||||
| `password` | string | Yes | Database password |
|
||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
||||
| `query` | string | Yes | SQL SELECT query to execute |
|
||||
| `query` | string | Yes | SQL SELECT query to execute \(e.g., SELECT * FROM users WHERE active = 1\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -67,11 +67,11 @@ Insert new record into MySQL database
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
|
||||
| `username` | string | Yes | Database username |
|
||||
| `password` | string | Yes | Database password |
|
||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
||||
| `table` | string | Yes | Table name to insert into |
|
||||
| `table` | string | Yes | Table name to insert into \(e.g., users, orders\) |
|
||||
| `data` | object | Yes | Data to insert as key-value pairs |
|
||||
|
||||
#### Output
|
||||
@@ -92,11 +92,11 @@ Update existing records in MySQL database
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
|
||||
| `username` | string | Yes | Database username |
|
||||
| `password` | string | Yes | Database password |
|
||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
||||
| `table` | string | Yes | Table name to update |
|
||||
| `table` | string | Yes | Table name to update \(e.g., users, orders\) |
|
||||
| `data` | object | Yes | Data to update as key-value pairs |
|
||||
| `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) |
|
||||
|
||||
@@ -118,11 +118,11 @@ Delete records from MySQL database
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
|
||||
| `username` | string | Yes | Database username |
|
||||
| `password` | string | Yes | Database password |
|
||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
||||
| `table` | string | Yes | Table name to delete from |
|
||||
| `table` | string | Yes | Table name to delete from \(e.g., users, orders\) |
|
||||
| `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) |
|
||||
|
||||
#### Output
|
||||
@@ -143,11 +143,11 @@ Execute raw SQL query on MySQL database
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
|
||||
| `username` | string | Yes | Database username |
|
||||
| `password` | string | Yes | Database password |
|
||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
||||
| `query` | string | Yes | Raw SQL query to execute |
|
||||
| `query` | string | Yes | Raw SQL query to execute \(e.g., CREATE TABLE users \(id INT PRIMARY KEY, name VARCHAR\(255\)\)\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -167,7 +167,7 @@ Introspect MySQL database schema to retrieve table structures, columns, and rela
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
|
||||
| `username` | string | Yes | Database username |
|
||||
| `password` | string | Yes | Database password |
|
||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
||||
|
||||
@@ -44,11 +44,11 @@ Execute MATCH queries to read nodes and relationships from Neo4j graph database.
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) |
|
||||
| `username` | string | Yes | Neo4j username |
|
||||
| `password` | string | Yes | Neo4j password |
|
||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||
| `cypherQuery` | string | Yes | Cypher query to execute \(typically MATCH statements\) |
|
||||
| `cypherQuery` | string | Yes | Cypher query to execute \(e.g., "MATCH \(n:Person\) RETURN n LIMIT 10", "MATCH \(a\)-\[r\]->\(b\) WHERE a.name = $name RETURN a, r, b"\) |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object. Use for any dynamic values including LIMIT \(e.g., query: "MATCH \(n\) RETURN n LIMIT $limit", parameters: \{limit: 100\}\). |
|
||||
| `parameters` | string | No | No description |
|
||||
|
||||
@@ -71,12 +71,12 @@ Execute CREATE statements to add new nodes and relationships to Neo4j graph data
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) |
|
||||
| `username` | string | Yes | Neo4j username |
|
||||
| `password` | string | Yes | Neo4j password |
|
||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||
| `cypherQuery` | string | Yes | Cypher CREATE statement to execute |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object |
|
||||
| `cypherQuery` | string | Yes | Cypher CREATE statement to execute \(e.g., "CREATE \(n:Person \{name: $name, age: $age\}\)", "CREATE \(a\)-\[:KNOWS\]->\(b\)"\) |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "age": 30\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -95,12 +95,12 @@ Execute MERGE statements to find or create nodes and relationships in Neo4j (ups
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) |
|
||||
| `username` | string | Yes | Neo4j username |
|
||||
| `password` | string | Yes | Neo4j password |
|
||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||
| `cypherQuery` | string | Yes | Cypher MERGE statement to execute |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object |
|
||||
| `cypherQuery` | string | Yes | Cypher MERGE statement to execute \(e.g., "MERGE \(n:Person \{name: $name\}\) ON CREATE SET n.created = timestamp\(\)", "MERGE \(a\)-\[r:KNOWS\]->\(b\)"\) |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "email": "alice@example.com"\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -119,12 +119,12 @@ Execute SET statements to update properties of existing nodes and relationships
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) |
|
||||
| `username` | string | Yes | Neo4j username |
|
||||
| `password` | string | Yes | Neo4j password |
|
||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||
| `cypherQuery` | string | Yes | Cypher query with MATCH and SET statements to update properties |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object |
|
||||
| `cypherQuery` | string | Yes | Cypher query with MATCH and SET statements to update properties \(e.g., "MATCH \(n:Person \{name: $name\}\) SET n.age = $age", "MATCH \(n\) WHERE n.id = $id SET n += $props"\) |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "age": 31, "props": \{"city": "NYC"\}\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -143,12 +143,12 @@ Execute DELETE or DETACH DELETE statements to remove nodes and relationships fro
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) |
|
||||
| `username` | string | Yes | Neo4j username |
|
||||
| `password` | string | Yes | Neo4j password |
|
||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||
| `cypherQuery` | string | Yes | Cypher query with MATCH and DELETE/DETACH DELETE statements |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object |
|
||||
| `cypherQuery` | string | Yes | Cypher query with MATCH and DELETE/DETACH DELETE statements \(e.g., "MATCH \(n:Person \{name: $name\}\) DELETE n", "MATCH \(n\) DETACH DELETE n"\) |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "id": 123\}\) |
|
||||
| `detach` | boolean | No | Whether to use DETACH DELETE to remove relationships before deleting nodes |
|
||||
|
||||
#### Output
|
||||
@@ -168,12 +168,12 @@ Execute arbitrary Cypher queries on Neo4j graph database for complex operations
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) |
|
||||
| `username` | string | Yes | Neo4j username |
|
||||
| `password` | string | Yes | Neo4j password |
|
||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||
| `cypherQuery` | string | Yes | Cypher query to execute \(any valid Cypher statement\) |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object |
|
||||
| `cypherQuery` | string | Yes | Cypher query to execute \(e.g., "CALL db.labels\(\)", "MATCH \(n\) RETURN count\(n\)", "CREATE INDEX FOR \(n:Person\) ON \(n.name\)"\) |
|
||||
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "limit": 100\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -194,7 +194,7 @@ Introspect a Neo4j database to discover its schema including node labels, relati
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
||||
| `database` | string | Yes | Database name to connect to |
|
||||
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) |
|
||||
| `username` | string | Yes | Neo4j username |
|
||||
| `password` | string | Yes | Neo4j password |
|
||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||
|
||||
@@ -26,17 +26,17 @@ Read content from a Notion page
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `pageId` | string | Yes | The ID of the Notion page to read |
|
||||
| `pageId` | string | Yes | The UUID of the Notion page to read |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
|
||||
@@ -46,18 +46,18 @@ Read database information and structure from Notion
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `databaseId` | string | Yes | The ID of the Notion database to read |
|
||||
| `databaseId` | string | Yes | The UUID of the Notion database to read |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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`
|
||||
|
||||
@@ -67,7 +67,7 @@ Append content to a Notion page
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `pageId` | string | Yes | The ID of the Notion page to append content to |
|
||||
| `pageId` | string | Yes | The UUID of the Notion page to append content to |
|
||||
| `content` | string | Yes | The content to append to the page |
|
||||
|
||||
#### Output
|
||||
@@ -84,7 +84,7 @@ Create a new page in Notion
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `parentId` | string | Yes | ID of the parent page |
|
||||
| `parentId` | string | Yes | The UUID of the parent Notion page where this page will be created |
|
||||
| `title` | string | No | Title of the new page |
|
||||
| `content` | string | No | Optional content to add to the page upon creation |
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -106,7 +106,7 @@ Query and filter Notion database entries with advanced filtering
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `databaseId` | string | Yes | The ID of the database to query |
|
||||
| `databaseId` | string | Yes | The UUID of the Notion database to query |
|
||||
| `filter` | string | No | Filter conditions as JSON \(optional\) |
|
||||
| `sorts` | string | No | Sort criteria as JSON array \(optional\) |
|
||||
| `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) |
|
||||
@@ -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`
|
||||
@@ -132,22 +162,39 @@ Search across all pages and databases in Notion workspace
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | No | Search terms \(leave empty to get all pages\) |
|
||||
| `filterType` | string | No | Filter by object type: page, database, or leave empty for all |
|
||||
| `query` | string | No | Search terms to find pages and databases \(leave empty to get all pages\) |
|
||||
| `filterType` | string | No | Filter by object type: "page", "database", or leave empty for all |
|
||||
| `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| 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 |
|
||||
|
||||
|
||||
|
||||
@@ -44,11 +44,11 @@ Upload a file to OneDrive
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `fileName` | string | Yes | The name of the file to upload |
|
||||
| `fileName` | string | Yes | The name of the file to upload \(e.g., "report.pdf", "data.xlsx"\) |
|
||||
| `file` | file | No | The file to upload \(binary\) |
|
||||
| `content` | string | No | The text content to upload \(if no file is provided\) |
|
||||
| `mimeType` | string | No | The MIME type of the file to create \(e.g., text/plain for .txt, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for .xlsx\) |
|
||||
| `folderSelector` | string | No | Select the folder to upload the file to |
|
||||
| `folderSelector` | string | No | Folder ID to upload the file to \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||||
| `manualFolderId` | string | No | Manually entered folder ID \(advanced mode\) |
|
||||
|
||||
#### Output
|
||||
@@ -66,8 +66,8 @@ Create a new folder in OneDrive
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `folderName` | string | Yes | Name of the folder to create |
|
||||
| `folderSelector` | string | No | Select the parent folder to create the folder in |
|
||||
| `folderName` | string | Yes | Name of the folder to create \(e.g., "My Documents", "Project Files"\) |
|
||||
| `folderSelector` | string | No | Parent folder ID to create the folder in \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||||
| `manualFolderId` | string | No | Manually entered parent folder ID \(advanced mode\) |
|
||||
|
||||
#### Output
|
||||
@@ -85,8 +85,8 @@ Download a file from OneDrive
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `fileId` | string | Yes | The ID of the file to download |
|
||||
| `fileName` | string | No | Optional filename override |
|
||||
| `fileId` | string | Yes | The ID of the file to download \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||||
| `fileName` | string | No | Optional filename override \(e.g., "report.pdf", "data.xlsx"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -102,10 +102,10 @@ List files and folders in OneDrive
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `folderSelector` | string | No | Select the folder to list files from |
|
||||
| `folderSelector` | string | No | Folder ID to list files from \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||||
| `manualFolderId` | string | No | The manually entered folder ID \(advanced mode\) |
|
||||
| `query` | string | No | A query to filter the files |
|
||||
| `pageSize` | number | No | The number of files to return |
|
||||
| `query` | string | No | Filter files by name prefix \(e.g., "report", "invoice_2024"\) |
|
||||
| `pageSize` | number | No | Maximum number of files to return \(e.g., 10, 50, 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -123,7 +123,7 @@ Delete a file or folder from OneDrive
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `fileId` | string | Yes | The ID of the file or folder to delete |
|
||||
| `fileId` | string | Yes | The ID of the file or folder to delete \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -54,12 +54,10 @@ Generate embeddings from text using OpenAI
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Embeddings generation results |
|
||||
| ↳ `embeddings` | array | Array of embedding vectors |
|
||||
| ↳ `model` | string | Model used for generating embeddings |
|
||||
| ↳ `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 |
|
||||
| ↳ `embeddings` | array | Array of embedding vectors |
|
||||
| ↳ `model` | string | Model used for generating embeddings |
|
||||
| ↳ `usage` | object | Token usage information |
|
||||
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
||||
| ↳ `total_tokens` | number | Total number of tokens used |
|
||||
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user