mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-31 09:48:06 -05:00
Compare commits
39 Commits
feat/copil
...
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 |
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.
|
||||||
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`) |
|
| `API_ENCRYPTION_KEY` | Yes | Encrypts API keys (`openssl rand -hex 32`) |
|
||||||
| `COPILOT_API_KEY` | No | API key from sim.ai for Copilot features |
|
| `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
|
## Tech Stack
|
||||||
|
|
||||||
- **Framework**: [Next.js](https://nextjs.org/) (App Router)
|
- **Framework**: [Next.js](https://nextjs.org/) (App Router)
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import type React from 'react'
|
import type React from 'react'
|
||||||
import { findNeighbour } from 'fumadocs-core/page-tree'
|
import { findNeighbour } from 'fumadocs-core/page-tree'
|
||||||
|
import { Pre } from 'fumadocs-ui/components/codeblock'
|
||||||
import defaultMdxComponents from 'fumadocs-ui/mdx'
|
import defaultMdxComponents from 'fumadocs-ui/mdx'
|
||||||
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/page'
|
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/page'
|
||||||
import { ChevronLeft, ChevronRight } from 'lucide-react'
|
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 data = page.data as PageData
|
||||||
const MDX = data.body
|
const MDX = data.body
|
||||||
const baseUrl = 'https://docs.sim.ai'
|
const baseUrl = 'https://docs.sim.ai'
|
||||||
|
const markdownContent = await data.getText('processed')
|
||||||
|
|
||||||
const pageTreeRecord = source.pageTree as Record<string, any>
|
const pageTreeRecord = source.pageTree as Record<string, any>
|
||||||
const pageTree =
|
const pageTree =
|
||||||
@@ -200,7 +202,7 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
|
|||||||
<div className='relative mt-6 sm:mt-0'>
|
<div className='relative mt-6 sm:mt-0'>
|
||||||
<div className='absolute top-1 right-0 flex items-center gap-2'>
|
<div className='absolute top-1 right-0 flex items-center gap-2'>
|
||||||
<div className='hidden sm:flex'>
|
<div className='hidden sm:flex'>
|
||||||
<LLMCopyButton markdownUrl={`${page.url}.mdx`} />
|
<LLMCopyButton content={markdownContent} />
|
||||||
</div>
|
</div>
|
||||||
<PageNavigationArrows previous={neighbours?.previous} next={neighbours?.next} />
|
<PageNavigationArrows previous={neighbours?.previous} next={neighbours?.next} />
|
||||||
</div>
|
</div>
|
||||||
@@ -211,7 +213,11 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
|
|||||||
<MDX
|
<MDX
|
||||||
components={{
|
components={{
|
||||||
...defaultMdxComponents,
|
...defaultMdxComponents,
|
||||||
CodeBlock,
|
pre: (props: React.HTMLAttributes<HTMLPreElement>) => (
|
||||||
|
<CodeBlock {...props}>
|
||||||
|
<Pre>{props.children}</Pre>
|
||||||
|
</CodeBlock>
|
||||||
|
),
|
||||||
h1: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
|
h1: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
|
||||||
<Heading as='h1' {...props} />
|
<Heading as='h1' {...props} />
|
||||||
),
|
),
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { defineI18nUI } from 'fumadocs-ui/i18n'
|
|||||||
import { DocsLayout } from 'fumadocs-ui/layouts/docs'
|
import { DocsLayout } from 'fumadocs-ui/layouts/docs'
|
||||||
import { RootProvider } from 'fumadocs-ui/provider/next'
|
import { RootProvider } from 'fumadocs-ui/provider/next'
|
||||||
import { Geist_Mono, Inter } from 'next/font/google'
|
import { Geist_Mono, Inter } from 'next/font/google'
|
||||||
|
import Script from 'next/script'
|
||||||
import {
|
import {
|
||||||
SidebarFolder,
|
SidebarFolder,
|
||||||
SidebarItem,
|
SidebarItem,
|
||||||
@@ -17,11 +18,13 @@ import '../global.css'
|
|||||||
const inter = Inter({
|
const inter = Inter({
|
||||||
subsets: ['latin'],
|
subsets: ['latin'],
|
||||||
variable: '--font-geist-sans',
|
variable: '--font-geist-sans',
|
||||||
|
display: 'swap',
|
||||||
})
|
})
|
||||||
|
|
||||||
const geistMono = Geist_Mono({
|
const geistMono = Geist_Mono({
|
||||||
subsets: ['latin'],
|
subsets: ['latin'],
|
||||||
variable: '--font-geist-mono',
|
variable: '--font-geist-mono',
|
||||||
|
display: 'swap',
|
||||||
})
|
})
|
||||||
|
|
||||||
const { provider } = defineI18nUI(i18n, {
|
const { provider } = defineI18nUI(i18n, {
|
||||||
@@ -93,10 +96,9 @@ export default async function Layout({ children, params }: LayoutProps) {
|
|||||||
type='application/ld+json'
|
type='application/ld+json'
|
||||||
dangerouslySetInnerHTML={{ __html: JSON.stringify(structuredData) }}
|
dangerouslySetInnerHTML={{ __html: JSON.stringify(structuredData) }}
|
||||||
/>
|
/>
|
||||||
{/* OneDollarStats Analytics - CDN script handles everything automatically */}
|
|
||||||
<script defer src='https://assets.onedollarstats.com/stonks.js' />
|
|
||||||
</head>
|
</head>
|
||||||
<body className='flex min-h-screen flex-col font-sans'>
|
<body className='flex min-h-screen flex-col font-sans'>
|
||||||
|
<Script src='https://assets.onedollarstats.com/stonks.js' strategy='lazyOnload' />
|
||||||
<RootProvider i18n={provider(lang)}>
|
<RootProvider i18n={provider(lang)}>
|
||||||
<Navbar />
|
<Navbar />
|
||||||
<DocsLayout
|
<DocsLayout
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ export default function NotFound() {
|
|||||||
<DocsPage>
|
<DocsPage>
|
||||||
<DocsBody>
|
<DocsBody>
|
||||||
<div className='flex min-h-[60vh] flex-col items-center justify-center text-center'>
|
<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
|
404
|
||||||
</h1>
|
</h1>
|
||||||
<h2 className='mb-2 font-semibold text-2xl text-foreground'>Page Not Found</h2>
|
<h2 className='mb-2 font-semibold text-2xl text-foreground'>Page Not Found</h2>
|
||||||
|
|||||||
@@ -5113,3 +5113,60 @@ export function PulseIcon(props: SVGProps<SVGSVGElement>) {
|
|||||||
</svg>
|
</svg>
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function SimilarwebIcon(props: SVGProps<SVGSVGElement>) {
|
||||||
|
return (
|
||||||
|
<svg
|
||||||
|
{...props}
|
||||||
|
role='img'
|
||||||
|
viewBox='0 0 24 24'
|
||||||
|
xmlns='http://www.w3.org/2000/svg'
|
||||||
|
height='24'
|
||||||
|
width='24'
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
d='M22.099 5.781c-1.283 -2 -3.14 -3.67 -5.27 -4.52l-0.63 -0.213a7.433 7.433 0 0 0 -2.15 -0.331c-2.307 0.01 -4.175 1.92 -4.175 4.275a4.3 4.3 0 0 0 0.867 2.602l-0.26 -0.342c0.124 0.186 0.26 0.37 0.417 0.556 0.663 0.802 1.604 1.635 2.822 2.58 2.999 2.32 4.943 4.378 5.104 6.93 0.038 0.344 0.062 0.696 0.062 1.051 0 1.297 -0.283 2.67 -0.764 3.635h0.005s-0.207 0.377 -0.077 0.487c0.066 0.057 0.21 0.1 0.46 -0.053a12.104 12.104 0 0 0 3.4 -3.33 12.111 12.111 0 0 0 2.088 -6.635 12.098 12.098 0 0 0 -1.9 -6.692zm-9.096 8.718 -1.878 -1.55c-3.934 -2.87 -5.98 -5.966 -4.859 -9.783a8.73 8.73 0 0 1 0.37 -1.016v-0.004s0.278 -0.583 -0.327 -0.295a12.067 12.067 0 0 0 -6.292 9.975 12.11 12.11 0 0 0 2.053 7.421 9.394 9.394 0 0 0 2.154 2.168H4.22c4.148 3.053 7.706 1.446 7.706 1.446h0.003a4.847 4.847 0 0 0 2.962 -4.492 4.855 4.855 0 0 0 -1.889 -3.87z'
|
||||||
|
fill='currentColor'
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function CalComIcon(props: SVGProps<SVGSVGElement>) {
|
||||||
|
return (
|
||||||
|
<svg
|
||||||
|
{...props}
|
||||||
|
width='101'
|
||||||
|
height='22'
|
||||||
|
viewBox='0 0 101 22'
|
||||||
|
fill='currentColor'
|
||||||
|
xmlns='http://www.w3.org/2000/svg'
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
d='M10.0582 20.817C4.32115 20.817 0 16.2763 0 10.6704C0 5.04589 4.1005 0.467773 10.0582 0.467773C13.2209 0.467773 15.409 1.43945 17.1191 3.66311L14.3609 5.96151C13.2025 4.72822 11.805 4.11158 10.0582 4.11158C6.17833 4.11158 4.04533 7.08268 4.04533 10.6704C4.04533 14.2582 6.38059 17.1732 10.0582 17.1732C11.7866 17.1732 13.2577 16.5566 14.4161 15.3233L17.1375 17.7151C15.501 19.8453 13.2577 20.817 10.0582 20.817Z'
|
||||||
|
fill='#292929'
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d='M29.0161 5.88601H32.7304V20.4612H29.0161V18.331C28.2438 19.8446 26.9566 20.8536 24.4927 20.8536C20.5577 20.8536 17.4133 17.4341 17.4133 13.2297C17.4133 9.02528 20.5577 5.60571 24.4927 5.60571C26.9383 5.60571 28.2438 6.61477 29.0161 8.12835V5.88601ZM29.1264 13.2297C29.1264 10.95 27.5634 9.06266 25.0995 9.06266C22.7274 9.06266 21.1828 10.9686 21.1828 13.2297C21.1828 15.4346 22.7274 17.3967 25.0995 17.3967C27.5451 17.3967 29.1264 15.4907 29.1264 13.2297Z'
|
||||||
|
fill='#292929'
|
||||||
|
/>
|
||||||
|
<path d='M35.3599 0H39.0742V20.4427H35.3599V0Z' fill='#292929' />
|
||||||
|
<path
|
||||||
|
d='M40.7291 18.5182C40.7291 17.3223 41.6853 16.3132 42.9908 16.3132C44.2964 16.3132 45.2158 17.3223 45.2158 18.5182C45.2158 19.7515 44.278 20.7605 42.9908 20.7605C41.7037 20.7605 40.7291 19.7515 40.7291 18.5182Z'
|
||||||
|
fill='#292929'
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d='M59.4296 18.1068C58.0505 19.7885 55.9543 20.8536 53.4719 20.8536C49.0404 20.8536 45.7858 17.4341 45.7858 13.2297C45.7858 9.02528 49.0404 5.60571 53.4719 5.60571C55.8623 5.60571 57.9402 6.61477 59.3193 8.20309L56.4508 10.6136C55.7336 9.71667 54.7958 9.04397 53.4719 9.04397C51.0999 9.04397 49.5553 10.95 49.5553 13.211C49.5553 15.472 51.0999 17.378 53.4719 17.378C54.9062 17.378 55.8991 16.6306 56.6346 15.6215L59.4296 18.1068Z'
|
||||||
|
fill='#292929'
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d='M59.7422 13.2297C59.7422 9.02528 62.9968 5.60571 67.4283 5.60571C71.8598 5.60571 75.1144 9.02528 75.1144 13.2297C75.1144 17.4341 71.8598 20.8536 67.4283 20.8536C62.9968 20.8349 59.7422 17.4341 59.7422 13.2297ZM71.3449 13.2297C71.3449 10.95 69.8003 9.06266 67.4283 9.06266C65.0563 9.04397 63.5117 10.95 63.5117 13.2297C63.5117 15.4907 65.0563 17.3967 67.4283 17.3967C69.8003 17.3967 71.3449 15.4907 71.3449 13.2297Z'
|
||||||
|
fill='#292929'
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d='M100.232 11.5482V20.4428H96.518V12.4638C96.518 9.94119 95.3412 8.85739 93.576 8.85739C91.921 8.85739 90.7442 9.67958 90.7442 12.4638V20.4428H87.0299V12.4638C87.0299 9.94119 85.8346 8.85739 84.0878 8.85739C82.4329 8.85739 80.9802 9.67958 80.9802 12.4638V20.4428H77.2659V5.8676H80.9802V7.88571C81.7525 6.31607 83.15 5.53125 85.3014 5.53125C87.3425 5.53125 89.0525 6.5403 89.9903 8.24074C90.9281 6.50293 92.3072 5.53125 94.8079 5.53125C97.8603 5.54994 100.232 7.86702 100.232 11.5482Z'
|
||||||
|
fill='#292929'
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|||||||
@@ -8,13 +8,7 @@ import { ThemeToggle } from '@/components/ui/theme-toggle'
|
|||||||
|
|
||||||
export function Navbar() {
|
export function Navbar() {
|
||||||
return (
|
return (
|
||||||
<nav
|
<nav className='sticky top-0 z-50 border-border/50 border-b bg-background/80 backdrop-blur-md backdrop-saturate-150'>
|
||||||
className='sticky top-0 z-50 border-border/50 border-b'
|
|
||||||
style={{
|
|
||||||
backdropFilter: 'blur(25px) saturate(180%)',
|
|
||||||
WebkitBackdropFilter: 'blur(25px) saturate(180%)',
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
{/* Desktop: Single row layout */}
|
{/* Desktop: Single row layout */}
|
||||||
<div className='hidden h-16 w-full items-center lg:flex'>
|
<div className='hidden h-16 w-full items-center lg:flex'>
|
||||||
<div
|
<div
|
||||||
|
|||||||
@@ -1,45 +1,13 @@
|
|||||||
'use client'
|
'use client'
|
||||||
|
|
||||||
import { useState } from 'react'
|
|
||||||
import { useCopyButton } from 'fumadocs-ui/utils/use-copy-button'
|
import { useCopyButton } from 'fumadocs-ui/utils/use-copy-button'
|
||||||
import { Check, Copy } from 'lucide-react'
|
import { Check, Copy } from 'lucide-react'
|
||||||
|
|
||||||
const cache = new Map<string, string>()
|
export function LLMCopyButton({ content }: { content: string }) {
|
||||||
|
const [checked, onClick] = useCopyButton(() => navigator.clipboard.writeText(content))
|
||||||
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)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<button
|
<button
|
||||||
disabled={isLoading}
|
|
||||||
onClick={onClick}
|
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'
|
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'}
|
aria-label={checked ? 'Copied to clipboard' : 'Copy page content'}
|
||||||
|
|||||||
@@ -17,23 +17,16 @@ export function CodeBlock(props: React.ComponentProps<typeof FumadocsCodeBlock>)
|
|||||||
return (
|
return (
|
||||||
<FumadocsCodeBlock
|
<FumadocsCodeBlock
|
||||||
{...props}
|
{...props}
|
||||||
Actions={({ children, className }) => (
|
Actions={({ className }) => (
|
||||||
<div className={cn('empty:hidden', className)}>
|
<div className={cn('empty:hidden', className)}>
|
||||||
{/* Custom copy button */}
|
|
||||||
<button
|
<button
|
||||||
type='button'
|
type='button'
|
||||||
aria-label={copied ? 'Copied Text' : 'Copy Text'}
|
aria-label={copied ? 'Copied Text' : 'Copy Text'}
|
||||||
onClick={(e) => {
|
onClick={(e) => {
|
||||||
const pre = (e.currentTarget as HTMLElement)
|
const pre = (e.currentTarget as HTMLElement).closest('figure')?.querySelector('pre')
|
||||||
.closest('.nd-codeblock')
|
|
||||||
?.querySelector('pre')
|
|
||||||
if (pre) handleCopy(pre.textContent || '')
|
if (pre) handleCopy(pre.textContent || '')
|
||||||
}}
|
}}
|
||||||
className={cn(
|
className='cursor-pointer rounded-md p-2 text-muted-foreground transition-colors hover:text-foreground'
|
||||||
'cursor-pointer rounded-md p-2 transition-all',
|
|
||||||
'border border-border bg-background/80 hover:bg-muted',
|
|
||||||
'backdrop-blur-sm'
|
|
||||||
)}
|
|
||||||
>
|
>
|
||||||
<span className='flex items-center justify-center'>
|
<span className='flex items-center justify-center'>
|
||||||
{copied ? (
|
{copied ? (
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ import {
|
|||||||
AsanaIcon,
|
AsanaIcon,
|
||||||
BrainIcon,
|
BrainIcon,
|
||||||
BrowserUseIcon,
|
BrowserUseIcon,
|
||||||
|
CalComIcon,
|
||||||
CalendlyIcon,
|
CalendlyIcon,
|
||||||
CirclebackIcon,
|
CirclebackIcon,
|
||||||
ClayIcon,
|
ClayIcon,
|
||||||
@@ -100,6 +101,7 @@ import {
|
|||||||
ServiceNowIcon,
|
ServiceNowIcon,
|
||||||
SftpIcon,
|
SftpIcon,
|
||||||
ShopifyIcon,
|
ShopifyIcon,
|
||||||
|
SimilarwebIcon,
|
||||||
SlackIcon,
|
SlackIcon,
|
||||||
SmtpIcon,
|
SmtpIcon,
|
||||||
SQSIcon,
|
SQSIcon,
|
||||||
@@ -141,6 +143,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
|||||||
arxiv: ArxivIcon,
|
arxiv: ArxivIcon,
|
||||||
asana: AsanaIcon,
|
asana: AsanaIcon,
|
||||||
browser_use: BrowserUseIcon,
|
browser_use: BrowserUseIcon,
|
||||||
|
calcom: CalComIcon,
|
||||||
calendly: CalendlyIcon,
|
calendly: CalendlyIcon,
|
||||||
circleback: CirclebackIcon,
|
circleback: CirclebackIcon,
|
||||||
clay: ClayIcon,
|
clay: ClayIcon,
|
||||||
@@ -228,6 +231,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
|||||||
sftp: SftpIcon,
|
sftp: SftpIcon,
|
||||||
sharepoint: MicrosoftSharepointIcon,
|
sharepoint: MicrosoftSharepointIcon,
|
||||||
shopify: ShopifyIcon,
|
shopify: ShopifyIcon,
|
||||||
|
similarweb: SimilarwebIcon,
|
||||||
slack: SlackIcon,
|
slack: SlackIcon,
|
||||||
smtp: SmtpIcon,
|
smtp: SmtpIcon,
|
||||||
sqs: SQSIcon,
|
sqs: SQSIcon,
|
||||||
|
|||||||
@@ -58,7 +58,7 @@ Controls response randomness and creativity:
|
|||||||
|
|
||||||
### Max Output Tokens
|
### 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. For long-form content generation via API, explicitly set a higher value.
|
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
|
### API Key
|
||||||
|
|
||||||
|
|||||||
@@ -280,14 +280,24 @@ A quick lookup for everyday actions in the Sim workflow editor. For keyboard sho
|
|||||||
<td>Click clear button in Chat panel</td>
|
<td>Click clear button in Chat panel</td>
|
||||||
<td><ActionImage src="/static/quick-reference/clear-chat.png" alt="Clear chat history" /></td>
|
<td><ActionImage src="/static/quick-reference/clear-chat.png" alt="Clear chat history" /></td>
|
||||||
</tr>
|
</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>
|
<tr>
|
||||||
<td>View execution logs</td>
|
<td>View execution logs</td>
|
||||||
<td>Open terminal panel at bottom, or `Mod+L`</td>
|
<td>Open terminal panel at bottom, or `Mod+L`</td>
|
||||||
<td><ActionImage src="/static/quick-reference/terminal.png" alt="Execution logs terminal" /></td>
|
<td><ActionImage src="/static/quick-reference/terminal.png" alt="Execution logs terminal" /></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>Filter logs by block or status</td>
|
<td>Filter logs</td>
|
||||||
<td>Click block filter in terminal or right-click log entry → **Filter by Block** or **Filter by Status**</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>
|
<td><ActionImage src="/static/quick-reference/filter-block.png" alt="Filter logs by block" /></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -335,6 +345,11 @@ A quick lookup for everyday actions in the Sim workflow editor. For keyboard sho
|
|||||||
<td>Access previous versions in Deploy tab → **Promote to live**</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>
|
<td><ActionImage src="/static/quick-reference/promote-deployment.png" alt="Promote deployment to live" /></td>
|
||||||
</tr>
|
</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>
|
<tr>
|
||||||
<td>Copy API endpoint</td>
|
<td>Copy API endpoint</td>
|
||||||
<td>Deploy tab → API → Copy API cURL</td>
|
<td>Deploy tab → API → Copy API cURL</td>
|
||||||
|
|||||||
@@ -52,12 +52,12 @@ Send a message to an external A2A-compatible agent.
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `content` | string | The text response from the agent |
|
| `content` | string | Text response content from the agent |
|
||||||
| `taskId` | string | Task ID for follow-up interactions |
|
| `taskId` | string | Unique task identifier |
|
||||||
| `contextId` | string | Context ID for conversation continuity |
|
| `contextId` | string | Groups related tasks/messages |
|
||||||
| `state` | string | Task state |
|
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) |
|
||||||
| `artifacts` | array | Structured output artifacts |
|
| `artifacts` | array | Task output artifacts |
|
||||||
| `history` | array | Full message history |
|
| `history` | array | Conversation history \(Message array\) |
|
||||||
|
|
||||||
### `a2a_get_task`
|
### `a2a_get_task`
|
||||||
|
|
||||||
@@ -76,11 +76,11 @@ Query the status of an existing A2A task.
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `taskId` | string | Task ID |
|
| `taskId` | string | Unique task identifier |
|
||||||
| `contextId` | string | Context ID |
|
| `contextId` | string | Groups related tasks/messages |
|
||||||
| `state` | string | Task state |
|
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) |
|
||||||
| `artifacts` | array | Output artifacts |
|
| `artifacts` | array | Task output artifacts |
|
||||||
| `history` | array | Message history |
|
| `history` | array | Conversation history \(Message array\) |
|
||||||
|
|
||||||
### `a2a_cancel_task`
|
### `a2a_cancel_task`
|
||||||
|
|
||||||
@@ -99,7 +99,7 @@ Cancel a running A2A task.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `cancelled` | boolean | Whether cancellation was successful |
|
| `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`
|
### `a2a_get_agent_card`
|
||||||
|
|
||||||
@@ -116,14 +116,15 @@ Fetch the Agent Card (discovery document) for an A2A agent.
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `name` | string | Agent name |
|
| `name` | string | Agent display name |
|
||||||
| `description` | string | Agent description |
|
| `description` | string | Agent purpose/capabilities |
|
||||||
| `url` | string | Agent endpoint URL |
|
| `url` | string | Service endpoint URL |
|
||||||
| `version` | string | Agent version |
|
| `provider` | object | Creator organization details |
|
||||||
| `capabilities` | object | Agent capabilities \(streaming, pushNotifications, etc.\) |
|
| `capabilities` | object | Feature support matrix |
|
||||||
| `skills` | array | Skills the agent can perform |
|
| `skills` | array | Available operations |
|
||||||
| `defaultInputModes` | array | Default input modes \(text, file, data\) |
|
| `version` | string | A2A protocol version supported by the agent |
|
||||||
| `defaultOutputModes` | array | Default output modes \(text, file, data\) |
|
| `defaultInputModes` | array | Default input content types accepted by the agent |
|
||||||
|
| `defaultOutputModes` | array | Default output content types produced by the agent |
|
||||||
|
|
||||||
### `a2a_resubscribe`
|
### `a2a_resubscribe`
|
||||||
|
|
||||||
@@ -141,12 +142,12 @@ Reconnect to an ongoing A2A task stream after connection interruption.
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `taskId` | string | Task ID |
|
| `taskId` | string | Unique task identifier |
|
||||||
| `contextId` | string | Context ID |
|
| `contextId` | string | Groups related tasks/messages |
|
||||||
| `state` | string | Current task state |
|
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) |
|
||||||
| `isRunning` | boolean | Whether the task is still running |
|
| `isRunning` | boolean | Whether the task is still running |
|
||||||
| `artifacts` | array | Output artifacts |
|
| `artifacts` | array | Task output artifacts |
|
||||||
| `history` | array | Message history |
|
| `history` | array | Conversation history \(Message array\) |
|
||||||
|
|
||||||
### `a2a_set_push_notification`
|
### `a2a_set_push_notification`
|
||||||
|
|
||||||
@@ -166,9 +167,9 @@ Configure a webhook to receive task update notifications.
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `url` | string | Configured webhook URL |
|
| `url` | string | HTTPS webhook URL for notifications |
|
||||||
| `token` | string | Token for webhook validation |
|
| `token` | string | Authentication token for webhook validation |
|
||||||
| `success` | boolean | Whether configuration was successful |
|
| `success` | boolean | Whether the operation was successful |
|
||||||
|
|
||||||
### `a2a_get_push_notification`
|
### `a2a_get_push_notification`
|
||||||
|
|
||||||
@@ -186,9 +187,8 @@ Get the push notification webhook configuration for a task.
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `url` | string | Configured webhook URL |
|
| `token` | string | Authentication token for webhook validation |
|
||||||
| `token` | string | Token for webhook validation |
|
| `exists` | boolean | Whether the resource exists |
|
||||||
| `exists` | boolean | Whether a push notification config exists |
|
|
||||||
|
|
||||||
### `a2a_delete_push_notification`
|
### `a2a_delete_push_notification`
|
||||||
|
|
||||||
@@ -207,6 +207,6 @@ Delete the push notification webhook configuration for a task.
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `target` | string | Yes | The target domain or URL to analyze |
|
| `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\) |
|
| `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\) |
|
| `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\) |
|
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
|
||||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -88,8 +88,8 @@ Get backlink statistics for a target domain or URL. Returns totals for different
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `target` | string | Yes | The target domain or URL to analyze |
|
| `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\) |
|
| `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\) |
|
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
| `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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `stats` | object | Backlink statistics summary |
|
| `stats` | object | Backlink statistics summary |
|
||||||
| ↳ `total` | number | Total number of live backlinks |
|
| ↳ `total` | number | Total number of live backlinks |
|
||||||
| ↳ `dofollow` | number | Number of dofollow backlinks |
|
| ↳ `dofollow` | number | Number of dofollow backlinks |
|
||||||
| ↳ `nofollow` | number | Number of nofollow backlinks |
|
| ↳ `nofollow` | number | Number of nofollow backlinks |
|
||||||
| ↳ `text` | number | Number of text backlinks |
|
| ↳ `text` | number | Number of text backlinks |
|
||||||
| ↳ `image` | number | Number of image backlinks |
|
| ↳ `image` | number | Number of image backlinks |
|
||||||
| ↳ `redirect` | number | Number of redirect backlinks |
|
| ↳ `redirect` | number | Number of redirect backlinks |
|
||||||
|
|
||||||
### `ahrefs_referring_domains`
|
### `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `target` | string | Yes | The target domain or URL to analyze |
|
| `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\) |
|
| `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\) |
|
| `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\) |
|
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
|
||||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -140,12 +140,12 @@ Get organic keywords that a target domain or URL ranks for in Google search resu
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `target` | string | Yes | The target domain or URL to analyze |
|
| `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 \(e.g., us, gb, de\). Default: us |
|
| `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\) |
|
| `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\) |
|
| `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\) |
|
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
|
||||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -168,12 +168,12 @@ Get the top pages of a target domain sorted by organic traffic. Returns page URL
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `target` | string | Yes | The target domain to analyze |
|
| `target` | string | Yes | The target domain to analyze. Example: "example.com" |
|
||||||
| `country` | string | No | Country code for traffic data \(e.g., us, gb, de\). Default: us |
|
| `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\) |
|
| `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\) |
|
| `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\) |
|
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `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 |
|
| `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 |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `keyword` | string | Yes | The keyword to analyze |
|
| `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 |
|
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -205,14 +205,14 @@ Get detailed metrics for a keyword including search volume, keyword difficulty,
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `overview` | object | Keyword metrics overview |
|
| `overview` | object | Keyword metrics overview |
|
||||||
| ↳ `keyword` | string | The analyzed keyword |
|
| ↳ `keyword` | string | The analyzed keyword |
|
||||||
| ↳ `searchVolume` | number | Monthly search volume |
|
| ↳ `searchVolume` | number | Monthly search volume |
|
||||||
| ↳ `keywordDifficulty` | number | Keyword difficulty score \(0-100\) |
|
| ↳ `keywordDifficulty` | number | Keyword difficulty score \(0-100\) |
|
||||||
| ↳ `cpc` | number | Cost per click in USD |
|
| ↳ `cpc` | number | Cost per click in USD |
|
||||||
| ↳ `clicks` | number | Estimated clicks per month |
|
| ↳ `clicks` | number | Estimated clicks per month |
|
||||||
| ↳ `clicksPercentage` | number | Percentage of searches that result in clicks |
|
| ↳ `clicksPercentage` | number | Percentage of searches that result in clicks |
|
||||||
| ↳ `parentTopic` | string | The parent topic for this keyword |
|
| ↳ `parentTopic` | string | The parent topic for this keyword |
|
||||||
| ↳ `trafficPotential` | number | Estimated traffic potential if ranking #1 |
|
| ↳ `trafficPotential` | number | Estimated traffic potential if ranking #1 |
|
||||||
|
|
||||||
### `ahrefs_broken_backlinks`
|
### `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `target` | string | Yes | The target domain or URL to analyze |
|
| `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\) |
|
| `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\) |
|
| `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\) |
|
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
|
||||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|||||||
@@ -40,9 +40,9 @@ Read records from an Airtable table
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `baseId` | string | Yes | ID of the Airtable base |
|
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
|
||||||
| `tableId` | string | Yes | ID of the table |
|
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
|
||||||
| `maxRecords` | number | No | Maximum number of records to return |
|
| `maxRecords` | number | No | Maximum number of records to return \(default: all records\) |
|
||||||
| `filterFormula` | string | No | Formula to filter records \(e.g., "\(\{Field Name\} = \'Value\'\)"\) |
|
| `filterFormula` | string | No | Formula to filter records \(e.g., "\(\{Field Name\} = \'Value\'\)"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -60,9 +60,9 @@ Retrieve a single record from an Airtable table by its ID
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `baseId` | string | Yes | ID of the Airtable base |
|
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
|
||||||
| `tableId` | string | Yes | ID or name of the table |
|
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
|
||||||
| `recordId` | string | Yes | ID of the record to retrieve |
|
| `recordId` | string | Yes | Record ID to retrieve \(starts with "rec", e.g., "recXXXXXXXXXXXXXX"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -79,8 +79,8 @@ Write new records to an Airtable table
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `baseId` | string | Yes | ID of the Airtable base |
|
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
|
||||||
| `tableId` | string | Yes | ID or name of the table |
|
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
|
||||||
| `records` | json | Yes | Array of records to create, each with a `fields` object |
|
| `records` | json | Yes | Array of records to create, each with a `fields` object |
|
||||||
| `fields` | string | No | No description |
|
| `fields` | string | No | No description |
|
||||||
|
|
||||||
@@ -99,9 +99,9 @@ Update an existing record in an Airtable table by ID
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `baseId` | string | Yes | ID of the Airtable base |
|
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
|
||||||
| `tableId` | string | Yes | ID or name of the table |
|
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
|
||||||
| `recordId` | string | Yes | ID of the record to update |
|
| `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 |
|
| `fields` | json | Yes | An object containing the field names and their new values |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -119,8 +119,8 @@ Update multiple existing records in an Airtable table
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `baseId` | string | Yes | ID of the Airtable base |
|
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
|
||||||
| `tableId` | string | Yes | ID or name of the table |
|
| `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 |
|
| `records` | json | Yes | Array of records to update, each with an `id` and a `fields` object |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|||||||
@@ -45,10 +45,12 @@ Run an APIFY actor synchronously and get results (max 5 minutes)
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations |
|
| `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\) |
|
| `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. See actor documentation for required fields. |
|
| `input` | string | No | Actor input as JSON string. Example: \{"startUrls": \[\{"url": "https://example.com"\}\], "maxPages": 10\} |
|
||||||
| `timeout` | number | No | Timeout in seconds \(default: actor default\) |
|
| `Example` | string | No | No description |
|
||||||
| `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -68,12 +70,14 @@ Run an APIFY actor asynchronously with polling for long-running tasks
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations |
|
| `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\) |
|
| `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 |
|
| `input` | string | No | Actor input as JSON string. Example: \{"startUrls": \[\{"url": "https://example.com"\}\], "maxPages": 10\} |
|
||||||
| `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts |
|
| `Example` | string | No | No description |
|
||||||
| `itemLimit` | number | No | Max dataset items to fetch \(1-250000, default 100\) |
|
| `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts. Example: 30 |
|
||||||
| `timeout` | number | No | Timeout in seconds \(default: actor default\) |
|
| `itemLimit` | number | No | Max dataset items to fetch \(1-250000\). Default: 100. Example: 500 |
|
||||||
| `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -53,8 +53,8 @@ Search Apollo
|
|||||||
| `person_seniorities` | array | No | Seniority levels \(e.g., \["senior", "executive", "manager"\]\) |
|
| `person_seniorities` | array | No | Seniority levels \(e.g., \["senior", "executive", "manager"\]\) |
|
||||||
| `organization_names` | array | No | Company names to search within |
|
| `organization_names` | array | No | Company names to search within |
|
||||||
| `q_keywords` | string | No | Keywords to search for |
|
| `q_keywords` | string | No | Keywords to search for |
|
||||||
| `page` | number | No | Page number for pagination \(default: 1\) |
|
| `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\) |
|
| `per_page` | number | No | Results per page, default 25, max 100 \(e.g., 25, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ Enrich data for a single person using Apollo
|
|||||||
| `last_name` | string | No | Last name of the person |
|
| `last_name` | string | No | Last name of the person |
|
||||||
| `email` | string | No | Email address of the person |
|
| `email` | string | No | Email address of the person |
|
||||||
| `organization_name` | string | No | Company name where the person works |
|
| `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 |
|
| `linkedin_url` | string | No | LinkedIn profile URL |
|
||||||
| `reveal_personal_emails` | boolean | No | Reveal personal email addresses \(uses credits\) |
|
| `reveal_personal_emails` | boolean | No | Reveal personal email addresses \(uses credits\) |
|
||||||
| `reveal_phone_number` | boolean | No | Reveal phone numbers \(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_locations` | array | No | Company locations to search |
|
||||||
| `organization_num_employees_ranges` | array | No | Employee count ranges \(e.g., \["1-10", "11-50"\]\) |
|
| `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_keyword_tags` | array | No | Industry or keyword tags |
|
||||||
| `q_organization_name` | string | No | Organization name to search for |
|
| `q_organization_name` | string | No | Organization name to search for \(e.g., "Acme", "TechCorp"\) |
|
||||||
| `page` | number | No | Page number for pagination |
|
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -145,8 +145,8 @@ Enrich data for a single organization using Apollo
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Apollo API key |
|
| `apiKey` | string | Yes | Apollo API key |
|
||||||
| `organization_name` | string | No | Name of the organization \(at least one of organization_name or domain 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\) \(at least one of domain or organization_name is required\) |
|
| `domain` | string | No | Company domain \(e.g., "apollo.io", "acme.com"\) - at least one of domain or organization_name is required |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -186,8 +186,8 @@ Create a new contact in your Apollo database
|
|||||||
| `first_name` | string | Yes | First name of the contact |
|
| `first_name` | string | Yes | First name of the contact |
|
||||||
| `last_name` | string | Yes | Last name of the contact |
|
| `last_name` | string | Yes | Last name of the contact |
|
||||||
| `email` | string | No | Email address of the contact |
|
| `email` | string | No | Email address of the contact |
|
||||||
| `title` | string | No | Job title |
|
| `title` | string | No | Job title \(e.g., "VP of Sales", "Software Engineer"\) |
|
||||||
| `account_id` | string | No | Apollo account ID to associate with |
|
| `account_id` | string | No | Apollo account ID to associate with \(e.g., "acc_abc123"\) |
|
||||||
| `owner_id` | string | No | User ID of the contact owner |
|
| `owner_id` | string | No | User ID of the contact owner |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -206,12 +206,12 @@ Update an existing contact in your Apollo database
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Apollo API key |
|
| `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 |
|
| `first_name` | string | No | First name of the contact |
|
||||||
| `last_name` | string | No | Last name of the contact |
|
| `last_name` | string | No | Last name of the contact |
|
||||||
| `email` | string | No | Email address |
|
| `email` | string | No | Email address |
|
||||||
| `title` | string | No | Job title |
|
| `title` | string | No | Job title \(e.g., "VP of Sales", "Software Engineer"\) |
|
||||||
| `account_id` | string | No | Apollo account ID |
|
| `account_id` | string | No | Apollo account ID \(e.g., "acc_abc123"\) |
|
||||||
| `owner_id` | string | No | User ID of the contact owner |
|
| `owner_id` | string | No | User ID of the contact owner |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -232,8 +232,8 @@ Search your team
|
|||||||
| `apiKey` | string | Yes | Apollo API key |
|
| `apiKey` | string | Yes | Apollo API key |
|
||||||
| `q_keywords` | string | No | Keywords to search for |
|
| `q_keywords` | string | No | Keywords to search for |
|
||||||
| `contact_stage_ids` | array | No | Filter by contact stage IDs |
|
| `contact_stage_ids` | array | No | Filter by contact stage IDs |
|
||||||
| `page` | number | No | Page number for pagination |
|
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -294,7 +294,7 @@ Create a new account (company) in your Apollo database
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Apollo API key |
|
| `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 |
|
| `website_url` | string | No | Company website URL |
|
||||||
| `phone` | string | No | Company phone number |
|
| `phone` | string | No | Company phone number |
|
||||||
| `owner_id` | string | No | User ID of the account owner |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Apollo API key |
|
| `apiKey` | string | Yes | Apollo API key |
|
||||||
| `account_id` | string | Yes | ID of the account to update |
|
| `account_id` | string | Yes | ID of the account to update \(e.g., "acc_abc123"\) |
|
||||||
| `name` | string | No | Company name |
|
| `name` | string | No | Company name \(e.g., "Acme Corporation"\) |
|
||||||
| `website_url` | string | No | Company website URL |
|
| `website_url` | string | No | Company website URL |
|
||||||
| `phone` | string | No | Company phone number |
|
| `phone` | string | No | Company phone number |
|
||||||
| `owner_id` | string | No | User ID of the account owner |
|
| `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 |
|
| `q_keywords` | string | No | Keywords to search for in account data |
|
||||||
| `owner_id` | string | No | Filter by account owner user ID |
|
| `owner_id` | string | No | Filter by account owner user ID |
|
||||||
| `account_stage_ids` | array | No | Filter by account stage IDs |
|
| `account_stage_ids` | array | No | Filter by account stage IDs |
|
||||||
| `page` | number | No | Page number for pagination |
|
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -401,8 +401,8 @@ Create a new deal for an account in your Apollo database (master key required)
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
||||||
| `name` | string | Yes | Name of the opportunity/deal |
|
| `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 |
|
| `account_id` | string | Yes | ID of the account this opportunity belongs to \(e.g., "acc_abc123"\) |
|
||||||
| `amount` | number | No | Monetary value of the opportunity |
|
| `amount` | number | No | Monetary value of the opportunity |
|
||||||
| `stage_id` | string | No | ID of the deal stage |
|
| `stage_id` | string | No | ID of the deal stage |
|
||||||
| `owner_id` | string | No | User ID of the opportunity owner |
|
| `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 |
|
| `apiKey` | string | Yes | Apollo API key |
|
||||||
| `q_keywords` | string | No | Keywords to search for in opportunity names |
|
| `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 |
|
| `stage_ids` | array | No | Filter by deal stage IDs |
|
||||||
| `owner_ids` | array | No | Filter by opportunity owner IDs |
|
| `owner_ids` | array | No | Filter by opportunity owner IDs |
|
||||||
| `page` | number | No | Page number for pagination |
|
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -450,7 +450,7 @@ Retrieve complete details of a specific deal/opportunity by ID
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Apollo API key |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -468,8 +468,8 @@ Update an existing deal/opportunity in your Apollo database
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Apollo API key |
|
| `apiKey` | string | Yes | Apollo API key |
|
||||||
| `opportunity_id` | string | Yes | ID of the opportunity to update |
|
| `opportunity_id` | string | Yes | ID of the opportunity to update \(e.g., "opp_abc123"\) |
|
||||||
| `name` | string | No | Name of the opportunity/deal |
|
| `name` | string | No | Name of the opportunity/deal \(e.g., "Enterprise License - Q1"\) |
|
||||||
| `amount` | number | No | Monetary value of the opportunity |
|
| `amount` | number | No | Monetary value of the opportunity |
|
||||||
| `stage_id` | string | No | ID of the deal stage |
|
| `stage_id` | string | No | ID of the deal stage |
|
||||||
| `owner_id` | string | No | User ID of the opportunity owner |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
| `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\) |
|
| `active` | boolean | No | Filter by active status \(true for active sequences, false for inactive\) |
|
||||||
| `page` | number | No | Page number for pagination |
|
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -515,8 +515,8 @@ Add contacts to an Apollo sequence
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
||||||
| `sequence_id` | string | Yes | ID of the sequence to add contacts to |
|
| `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 |
|
| `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 |
|
| `emailer_campaign_id` | string | No | Optional emailer campaign ID |
|
||||||
| `send_email_from_user_id` | string | No | User ID to send emails from |
|
| `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\) |
|
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
||||||
| `note` | string | Yes | Task note/description |
|
| `note` | string | Yes | Task note/description |
|
||||||
| `contact_id` | string | No | Contact 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 |
|
| `account_id` | string | No | Account ID to associate with \(e.g., "acc_abc123"\) |
|
||||||
| `due_at` | string | No | Due date in ISO format |
|
| `due_at` | string | No | Due date in ISO format |
|
||||||
| `priority` | string | No | Task priority |
|
| `priority` | string | No | Task priority |
|
||||||
| `type` | string | No | Task type |
|
| `type` | string | No | Task type |
|
||||||
@@ -560,11 +560,11 @@ Search for tasks in Apollo
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
| `apiKey` | string | Yes | Apollo API key \(master key required\) |
|
||||||
| `contact_id` | string | No | Filter by contact ID |
|
| `contact_id` | string | No | Filter by contact ID \(e.g., "con_abc123"\) |
|
||||||
| `account_id` | string | No | Filter by account ID |
|
| `account_id` | string | No | Filter by account ID \(e.g., "acc_abc123"\) |
|
||||||
| `completed` | boolean | No | Filter by completion status |
|
| `completed` | boolean | No | Filter by completion status |
|
||||||
| `page` | number | No | Page number for pagination |
|
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) |
|
||||||
| `per_page` | number | No | Results per page \(max: 100\) |
|
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -42,8 +42,8 @@ Retrieve a single task by GID or get multiple tasks with filters
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `taskGid` | string | No | The globally unique identifier \(GID\) of the task. If not provided, will get multiple tasks. |
|
| `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\) |
|
| `workspace` | string | No | Asana workspace GID \(numeric string\) to filter tasks \(required when not using taskGid\) |
|
||||||
| `project` | string | No | Project GID to filter tasks |
|
| `project` | string | No | Asana project GID \(numeric string\) to filter tasks |
|
||||||
| `limit` | number | No | Maximum number of tasks to return \(default: 50\) |
|
| `limit` | number | No | Maximum number of tasks to return \(default: 50\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -59,11 +59,11 @@ Retrieve a single task by GID or get multiple tasks with filters
|
|||||||
| `notes` | string | Task notes or description |
|
| `notes` | string | Task notes or description |
|
||||||
| `completed` | boolean | Whether the task is completed |
|
| `completed` | boolean | Whether the task is completed |
|
||||||
| `assignee` | object | Assignee details |
|
| `assignee` | object | Assignee details |
|
||||||
| ↳ `gid` | string | Assignee GID |
|
| ↳ `gid` | string | Assignee GID |
|
||||||
| ↳ `name` | string | Assignee name |
|
| ↳ `name` | string | Assignee name |
|
||||||
| `created_by` | object | Creator details |
|
| `created_by` | object | Creator details |
|
||||||
| ↳ `gid` | string | Creator GID |
|
| ↳ `gid` | string | Creator GID |
|
||||||
| ↳ `name` | string | Creator name |
|
| ↳ `name` | string | Creator name |
|
||||||
| `due_on` | string | Due date \(YYYY-MM-DD\) |
|
| `due_on` | string | Due date \(YYYY-MM-DD\) |
|
||||||
| `created_at` | string | Task creation timestamp |
|
| `created_at` | string | Task creation timestamp |
|
||||||
| `modified_at` | string | Task last modified timestamp |
|
| `modified_at` | string | Task last modified timestamp |
|
||||||
@@ -80,7 +80,7 @@ Create a new task in Asana
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `name` | string | Yes | Name of the task |
|
||||||
| `notes` | string | No | Notes or description for the task |
|
| `notes` | string | No | Notes or description for the task |
|
||||||
| `assignee` | string | No | User GID to assign the task to |
|
| `assignee` | string | No | User GID to assign the task to |
|
||||||
@@ -107,7 +107,7 @@ Update an existing task in Asana
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `name` | string | No | Updated name for the task |
|
||||||
| `notes` | string | No | Updated notes or description for the task |
|
| `notes` | string | No | Updated notes or description for the task |
|
||||||
| `assignee` | string | No | Updated assignee user GID |
|
| `assignee` | string | No | Updated assignee user GID |
|
||||||
@@ -134,7 +134,7 @@ Retrieve all projects from an Asana workspace
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
@@ -155,10 +155,10 @@ Search for tasks in an Asana workspace
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `text` | string | No | Text to search for in task names |
|
||||||
| `assignee` | string | No | Filter tasks by assignee user GID |
|
| `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 |
|
| `completed` | boolean | No | Filter by completion status |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -175,15 +175,15 @@ Search for tasks in an Asana workspace
|
|||||||
| ↳ `notes` | string | Task notes |
|
| ↳ `notes` | string | Task notes |
|
||||||
| ↳ `completed` | boolean | Completion status |
|
| ↳ `completed` | boolean | Completion status |
|
||||||
| ↳ `assignee` | object | Assignee details |
|
| ↳ `assignee` | object | Assignee details |
|
||||||
| ↳ `gid` | string | Assignee GID |
|
| ↳ `gid` | string | Assignee GID |
|
||||||
| ↳ `name` | string | Assignee name |
|
| ↳ `name` | string | Assignee name |
|
||||||
| ↳ `due_on` | string | Due date |
|
| ↳ `due_on` | string | Due date |
|
||||||
| ↳ `created_at` | string | Creation timestamp |
|
| ↳ `created_at` | string | Creation timestamp |
|
||||||
| ↳ `modified_at` | string | Modified timestamp |
|
| ↳ `modified_at` | string | Modified timestamp |
|
||||||
| `next_page` | object | Pagination info |
|
| `next_page` | object | Pagination info |
|
||||||
| ↳ `offset` | string | Offset token |
|
| ↳ `offset` | string | Offset token |
|
||||||
| ↳ `path` | string | API path |
|
| ↳ `path` | string | API path |
|
||||||
| ↳ `uri` | string | Full URI |
|
| ↳ `uri` | string | Full URI |
|
||||||
|
|
||||||
### `asana_add_comment`
|
### `asana_add_comment`
|
||||||
|
|
||||||
@@ -193,7 +193,7 @@ Add a comment (story) to an Asana task
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `text` | string | Yes | The text content of the comment |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -206,7 +206,7 @@ Add a comment (story) to an Asana task
|
|||||||
| `text` | string | Comment text content |
|
| `text` | string | Comment text content |
|
||||||
| `created_at` | string | Comment creation timestamp |
|
| `created_at` | string | Comment creation timestamp |
|
||||||
| `created_by` | object | Comment author details |
|
| `created_by` | object | Comment author details |
|
||||||
| ↳ `gid` | string | Author GID |
|
| ↳ `gid` | string | Author GID |
|
||||||
| ↳ `name` | string | Author name |
|
| ↳ `name` | string | Author name |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `resource` | object | Current user information |
|
| `resource` | object | Current user information |
|
||||||
| ↳ `uri` | string | Canonical reference to the user |
|
| ↳ `uri` | string | Canonical reference to the user |
|
||||||
| ↳ `name` | string | User full name |
|
| ↳ `name` | string | User full name |
|
||||||
| ↳ `slug` | string | Unique identifier for the user in URLs |
|
| ↳ `slug` | string | Unique identifier for the user in URLs |
|
||||||
| ↳ `email` | string | User email address |
|
| ↳ `email` | string | User email address |
|
||||||
| ↳ `scheduling_url` | string | URL to the user |
|
| ↳ `scheduling_url` | string | URL to the user's scheduling page |
|
||||||
| ↳ `timezone` | string | User timezone |
|
| ↳ `timezone` | string | User timezone |
|
||||||
| ↳ `avatar_url` | string | URL to user avatar image |
|
| ↳ `avatar_url` | string | URL to user avatar image |
|
||||||
| ↳ `created_at` | string | ISO timestamp when user was created |
|
| ↳ `created_at` | string | ISO timestamp when user was created |
|
||||||
| ↳ `updated_at` | string | ISO timestamp when user was last updated |
|
| ↳ `updated_at` | string | ISO timestamp when user was last updated |
|
||||||
| ↳ `current_organization` | string | URI of current organization |
|
| ↳ `current_organization` | string | URI of current organization |
|
||||||
|
|
||||||
### `calendly_list_event_types`
|
### `calendly_list_event_types`
|
||||||
|
|
||||||
@@ -67,11 +67,11 @@ Retrieve a list of all event types for a user or organization
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
||||||
| `user` | string | No | Return only event types that belong to this user \(URI format\) |
|
| `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 \(URI format\) |
|
| `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 \(default: 20, max: 100\) |
|
| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) |
|
||||||
| `pageToken` | string | No | Page token for pagination |
|
| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token |
|
||||||
| `sort` | string | No | Sort order for results \(e.g., "name:asc", "name:desc"\) |
|
| `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\). |
|
| `active` | boolean | No | When true, show only active event types. When false or unchecked, show all event types \(both active and inactive\). |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| ↳ `uri` | string | Canonical reference to the event type |
|
||||||
| ↳ `name` | string | Event type name |
|
| ↳ `name` | string | Event type name |
|
||||||
| ↳ `active` | boolean | Whether the event type is active |
|
| ↳ `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 |
|
| ↳ `color` | string | Hex color code |
|
||||||
| ↳ `created_at` | string | ISO timestamp of creation |
|
| ↳ `created_at` | string | ISO timestamp of creation |
|
||||||
| ↳ `description_html` | string | HTML formatted description |
|
| ↳ `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 |
|
| ↳ `type` | string | Event type classification |
|
||||||
| ↳ `updated_at` | string | ISO timestamp of last update |
|
| ↳ `updated_at` | string | ISO timestamp of last update |
|
||||||
| `pagination` | object | Pagination information |
|
| `pagination` | object | Pagination information |
|
||||||
| ↳ `count` | number | Number of results in this page |
|
| ↳ `count` | number | Number of results in this page |
|
||||||
| ↳ `next_page` | string | URL to next page \(if available\) |
|
| ↳ `next_page` | string | URL to next page \(if available\) |
|
||||||
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
||||||
| ↳ `next_page_token` | string | Token for next page |
|
| ↳ `next_page_token` | string | Token for next page |
|
||||||
| ↳ `previous_page_token` | string | Token for previous page |
|
| ↳ `previous_page_token` | string | Token for previous page |
|
||||||
|
|
||||||
### `calendly_get_event_type`
|
### `calendly_get_event_type`
|
||||||
|
|
||||||
@@ -108,33 +108,33 @@ Get detailed information about a specific event type
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `resource` | object | Event type details |
|
| `resource` | object | Event type details |
|
||||||
| ↳ `uri` | string | Canonical reference to the event type |
|
| ↳ `uri` | string | Canonical reference to the event type |
|
||||||
| ↳ `name` | string | Event type name |
|
| ↳ `name` | string | Event type name |
|
||||||
| ↳ `active` | boolean | Whether the event type is active |
|
| ↳ `active` | boolean | Whether the event type is active |
|
||||||
| ↳ `booking_method` | string | Booking method |
|
| ↳ `booking_method` | string | Booking method |
|
||||||
| ↳ `color` | string | Hex color code |
|
| ↳ `color` | string | Hex color code |
|
||||||
| ↳ `created_at` | string | ISO timestamp of creation |
|
| ↳ `created_at` | string | ISO timestamp of creation |
|
||||||
| ↳ `custom_questions` | array | Custom questions for invitees |
|
| ↳ `custom_questions` | array | Custom questions for invitees |
|
||||||
| ↳ `name` | string | Question text |
|
| ↳ `name` | string | Question text |
|
||||||
| ↳ `type` | string | Question type \(text, single_select, multi_select, etc.\) |
|
| ↳ `type` | string | Question type \(text, single_select, multi_select, etc.\) |
|
||||||
| ↳ `position` | number | Question order |
|
| ↳ `position` | number | Question order |
|
||||||
| ↳ `enabled` | boolean | Whether question is enabled |
|
| ↳ `enabled` | boolean | Whether question is enabled |
|
||||||
| ↳ `required` | boolean | Whether question is required |
|
| ↳ `required` | boolean | Whether question is required |
|
||||||
| ↳ `answer_choices` | array | Available answer choices |
|
| ↳ `answer_choices` | array | Available answer choices |
|
||||||
| ↳ `description_html` | string | HTML formatted description |
|
| ↳ `description_html` | string | HTML formatted description |
|
||||||
| ↳ `description_plain` | string | Plain text description |
|
| ↳ `description_plain` | string | Plain text description |
|
||||||
| ↳ `duration` | number | Duration in minutes |
|
| ↳ `duration` | number | Duration in minutes |
|
||||||
| ↳ `scheduling_url` | string | URL to scheduling page |
|
| ↳ `scheduling_url` | string | URL to scheduling page |
|
||||||
| ↳ `slug` | string | Unique identifier for URLs |
|
| ↳ `slug` | string | Unique identifier for URLs |
|
||||||
| ↳ `type` | string | Event type classification |
|
| ↳ `type` | string | Event type classification |
|
||||||
| ↳ `updated_at` | string | ISO timestamp of last update |
|
| ↳ `updated_at` | string | ISO timestamp of last update |
|
||||||
|
|
||||||
### `calendly_list_scheduled_events`
|
### `calendly_list_scheduled_events`
|
||||||
|
|
||||||
@@ -145,15 +145,15 @@ Retrieve a list of scheduled events for a user or organization
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
| `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. |
|
| `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 \(URI format\). Either "user" or "organization" must be provided. |
|
| `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 |
|
| `invitee_email` | string | No | Return events where invitee has this email |
|
||||||
| `count` | number | No | Number of results per page \(default: 20, max: 100\) |
|
| `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 \(ISO 8601 format\) |
|
| `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 \(ISO 8601 format\) |
|
| `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 |
|
| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token |
|
||||||
| `sort` | string | No | Sort order for results \(e.g., "start_time:asc", "start_time:desc"\) |
|
| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "start_time:asc", "start_time:desc"\) |
|
||||||
| `status` | string | No | Filter by status \("active" or "canceled"\) |
|
| `status` | string | No | Filter by status. Format: "active" or "canceled" |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -167,21 +167,21 @@ Retrieve a list of scheduled events for a user or organization
|
|||||||
| ↳ `end_time` | string | ISO timestamp of event end |
|
| ↳ `end_time` | string | ISO timestamp of event end |
|
||||||
| ↳ `event_type` | string | URI of the event type |
|
| ↳ `event_type` | string | URI of the event type |
|
||||||
| ↳ `location` | object | Event location details |
|
| ↳ `location` | object | Event location details |
|
||||||
| ↳ `type` | string | Location type \(e.g., |
|
| ↳ `type` | string | Location type \(e.g., "zoom", "google_meet", "physical"\) |
|
||||||
| ↳ `location` | string | Location description |
|
| ↳ `location` | string | Location description |
|
||||||
| ↳ `join_url` | string | URL to join online meeting \(if applicable\) |
|
| ↳ `join_url` | string | URL to join online meeting \(if applicable\) |
|
||||||
| ↳ `invitees_counter` | object | Invitee count information |
|
| ↳ `invitees_counter` | object | Invitee count information |
|
||||||
| ↳ `total` | number | Total number of invitees |
|
| ↳ `total` | number | Total number of invitees |
|
||||||
| ↳ `active` | number | Number of active invitees |
|
| ↳ `active` | number | Number of active invitees |
|
||||||
| ↳ `limit` | number | Maximum number of invitees |
|
| ↳ `limit` | number | Maximum number of invitees |
|
||||||
| ↳ `created_at` | string | ISO timestamp of event creation |
|
| ↳ `created_at` | string | ISO timestamp of event creation |
|
||||||
| ↳ `updated_at` | string | ISO timestamp of last update |
|
| ↳ `updated_at` | string | ISO timestamp of last update |
|
||||||
| `pagination` | object | Pagination information |
|
| `pagination` | object | Pagination information |
|
||||||
| ↳ `count` | number | Number of results in this page |
|
| ↳ `count` | number | Number of results in this page |
|
||||||
| ↳ `next_page` | string | URL to next page \(if available\) |
|
| ↳ `next_page` | string | URL to next page \(if available\) |
|
||||||
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
||||||
| ↳ `next_page_token` | string | Token for next page |
|
| ↳ `next_page_token` | string | Token for next page |
|
||||||
| ↳ `previous_page_token` | string | Token for previous page |
|
| ↳ `previous_page_token` | string | Token for previous page |
|
||||||
|
|
||||||
### `calendly_get_scheduled_event`
|
### `calendly_get_scheduled_event`
|
||||||
|
|
||||||
@@ -192,37 +192,37 @@ Get detailed information about a specific scheduled event
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `resource` | object | Scheduled event details |
|
| `resource` | object | Scheduled event details |
|
||||||
| ↳ `uri` | string | Canonical reference to the event |
|
| ↳ `uri` | string | Canonical reference to the event |
|
||||||
| ↳ `name` | string | Event name |
|
| ↳ `name` | string | Event name |
|
||||||
| ↳ `status` | string | Event status \(active or canceled\) |
|
| ↳ `status` | string | Event status \(active or canceled\) |
|
||||||
| ↳ `start_time` | string | ISO timestamp of event start |
|
| ↳ `start_time` | string | ISO timestamp of event start |
|
||||||
| ↳ `end_time` | string | ISO timestamp of event end |
|
| ↳ `end_time` | string | ISO timestamp of event end |
|
||||||
| ↳ `event_type` | string | URI of the event type |
|
| ↳ `event_type` | string | URI of the event type |
|
||||||
| ↳ `location` | object | Event location details |
|
| ↳ `location` | object | Event location details |
|
||||||
| ↳ `type` | string | Location type |
|
| ↳ `type` | string | Location type |
|
||||||
| ↳ `location` | string | Location description |
|
| ↳ `location` | string | Location description |
|
||||||
| ↳ `join_url` | string | URL to join online meeting |
|
| ↳ `join_url` | string | URL to join online meeting |
|
||||||
| ↳ `invitees_counter` | object | Invitee count information |
|
| ↳ `invitees_counter` | object | Invitee count information |
|
||||||
| ↳ `total` | number | Total number of invitees |
|
| ↳ `total` | number | Total number of invitees |
|
||||||
| ↳ `active` | number | Number of active invitees |
|
| ↳ `active` | number | Number of active invitees |
|
||||||
| ↳ `limit` | number | Maximum number of invitees |
|
| ↳ `limit` | number | Maximum number of invitees |
|
||||||
| ↳ `event_memberships` | array | Event hosts/members |
|
| ↳ `event_memberships` | array | Event hosts/members |
|
||||||
| ↳ `user` | string | User URI |
|
| ↳ `user` | string | User URI |
|
||||||
| ↳ `user_email` | string | User email |
|
| ↳ `user_email` | string | User email |
|
||||||
| ↳ `user_name` | string | User name |
|
| ↳ `user_name` | string | User name |
|
||||||
| ↳ `event_guests` | array | Additional guests |
|
| ↳ `event_guests` | array | Additional guests |
|
||||||
| ↳ `email` | string | Guest email |
|
| ↳ `email` | string | Guest email |
|
||||||
| ↳ `created_at` | string | When guest was added |
|
| ↳ `created_at` | string | When guest was added |
|
||||||
| ↳ `updated_at` | string | When guest info was updated |
|
| ↳ `updated_at` | string | When guest info was updated |
|
||||||
| ↳ `created_at` | string | ISO timestamp of event creation |
|
| ↳ `created_at` | string | ISO timestamp of event creation |
|
||||||
| ↳ `updated_at` | string | ISO timestamp of last update |
|
| ↳ `updated_at` | string | ISO timestamp of last update |
|
||||||
|
|
||||||
### `calendly_list_event_invitees`
|
### `calendly_list_event_invitees`
|
||||||
|
|
||||||
@@ -233,12 +233,12 @@ Retrieve a list of invitees for a scheduled event
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
| `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"\) |
|
||||||
| `count` | number | No | Number of results per page \(default: 20, max: 100\) |
|
| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) |
|
||||||
| `email` | string | No | Filter invitees by email address |
|
| `email` | string | No | Filter invitees by email address |
|
||||||
| `pageToken` | string | No | Page token for pagination |
|
| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token |
|
||||||
| `sort` | string | No | Sort order for results \(e.g., "created_at:asc", "created_at:desc"\) |
|
| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "created_at:asc", "created_at:desc"\) |
|
||||||
| `status` | string | No | Filter by status \("active" or "canceled"\) |
|
| `status` | string | No | Filter by status. Format: "active" or "canceled" |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -252,9 +252,9 @@ Retrieve a list of invitees for a scheduled event
|
|||||||
| ↳ `last_name` | string | Invitee last name |
|
| ↳ `last_name` | string | Invitee last name |
|
||||||
| ↳ `status` | string | Invitee status \(active or canceled\) |
|
| ↳ `status` | string | Invitee status \(active or canceled\) |
|
||||||
| ↳ `questions_and_answers` | array | Responses to custom questions |
|
| ↳ `questions_and_answers` | array | Responses to custom questions |
|
||||||
| ↳ `question` | string | Question text |
|
| ↳ `question` | string | Question text |
|
||||||
| ↳ `answer` | string | Invitee answer |
|
| ↳ `answer` | string | Invitee answer |
|
||||||
| ↳ `position` | number | Question order |
|
| ↳ `position` | number | Question order |
|
||||||
| ↳ `timezone` | string | Invitee timezone |
|
| ↳ `timezone` | string | Invitee timezone |
|
||||||
| ↳ `event` | string | URI of the scheduled event |
|
| ↳ `event` | string | URI of the scheduled event |
|
||||||
| ↳ `created_at` | string | ISO timestamp when invitee was created |
|
| ↳ `created_at` | string | ISO timestamp when invitee was created |
|
||||||
@@ -263,11 +263,11 @@ Retrieve a list of invitees for a scheduled event
|
|||||||
| ↳ `reschedule_url` | string | URL to reschedule the booking |
|
| ↳ `reschedule_url` | string | URL to reschedule the booking |
|
||||||
| ↳ `rescheduled` | boolean | Whether invitee rescheduled |
|
| ↳ `rescheduled` | boolean | Whether invitee rescheduled |
|
||||||
| `pagination` | object | Pagination information |
|
| `pagination` | object | Pagination information |
|
||||||
| ↳ `count` | number | Number of results in this page |
|
| ↳ `count` | number | Number of results in this page |
|
||||||
| ↳ `next_page` | string | URL to next page \(if available\) |
|
| ↳ `next_page` | string | URL to next page \(if available\) |
|
||||||
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
| ↳ `previous_page` | string | URL to previous page \(if available\) |
|
||||||
| ↳ `next_page_token` | string | Token for next page |
|
| ↳ `next_page_token` | string | Token for next page |
|
||||||
| ↳ `previous_page_token` | string | Token for previous page |
|
| ↳ `previous_page_token` | string | Token for previous page |
|
||||||
|
|
||||||
### `calendly_cancel_event`
|
### `calendly_cancel_event`
|
||||||
|
|
||||||
@@ -278,7 +278,7 @@ Cancel a scheduled event
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Calendly Personal Access Token |
|
| `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\) |
|
| `reason` | string | No | Reason for cancellation \(will be sent to invitees\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -286,9 +286,9 @@ Cancel a scheduled event
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `resource` | object | Cancellation details |
|
| `resource` | object | Cancellation details |
|
||||||
| ↳ `canceler_type` | string | Type of canceler \(host or invitee\) |
|
| ↳ `canceler_type` | string | Type of canceler \(host or invitee\) |
|
||||||
| ↳ `canceled_by` | string | Name of person who canceled |
|
| ↳ `canceled_by` | string | Name of person who canceled |
|
||||||
| ↳ `reason` | string | Cancellation reason |
|
| ↳ `reason` | string | Cancellation reason |
|
||||||
| ↳ `created_at` | string | ISO timestamp when event was canceled |
|
| ↳ `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 |
|
| `data` | json | Response data from Clay webhook |
|
||||||
| `metadata` | object | Webhook response metadata |
|
| `metadata` | object | Webhook response metadata |
|
||||||
| ↳ `status` | number | HTTP status code |
|
| ↳ `status` | number | HTTP status code |
|
||||||
| ↳ `statusText` | string | HTTP status text |
|
| ↳ `statusText` | string | HTTP status text |
|
||||||
| ↳ `headers` | object | Response headers from Clay |
|
| ↳ `headers` | object | Response headers from Clay |
|
||||||
| ↳ `timestamp` | string | ISO timestamp when webhook was received |
|
| ↳ `timestamp` | string | ISO timestamp when webhook was received |
|
||||||
| ↳ `contentType` | string | Content type of the response |
|
| ↳ `contentType` | string | Content type of the response |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -43,15 +43,15 @@ List all users in your Clerk application with optional filtering and pagination
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||||
| `limit` | number | No | Number of results per page \(1-500, default: 10\) |
|
| `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 |
|
| `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\) |
|
| `orderBy` | string | No | Sort field with optional +/- prefix for direction \(default: -created_at\) |
|
||||||
| `emailAddress` | string | No | Filter by email address \(comma-separated for multiple\) |
|
| `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\) |
|
| `phoneNumber` | string | No | Filter by phone number \(comma-separated for multiple\) |
|
||||||
| `externalId` | string | No | Filter by external ID \(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\) |
|
| `username` | string | No | Filter by username \(comma-separated for multiple\) |
|
||||||
| `userId` | string | No | Filter by user ID \(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 |
|
| `query` | string | No | Search query to match across email, phone, username, and names \(e.g., john or john@example.com\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -67,11 +67,11 @@ List all users in your Clerk application with optional filtering and pagination
|
|||||||
| ↳ `primaryEmailAddressId` | string | Primary email address ID |
|
| ↳ `primaryEmailAddressId` | string | Primary email address ID |
|
||||||
| ↳ `primaryPhoneNumberId` | string | Primary phone number ID |
|
| ↳ `primaryPhoneNumberId` | string | Primary phone number ID |
|
||||||
| ↳ `emailAddresses` | array | User email addresses |
|
| ↳ `emailAddresses` | array | User email addresses |
|
||||||
| ↳ `id` | string | Email address ID |
|
| ↳ `id` | string | Email address ID |
|
||||||
| ↳ `emailAddress` | string | Email address |
|
| ↳ `emailAddress` | string | Email address |
|
||||||
| ↳ `phoneNumbers` | array | User phone numbers |
|
| ↳ `phoneNumbers` | array | User phone numbers |
|
||||||
| ↳ `id` | string | Phone number ID |
|
| ↳ `id` | string | Phone number ID |
|
||||||
| ↳ `phoneNumber` | string | Phone number |
|
| ↳ `phoneNumber` | string | Phone number |
|
||||||
| ↳ `externalId` | string | External system ID |
|
| ↳ `externalId` | string | External system ID |
|
||||||
| ↳ `passwordEnabled` | boolean | Whether password is enabled |
|
| ↳ `passwordEnabled` | boolean | Whether password is enabled |
|
||||||
| ↳ `twoFactorEnabled` | boolean | Whether 2FA is enabled |
|
| ↳ `twoFactorEnabled` | boolean | Whether 2FA is enabled |
|
||||||
@@ -94,7 +94,7 @@ Retrieve a single user by their ID from Clerk
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||||
| `userId` | string | Yes | The ID of the user to retrieve |
|
| `userId` | string | Yes | The ID of the user to retrieve \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -191,7 +191,7 @@ Update an existing user in your Clerk application
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||||
| `userId` | string | Yes | The ID of the user to update |
|
| `userId` | string | Yes | The ID of the user to update \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||||
| `firstName` | string | No | First name of the user |
|
| `firstName` | string | No | First name of the user |
|
||||||
| `lastName` | string | No | Last name of the user |
|
| `lastName` | string | No | Last name of the user |
|
||||||
| `username` | string | No | Username \(must be unique\) |
|
| `username` | string | No | Username \(must be unique\) |
|
||||||
@@ -240,7 +240,7 @@ Delete a user from your Clerk application
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||||
| `userId` | string | Yes | The ID of the user to delete |
|
| `userId` | string | Yes | The ID of the user to delete \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -260,10 +260,10 @@ List all organizations in your Clerk application with optional filtering
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||||
| `limit` | number | No | Number of results per page \(1-500, default: 10\) |
|
| `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 |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) |
|
||||||
| `includeMembersCount` | boolean | No | Include member count for each organization |
|
| `includeMembersCount` | boolean | No | Include member count for each organization |
|
||||||
| `query` | string | No | Search by organization ID, name, or slug |
|
| `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 |
|
| `orderBy` | string | No | Sort field \(name, created_at, members_count\) with +/- prefix |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -296,7 +296,7 @@ Retrieve a single organization by ID or slug from Clerk
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||||
| `organizationId` | string | Yes | The ID or slug of the organization to retrieve |
|
| `organizationId` | string | Yes | The ID or slug of the organization to retrieve \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC or my-org-slug\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -327,7 +327,7 @@ Create a new organization in your Clerk application
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||||
| `name` | string | Yes | Name of the organization |
|
| `name` | string | Yes | Name of the organization |
|
||||||
| `createdBy` | string | Yes | User ID of the creator \(will become admin\) |
|
| `createdBy` | string | Yes | User ID of the creator who will become admin \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||||
| `slug` | string | No | Slug identifier for the organization |
|
| `slug` | string | No | Slug identifier for the organization |
|
||||||
| `maxAllowedMemberships` | number | No | Maximum member capacity \(0 for unlimited\) |
|
| `maxAllowedMemberships` | number | No | Maximum member capacity \(0 for unlimited\) |
|
||||||
| `publicMetadata` | json | No | Public metadata \(JSON object\) |
|
| `publicMetadata` | json | No | Public metadata \(JSON object\) |
|
||||||
@@ -361,11 +361,11 @@ List sessions for a user or client in your Clerk application
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||||
| `userId` | string | No | User ID to list sessions for \(required if clientId not provided\) |
|
| `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\) |
|
| `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\) |
|
| `status` | string | No | Filter by session status \(abandoned, active, ended, expired, pending, removed, replaced, revoked\) |
|
||||||
| `limit` | number | No | Number of results per page \(1-500, default: 10\) |
|
| `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 |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -394,7 +394,7 @@ Retrieve a single session by ID from Clerk
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||||
| `sessionId` | string | Yes | The ID of the session to retrieve |
|
| `sessionId` | string | Yes | The ID of the session to retrieve \(e.g., sess_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -421,7 +421,7 @@ Revoke a session to immediately invalidate it
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
|
||||||
| `sessionId` | string | Yes | The ID of the session to revoke |
|
| `sessionId` | string | Yes | The ID of the session to revoke \(e.g., sess_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ Retrieve content from Confluence pages using the Confluence API.
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
|
| `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. |
|
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -63,7 +63,7 @@ Update a Confluence page using the Confluence API.
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
|
| `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 |
|
| `title` | string | No | New title for the page |
|
||||||
| `content` | string | No | New content for the page in Confluence storage format |
|
| `content` | string | No | New content for the page in Confluence storage format |
|
||||||
| `version` | number | No | Version number of the page \(required for preventing conflicts\) |
|
| `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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `ts` | string | Timestamp of search |
|
| `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`
|
### `confluence_create_comment`
|
||||||
|
|
||||||
@@ -180,8 +193,25 @@ List all comments on a Confluence page.
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `ts` | string | Timestamp of retrieval |
|
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||||
| `comments` | array | List of comments |
|
| `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`
|
### `confluence_update_comment`
|
||||||
|
|
||||||
@@ -268,8 +298,24 @@ List all attachments on a Confluence page.
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `ts` | string | Timestamp of retrieval |
|
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||||
| `attachments` | array | List of attachments |
|
| `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`
|
### `confluence_delete_attachment`
|
||||||
|
|
||||||
@@ -308,7 +354,10 @@ List all labels on a Confluence page.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `ts` | string | Timestamp of retrieval |
|
| `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`
|
### `confluence_get_space`
|
||||||
|
|
||||||
@@ -350,7 +399,18 @@ List all Confluence spaces accessible to the user.
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `ts` | string | Timestamp of retrieval |
|
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||||
| `spaces` | array | List of spaces |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | Yes | Datadog metrics query \(e.g., "avg:system.cpu.user\{*\}"\) |
|
| `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 |
|
| `from` | number | Yes | Start time as Unix timestamp in seconds \(e.g., 1705320000\) |
|
||||||
| `to` | number | Yes | End time as Unix timestamp in seconds |
|
| `to` | number | Yes | End time as Unix timestamp in seconds \(e.g., 1705323600\) |
|
||||||
| `apiKey` | string | Yes | Datadog API key |
|
| `apiKey` | string | Yes | Datadog API key |
|
||||||
| `applicationKey` | string | Yes | Datadog Application key |
|
| `applicationKey` | string | Yes | Datadog Application key |
|
||||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
| `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. |
|
| `text` | string | Yes | Event body/description. Supports markdown. |
|
||||||
| `alertType` | string | No | Alert type: error, warning, info, success, user_update, recommendation, or snapshot |
|
| `alertType` | string | No | Alert type: error, warning, info, success, user_update, recommendation, or snapshot |
|
||||||
| `priority` | string | No | Event priority: normal or low |
|
| `priority` | string | No | Event priority: normal or low |
|
||||||
| `host` | string | No | Host name to associate with this event |
|
| `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"\) |
|
| `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 |
|
| `aggregationKey` | string | No | Key to aggregate events together |
|
||||||
| `sourceTypeName` | string | No | Source type name for the event |
|
| `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 |
|
| `apiKey` | string | Yes | Datadog API key |
|
||||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
| `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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `event` | object | The created event details |
|
| `event` | object | The created event details |
|
||||||
| ↳ `id` | number | Event ID |
|
| ↳ `id` | number | Event ID |
|
||||||
| ↳ `title` | string | Event title |
|
| ↳ `title` | string | Event title |
|
||||||
| ↳ `text` | string | Event text |
|
| ↳ `text` | string | Event text |
|
||||||
| ↳ `date_happened` | number | Unix timestamp when event occurred |
|
| ↳ `date_happened` | number | Unix timestamp when event occurred |
|
||||||
| ↳ `priority` | string | Event priority |
|
| ↳ `priority` | string | Event priority |
|
||||||
| ↳ `alert_type` | string | Alert type |
|
| ↳ `alert_type` | string | Alert type |
|
||||||
| ↳ `host` | string | Associated host |
|
| ↳ `host` | string | Associated host |
|
||||||
| ↳ `tags` | array | Event tags |
|
| ↳ `tags` | array | Event tags |
|
||||||
| ↳ `url` | string | URL to view the event in Datadog |
|
| ↳ `url` | string | URL to view the event in Datadog |
|
||||||
|
|
||||||
### `datadog_create_monitor`
|
### `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 |
|
| `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 |
|
| `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. |
|
| `message` | string | No | Message to include with notifications. Can include @-mentions and markdown. |
|
||||||
| `tags` | string | No | Comma-separated list of tags |
|
| `tags` | string | No | Comma-separated list of tags |
|
||||||
| `priority` | number | No | Monitor priority \(1-5, where 1 is highest\) |
|
| `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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `monitor` | object | The created monitor details |
|
| `monitor` | object | The created monitor details |
|
||||||
| ↳ `id` | number | Monitor ID |
|
| ↳ `id` | number | Monitor ID |
|
||||||
| ↳ `name` | string | Monitor name |
|
| ↳ `name` | string | Monitor name |
|
||||||
| ↳ `type` | string | Monitor type |
|
| ↳ `type` | string | Monitor type |
|
||||||
| ↳ `query` | string | Monitor query |
|
| ↳ `query` | string | Monitor query |
|
||||||
| ↳ `message` | string | Notification message |
|
| ↳ `message` | string | Notification message |
|
||||||
| ↳ `tags` | array | Monitor tags |
|
| ↳ `tags` | array | Monitor tags |
|
||||||
| ↳ `priority` | number | Monitor priority |
|
| ↳ `priority` | number | Monitor priority |
|
||||||
| ↳ `overall_state` | string | Current monitor state |
|
| ↳ `overall_state` | string | Current monitor state |
|
||||||
| ↳ `created` | string | Creation timestamp |
|
| ↳ `created` | string | Creation timestamp |
|
||||||
| ↳ `modified` | string | Last modification timestamp |
|
| ↳ `modified` | string | Last modification timestamp |
|
||||||
|
|
||||||
### `datadog_get_monitor`
|
### `datadog_get_monitor`
|
||||||
|
|
||||||
@@ -152,8 +152,8 @@ Retrieve details of a specific monitor by ID.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `monitorId` | string | Yes | The ID of the monitor to retrieve |
|
| `monitorId` | string | Yes | The ID of the monitor to retrieve \(e.g., "12345678"\) |
|
||||||
| `groupStates` | string | No | Comma-separated group states to include: alert, warn, no data, ok |
|
| `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 |
|
| `withDowntimes` | boolean | No | Include downtime data with the monitor |
|
||||||
| `apiKey` | string | Yes | Datadog API key |
|
| `apiKey` | string | Yes | Datadog API key |
|
||||||
| `applicationKey` | string | Yes | Datadog Application key |
|
| `applicationKey` | string | Yes | Datadog Application key |
|
||||||
@@ -164,16 +164,16 @@ Retrieve details of a specific monitor by ID.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `monitor` | object | The monitor details |
|
| `monitor` | object | The monitor details |
|
||||||
| ↳ `id` | number | Monitor ID |
|
| ↳ `id` | number | Monitor ID |
|
||||||
| ↳ `name` | string | Monitor name |
|
| ↳ `name` | string | Monitor name |
|
||||||
| ↳ `type` | string | Monitor type |
|
| ↳ `type` | string | Monitor type |
|
||||||
| ↳ `query` | string | Monitor query |
|
| ↳ `query` | string | Monitor query |
|
||||||
| ↳ `message` | string | Notification message |
|
| ↳ `message` | string | Notification message |
|
||||||
| ↳ `tags` | array | Monitor tags |
|
| ↳ `tags` | array | Monitor tags |
|
||||||
| ↳ `priority` | number | Monitor priority |
|
| ↳ `priority` | number | Monitor priority |
|
||||||
| ↳ `overall_state` | string | Current monitor state |
|
| ↳ `overall_state` | string | Current monitor state |
|
||||||
| ↳ `created` | string | Creation timestamp |
|
| ↳ `created` | string | Creation timestamp |
|
||||||
| ↳ `modified` | string | Last modification timestamp |
|
| ↳ `modified` | string | Last modification timestamp |
|
||||||
|
|
||||||
### `datadog_list_monitors`
|
### `datadog_list_monitors`
|
||||||
|
|
||||||
@@ -183,13 +183,13 @@ List all monitors in Datadog with optional filtering by name, tags, or state.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `groupStates` | string | No | Comma-separated group states to filter by: alert, warn, no data, ok |
|
| `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 \(partial match\) |
|
| `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 |
|
| `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 |
|
| `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 |
|
| `withDowntimes` | boolean | No | Include downtime data with monitors |
|
||||||
| `page` | number | No | Page number for pagination \(0-indexed\) |
|
| `page` | number | No | Page number for pagination \(0-indexed, e.g., 0, 1, 2\) |
|
||||||
| `pageSize` | number | No | Number of monitors per page \(max 1000\) |
|
| `pageSize` | number | No | Number of monitors per page \(e.g., 50, max: 1000\) |
|
||||||
| `apiKey` | string | Yes | Datadog API key |
|
| `apiKey` | string | Yes | Datadog API key |
|
||||||
| `applicationKey` | string | Yes | Datadog Application key |
|
| `applicationKey` | string | Yes | Datadog Application key |
|
||||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||||
@@ -214,9 +214,9 @@ Mute a monitor to temporarily suppress notifications.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `monitorId` | string | Yes | The ID of the monitor to mute |
|
| `monitorId` | string | Yes | The ID of the monitor to mute \(e.g., "12345678"\) |
|
||||||
| `scope` | string | No | Scope to mute \(e.g., "host:myhost"\). If not specified, mutes all scopes. |
|
| `scope` | string | No | Scope to mute \(e.g., "host:myhost", "env:prod"\). If not specified, mutes all scopes. |
|
||||||
| `end` | number | No | Unix timestamp when the mute should end. If not specified, mutes indefinitely. |
|
| `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 |
|
| `apiKey` | string | Yes | Datadog API key |
|
||||||
| `applicationKey` | string | Yes | Datadog Application key |
|
| `applicationKey` | string | Yes | Datadog Application key |
|
||||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | Yes | Log search query \(e.g., "service:web-app status:error"\) |
|
| `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 \(e.g., "now-1h"\) |
|
| `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 \(e.g., "now"\) |
|
| `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 \(default: 50, max: 1000\) |
|
| `limit` | number | No | Maximum number of logs to return \(e.g., 50, 100, max: 1000\) |
|
||||||
| `sort` | string | No | Sort order: timestamp \(oldest first\) or -timestamp \(newest first\) |
|
| `sort` | string | No | Sort order: "timestamp" for oldest first, "-timestamp" for newest first |
|
||||||
| `indexes` | string | No | Comma-separated list of log indexes to search |
|
| `indexes` | string | No | Comma-separated list of log indexes to search |
|
||||||
| `apiKey` | string | Yes | Datadog API key |
|
| `apiKey` | string | Yes | Datadog API key |
|
||||||
| `applicationKey` | string | Yes | Datadog Application key |
|
| `applicationKey` | string | Yes | Datadog Application key |
|
||||||
@@ -252,11 +252,11 @@ Search and retrieve logs from Datadog. Use for troubleshooting, analysis, or mon
|
|||||||
| `logs` | array | List of log entries |
|
| `logs` | array | List of log entries |
|
||||||
| ↳ `id` | string | Log ID |
|
| ↳ `id` | string | Log ID |
|
||||||
| ↳ `content` | object | Log content |
|
| ↳ `content` | object | Log content |
|
||||||
| ↳ `timestamp` | string | Log timestamp |
|
| ↳ `timestamp` | string | Log timestamp |
|
||||||
| ↳ `host` | string | Host name |
|
| ↳ `host` | string | Host name |
|
||||||
| ↳ `service` | string | Service name |
|
| ↳ `service` | string | Service name |
|
||||||
| ↳ `message` | string | Log message |
|
| ↳ `message` | string | Log message |
|
||||||
| ↳ `status` | string | Log status/level |
|
| ↳ `status` | string | Log status/level |
|
||||||
| `nextLogId` | string | Cursor for pagination |
|
| `nextLogId` | string | Cursor for pagination |
|
||||||
|
|
||||||
### `datadog_send_logs`
|
### `datadog_send_logs`
|
||||||
@@ -287,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\) |
|
| `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 |
|
| `message` | string | No | Message to display during downtime |
|
||||||
| `start` | number | No | Unix timestamp for downtime start \(defaults to now\) |
|
| `start` | number | No | Unix timestamp for downtime start in seconds \(e.g., 1705320000, defaults to now\) |
|
||||||
| `end` | number | No | Unix timestamp for downtime end |
|
| `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"\) |
|
| `timezone` | string | No | Timezone for the downtime \(e.g., "America/New_York", "UTC", "Europe/London"\) |
|
||||||
| `monitorId` | string | No | Specific monitor ID to mute |
|
| `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"\) |
|
| `monitorTags` | string | No | Comma-separated monitor tags to match \(e.g., "team:backend,priority:high"\) |
|
||||||
| `muteFirstRecoveryNotification` | boolean | No | Mute the first recovery notification |
|
| `muteFirstRecoveryNotification` | boolean | No | Mute the first recovery notification |
|
||||||
| `apiKey` | string | Yes | Datadog API key |
|
| `apiKey` | string | Yes | Datadog API key |
|
||||||
@@ -302,12 +302,12 @@ Schedule a downtime to suppress monitor notifications during maintenance windows
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `downtime` | object | The created downtime details |
|
| `downtime` | object | The created downtime details |
|
||||||
| ↳ `id` | number | Downtime ID |
|
| ↳ `id` | number | Downtime ID |
|
||||||
| ↳ `scope` | array | Downtime scope |
|
| ↳ `scope` | array | Downtime scope |
|
||||||
| ↳ `message` | string | Downtime message |
|
| ↳ `message` | string | Downtime message |
|
||||||
| ↳ `start` | number | Start time \(Unix timestamp\) |
|
| ↳ `start` | number | Start time \(Unix timestamp\) |
|
||||||
| ↳ `end` | number | End time \(Unix timestamp\) |
|
| ↳ `end` | number | End time \(Unix timestamp\) |
|
||||||
| ↳ `active` | boolean | Whether downtime is currently active |
|
| ↳ `active` | boolean | Whether downtime is currently active |
|
||||||
|
|
||||||
### `datadog_list_downtimes`
|
### `datadog_list_downtimes`
|
||||||
|
|
||||||
@@ -318,7 +318,7 @@ List all scheduled downtimes in Datadog.
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `currentOnly` | boolean | No | Only return currently active downtimes |
|
| `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 |
|
| `apiKey` | string | Yes | Datadog API key |
|
||||||
| `applicationKey` | string | Yes | Datadog Application key |
|
| `applicationKey` | string | Yes | Datadog Application key |
|
||||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||||
@@ -343,7 +343,7 @@ Cancel a scheduled downtime.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `apiKey` | string | Yes | Datadog API key |
|
||||||
| `applicationKey` | string | Yes | Datadog Application key |
|
| `applicationKey` | string | Yes | Datadog Application key |
|
||||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||||
|
|||||||
@@ -53,9 +53,9 @@ Send a message to a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
| `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 |
|
| `files` | file[] | No | Files to attach to the message |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -64,21 +64,21 @@ Send a message to a Discord channel
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Discord message data |
|
| `data` | object | Discord message data |
|
||||||
| ↳ `id` | string | Message ID |
|
| ↳ `id` | string | Message ID |
|
||||||
| ↳ `content` | string | Message content |
|
| ↳ `content` | string | Message content |
|
||||||
| ↳ `channel_id` | string | Channel ID where message was sent |
|
| ↳ `channel_id` | string | Channel ID where message was sent |
|
||||||
| ↳ `author` | object | Message author information |
|
| ↳ `author` | object | Message author information |
|
||||||
| ↳ `id` | string | Author user ID |
|
| ↳ `id` | string | Author user ID |
|
||||||
| ↳ `username` | string | Author username |
|
| ↳ `username` | string | Author username |
|
||||||
| ↳ `avatar` | string | Author avatar hash |
|
| ↳ `avatar` | string | Author avatar hash |
|
||||||
| ↳ `bot` | boolean | Whether author is a bot |
|
| ↳ `bot` | boolean | Whether author is a bot |
|
||||||
| ↳ `timestamp` | string | Message timestamp |
|
| ↳ `timestamp` | string | Message timestamp |
|
||||||
| ↳ `edited_timestamp` | string | Message edited timestamp |
|
| ↳ `edited_timestamp` | string | Message edited timestamp |
|
||||||
| ↳ `embeds` | array | Message embeds |
|
| ↳ `embeds` | array | Message embeds |
|
||||||
| ↳ `attachments` | array | Message attachments |
|
| ↳ `attachments` | array | Message attachments |
|
||||||
| ↳ `mentions` | array | User mentions in message |
|
| ↳ `mentions` | array | User mentions in message |
|
||||||
| ↳ `mention_roles` | array | Role mentions in message |
|
| ↳ `mention_roles` | array | Role mentions in message |
|
||||||
| ↳ `mention_everyone` | boolean | Whether message mentions everyone |
|
| ↳ `mention_everyone` | boolean | Whether message mentions everyone |
|
||||||
|
|
||||||
### `discord_get_messages`
|
### `discord_get_messages`
|
||||||
|
|
||||||
@@ -89,7 +89,7 @@ Retrieve messages from a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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\) |
|
| `limit` | number | No | Maximum number of messages to retrieve \(default: 10, max: 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -98,23 +98,23 @@ Retrieve messages from a Discord channel
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Container for messages data |
|
| `data` | object | Container for messages data |
|
||||||
| ↳ `messages` | array | Array of Discord messages with full metadata |
|
| ↳ `messages` | array | Array of Discord messages with full metadata |
|
||||||
| ↳ `id` | string | Message ID |
|
| ↳ `id` | string | Message ID |
|
||||||
| ↳ `content` | string | Message content |
|
| ↳ `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 |
|
| ↳ `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 |
|
|
||||||
|
|
||||||
### `discord_get_server`
|
### `discord_get_server`
|
||||||
|
|
||||||
@@ -125,7 +125,7 @@ Retrieve information about a Discord server (guild)
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -133,14 +133,14 @@ Retrieve information about a Discord server (guild)
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Discord server \(guild\) information |
|
| `data` | object | Discord server \(guild\) information |
|
||||||
| ↳ `id` | string | Server ID |
|
| ↳ `id` | string | Server ID |
|
||||||
| ↳ `name` | string | Server name |
|
| ↳ `name` | string | Server name |
|
||||||
| ↳ `icon` | string | Server icon hash |
|
| ↳ `icon` | string | Server icon hash |
|
||||||
| ↳ `description` | string | Server description |
|
| ↳ `description` | string | Server description |
|
||||||
| ↳ `owner_id` | string | Server owner user ID |
|
| ↳ `owner_id` | string | Server owner user ID |
|
||||||
| ↳ `roles` | array | Server roles |
|
| ↳ `roles` | array | Server roles |
|
||||||
| ↳ `channels` | array | Server channels |
|
| ↳ `channels` | array | Server channels |
|
||||||
| ↳ `member_count` | number | Number of members in server |
|
| ↳ `member_count` | number | Number of members in server |
|
||||||
|
|
||||||
### `discord_get_user`
|
### `discord_get_user`
|
||||||
|
|
||||||
@@ -151,7 +151,7 @@ Retrieve information about a Discord user
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | Discord bot token for authentication |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -159,14 +159,14 @@ Retrieve information about a Discord user
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Discord user information |
|
| `data` | object | Discord user information |
|
||||||
| ↳ `id` | string | User ID |
|
| ↳ `id` | string | User ID |
|
||||||
| ↳ `username` | string | Username |
|
| ↳ `username` | string | Username |
|
||||||
| ↳ `discriminator` | string | User discriminator \(4-digit number\) |
|
| ↳ `discriminator` | string | User discriminator \(4-digit number\) |
|
||||||
| ↳ `avatar` | string | User avatar hash |
|
| ↳ `avatar` | string | User avatar hash |
|
||||||
| ↳ `bot` | boolean | Whether user is a bot |
|
| ↳ `bot` | boolean | Whether user is a bot |
|
||||||
| ↳ `system` | boolean | Whether user is a system user |
|
| ↳ `system` | boolean | Whether user is a system user |
|
||||||
| ↳ `email` | string | User email \(if available\) |
|
| ↳ `email` | string | User email \(if available\) |
|
||||||
| ↳ `verified` | boolean | Whether user email is verified |
|
| ↳ `verified` | boolean | Whether user email is verified |
|
||||||
|
|
||||||
### `discord_edit_message`
|
### `discord_edit_message`
|
||||||
|
|
||||||
@@ -177,10 +177,10 @@ Edit an existing message in a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||||
| `messageId` | string | Yes | The ID of the message to edit |
|
| `messageId` | string | Yes | The ID of the message to edit, e.g., 123456789012345678 |
|
||||||
| `content` | string | No | The new text content for the message |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -188,10 +188,10 @@ Edit an existing message in a Discord channel
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Updated Discord message data |
|
| `data` | object | Updated Discord message data |
|
||||||
| ↳ `id` | string | Message ID |
|
| ↳ `id` | string | Message ID |
|
||||||
| ↳ `content` | string | Updated message content |
|
| ↳ `content` | string | Updated message content |
|
||||||
| ↳ `channel_id` | string | Channel ID |
|
| ↳ `channel_id` | string | Channel ID |
|
||||||
| ↳ `edited_timestamp` | string | Message edited timestamp |
|
| ↳ `edited_timestamp` | string | Message edited timestamp |
|
||||||
|
|
||||||
### `discord_delete_message`
|
### `discord_delete_message`
|
||||||
|
|
||||||
@@ -202,9 +202,9 @@ Delete a message from a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||||
| `messageId` | string | Yes | The ID of the message to delete |
|
| `messageId` | string | Yes | The ID of the message to delete, e.g., 123456789012345678 |
|
||||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -221,10 +221,10 @@ Add a reaction emoji to a Discord message
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||||
| `messageId` | string | Yes | The ID of the message to react to |
|
| `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\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -241,11 +241,11 @@ Remove a reaction from a Discord message
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||||
| `messageId` | string | Yes | The ID of the message with the reaction |
|
| `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\) |
|
| `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\) |
|
| `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\) |
|
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -262,9 +262,9 @@ Pin a message in a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||||
| `messageId` | string | Yes | The ID of the message to pin |
|
| `messageId` | string | Yes | The ID of the message to pin, e.g., 123456789012345678 |
|
||||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -281,9 +281,9 @@ Unpin a message in a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `channelId` | string | Yes | The Discord channel ID containing the message |
|
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 |
|
||||||
| `messageId` | string | Yes | The ID of the message to unpin |
|
| `messageId` | string | Yes | The ID of the message to unpin, e.g., 123456789012345678 |
|
||||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -300,11 +300,11 @@ Create a thread in a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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\) |
|
| `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\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -312,11 +312,11 @@ Create a thread in a Discord channel
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Created thread data |
|
| `data` | object | Created thread data |
|
||||||
| ↳ `id` | string | Thread ID |
|
| ↳ `id` | string | Thread ID |
|
||||||
| ↳ `name` | string | Thread name |
|
| ↳ `name` | string | Thread name |
|
||||||
| ↳ `type` | number | Thread channel type |
|
| ↳ `type` | number | Thread channel type |
|
||||||
| ↳ `guild_id` | string | Server ID |
|
| ↳ `guild_id` | string | Server ID |
|
||||||
| ↳ `parent_id` | string | Parent channel ID |
|
| ↳ `parent_id` | string | Parent channel ID |
|
||||||
|
|
||||||
### `discord_join_thread`
|
### `discord_join_thread`
|
||||||
|
|
||||||
@@ -327,8 +327,8 @@ Join a thread in Discord
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `threadId` | string | Yes | The thread ID to join |
|
| `threadId` | string | Yes | The thread ID to join, e.g., 123456789012345678 |
|
||||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -345,8 +345,8 @@ Leave a thread in Discord
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `threadId` | string | Yes | The thread ID to leave |
|
| `threadId` | string | Yes | The thread ID to leave, e.g., 123456789012345678 |
|
||||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -363,9 +363,9 @@ Archive or unarchive a thread in Discord
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -373,8 +373,8 @@ Archive or unarchive a thread in Discord
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Updated thread data |
|
| `data` | object | Updated thread data |
|
||||||
| ↳ `id` | string | Thread ID |
|
| ↳ `id` | string | Thread ID |
|
||||||
| ↳ `archived` | boolean | Whether thread is archived |
|
| ↳ `archived` | boolean | Whether thread is archived |
|
||||||
|
|
||||||
### `discord_create_channel`
|
### `discord_create_channel`
|
||||||
|
|
||||||
@@ -385,11 +385,11 @@ Create a new channel in a Discord server
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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\) |
|
| `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\) |
|
| `type` | number | No | Channel type \(0=text, 2=voice, 4=category, 5=announcement, 13=stage\) |
|
||||||
| `topic` | string | No | Channel topic \(0-1024 characters\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -397,10 +397,10 @@ Create a new channel in a Discord server
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Created channel data |
|
| `data` | object | Created channel data |
|
||||||
| ↳ `id` | string | Channel ID |
|
| ↳ `id` | string | Channel ID |
|
||||||
| ↳ `name` | string | Channel name |
|
| ↳ `name` | string | Channel name |
|
||||||
| ↳ `type` | number | Channel type |
|
| ↳ `type` | number | Channel type |
|
||||||
| ↳ `guild_id` | string | Server ID |
|
| ↳ `guild_id` | string | Server ID |
|
||||||
|
|
||||||
### `discord_update_channel`
|
### `discord_update_channel`
|
||||||
|
|
||||||
@@ -411,10 +411,10 @@ Update a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
| `name` | string | No | The new name for the channel |
|
||||||
| `topic` | string | No | The new topic 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
|
#### Output
|
||||||
|
|
||||||
@@ -422,10 +422,10 @@ Update a Discord channel
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Updated channel data |
|
| `data` | object | Updated channel data |
|
||||||
| ↳ `id` | string | Channel ID |
|
| ↳ `id` | string | Channel ID |
|
||||||
| ↳ `name` | string | Channel name |
|
| ↳ `name` | string | Channel name |
|
||||||
| ↳ `type` | number | Channel type |
|
| ↳ `type` | number | Channel type |
|
||||||
| ↳ `topic` | string | Channel topic |
|
| ↳ `topic` | string | Channel topic |
|
||||||
|
|
||||||
### `discord_delete_channel`
|
### `discord_delete_channel`
|
||||||
|
|
||||||
@@ -436,8 +436,8 @@ Delete a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `channelId` | string | Yes | The Discord channel ID to delete |
|
| `channelId` | string | Yes | The Discord channel ID to delete, e.g., 123456789012345678 |
|
||||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -454,8 +454,8 @@ Get information about a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `channelId` | string | Yes | The Discord channel ID to retrieve |
|
| `channelId` | string | Yes | The Discord channel ID to retrieve, e.g., 123456789012345678 |
|
||||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -463,11 +463,11 @@ Get information about a Discord channel
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Channel data |
|
| `data` | object | Channel data |
|
||||||
| ↳ `id` | string | Channel ID |
|
| ↳ `id` | string | Channel ID |
|
||||||
| ↳ `name` | string | Channel name |
|
| ↳ `name` | string | Channel name |
|
||||||
| ↳ `type` | number | Channel type |
|
| ↳ `type` | number | Channel type |
|
||||||
| ↳ `topic` | string | Channel topic |
|
| ↳ `topic` | string | Channel topic |
|
||||||
| ↳ `guild_id` | string | Server ID |
|
| ↳ `guild_id` | string | Server ID |
|
||||||
|
|
||||||
### `discord_create_role`
|
### `discord_create_role`
|
||||||
|
|
||||||
@@ -478,7 +478,7 @@ Create a new role in a Discord server
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
| `name` | string | Yes | The name of the role |
|
||||||
| `color` | number | No | RGB color value as integer \(e.g., 0xFF0000 for red\) |
|
| `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 |
|
| `hoist` | boolean | No | Whether to display role members separately from online members |
|
||||||
@@ -490,11 +490,11 @@ Create a new role in a Discord server
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Created role data |
|
| `data` | object | Created role data |
|
||||||
| ↳ `id` | string | Role ID |
|
| ↳ `id` | string | Role ID |
|
||||||
| ↳ `name` | string | Role name |
|
| ↳ `name` | string | Role name |
|
||||||
| ↳ `color` | number | Role color |
|
| ↳ `color` | number | Role color |
|
||||||
| ↳ `hoist` | boolean | Whether role is hoisted |
|
| ↳ `hoist` | boolean | Whether role is hoisted |
|
||||||
| ↳ `mentionable` | boolean | Whether role is mentionable |
|
| ↳ `mentionable` | boolean | Whether role is mentionable |
|
||||||
|
|
||||||
### `discord_update_role`
|
### `discord_update_role`
|
||||||
|
|
||||||
@@ -505,8 +505,8 @@ Update a role in a Discord server
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
||||||
| `roleId` | string | Yes | The role ID to update |
|
| `roleId` | string | Yes | The role ID to update, e.g., 123456789012345678 |
|
||||||
| `name` | string | No | The new name for the role |
|
| `name` | string | No | The new name for the role |
|
||||||
| `color` | number | No | RGB color value as integer |
|
| `color` | number | No | RGB color value as integer |
|
||||||
| `hoist` | boolean | No | Whether to display role members separately |
|
| `hoist` | boolean | No | Whether to display role members separately |
|
||||||
@@ -518,9 +518,9 @@ Update a role in a Discord server
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Updated role data |
|
| `data` | object | Updated role data |
|
||||||
| ↳ `id` | string | Role ID |
|
| ↳ `id` | string | Role ID |
|
||||||
| ↳ `name` | string | Role name |
|
| ↳ `name` | string | Role name |
|
||||||
| ↳ `color` | number | Role color |
|
| ↳ `color` | number | Role color |
|
||||||
|
|
||||||
### `discord_delete_role`
|
### `discord_delete_role`
|
||||||
|
|
||||||
@@ -531,8 +531,8 @@ Delete a role from a Discord server
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
||||||
| `roleId` | string | Yes | The role ID to delete |
|
| `roleId` | string | Yes | The role ID to delete, e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -549,9 +549,9 @@ Assign a role to a member in a Discord server
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
||||||
| `userId` | string | Yes | The user ID to assign the role to |
|
| `userId` | string | Yes | The user ID to assign the role to, e.g., 123456789012345678 |
|
||||||
| `roleId` | string | Yes | The role ID to assign |
|
| `roleId` | string | Yes | The role ID to assign, e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -568,9 +568,9 @@ Remove a role from a member in a Discord server
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
||||||
| `userId` | string | Yes | The user ID to remove the role from |
|
| `userId` | string | Yes | The user ID to remove the role from, e.g., 123456789012345678 |
|
||||||
| `roleId` | string | Yes | The role ID to remove |
|
| `roleId` | string | Yes | The role ID to remove, e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -587,8 +587,8 @@ Kick a member from a Discord server
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
||||||
| `userId` | string | Yes | The user ID to kick |
|
| `userId` | string | Yes | The user ID to kick, e.g., 123456789012345678 |
|
||||||
| `reason` | string | No | Reason for kicking the member |
|
| `reason` | string | No | Reason for kicking the member |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -606,8 +606,8 @@ Ban a member from a Discord server
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
||||||
| `userId` | string | Yes | The user ID to ban |
|
| `userId` | string | Yes | The user ID to ban, e.g., 123456789012345678 |
|
||||||
| `reason` | string | No | Reason for banning the member |
|
| `reason` | string | No | Reason for banning the member |
|
||||||
| `deleteMessageDays` | number | No | Number of days to delete messages for \(0-7\) |
|
| `deleteMessageDays` | number | No | Number of days to delete messages for \(0-7\) |
|
||||||
|
|
||||||
@@ -626,8 +626,8 @@ Unban a member from a Discord server
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
||||||
| `userId` | string | Yes | The user ID to unban |
|
| `userId` | string | Yes | The user ID to unban, e.g., 123456789012345678 |
|
||||||
| `reason` | string | No | Reason for unbanning the member |
|
| `reason` | string | No | Reason for unbanning the member |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -645,8 +645,8 @@ Get information about a member in a Discord server
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
||||||
| `userId` | string | Yes | The user ID to retrieve |
|
| `userId` | string | Yes | The user ID to retrieve, e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -654,13 +654,13 @@ Get information about a member in a Discord server
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Member data |
|
| `data` | object | Member data |
|
||||||
| ↳ `user` | object | User information |
|
| ↳ `user` | object | User information |
|
||||||
| ↳ `id` | string | User ID |
|
| ↳ `id` | string | User ID |
|
||||||
| ↳ `username` | string | Username |
|
| ↳ `username` | string | Username |
|
||||||
| ↳ `avatar` | string | Avatar hash |
|
| ↳ `avatar` | string | Avatar hash |
|
||||||
| ↳ `nick` | string | Server nickname |
|
| ↳ `nick` | string | Server nickname |
|
||||||
| ↳ `roles` | array | Array of role IDs |
|
| ↳ `roles` | array | Array of role IDs |
|
||||||
| ↳ `joined_at` | string | When the member joined |
|
| ↳ `joined_at` | string | When the member joined |
|
||||||
|
|
||||||
### `discord_update_member`
|
### `discord_update_member`
|
||||||
|
|
||||||
@@ -671,8 +671,8 @@ Update a member in a Discord server (e.g., change nickname)
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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 |
|
||||||
| `userId` | string | Yes | The user ID to update |
|
| `userId` | string | Yes | The user ID to update, e.g., 123456789012345678 |
|
||||||
| `nick` | string | No | New nickname for the member \(null to remove\) |
|
| `nick` | string | No | New nickname for the member \(null to remove\) |
|
||||||
| `mute` | boolean | No | Whether to mute the member in voice channels |
|
| `mute` | boolean | No | Whether to mute the member in voice channels |
|
||||||
| `deaf` | boolean | No | Whether to deafen the member in voice channels |
|
| `deaf` | boolean | No | Whether to deafen the member in voice channels |
|
||||||
@@ -683,9 +683,9 @@ Update a member in a Discord server (e.g., change nickname)
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Updated member data |
|
| `data` | object | Updated member data |
|
||||||
| ↳ `nick` | string | Server nickname |
|
| ↳ `nick` | string | Server nickname |
|
||||||
| ↳ `mute` | boolean | Voice mute status |
|
| ↳ `mute` | boolean | Voice mute status |
|
||||||
| ↳ `deaf` | boolean | Voice deaf status |
|
| ↳ `deaf` | boolean | Voice deaf status |
|
||||||
|
|
||||||
### `discord_create_invite`
|
### `discord_create_invite`
|
||||||
|
|
||||||
@@ -696,11 +696,11 @@ Create an invite link for a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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\) |
|
| `maxAge` | number | No | Duration of invite in seconds \(0 = never expires, default 86400\) |
|
||||||
| `maxUses` | number | No | Max number of uses \(0 = unlimited, default 0\) |
|
| `maxUses` | number | No | Max number of uses \(0 = unlimited, default 0\) |
|
||||||
| `temporary` | boolean | No | Whether invite grants temporary membership |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -708,11 +708,11 @@ Create an invite link for a Discord channel
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Created invite data |
|
| `data` | object | Created invite data |
|
||||||
| ↳ `code` | string | Invite code |
|
| ↳ `code` | string | Invite code |
|
||||||
| ↳ `url` | string | Full invite URL |
|
| ↳ `url` | string | Full invite URL |
|
||||||
| ↳ `max_age` | number | Max age in seconds |
|
| ↳ `max_age` | number | Max age in seconds |
|
||||||
| ↳ `max_uses` | number | Max uses |
|
| ↳ `max_uses` | number | Max uses |
|
||||||
| ↳ `temporary` | boolean | Whether temporary |
|
| ↳ `temporary` | boolean | Whether temporary |
|
||||||
|
|
||||||
### `discord_get_invite`
|
### `discord_get_invite`
|
||||||
|
|
||||||
@@ -724,7 +724,7 @@ Get information about a Discord invite
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `inviteCode` | string | Yes | The invite code to retrieve |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -732,11 +732,11 @@ Get information about a Discord invite
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Invite data |
|
| `data` | object | Invite data |
|
||||||
| ↳ `code` | string | Invite code |
|
| ↳ `code` | string | Invite code |
|
||||||
| ↳ `guild` | object | Server information |
|
| ↳ `guild` | object | Server information |
|
||||||
| ↳ `channel` | object | Channel information |
|
| ↳ `channel` | object | Channel information |
|
||||||
| ↳ `approximate_member_count` | number | Approximate member count |
|
| ↳ `approximate_member_count` | number | Approximate member count |
|
||||||
| ↳ `approximate_presence_count` | number | Approximate online count |
|
| ↳ `approximate_presence_count` | number | Approximate online count |
|
||||||
|
|
||||||
### `discord_delete_invite`
|
### `discord_delete_invite`
|
||||||
|
|
||||||
@@ -748,7 +748,7 @@ Delete a Discord invite
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `inviteCode` | string | Yes | The invite code to delete |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -765,9 +765,9 @@ Create a webhook in a Discord channel
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `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\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -775,11 +775,11 @@ Create a webhook in a Discord channel
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Created webhook data |
|
| `data` | object | Created webhook data |
|
||||||
| ↳ `id` | string | Webhook ID |
|
| ↳ `id` | string | Webhook ID |
|
||||||
| ↳ `name` | string | Webhook name |
|
| ↳ `name` | string | Webhook name |
|
||||||
| ↳ `token` | string | Webhook token |
|
| ↳ `token` | string | Webhook token |
|
||||||
| ↳ `url` | string | Webhook URL |
|
| ↳ `url` | string | Webhook URL |
|
||||||
| ↳ `channel_id` | string | Channel ID |
|
| ↳ `channel_id` | string | Channel ID |
|
||||||
|
|
||||||
### `discord_execute_webhook`
|
### `discord_execute_webhook`
|
||||||
|
|
||||||
@@ -789,11 +789,11 @@ Execute a Discord webhook to send a message
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `webhookToken` | string | Yes | The webhook token |
|
||||||
| `content` | string | Yes | The message content to send |
|
| `content` | string | Yes | The message content to send |
|
||||||
| `username` | string | No | Override the default username of the webhook |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -801,10 +801,10 @@ Execute a Discord webhook to send a message
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Message sent via webhook |
|
| `data` | object | Message sent via webhook |
|
||||||
| ↳ `id` | string | Message ID |
|
| ↳ `id` | string | Message ID |
|
||||||
| ↳ `content` | string | Message content |
|
| ↳ `content` | string | Message content |
|
||||||
| ↳ `channel_id` | string | Channel ID |
|
| ↳ `channel_id` | string | Channel ID |
|
||||||
| ↳ `timestamp` | string | Message timestamp |
|
| ↳ `timestamp` | string | Message timestamp |
|
||||||
|
|
||||||
### `discord_get_webhook`
|
### `discord_get_webhook`
|
||||||
|
|
||||||
@@ -815,8 +815,8 @@ Get information about a Discord webhook
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `webhookId` | string | Yes | The webhook ID to retrieve |
|
| `webhookId` | string | Yes | The webhook ID to retrieve, e.g., 123456789012345678 |
|
||||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -824,11 +824,11 @@ Get information about a Discord webhook
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Webhook data |
|
| `data` | object | Webhook data |
|
||||||
| ↳ `id` | string | Webhook ID |
|
| ↳ `id` | string | Webhook ID |
|
||||||
| ↳ `name` | string | Webhook name |
|
| ↳ `name` | string | Webhook name |
|
||||||
| ↳ `channel_id` | string | Channel ID |
|
| ↳ `channel_id` | string | Channel ID |
|
||||||
| ↳ `guild_id` | string | Server ID |
|
| ↳ `guild_id` | string | Server ID |
|
||||||
| ↳ `token` | string | Webhook token |
|
| ↳ `token` | string | Webhook token |
|
||||||
|
|
||||||
### `discord_delete_webhook`
|
### `discord_delete_webhook`
|
||||||
|
|
||||||
@@ -839,8 +839,8 @@ Delete a Discord webhook
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `botToken` | string | Yes | The bot token for authentication |
|
| `botToken` | string | Yes | The bot token for authentication |
|
||||||
| `webhookId` | string | Yes | The webhook ID to delete |
|
| `webhookId` | string | Yes | The webhook ID to delete, e.g., 123456789012345678 |
|
||||||
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
|
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -54,15 +54,15 @@ Upload a file to Dropbox
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `file` | object | The uploaded file metadata |
|
| `file` | object | The uploaded file metadata |
|
||||||
| ↳ `id` | string | Unique identifier for the file |
|
| ↳ `id` | string | Unique identifier for the file |
|
||||||
| ↳ `name` | string | Name of the file |
|
| ↳ `name` | string | Name of the file |
|
||||||
| ↳ `path_display` | string | Display path of the file |
|
| ↳ `path_display` | string | Display path of the file |
|
||||||
| ↳ `path_lower` | string | Lowercase path of the file |
|
| ↳ `path_lower` | string | Lowercase path of the file |
|
||||||
| ↳ `size` | number | Size of the file in bytes |
|
| ↳ `size` | number | Size of the file in bytes |
|
||||||
| ↳ `client_modified` | string | Client modification time |
|
| ↳ `client_modified` | string | Client modification time |
|
||||||
| ↳ `server_modified` | string | Server modification time |
|
| ↳ `server_modified` | string | Server modification time |
|
||||||
| ↳ `rev` | string | Revision identifier |
|
| ↳ `rev` | string | Revision identifier |
|
||||||
| ↳ `content_hash` | string | Content hash for the file |
|
| ↳ `content_hash` | string | Content hash for the file |
|
||||||
|
|
||||||
### `dropbox_download`
|
### `dropbox_download`
|
||||||
|
|
||||||
@@ -79,10 +79,10 @@ Download a file from Dropbox and get a temporary link
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `file` | object | The file metadata |
|
| `file` | object | The file metadata |
|
||||||
| ↳ `id` | string | Unique identifier for the file |
|
| ↳ `id` | string | Unique identifier for the file |
|
||||||
| ↳ `name` | string | Name of the file |
|
| ↳ `name` | string | Name of the file |
|
||||||
| ↳ `path_display` | string | Display path of the file |
|
| ↳ `path_display` | string | Display path of the file |
|
||||||
| ↳ `size` | number | Size of the file in bytes |
|
| ↳ `size` | number | Size of the file in bytes |
|
||||||
| `temporaryLink` | string | Temporary link to download the file \(valid for ~4 hours\) |
|
| `temporaryLink` | string | Temporary link to download the file \(valid for ~4 hours\) |
|
||||||
| `content` | string | Base64 encoded file content \(if fetched\) |
|
| `content` | string | Base64 encoded file content \(if fetched\) |
|
||||||
|
|
||||||
@@ -128,10 +128,10 @@ Create a new folder in Dropbox
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `folder` | object | The created folder metadata |
|
| `folder` | object | The created folder metadata |
|
||||||
| ↳ `id` | string | Unique identifier for the folder |
|
| ↳ `id` | string | Unique identifier for the folder |
|
||||||
| ↳ `name` | string | Name of the folder |
|
| ↳ `name` | string | Name of the folder |
|
||||||
| ↳ `path_display` | string | Display path of the folder |
|
| ↳ `path_display` | string | Display path of the folder |
|
||||||
| ↳ `path_lower` | string | Lowercase path of the folder |
|
| ↳ `path_lower` | string | Lowercase path of the folder |
|
||||||
|
|
||||||
### `dropbox_delete`
|
### `dropbox_delete`
|
||||||
|
|
||||||
@@ -148,8 +148,8 @@ Delete a file or folder in Dropbox (moves to trash)
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `metadata` | object | Metadata of the deleted item |
|
| `metadata` | object | Metadata of the deleted item |
|
||||||
| ↳ `name` | string | Name of the deleted item |
|
| ↳ `name` | string | Name of the deleted item |
|
||||||
| ↳ `path_display` | string | Display path |
|
| ↳ `path_display` | string | Display path |
|
||||||
| `deleted` | boolean | Whether the deletion was successful |
|
| `deleted` | boolean | Whether the deletion was successful |
|
||||||
|
|
||||||
### `dropbox_copy`
|
### `dropbox_copy`
|
||||||
@@ -169,10 +169,10 @@ Copy a file or folder in Dropbox
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `metadata` | object | Metadata of the copied item |
|
| `metadata` | object | Metadata of the copied item |
|
||||||
| ↳ `id` | string | Unique identifier |
|
| ↳ `id` | string | Unique identifier |
|
||||||
| ↳ `name` | string | Name of the copied item |
|
| ↳ `name` | string | Name of the copied item |
|
||||||
| ↳ `path_display` | string | Display path |
|
| ↳ `path_display` | string | Display path |
|
||||||
| ↳ `size` | number | Size in bytes \(files only\) |
|
| ↳ `size` | number | Size in bytes \(files only\) |
|
||||||
|
|
||||||
### `dropbox_move`
|
### `dropbox_move`
|
||||||
|
|
||||||
@@ -191,10 +191,10 @@ Move or rename a file or folder in Dropbox
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `metadata` | object | Metadata of the moved item |
|
| `metadata` | object | Metadata of the moved item |
|
||||||
| ↳ `id` | string | Unique identifier |
|
| ↳ `id` | string | Unique identifier |
|
||||||
| ↳ `name` | string | Name of the moved item |
|
| ↳ `name` | string | Name of the moved item |
|
||||||
| ↳ `path_display` | string | Display path |
|
| ↳ `path_display` | string | Display path |
|
||||||
| ↳ `size` | number | Size in bytes \(files only\) |
|
| ↳ `size` | number | Size in bytes \(files only\) |
|
||||||
|
|
||||||
### `dropbox_get_metadata`
|
### `dropbox_get_metadata`
|
||||||
|
|
||||||
@@ -213,15 +213,15 @@ Get metadata for a file or folder in Dropbox
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `metadata` | object | Metadata for the file or folder |
|
| `metadata` | object | Metadata for the file or folder |
|
||||||
| ↳ `id` | string | Unique identifier |
|
| ↳ `id` | string | Unique identifier |
|
||||||
| ↳ `name` | string | Name of the item |
|
| ↳ `name` | string | Name of the item |
|
||||||
| ↳ `path_display` | string | Display path |
|
| ↳ `path_display` | string | Display path |
|
||||||
| ↳ `path_lower` | string | Lowercase path |
|
| ↳ `path_lower` | string | Lowercase path |
|
||||||
| ↳ `size` | number | Size in bytes \(files only\) |
|
| ↳ `size` | number | Size in bytes \(files only\) |
|
||||||
| ↳ `client_modified` | string | Client modification time |
|
| ↳ `client_modified` | string | Client modification time |
|
||||||
| ↳ `server_modified` | string | Server modification time |
|
| ↳ `server_modified` | string | Server modification time |
|
||||||
| ↳ `rev` | string | Revision identifier |
|
| ↳ `rev` | string | Revision identifier |
|
||||||
| ↳ `content_hash` | string | Content hash |
|
| ↳ `content_hash` | string | Content hash |
|
||||||
|
|
||||||
### `dropbox_create_shared_link`
|
### `dropbox_create_shared_link`
|
||||||
|
|
||||||
@@ -241,11 +241,11 @@ Create a shareable link for a file or folder in Dropbox
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `sharedLink` | object | The created shared link |
|
| `sharedLink` | object | The created shared link |
|
||||||
| ↳ `url` | string | The shared link URL |
|
| ↳ `url` | string | The shared link URL |
|
||||||
| ↳ `name` | string | Name of the shared item |
|
| ↳ `name` | string | Name of the shared item |
|
||||||
| ↳ `path_lower` | string | Lowercase path of the shared item |
|
| ↳ `path_lower` | string | Lowercase path of the shared item |
|
||||||
| ↳ `expires` | string | Expiration date if set |
|
| ↳ `expires` | string | Expiration date if set |
|
||||||
| ↳ `link_permissions` | object | Permissions for the shared link |
|
| ↳ `link_permissions` | object | Permissions for the shared link |
|
||||||
|
|
||||||
### `dropbox_search`
|
### `dropbox_search`
|
||||||
|
|
||||||
@@ -256,7 +256,7 @@ Search for files and folders in Dropbox
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | Yes | The search query |
|
| `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\) |
|
| `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\) |
|
| `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\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `tableName` | string | Yes | DynamoDB table name |
|
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||||
| `key` | object | Yes | Primary key of the item to retrieve |
|
| `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 |
|
| `consistentRead` | boolean | No | Use strongly consistent read |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -76,8 +76,8 @@ Put an item into a DynamoDB table
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `tableName` | string | Yes | DynamoDB table name |
|
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||||
| `item` | object | Yes | Item to put into the table |
|
| `item` | object | Yes | Item to put into the table \(e.g., \{"pk": "USER#123", "name": "John", "email": "john@example.com"\}\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -97,13 +97,13 @@ Query items from a DynamoDB table using key conditions
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `tableName` | string | Yes | DynamoDB table name |
|
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||||
| `keyConditionExpression` | string | Yes | Key condition expression \(e.g., "pk = :pk"\) |
|
| `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 |
|
| `filterExpression` | string | No | Filter expression for results \(e.g., "age > :minAge AND #status = :status"\) |
|
||||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
|
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#status": "status"\}\) |
|
||||||
| `expressionAttributeValues` | object | No | Expression attribute values |
|
| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":pk": "USER#123", ":minAge": 18\}\) |
|
||||||
| `indexName` | string | No | Secondary index name to query |
|
| `indexName` | string | No | Secondary index name to query \(e.g., "GSI1", "email-index"\) |
|
||||||
| `limit` | number | No | Maximum number of items to return |
|
| `limit` | number | No | Maximum number of items to return \(e.g., 10, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -124,12 +124,12 @@ Scan all items in a DynamoDB table
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `tableName` | string | Yes | DynamoDB table name |
|
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||||
| `filterExpression` | string | No | Filter expression for results |
|
| `filterExpression` | string | No | Filter expression for results \(e.g., "age > :minAge AND #status = :status"\) |
|
||||||
| `projectionExpression` | string | No | Attributes to retrieve |
|
| `projectionExpression` | string | No | Attributes to retrieve \(e.g., "pk, sk, #name, email"\) |
|
||||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
|
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#name": "name", "#status": "status"\}\) |
|
||||||
| `expressionAttributeValues` | object | No | Expression attribute values |
|
| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":minAge": 18, ":status": "active"\}\) |
|
||||||
| `limit` | number | No | Maximum number of items to return |
|
| `limit` | number | No | Maximum number of items to return \(e.g., 10, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -150,12 +150,12 @@ Update an item in a DynamoDB table
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `tableName` | string | Yes | DynamoDB table name |
|
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||||
| `key` | object | Yes | Primary key of the item to update |
|
| `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"\) |
|
| `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 |
|
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#name": "name", "#count": "count"\}\) |
|
||||||
| `expressionAttributeValues` | object | No | Expression attribute values |
|
| `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 |
|
| `conditionExpression` | string | No | Condition that must be met for the update to succeed \(e.g., "attribute_exists\(pk\)" or "version = :expectedVersion"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -175,9 +175,9 @@ Delete an item from a DynamoDB table
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `tableName` | string | Yes | DynamoDB table name |
|
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) |
|
||||||
| `key` | object | Yes | Primary key of the item to delete |
|
| `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 |
|
| `conditionExpression` | string | No | Condition that must be met for the delete to succeed \(e.g., "attribute_exists\(pk\)"\) |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `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
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -49,11 +49,12 @@ Search documents in Elasticsearch using Query DSL. Returns matching documents wi
|
|||||||
| `apiKey` | string | No | Elasticsearch API key |
|
| `apiKey` | string | No | Elasticsearch API key |
|
||||||
| `username` | string | No | Username for basic auth |
|
| `username` | string | No | Username for basic auth |
|
||||||
| `password` | string | No | Password for basic auth |
|
| `password` | string | No | Password for basic auth |
|
||||||
| `index` | string | Yes | Index name to search |
|
| `index` | string | Yes | Index name to search \(e.g., "products", "logs-2024"\) |
|
||||||
| `query` | string | No | Query DSL as JSON string |
|
| `query` | string | No | Query DSL as JSON string. Example: \{"match":\{"title":"search term"\}\} or \{"bool":\{"must":\[...\]\}\} |
|
||||||
| `from` | number | No | Starting offset for pagination \(default: 0\) |
|
| `Example` | string | No | No description |
|
||||||
| `size` | number | No | Number of results to return \(default: 10\) |
|
| `from` | number | No | Starting offset for pagination \(e.g., 0, 10, 20\). Default: 0 |
|
||||||
| `sort` | string | No | Sort specification as JSON string |
|
| `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 |
|
| `sourceIncludes` | string | No | Comma-separated list of fields to include in _source |
|
||||||
| `sourceExcludes` | string | No | Comma-separated list of fields to exclude from _source |
|
| `sourceExcludes` | string | No | Comma-separated list of fields to exclude from _source |
|
||||||
| `trackTotalHits` | boolean | No | Track accurate total hit count \(default: true\) |
|
| `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 |
|
| `apiKey` | string | No | Elasticsearch API key |
|
||||||
| `username` | string | No | Username for basic auth |
|
| `username` | string | No | Username for basic auth |
|
||||||
| `password` | string | No | Password for basic auth |
|
| `password` | string | No | Password for basic auth |
|
||||||
| `index` | string | Yes | Target index name |
|
| `index` | string | Yes | Target index name \(e.g., "products", "logs-2024"\) |
|
||||||
| `documentId` | string | No | Document ID \(auto-generated if not provided\) |
|
| `documentId` | string | No | Document ID \(e.g., "abc123", "user_456"\). Auto-generated if not provided |
|
||||||
| `document` | string | Yes | Document body as JSON string |
|
| `document` | string | Yes | Document body as JSON string |
|
||||||
| `refresh` | string | No | Refresh policy: true, false, or wait_for |
|
| `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 |
|
| `apiKey` | string | No | Elasticsearch API key |
|
||||||
| `username` | string | No | Username for basic auth |
|
| `username` | string | No | Username for basic auth |
|
||||||
| `password` | string | No | Password for basic auth |
|
| `password` | string | No | Password for basic auth |
|
||||||
| `index` | string | Yes | Index name |
|
| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) |
|
||||||
| `documentId` | string | Yes | Document ID to retrieve |
|
| `documentId` | string | Yes | Document ID to retrieve \(e.g., "abc123", "user_456"\) |
|
||||||
| `sourceIncludes` | string | No | Comma-separated list of fields to include |
|
| `sourceIncludes` | string | No | Comma-separated list of fields to include |
|
||||||
| `sourceExcludes` | string | No | Comma-separated list of fields to exclude |
|
| `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 |
|
| `apiKey` | string | No | Elasticsearch API key |
|
||||||
| `username` | string | No | Username for basic auth |
|
| `username` | string | No | Username for basic auth |
|
||||||
| `password` | string | No | Password for basic auth |
|
| `password` | string | No | Password for basic auth |
|
||||||
| `index` | string | Yes | Index name |
|
| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) |
|
||||||
| `documentId` | string | Yes | Document ID to update |
|
| `documentId` | string | Yes | Document ID to update \(e.g., "abc123", "user_456"\) |
|
||||||
| `document` | string | Yes | Partial document to merge as JSON string |
|
| `document` | string | Yes | Partial document to merge as JSON string |
|
||||||
| `retryOnConflict` | number | No | Number of retries on version conflict |
|
| `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 |
|
| `apiKey` | string | No | Elasticsearch API key |
|
||||||
| `username` | string | No | Username for basic auth |
|
| `username` | string | No | Username for basic auth |
|
||||||
| `password` | string | No | Password for basic auth |
|
| `password` | string | No | Password for basic auth |
|
||||||
| `index` | string | Yes | Index name |
|
| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) |
|
||||||
| `documentId` | string | Yes | Document ID to delete |
|
| `documentId` | string | Yes | Document ID to delete \(e.g., "abc123", "user_456"\) |
|
||||||
| `refresh` | string | No | Refresh policy: true, false, or wait_for |
|
| `refresh` | string | No | Refresh policy: true, false, or wait_for |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -198,8 +199,9 @@ Perform multiple index, create, delete, or update operations in a single request
|
|||||||
| `apiKey` | string | No | Elasticsearch API key |
|
| `apiKey` | string | No | Elasticsearch API key |
|
||||||
| `username` | string | No | Username for basic auth |
|
| `username` | string | No | Username for basic auth |
|
||||||
| `password` | string | No | Password for basic auth |
|
| `password` | string | No | Password for basic auth |
|
||||||
| `index` | string | No | Default index for operations that do not specify one |
|
| `index` | string | No | Default index for operations \(e.g., "products", "logs-2024"\) |
|
||||||
| `operations` | string | Yes | Bulk operations as NDJSON string \(newline-delimited JSON\) |
|
| `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 |
|
| `refresh` | string | No | Refresh policy: true, false, or wait_for |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -225,8 +227,9 @@ Count documents matching a query in Elasticsearch.
|
|||||||
| `apiKey` | string | No | Elasticsearch API key |
|
| `apiKey` | string | No | Elasticsearch API key |
|
||||||
| `username` | string | No | Username for basic auth |
|
| `username` | string | No | Username for basic auth |
|
||||||
| `password` | string | No | Password for basic auth |
|
| `password` | string | No | Password for basic auth |
|
||||||
| `index` | string | Yes | Index name to count documents in |
|
| `index` | string | Yes | Index name to count documents in \(e.g., "products", "logs-2024"\) |
|
||||||
| `query` | string | No | Optional query to filter documents \(JSON string\) |
|
| `query` | string | No | Query DSL to filter documents \(JSON string\). Example: \{"match":\{"status":"active"\}\} |
|
||||||
|
| `Example` | string | No | No description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -250,7 +253,7 @@ Create a new index with optional settings and mappings.
|
|||||||
| `apiKey` | string | No | Elasticsearch API key |
|
| `apiKey` | string | No | Elasticsearch API key |
|
||||||
| `username` | string | No | Username for basic auth |
|
| `username` | string | No | Username for basic auth |
|
||||||
| `password` | string | No | Password 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 |
|
| `settings` | string | No | Index settings as JSON string |
|
||||||
| `mappings` | string | No | Index mappings 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 |
|
| `apiKey` | string | No | Elasticsearch API key |
|
||||||
| `username` | string | No | Username for basic auth |
|
| `username` | string | No | Username for basic auth |
|
||||||
| `password` | string | No | Password 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
|
#### Output
|
||||||
|
|
||||||
@@ -300,7 +303,7 @@ Retrieve index information including settings, mappings, and aliases.
|
|||||||
| `apiKey` | string | No | Elasticsearch API key |
|
| `apiKey` | string | No | Elasticsearch API key |
|
||||||
| `username` | string | No | Username for basic auth |
|
| `username` | string | No | Username for basic auth |
|
||||||
| `password` | string | No | Password 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
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -41,9 +41,11 @@ Convert TTS using ElevenLabs voices
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `text` | string | Yes | The text to convert to speech |
|
| `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 |
|
| `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 \(defaults to eleven_monolingual_v1\) |
|
| `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 |
|
| `apiKey` | string | Yes | Your ElevenLabs API key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|||||||
@@ -44,11 +44,11 @@ Search the web using Exa AI. Returns relevant search results with titles, URLs,
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | Yes | The search query to execute |
|
| `query` | string | Yes | The search query to execute |
|
||||||
| `numResults` | number | No | Number of results to return \(default: 10, max: 25\) |
|
| `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 \(default: false\) |
|
| `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\) |
|
| `type` | string | No | Search type: "neural", "keyword", "auto", or "fast". Default: "auto" |
|
||||||
| `includeDomains` | string | No | Comma-separated list of domains to include in 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 |
|
| `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 |
|
| `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\) |
|
| `text` | boolean | No | Include full text content in results \(default: false\) |
|
||||||
| `highlights` | boolean | No | Include highlighted snippets 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 |
|
| ↳ `publishedDate` | string | Date when the content was published |
|
||||||
| ↳ `author` | string | The author of the content |
|
| ↳ `author` | string | The author of the content |
|
||||||
| ↳ `summary` | string | A brief summary 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 |
|
| ↳ `image` | string | URL of a representative image from the page |
|
||||||
| ↳ `text` | string | Text snippet or full content from the page |
|
| ↳ `text` | string | Text snippet or full content from the page |
|
||||||
| ↳ `score` | number | Relevance score for the search result |
|
| ↳ `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `url` | string | Yes | The URL to find similar links for |
|
| `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 |
|
| `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 |
|
| `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 |
|
| `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\) |
|
| `excludeSourceDomain` | boolean | No | Exclude the source domain from results \(default: false\) |
|
||||||
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
|
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
|
||||||
| `summary` | boolean | No | Include AI-generated summaries 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 |
|
| 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 |
|
| `scrapeOptions` | json | No | Options for content scraping |
|
||||||
| `apiKey` | string | Yes | Firecrawl API key |
|
| `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 |
|
| `markdown` | string | Page content in markdown format |
|
||||||
| `html` | string | Raw HTML content of the page |
|
| `html` | string | Raw HTML content of the page |
|
||||||
| `metadata` | object | Page metadata including SEO and Open Graph information |
|
| `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`
|
### `firecrawl_search`
|
||||||
|
|
||||||
@@ -77,7 +91,21 @@ Search for information on the web using Firecrawl
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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`
|
### `firecrawl_crawl`
|
||||||
|
|
||||||
@@ -87,8 +115,12 @@ Crawl entire websites and extract structured content from all accessible pages
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `url` | string | Yes | The website URL to crawl |
|
| `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 \(default: 100\) |
|
| `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 |
|
| `onlyMainContent` | boolean | No | Extract only main content from pages |
|
||||||
| `apiKey` | string | Yes | Firecrawl API Key |
|
| `apiKey` | string | Yes | Firecrawl API Key |
|
||||||
|
|
||||||
@@ -98,13 +130,17 @@ Crawl entire websites and extract structured content from all accessible pages
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `pages` | array | Array of crawled pages with their content and metadata |
|
| `pages` | array | Array of crawled pages with their content and metadata |
|
||||||
| ↳ `markdown` | string | Page content in markdown format |
|
| ↳ `markdown` | string | Page content in markdown format |
|
||||||
| ↳ `html` | string | Page HTML content |
|
| ↳ `html` | string | Processed HTML content of the page |
|
||||||
| ↳ `metadata` | object | Page metadata |
|
| ↳ `rawHtml` | string | Unprocessed raw HTML content |
|
||||||
| ↳ `title` | string | Page title |
|
| ↳ `links` | array | Array of links found on the page |
|
||||||
| ↳ `description` | string | Page description |
|
| ↳ `screenshot` | string | Screenshot URL \(expires after 24 hours\) |
|
||||||
| ↳ `language` | string | Page language |
|
| ↳ `metadata` | object | Page metadata from crawl operation |
|
||||||
| ↳ `sourceURL` | string | Source URL of the page |
|
| ↳ `title` | string | Page title |
|
||||||
| ↳ `statusCode` | number | HTTP status code |
|
| ↳ `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 |
|
| `total` | number | Total number of pages found during crawl |
|
||||||
| `creditsUsed` | number | Number of credits consumed by the crawl operation |
|
| `creditsUsed` | number | Number of credits consumed by the crawl operation |
|
||||||
|
|
||||||
@@ -116,12 +152,12 @@ Get a complete list of URLs from any website quickly and reliably. Useful for di
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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"\) |
|
| `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" |
|
| `sitemap` | string | No | Controls sitemap usage: "skip", "include" \(default\), or "only" |
|
||||||
| `includeSubdomains` | boolean | No | Whether to include URLs from subdomains \(default: true\) |
|
| `includeSubdomains` | boolean | No | Whether to include URLs from subdomains \(default: true\) |
|
||||||
| `ignoreQueryParameters` | boolean | No | Exclude URLs containing query strings \(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 |
|
| `timeout` | number | No | Request timeout in milliseconds |
|
||||||
| `location` | json | No | Geographic context for proxying \(country, languages\) |
|
| `location` | json | No | Geographic context for proxying \(country, languages\) |
|
||||||
| `apiKey` | string | Yes | Firecrawl API key |
|
| `apiKey` | string | Yes | Firecrawl API key |
|
||||||
@@ -141,7 +177,7 @@ Extract structured data from entire webpages using natural language prompts and
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `prompt` | string | No | Natural language guidance for the extraction process |
|
||||||
| `schema` | json | No | JSON Schema defining the structure of data to extract |
|
| `schema` | json | No | JSON Schema defining the structure of data to extract |
|
||||||
| `enableWebSearch` | boolean | No | Enable web search to find supplementary information \(default: false\) |
|
| `enableWebSearch` | boolean | No | Enable web search to find supplementary information \(default: false\) |
|
||||||
@@ -168,7 +204,7 @@ Autonomous web data extraction agent. Searches and gathers information based on
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `prompt` | string | Yes | Natural language description of the data to extract \(max 10,000 characters\) |
|
| `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 |
|
| `schema` | json | No | JSON Schema defining the structure of data to extract |
|
||||||
| `maxCredits` | number | No | Maximum credits to spend on this agent task |
|
| `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 |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Fireflies API key |
|
| `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\) |
|
| `fromDate` | string | No | Filter transcripts from this date \(ISO 8601 format\) |
|
||||||
| `toDate` | string | No | Filter transcripts until this date \(ISO 8601 format\) |
|
| `toDate` | string | No | Filter transcripts until this date \(ISO 8601 format\) |
|
||||||
| `hostEmail` | string | No | Filter by meeting host email |
|
| `hostEmail` | string | No | Filter by meeting host email |
|
||||||
| `participants` | string | No | Filter by participant emails \(comma-separated\) |
|
| `participants` | string | No | Filter by participant emails \(comma-separated\) |
|
||||||
| `limit` | number | No | Maximum number of transcripts to return \(max 50\) |
|
| `limit` | number | No | Maximum number of transcripts to return \(e.g., 10, max 50\) |
|
||||||
| `skip` | number | No | Number of transcripts to skip for pagination |
|
| `skip` | number | No | Number of transcripts to skip for pagination \(e.g., 0, 10, 20\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -68,25 +68,25 @@ Get a single transcript with full details including summary, action items, and a
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Fireflies API key |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `transcript` | object | The transcript with full details |
|
| `transcript` | object | The transcript with full details |
|
||||||
| ↳ `id` | string | Transcript ID |
|
| ↳ `id` | string | Transcript ID |
|
||||||
| ↳ `title` | string | Meeting title |
|
| ↳ `title` | string | Meeting title |
|
||||||
| ↳ `date` | number | Meeting timestamp |
|
| ↳ `date` | number | Meeting timestamp |
|
||||||
| ↳ `duration` | number | Meeting duration in seconds |
|
| ↳ `duration` | number | Meeting duration in seconds |
|
||||||
| ↳ `transcript_url` | string | URL to view transcript |
|
| ↳ `transcript_url` | string | URL to view transcript |
|
||||||
| ↳ `audio_url` | string | URL to audio recording |
|
| ↳ `audio_url` | string | URL to audio recording |
|
||||||
| ↳ `host_email` | string | Host email address |
|
| ↳ `host_email` | string | Host email address |
|
||||||
| ↳ `participants` | array | List of participant emails |
|
| ↳ `participants` | array | List of participant emails |
|
||||||
| ↳ `speakers` | array | List of speakers |
|
| ↳ `speakers` | array | List of speakers |
|
||||||
| ↳ `sentences` | array | Transcript sentences |
|
| ↳ `sentences` | array | Transcript sentences |
|
||||||
| ↳ `summary` | object | Meeting summary and action items |
|
| ↳ `summary` | object | Meeting summary and action items |
|
||||||
| ↳ `analytics` | object | Meeting analytics and sentiment |
|
| ↳ `analytics` | object | Meeting analytics and sentiment |
|
||||||
|
|
||||||
### `fireflies_get_user`
|
### `fireflies_get_user`
|
||||||
|
|
||||||
@@ -97,22 +97,22 @@ Get user information from Fireflies.ai. Returns current user if no ID specified.
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Fireflies API key |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `user` | object | User information |
|
| `user` | object | User information |
|
||||||
| ↳ `user_id` | string | User ID |
|
| ↳ `user_id` | string | User ID |
|
||||||
| ↳ `name` | string | User name |
|
| ↳ `name` | string | User name |
|
||||||
| ↳ `email` | string | User email |
|
| ↳ `email` | string | User email |
|
||||||
| ↳ `integrations` | array | Connected integrations |
|
| ↳ `integrations` | array | Connected integrations |
|
||||||
| ↳ `is_admin` | boolean | Whether user is admin |
|
| ↳ `is_admin` | boolean | Whether user is admin |
|
||||||
| ↳ `minutes_consumed` | number | Total minutes transcribed |
|
| ↳ `minutes_consumed` | number | Total minutes transcribed |
|
||||||
| ↳ `num_transcripts` | number | Number of transcripts |
|
| ↳ `num_transcripts` | number | Number of transcripts |
|
||||||
| ↳ `recent_transcript` | string | Most recent transcript ID |
|
| ↳ `recent_transcript` | string | Most recent transcript ID |
|
||||||
| ↳ `recent_meeting` | string | Most recent meeting date |
|
| ↳ `recent_meeting` | string | Most recent meeting date |
|
||||||
|
|
||||||
### `fireflies_list_users`
|
### `fireflies_list_users`
|
||||||
|
|
||||||
@@ -164,7 +164,7 @@ Delete a transcript from Fireflies.ai
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Fireflies API key |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -202,7 +202,7 @@ Create a soundbite/highlight from a specific time range in a transcript
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Fireflies API key |
|
| `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 |
|
| `startTime` | number | Yes | Start time of the bite in seconds |
|
||||||
| `endTime` | number | Yes | End 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\) |
|
| `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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `bite` | object | Created bite details |
|
| `bite` | object | Created bite details |
|
||||||
| ↳ `id` | string | Bite ID |
|
| ↳ `id` | string | Bite ID |
|
||||||
| ↳ `name` | string | Bite name |
|
| ↳ `name` | string | Bite name |
|
||||||
| ↳ `status` | string | Processing status |
|
| ↳ `status` | string | Processing status |
|
||||||
|
|
||||||
### `fireflies_list_bites`
|
### `fireflies_list_bites`
|
||||||
|
|
||||||
@@ -227,10 +227,10 @@ List soundbites/highlights from Fireflies.ai
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Fireflies API key |
|
| `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\) |
|
| `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\) |
|
| `limit` | number | No | Maximum number of bites to return \(e.g., 10, max 50\) |
|
||||||
| `skip` | number | No | Number of bites to skip for pagination |
|
| `skip` | number | No | Number of bites to skip for pagination \(e.g., 0, 10, 20\) |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `messageId` | string | No | ID of the message to read |
|
| `messageId` | string | No | Gmail message ID to read \(e.g., 18f1a2b3c4d5e6f7\) |
|
||||||
| `folder` | string | No | Folder/label to read emails from |
|
| `folder` | string | No | Folder/label to read emails from \(e.g., INBOX, SENT, DRAFT, TRASH, SPAM, or custom label name\) |
|
||||||
| `unreadOnly` | boolean | No | Only retrieve unread messages |
|
| `unreadOnly` | boolean | No | Set to true to only retrieve unread messages |
|
||||||
| `maxResults` | number | No | Maximum number of messages to retrieve \(default: 1, max: 10\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -128,7 +128,7 @@ Search emails in Gmail. Returns API-aligned fields only.
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | Yes | Search query for emails |
|
| `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
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ Create a new event in Google Calendar. Returns API-aligned fields only.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `summary` | string | Yes | Event title/summary |
|
||||||
| `description` | string | No | Event description |
|
| `description` | string | No | Event description |
|
||||||
| `location` | string | No | Event location |
|
| `location` | string | No | Event location |
|
||||||
@@ -78,7 +78,7 @@ List events from Google Calendar. Returns API-aligned fields only.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `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\) |
|
| `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\) |
|
| `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 |
|
| 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 | Event ID to retrieve |
|
| `eventId` | string | Yes | Google Calendar event ID to retrieve |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -127,8 +127,8 @@ Update an existing event in Google Calendar. Returns API-aligned fields only.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 | Event ID to update |
|
| `eventId` | string | Yes | Google Calendar event ID to update |
|
||||||
| `summary` | string | No | New event title/summary |
|
| `summary` | string | No | New event title/summary |
|
||||||
| `description` | string | No | New event description |
|
| `description` | string | No | New event description |
|
||||||
| `location` | string | No | New event location |
|
| `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 |
|
| 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 | Event ID to delete |
|
| `eventId` | string | Yes | Google Calendar event ID to delete |
|
||||||
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
|
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -181,9 +181,9 @@ Move an event to a different calendar. Returns API-aligned fields only.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `calendarId` | string | No | Source calendar ID \(defaults to primary\) |
|
| `calendarId` | string | No | Source Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) |
|
||||||
| `eventId` | string | Yes | Event ID to move |
|
| `eventId` | string | Yes | Google Calendar event ID to move |
|
||||||
| `destinationCalendarId` | string | Yes | Destination calendar ID |
|
| `destinationCalendarId` | string | Yes | Destination Google Calendar ID |
|
||||||
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
|
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -210,7 +210,7 @@ Get instances of a recurring event from Google Calendar. Returns API-aligned fie
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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\) |
|
| `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\) |
|
| `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 |
|
| 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"\) |
|
| `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\) |
|
| `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 |
|
| `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 |
|
| 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 | Event ID to invite attendees to |
|
| `eventId` | string | Yes | Google Calendar event ID to invite attendees to |
|
||||||
| `attendees` | array | Yes | Array of attendee email addresses to invite |
|
| `attendees` | array | Yes | Array of attendee email addresses to invite |
|
||||||
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
|
| `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\) |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `documentId` | string | Yes | The ID of the document to read |
|
| `documentId` | string | Yes | Google Docs document ID |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -87,10 +87,10 @@ Read content from a Google Docs document
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `content` | string | Extracted document text content |
|
| `content` | string | Extracted document text content |
|
||||||
| `metadata` | json | Document metadata including ID, title, and URL |
|
| `metadata` | json | Document metadata including ID, title, and URL |
|
||||||
| ↳ `documentId` | string | Google Docs document ID |
|
| ↳ `documentId` | string | Google Docs document ID |
|
||||||
| ↳ `title` | string | Document title |
|
| ↳ `title` | string | Document title |
|
||||||
| ↳ `mimeType` | string | Document MIME type |
|
| ↳ `mimeType` | string | Document MIME type |
|
||||||
| ↳ `url` | string | Document URL |
|
| ↳ `url` | string | Document URL |
|
||||||
|
|
||||||
### `google_docs_write`
|
### `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 |
|
| `updatedContent` | boolean | Indicates if document content was updated successfully |
|
||||||
| `metadata` | json | Updated document metadata including ID, title, and URL |
|
| `metadata` | json | Updated document metadata including ID, title, and URL |
|
||||||
| ↳ `documentId` | string | Google Docs document ID |
|
| ↳ `documentId` | string | Google Docs document ID |
|
||||||
| ↳ `title` | string | Document title |
|
| ↳ `title` | string | Document title |
|
||||||
| ↳ `mimeType` | string | Document MIME type |
|
| ↳ `mimeType` | string | Document MIME type |
|
||||||
| ↳ `url` | string | Document URL |
|
| ↳ `url` | string | Document URL |
|
||||||
|
|
||||||
### `google_docs_create`
|
### `google_docs_create`
|
||||||
|
|
||||||
@@ -124,7 +124,7 @@ Create a new Google Docs document
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `title` | string | Yes | The title of the document to create |
|
| `title` | string | Yes | The title of the document to create |
|
||||||
| `content` | string | No | The content 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\) |
|
| `folderId` | string | No | The ID of the folder to create the document in \(internal use\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -132,9 +132,9 @@ Create a new Google Docs document
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `metadata` | json | Created document metadata including ID, title, and URL |
|
| `metadata` | json | Created document metadata including ID, title, and URL |
|
||||||
| ↳ `documentId` | string | Google Docs document ID |
|
| ↳ `documentId` | string | Google Docs document ID |
|
||||||
| ↳ `title` | string | Document title |
|
| ↳ `title` | string | Document title |
|
||||||
| ↳ `mimeType` | string | Document MIME type |
|
| ↳ `mimeType` | string | Document MIME type |
|
||||||
| ↳ `url` | string | Document URL |
|
| ↳ `url` | string | Document URL |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ List files and folders in Google Drive with complete metadata
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `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. |
|
| `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\) |
|
| `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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `file` | json | The file metadata |
|
| `file` | json | The file metadata |
|
||||||
| ↳ `id` | string | Google Drive file ID |
|
| ↳ `id` | string | Google Drive file ID |
|
||||||
| ↳ `kind` | string | Resource type identifier |
|
| ↳ `kind` | string | Resource type identifier |
|
||||||
| ↳ `name` | string | File name |
|
| ↳ `name` | string | File name |
|
||||||
| ↳ `mimeType` | string | MIME type |
|
| ↳ `mimeType` | string | MIME type |
|
||||||
| ↳ `description` | string | File description |
|
| ↳ `description` | string | File description |
|
||||||
| ↳ `size` | string | File size in bytes |
|
| ↳ `size` | string | File size in bytes |
|
||||||
| ↳ `starred` | boolean | Whether file is starred |
|
| ↳ `starred` | boolean | Whether file is starred |
|
||||||
| ↳ `trashed` | boolean | Whether file is in trash |
|
| ↳ `trashed` | boolean | Whether file is in trash |
|
||||||
| ↳ `webViewLink` | string | URL to view in browser |
|
| ↳ `webViewLink` | string | URL to view in browser |
|
||||||
| ↳ `webContentLink` | string | Direct download URL |
|
| ↳ `webContentLink` | string | Direct download URL |
|
||||||
| ↳ `iconLink` | string | URL to file icon |
|
| ↳ `iconLink` | string | URL to file icon |
|
||||||
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
||||||
| ↳ `parents` | json | Parent folder IDs |
|
| ↳ `parents` | json | Parent folder IDs |
|
||||||
| ↳ `owners` | json | List of file owners |
|
| ↳ `owners` | json | List of file owners |
|
||||||
| ↳ `permissions` | json | File permissions |
|
| ↳ `permissions` | json | File permissions |
|
||||||
| ↳ `createdTime` | string | File creation time |
|
| ↳ `createdTime` | string | File creation time |
|
||||||
| ↳ `modifiedTime` | string | Last modification time |
|
| ↳ `modifiedTime` | string | Last modification time |
|
||||||
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
||||||
| ↳ `shared` | boolean | Whether file is shared |
|
| ↳ `shared` | boolean | Whether file is shared |
|
||||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||||
| ↳ `capabilities` | json | User capabilities on file |
|
| ↳ `capabilities` | json | User capabilities on file |
|
||||||
| ↳ `md5Checksum` | string | MD5 hash |
|
| ↳ `md5Checksum` | string | MD5 hash |
|
||||||
| ↳ `version` | string | Version number |
|
| ↳ `version` | string | Version number |
|
||||||
|
|
||||||
### `google_drive_create_folder`
|
### `google_drive_create_folder`
|
||||||
|
|
||||||
@@ -167,7 +167,7 @@ Create a new folder in Google Drive with complete metadata returned
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `fileName` | string | Yes | Name of the folder to create |
|
| `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\) |
|
| `folderId` | string | No | ID of the parent folder \(internal use\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -175,43 +175,43 @@ Create a new folder in Google Drive with complete metadata returned
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `file` | object | Complete created folder metadata from Google Drive |
|
| `file` | object | Complete created folder metadata from Google Drive |
|
||||||
| ↳ `id` | string | Google Drive folder ID |
|
| ↳ `id` | string | Google Drive folder ID |
|
||||||
| ↳ `kind` | string | Resource type identifier |
|
| ↳ `kind` | string | Resource type identifier |
|
||||||
| ↳ `name` | string | Folder name |
|
| ↳ `name` | string | Folder name |
|
||||||
| ↳ `mimeType` | string | MIME type \(application/vnd.google-apps.folder\) |
|
| ↳ `mimeType` | string | MIME type \(application/vnd.google-apps.folder\) |
|
||||||
| ↳ `description` | string | Folder description |
|
| ↳ `description` | string | Folder description |
|
||||||
| ↳ `owners` | json | List of folder owners |
|
| ↳ `owners` | json | List of folder owners |
|
||||||
| ↳ `permissions` | json | Folder permissions |
|
| ↳ `permissions` | json | Folder permissions |
|
||||||
| ↳ `permissionIds` | json | Permission IDs |
|
| ↳ `permissionIds` | json | Permission IDs |
|
||||||
| ↳ `shared` | boolean | Whether folder is shared |
|
| ↳ `shared` | boolean | Whether folder is shared |
|
||||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||||
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
||||||
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
||||||
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
||||||
| ↳ `sharingUser` | json | User who shared the folder |
|
| ↳ `sharingUser` | json | User who shared the folder |
|
||||||
| ↳ `starred` | boolean | Whether folder is starred |
|
| ↳ `starred` | boolean | Whether folder is starred |
|
||||||
| ↳ `trashed` | boolean | Whether folder is in trash |
|
| ↳ `trashed` | boolean | Whether folder is in trash |
|
||||||
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
||||||
| ↳ `appProperties` | json | App-specific properties |
|
| ↳ `appProperties` | json | App-specific properties |
|
||||||
| ↳ `folderColorRgb` | string | Folder color |
|
| ↳ `folderColorRgb` | string | Folder color |
|
||||||
| ↳ `createdTime` | string | Folder creation time |
|
| ↳ `createdTime` | string | Folder creation time |
|
||||||
| ↳ `modifiedTime` | string | Last modification time |
|
| ↳ `modifiedTime` | string | Last modification time |
|
||||||
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
||||||
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
||||||
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
||||||
| ↳ `lastModifyingUser` | json | User who last modified the folder |
|
| ↳ `lastModifyingUser` | json | User who last modified the folder |
|
||||||
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
||||||
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
||||||
| ↳ `webViewLink` | string | URL to view in browser |
|
| ↳ `webViewLink` | string | URL to view in browser |
|
||||||
| ↳ `iconLink` | string | URL to folder icon |
|
| ↳ `iconLink` | string | URL to folder icon |
|
||||||
| ↳ `parents` | json | Parent folder IDs |
|
| ↳ `parents` | json | Parent folder IDs |
|
||||||
| ↳ `spaces` | json | Spaces containing folder |
|
| ↳ `spaces` | json | Spaces containing folder |
|
||||||
| ↳ `driveId` | string | Shared drive ID |
|
| ↳ `driveId` | string | Shared drive ID |
|
||||||
| ↳ `capabilities` | json | User capabilities on folder |
|
| ↳ `capabilities` | json | User capabilities on folder |
|
||||||
| ↳ `version` | string | Version number |
|
| ↳ `version` | string | Version number |
|
||||||
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
||||||
| ↳ `contentRestrictions` | json | Content restrictions |
|
| ↳ `contentRestrictions` | json | Content restrictions |
|
||||||
| ↳ `linkShareMetadata` | json | Link share metadata |
|
| ↳ `linkShareMetadata` | json | Link share metadata |
|
||||||
|
|
||||||
### `google_drive_upload`
|
### `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\) |
|
| `file` | file | No | Binary file to upload \(UserFile object\) |
|
||||||
| `content` | string | No | Text content to upload \(use this OR file, not both\) |
|
| `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\) |
|
| `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\) |
|
| `folderId` | string | No | The ID of the folder to upload the file to \(internal use\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -233,58 +233,58 @@ Upload a file to Google Drive with complete metadata returned
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `file` | object | Complete uploaded file metadata from Google Drive |
|
| `file` | object | Complete uploaded file metadata from Google Drive |
|
||||||
| ↳ `id` | string | Google Drive file ID |
|
| ↳ `id` | string | Google Drive file ID |
|
||||||
| ↳ `kind` | string | Resource type identifier |
|
| ↳ `kind` | string | Resource type identifier |
|
||||||
| ↳ `name` | string | File name |
|
| ↳ `name` | string | File name |
|
||||||
| ↳ `mimeType` | string | MIME type |
|
| ↳ `mimeType` | string | MIME type |
|
||||||
| ↳ `description` | string | File description |
|
| ↳ `description` | string | File description |
|
||||||
| ↳ `originalFilename` | string | Original uploaded filename |
|
| ↳ `originalFilename` | string | Original uploaded filename |
|
||||||
| ↳ `fullFileExtension` | string | Full file extension |
|
| ↳ `fullFileExtension` | string | Full file extension |
|
||||||
| ↳ `fileExtension` | string | File extension |
|
| ↳ `fileExtension` | string | File extension |
|
||||||
| ↳ `owners` | json | List of file owners |
|
| ↳ `owners` | json | List of file owners |
|
||||||
| ↳ `permissions` | json | File permissions |
|
| ↳ `permissions` | json | File permissions |
|
||||||
| ↳ `permissionIds` | json | Permission IDs |
|
| ↳ `permissionIds` | json | Permission IDs |
|
||||||
| ↳ `shared` | boolean | Whether file is shared |
|
| ↳ `shared` | boolean | Whether file is shared |
|
||||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||||
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
||||||
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
||||||
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
||||||
| ↳ `sharingUser` | json | User who shared the file |
|
| ↳ `sharingUser` | json | User who shared the file |
|
||||||
| ↳ `starred` | boolean | Whether file is starred |
|
| ↳ `starred` | boolean | Whether file is starred |
|
||||||
| ↳ `trashed` | boolean | Whether file is in trash |
|
| ↳ `trashed` | boolean | Whether file is in trash |
|
||||||
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
||||||
| ↳ `appProperties` | json | App-specific properties |
|
| ↳ `appProperties` | json | App-specific properties |
|
||||||
| ↳ `createdTime` | string | File creation time |
|
| ↳ `createdTime` | string | File creation time |
|
||||||
| ↳ `modifiedTime` | string | Last modification time |
|
| ↳ `modifiedTime` | string | Last modification time |
|
||||||
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
||||||
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
||||||
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
||||||
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
||||||
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
||||||
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
||||||
| ↳ `webViewLink` | string | URL to view in browser |
|
| ↳ `webViewLink` | string | URL to view in browser |
|
||||||
| ↳ `webContentLink` | string | Direct download URL |
|
| ↳ `webContentLink` | string | Direct download URL |
|
||||||
| ↳ `iconLink` | string | URL to file icon |
|
| ↳ `iconLink` | string | URL to file icon |
|
||||||
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
||||||
| ↳ `exportLinks` | json | Export format links |
|
| ↳ `exportLinks` | json | Export format links |
|
||||||
| ↳ `size` | string | File size in bytes |
|
| ↳ `size` | string | File size in bytes |
|
||||||
| ↳ `quotaBytesUsed` | string | Storage quota used |
|
| ↳ `quotaBytesUsed` | string | Storage quota used |
|
||||||
| ↳ `md5Checksum` | string | MD5 hash |
|
| ↳ `md5Checksum` | string | MD5 hash |
|
||||||
| ↳ `sha1Checksum` | string | SHA-1 hash |
|
| ↳ `sha1Checksum` | string | SHA-1 hash |
|
||||||
| ↳ `sha256Checksum` | string | SHA-256 hash |
|
| ↳ `sha256Checksum` | string | SHA-256 hash |
|
||||||
| ↳ `parents` | json | Parent folder IDs |
|
| ↳ `parents` | json | Parent folder IDs |
|
||||||
| ↳ `spaces` | json | Spaces containing file |
|
| ↳ `spaces` | json | Spaces containing file |
|
||||||
| ↳ `driveId` | string | Shared drive ID |
|
| ↳ `driveId` | string | Shared drive ID |
|
||||||
| ↳ `capabilities` | json | User capabilities on file |
|
| ↳ `capabilities` | json | User capabilities on file |
|
||||||
| ↳ `version` | string | Version number |
|
| ↳ `version` | string | Version number |
|
||||||
| ↳ `headRevisionId` | string | Head revision ID |
|
| ↳ `headRevisionId` | string | Head revision ID |
|
||||||
| ↳ `hasThumbnail` | boolean | Whether has thumbnail |
|
| ↳ `hasThumbnail` | boolean | Whether has thumbnail |
|
||||||
| ↳ `thumbnailVersion` | string | Thumbnail version |
|
| ↳ `thumbnailVersion` | string | Thumbnail version |
|
||||||
| ↳ `imageMediaMetadata` | json | Image-specific metadata |
|
| ↳ `imageMediaMetadata` | json | Image-specific metadata |
|
||||||
| ↳ `videoMediaMetadata` | json | Video-specific metadata |
|
| ↳ `videoMediaMetadata` | json | Video-specific metadata |
|
||||||
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
||||||
| ↳ `contentRestrictions` | json | Content restrictions |
|
| ↳ `contentRestrictions` | json | Content restrictions |
|
||||||
| ↳ `linkShareMetadata` | json | Link share metadata |
|
| ↳ `linkShareMetadata` | json | Link share metadata |
|
||||||
|
|
||||||
### `google_drive_download`
|
### `google_drive_download`
|
||||||
|
|
||||||
@@ -304,64 +304,64 @@ Download a file from Google Drive with complete metadata (exports Google Workspa
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `file` | object | Downloaded file data |
|
| `file` | object | Downloaded file data |
|
||||||
| ↳ `name` | string | File name |
|
| ↳ `name` | string | File name |
|
||||||
| ↳ `mimeType` | string | MIME type of the file |
|
| ↳ `mimeType` | string | MIME type of the file |
|
||||||
| ↳ `data` | string | File content as base64-encoded string |
|
| ↳ `data` | string | File content as base64-encoded string |
|
||||||
| ↳ `size` | number | File size in bytes |
|
| ↳ `size` | number | File size in bytes |
|
||||||
| `metadata` | object | Complete file metadata from Google Drive |
|
| `metadata` | object | Complete file metadata from Google Drive |
|
||||||
| ↳ `id` | string | Google Drive file ID |
|
| ↳ `id` | string | Google Drive file ID |
|
||||||
| ↳ `kind` | string | Resource type identifier |
|
| ↳ `kind` | string | Resource type identifier |
|
||||||
| ↳ `name` | string | File name |
|
| ↳ `name` | string | File name |
|
||||||
| ↳ `mimeType` | string | MIME type |
|
| ↳ `mimeType` | string | MIME type |
|
||||||
| ↳ `description` | string | File description |
|
| ↳ `description` | string | File description |
|
||||||
| ↳ `originalFilename` | string | Original uploaded filename |
|
| ↳ `originalFilename` | string | Original uploaded filename |
|
||||||
| ↳ `fullFileExtension` | string | Full file extension |
|
| ↳ `fullFileExtension` | string | Full file extension |
|
||||||
| ↳ `fileExtension` | string | File extension |
|
| ↳ `fileExtension` | string | File extension |
|
||||||
| ↳ `owners` | json | List of file owners |
|
| ↳ `owners` | json | List of file owners |
|
||||||
| ↳ `permissions` | json | File permissions |
|
| ↳ `permissions` | json | File permissions |
|
||||||
| ↳ `permissionIds` | json | Permission IDs |
|
| ↳ `permissionIds` | json | Permission IDs |
|
||||||
| ↳ `shared` | boolean | Whether file is shared |
|
| ↳ `shared` | boolean | Whether file is shared |
|
||||||
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
| ↳ `ownedByMe` | boolean | Whether owned by current user |
|
||||||
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
| ↳ `writersCanShare` | boolean | Whether writers can share |
|
||||||
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy |
|
||||||
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission |
|
||||||
| ↳ `sharingUser` | json | User who shared the file |
|
| ↳ `sharingUser` | json | User who shared the file |
|
||||||
| ↳ `starred` | boolean | Whether file is starred |
|
| ↳ `starred` | boolean | Whether file is starred |
|
||||||
| ↳ `trashed` | boolean | Whether file is in trash |
|
| ↳ `trashed` | boolean | Whether file is in trash |
|
||||||
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed |
|
||||||
| ↳ `appProperties` | json | App-specific properties |
|
| ↳ `appProperties` | json | App-specific properties |
|
||||||
| ↳ `createdTime` | string | File creation time |
|
| ↳ `createdTime` | string | File creation time |
|
||||||
| ↳ `modifiedTime` | string | Last modification time |
|
| ↳ `modifiedTime` | string | Last modification time |
|
||||||
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
| ↳ `modifiedByMeTime` | string | When modified by current user |
|
||||||
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
| ↳ `viewedByMeTime` | string | When last viewed by current user |
|
||||||
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
| ↳ `sharedWithMeTime` | string | When shared with current user |
|
||||||
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
| ↳ `lastModifyingUser` | json | User who last modified the file |
|
||||||
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
| ↳ `viewedByMe` | boolean | Whether viewed by current user |
|
||||||
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
| ↳ `modifiedByMe` | boolean | Whether modified by current user |
|
||||||
| ↳ `webViewLink` | string | URL to view in browser |
|
| ↳ `webViewLink` | string | URL to view in browser |
|
||||||
| ↳ `webContentLink` | string | Direct download URL |
|
| ↳ `webContentLink` | string | Direct download URL |
|
||||||
| ↳ `iconLink` | string | URL to file icon |
|
| ↳ `iconLink` | string | URL to file icon |
|
||||||
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
| ↳ `thumbnailLink` | string | URL to thumbnail |
|
||||||
| ↳ `exportLinks` | json | Export format links |
|
| ↳ `exportLinks` | json | Export format links |
|
||||||
| ↳ `size` | string | File size in bytes |
|
| ↳ `size` | string | File size in bytes |
|
||||||
| ↳ `quotaBytesUsed` | string | Storage quota used |
|
| ↳ `quotaBytesUsed` | string | Storage quota used |
|
||||||
| ↳ `md5Checksum` | string | MD5 hash |
|
| ↳ `md5Checksum` | string | MD5 hash |
|
||||||
| ↳ `sha1Checksum` | string | SHA-1 hash |
|
| ↳ `sha1Checksum` | string | SHA-1 hash |
|
||||||
| ↳ `sha256Checksum` | string | SHA-256 hash |
|
| ↳ `sha256Checksum` | string | SHA-256 hash |
|
||||||
| ↳ `parents` | json | Parent folder IDs |
|
| ↳ `parents` | json | Parent folder IDs |
|
||||||
| ↳ `spaces` | json | Spaces containing file |
|
| ↳ `spaces` | json | Spaces containing file |
|
||||||
| ↳ `driveId` | string | Shared drive ID |
|
| ↳ `driveId` | string | Shared drive ID |
|
||||||
| ↳ `capabilities` | json | User capabilities on file |
|
| ↳ `capabilities` | json | User capabilities on file |
|
||||||
| ↳ `version` | string | Version number |
|
| ↳ `version` | string | Version number |
|
||||||
| ↳ `headRevisionId` | string | Head revision ID |
|
| ↳ `headRevisionId` | string | Head revision ID |
|
||||||
| ↳ `hasThumbnail` | boolean | Whether has thumbnail |
|
| ↳ `hasThumbnail` | boolean | Whether has thumbnail |
|
||||||
| ↳ `thumbnailVersion` | string | Thumbnail version |
|
| ↳ `thumbnailVersion` | string | Thumbnail version |
|
||||||
| ↳ `imageMediaMetadata` | json | Image-specific metadata |
|
| ↳ `imageMediaMetadata` | json | Image-specific metadata |
|
||||||
| ↳ `videoMediaMetadata` | json | Video-specific metadata |
|
| ↳ `videoMediaMetadata` | json | Video-specific metadata |
|
||||||
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
| ↳ `isAppAuthorized` | boolean | Whether created by requesting app |
|
||||||
| ↳ `contentRestrictions` | json | Content restrictions |
|
| ↳ `contentRestrictions` | json | Content restrictions |
|
||||||
| ↳ `linkShareMetadata` | json | Link share metadata |
|
| ↳ `linkShareMetadata` | json | Link share metadata |
|
||||||
| ↳ `revisions` | json | File revision history \(first 100 revisions only\) |
|
| ↳ `revisions` | json | File revision history \(first 100 revisions only\) |
|
||||||
|
|
||||||
### `google_drive_copy`
|
### `google_drive_copy`
|
||||||
|
|
||||||
@@ -380,16 +380,16 @@ Create a copy of a file in Google Drive
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `file` | json | The copied file metadata |
|
| `file` | json | The copied file metadata |
|
||||||
| ↳ `id` | string | Google Drive file ID of the copy |
|
| ↳ `id` | string | Google Drive file ID of the copy |
|
||||||
| ↳ `kind` | string | Resource type identifier |
|
| ↳ `kind` | string | Resource type identifier |
|
||||||
| ↳ `name` | string | File name |
|
| ↳ `name` | string | File name |
|
||||||
| ↳ `mimeType` | string | MIME type |
|
| ↳ `mimeType` | string | MIME type |
|
||||||
| ↳ `webViewLink` | string | URL to view in browser |
|
| ↳ `webViewLink` | string | URL to view in browser |
|
||||||
| ↳ `parents` | json | Parent folder IDs |
|
| ↳ `parents` | json | Parent folder IDs |
|
||||||
| ↳ `createdTime` | string | File creation time |
|
| ↳ `createdTime` | string | File creation time |
|
||||||
| ↳ `modifiedTime` | string | Last modification time |
|
| ↳ `modifiedTime` | string | Last modification time |
|
||||||
| ↳ `owners` | json | List of file owners |
|
| ↳ `owners` | json | List of file owners |
|
||||||
| ↳ `size` | string | File size in bytes |
|
| ↳ `size` | string | File size in bytes |
|
||||||
|
|
||||||
### `google_drive_update`
|
### `google_drive_update`
|
||||||
|
|
||||||
@@ -411,15 +411,15 @@ Update file metadata in Google Drive (rename, move, star, add description)
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `file` | json | The updated file metadata |
|
| `file` | json | The updated file metadata |
|
||||||
| ↳ `id` | string | Google Drive file ID |
|
| ↳ `id` | string | Google Drive file ID |
|
||||||
| ↳ `kind` | string | Resource type identifier |
|
| ↳ `kind` | string | Resource type identifier |
|
||||||
| ↳ `name` | string | File name |
|
| ↳ `name` | string | File name |
|
||||||
| ↳ `mimeType` | string | MIME type |
|
| ↳ `mimeType` | string | MIME type |
|
||||||
| ↳ `description` | string | File description |
|
| ↳ `description` | string | File description |
|
||||||
| ↳ `starred` | boolean | Whether file is starred |
|
| ↳ `starred` | boolean | Whether file is starred |
|
||||||
| ↳ `webViewLink` | string | URL to view in browser |
|
| ↳ `webViewLink` | string | URL to view in browser |
|
||||||
| ↳ `parents` | json | Parent folder IDs |
|
| ↳ `parents` | json | Parent folder IDs |
|
||||||
| ↳ `modifiedTime` | string | Last modification time |
|
| ↳ `modifiedTime` | string | Last modification time |
|
||||||
|
|
||||||
### `google_drive_trash`
|
### `google_drive_trash`
|
||||||
|
|
||||||
@@ -436,13 +436,13 @@ Move a file to the trash in Google Drive (can be restored later)
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `file` | json | The trashed file metadata |
|
| `file` | json | The trashed file metadata |
|
||||||
| ↳ `id` | string | Google Drive file ID |
|
| ↳ `id` | string | Google Drive file ID |
|
||||||
| ↳ `kind` | string | Resource type identifier |
|
| ↳ `kind` | string | Resource type identifier |
|
||||||
| ↳ `name` | string | File name |
|
| ↳ `name` | string | File name |
|
||||||
| ↳ `mimeType` | string | MIME type |
|
| ↳ `mimeType` | string | MIME type |
|
||||||
| ↳ `trashed` | boolean | Whether file is in trash \(should be true\) |
|
| ↳ `trashed` | boolean | Whether file is in trash \(should be true\) |
|
||||||
| ↳ `trashedTime` | string | When file was trashed |
|
| ↳ `trashedTime` | string | When file was trashed |
|
||||||
| ↳ `webViewLink` | string | URL to view in browser |
|
| ↳ `webViewLink` | string | URL to view in browser |
|
||||||
|
|
||||||
### `google_drive_delete`
|
### `google_drive_delete`
|
||||||
|
|
||||||
@@ -484,14 +484,14 @@ Share a file with a user, group, domain, or make it public
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `permission` | json | The created permission details |
|
| `permission` | json | The created permission details |
|
||||||
| ↳ `id` | string | Permission ID |
|
| ↳ `id` | string | Permission ID |
|
||||||
| ↳ `type` | string | Grantee type \(user, group, domain, anyone\) |
|
| ↳ `type` | string | Grantee type \(user, group, domain, anyone\) |
|
||||||
| ↳ `role` | string | Permission role |
|
| ↳ `role` | string | Permission role |
|
||||||
| ↳ `emailAddress` | string | Email of the grantee |
|
| ↳ `emailAddress` | string | Email of the grantee |
|
||||||
| ↳ `displayName` | string | Display name of the grantee |
|
| ↳ `displayName` | string | Display name of the grantee |
|
||||||
| ↳ `domain` | string | Domain of the grantee |
|
| ↳ `domain` | string | Domain of the grantee |
|
||||||
| ↳ `expirationTime` | string | Expiration time |
|
| ↳ `expirationTime` | string | Expiration time |
|
||||||
| ↳ `deleted` | boolean | Whether grantee is deleted |
|
| ↳ `deleted` | boolean | Whether grantee is deleted |
|
||||||
|
|
||||||
### `google_drive_unshare`
|
### `google_drive_unshare`
|
||||||
|
|
||||||
@@ -555,16 +555,16 @@ Get information about the user and their Google Drive (storage quota, capabiliti
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `user` | json | Information about the authenticated user |
|
| `user` | json | Information about the authenticated user |
|
||||||
| ↳ `displayName` | string | User display name |
|
| ↳ `displayName` | string | User display name |
|
||||||
| ↳ `emailAddress` | string | User email address |
|
| ↳ `emailAddress` | string | User email address |
|
||||||
| ↳ `photoLink` | string | URL to user profile photo |
|
| ↳ `photoLink` | string | URL to user profile photo |
|
||||||
| ↳ `permissionId` | string | User permission ID |
|
| ↳ `permissionId` | string | User permission ID |
|
||||||
| ↳ `me` | boolean | Whether this is the authenticated user |
|
| ↳ `me` | boolean | Whether this is the authenticated user |
|
||||||
| `storageQuota` | json | Storage quota information in bytes |
|
| `storageQuota` | json | Storage quota information in bytes |
|
||||||
| ↳ `limit` | string | Total storage limit in bytes \(null for unlimited\) |
|
| ↳ `limit` | string | Total storage limit in bytes \(null for unlimited\) |
|
||||||
| ↳ `usage` | string | Total storage used in bytes |
|
| ↳ `usage` | string | Total storage used in bytes |
|
||||||
| ↳ `usageInDrive` | string | Storage used by Drive files in bytes |
|
| ↳ `usageInDrive` | string | Storage used by Drive files in bytes |
|
||||||
| ↳ `usageInDriveTrash` | string | Storage used by trashed files in bytes |
|
| ↳ `usageInDriveTrash` | string | Storage used by trashed files in bytes |
|
||||||
| `canCreateDrives` | boolean | Whether user can create shared drives |
|
| `canCreateDrives` | boolean | Whether user can create shared drives |
|
||||||
| `importFormats` | json | Map of MIME types that can be imported and their target formats |
|
| `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 |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `formId` | string | Yes | The ID of the Google Form |
|
| `formId` | string | Yes | Google Forms form ID |
|
||||||
| `responseId` | string | No | If provided, returns this specific response |
|
| `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. |
|
| `pageSize` | number | No | Maximum number of responses to return \(service may return fewer\). Defaults to 5000. |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -57,10 +57,10 @@ Retrieve a single response or list responses from a Google Form
|
|||||||
| ↳ `lastSubmittedTime` | string | When the response was last submitted |
|
| ↳ `lastSubmittedTime` | string | When the response was last submitted |
|
||||||
| ↳ `answers` | json | Map of question IDs to answer values |
|
| ↳ `answers` | json | Map of question IDs to answer values |
|
||||||
| `response` | object | Single form response \(when responseId is provided\) |
|
| `response` | object | Single form response \(when responseId is provided\) |
|
||||||
| ↳ `responseId` | string | Unique response ID |
|
| ↳ `responseId` | string | Unique response ID |
|
||||||
| ↳ `createTime` | string | When the response was created |
|
| ↳ `createTime` | string | When the response was created |
|
||||||
| ↳ `lastSubmittedTime` | string | When the response was last submitted |
|
| ↳ `lastSubmittedTime` | string | When the response was last submitted |
|
||||||
| ↳ `answers` | json | Map of question IDs to answer values |
|
| ↳ `answers` | json | Map of question IDs to answer values |
|
||||||
| `raw` | json | Raw API response data |
|
| `raw` | json | Raw API response data |
|
||||||
|
|
||||||
### `google_forms_get_form`
|
### `google_forms_get_form`
|
||||||
@@ -71,7 +71,7 @@ Retrieve a form structure including its items, settings, and metadata
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
@@ -121,7 +121,7 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `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 |
|
| `includeFormInResponse` | boolean | No | Whether to return the updated form in the response |
|
||||||
|
|
||||||
@@ -131,25 +131,25 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `replies` | array | The replies from each update request |
|
| `replies` | array | The replies from each update request |
|
||||||
| `writeControl` | object | Write control information with revision IDs |
|
| `writeControl` | object | Write control information with revision IDs |
|
||||||
| ↳ `requiredRevisionId` | string | Required revision ID for conflict detection |
|
| ↳ `requiredRevisionId` | string | Required revision ID for conflict detection |
|
||||||
| ↳ `targetRevisionId` | string | Target revision ID |
|
| ↳ `targetRevisionId` | string | Target revision ID |
|
||||||
| `form` | object | The updated form \(if includeFormInResponse was true\) |
|
| `form` | object | The updated form \(if includeFormInResponse was true\) |
|
||||||
| ↳ `formId` | string | The form ID |
|
| ↳ `formId` | string | The form ID |
|
||||||
| ↳ `info` | object | Form info containing title and description |
|
| ↳ `info` | object | Form info containing title and description |
|
||||||
| ↳ `title` | string | The form title visible to responders |
|
| ↳ `title` | string | The form title visible to responders |
|
||||||
| ↳ `description` | string | The form description |
|
| ↳ `description` | string | The form description |
|
||||||
| ↳ `documentTitle` | string | The document title visible in Drive |
|
| ↳ `documentTitle` | string | The document title visible in Drive |
|
||||||
| ↳ `settings` | object | Form settings |
|
| ↳ `settings` | object | Form settings |
|
||||||
| ↳ `quizSettings` | object | Quiz 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 |
|
| ↳ `emailCollectionType` | string | Email collection type |
|
||||||
| ↳ `revisionId` | string | The revision ID of the form |
|
| ↳ `revisionId` | string | The revision ID of the form |
|
||||||
| ↳ `responderUri` | string | The URI to share with responders |
|
| ↳ `responderUri` | string | The URI to share with responders |
|
||||||
| ↳ `linkedSheetId` | string | The ID of the linked Google Sheet |
|
| ↳ `linkedSheetId` | string | The ID of the linked Google Sheet |
|
||||||
| ↳ `publishSettings` | object | Form publish settings |
|
| ↳ `publishSettings` | object | Form publish settings |
|
||||||
| ↳ `publishState` | object | Current publish state |
|
| ↳ `publishState` | object | Current publish state |
|
||||||
| ↳ `isPublished` | boolean | Whether the form is published |
|
| ↳ `isPublished` | boolean | Whether the form is published |
|
||||||
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
|
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
|
||||||
|
|
||||||
### `google_forms_set_publish_settings`
|
### `google_forms_set_publish_settings`
|
||||||
|
|
||||||
@@ -159,7 +159,7 @@ Update the publish settings of a form (publish/unpublish, accept responses)
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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\) |
|
| `isAcceptingResponses` | boolean | No | Whether the form accepts responses \(forced to false if isPublished is false\) |
|
||||||
|
|
||||||
@@ -169,9 +169,9 @@ Update the publish settings of a form (publish/unpublish, accept responses)
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `formId` | string | The form ID |
|
| `formId` | string | The form ID |
|
||||||
| `publishSettings` | json | The updated publish settings |
|
| `publishSettings` | json | The updated publish settings |
|
||||||
| ↳ `publishState` | object | The publish state |
|
| ↳ `publishState` | object | The publish state |
|
||||||
| ↳ `isPublished` | boolean | Whether the form is published |
|
| ↳ `isPublished` | boolean | Whether the form is published |
|
||||||
| ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses |
|
| ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses |
|
||||||
|
|
||||||
### `google_forms_create_watch`
|
### `google_forms_create_watch`
|
||||||
|
|
||||||
@@ -181,7 +181,7 @@ Create a notification watch for form changes (schema changes or new responses)
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `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\}\) |
|
| `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\) |
|
| `watchId` | string | No | Custom watch ID \(4-63 chars, lowercase letters, numbers, hyphens\) |
|
||||||
@@ -205,7 +205,7 @@ List all notification watches for a form
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `formId` | string | Yes | The ID of the Google Form |
|
| `formId` | string | Yes | Google Forms form ID |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -226,8 +226,8 @@ Delete a notification watch from a form
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `formId` | string | Yes | The ID of the Google Form |
|
| `formId` | string | Yes | Google Forms form ID |
|
||||||
| `watchId` | string | Yes | The ID of the watch to delete |
|
| `watchId` | string | Yes | Watch ID to delete |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -243,8 +243,8 @@ Renew a notification watch for another 7 days
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `formId` | string | Yes | The ID of the Google Form |
|
| `formId` | string | Yes | Google Forms form ID |
|
||||||
| `watchId` | string | Yes | The ID of the watch to renew |
|
| `watchId` | string | Yes | Watch ID to renew |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| `customer` | string | No | Customer ID or "my_customer" for the authenticated user\'s domain |
|
||||||
| `domain` | string | No | Domain name to filter groups by |
|
| `domain` | string | No | Domain name to filter groups by |
|
||||||
| `maxResults` | number | No | Maximum number of results to return \(1-200\) |
|
| `maxResults` | number | No | Maximum number of results to return \(1-200\). Example: 50 |
|
||||||
| `pageToken` | string | No | Token for pagination |
|
| `pageToken` | string | No | Token for fetching the next page of results |
|
||||||
| `query` | string | No | Search query to filter groups \(e.g., "email:admin*"\) |
|
| `query` | string | No | Search query to filter groups \(e.g., "email:admin*"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -47,7 +47,7 @@ Get details of a specific Google Group by email or group ID
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
@@ -63,8 +63,8 @@ Create a new Google Group in the domain
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `email` | string | Yes | Email address for the new group \(e.g., team@yourdomain.com\) |
|
| `email` | string | Yes | Email address for the new group \(e.g., team@example.com\) |
|
||||||
| `name` | string | Yes | Display name for the group |
|
| `name` | string | Yes | Display name for the group \(e.g., Engineering Team\) |
|
||||||
| `description` | string | No | Description of the group |
|
| `description` | string | No | Description of the group |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -81,10 +81,10 @@ Update an existing Google Group
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
||||||
| `name` | string | No | New display name for the group |
|
| `name` | string | No | New display name for the group \(e.g., Engineering Team\) |
|
||||||
| `description` | string | No | New description for the group |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ Delete a Google Group
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
@@ -116,9 +116,9 @@ List all members of a Google Group
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
||||||
| `maxResults` | number | No | Maximum number of results to return \(1-200\) |
|
| `maxResults` | number | No | Maximum number of results to return \(1-200\). Example: 50 |
|
||||||
| `pageToken` | string | No | Token for pagination |
|
| `pageToken` | string | No | Token for fetching the next page of results |
|
||||||
| `roles` | string | No | Filter by roles \(comma-separated: OWNER, MANAGER, MEMBER\) |
|
| `roles` | string | No | Filter by roles \(comma-separated: OWNER, MANAGER, MEMBER\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -136,8 +136,8 @@ Get details of a specific member in a Google Group
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
||||||
| `memberKey` | string | Yes | Member email address or unique member ID |
|
| `memberKey` | string | Yes | Member identifier. Can be the member email address \(e.g., user@example.com\) or the unique member ID |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -153,9 +153,9 @@ Add a new member to a Google Group
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
||||||
| `email` | string | Yes | Email address of the member to add |
|
| `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. |
|
| `role` | string | No | Role for the member: MEMBER, MANAGER, or OWNER. Defaults to MEMBER |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -171,8 +171,8 @@ Remove a member from a Google Group
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
||||||
| `memberKey` | string | Yes | Email address or unique ID of the member to remove |
|
| `memberKey` | string | Yes | Member identifier to remove. Can be the member email address \(e.g., user@example.com\) or the unique member ID |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -188,9 +188,9 @@ Update a member
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
||||||
| `memberKey` | string | Yes | Member email address or unique member 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\) |
|
| `role` | string | Yes | New role for the member: MEMBER, MANAGER, or OWNER |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -206,8 +206,8 @@ Check if a user is a member of a Google Group
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
||||||
| `memberKey` | string | Yes | Member email address or unique member ID to check |
|
| `memberKey` | string | Yes | Member identifier to check. Can be the member email address \(e.g., user@example.com\) or the unique member ID |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -223,7 +223,7 @@ List all email aliases for a Google Group
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
@@ -231,7 +231,7 @@ List all email aliases for a Google Group
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `aliases` | array | List of email aliases for the group |
|
| `aliases` | array | List of email aliases for the group |
|
||||||
| ↳ `id` | string | Unique group identifier |
|
| ↳ `id` | string | Unique group identifier |
|
||||||
| ↳ `primaryEmail` | string | Group |
|
| ↳ `primaryEmail` | string | Group's primary email address |
|
||||||
| ↳ `alias` | string | Alias email address |
|
| ↳ `alias` | string | Alias email address |
|
||||||
| ↳ `kind` | string | API resource type |
|
| ↳ `kind` | string | API resource type |
|
||||||
| ↳ `etag` | string | Resource version identifier |
|
| ↳ `etag` | string | Resource version identifier |
|
||||||
@@ -244,7 +244,7 @@ Add an email alias to a Google Group
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `alias` | string | Yes | The email alias to add to the group |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -252,7 +252,7 @@ Add an email alias to a Google Group
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `id` | string | Unique group identifier |
|
| `id` | string | Unique group identifier |
|
||||||
| `primaryEmail` | string | Group |
|
| `primaryEmail` | string | Group's primary email address |
|
||||||
| `alias` | string | The alias that was added |
|
| `alias` | string | The alias that was added |
|
||||||
| `kind` | string | API resource type |
|
| `kind` | string | API resource type |
|
||||||
| `etag` | string | Resource version identifier |
|
| `etag` | string | Resource version identifier |
|
||||||
@@ -265,7 +265,7 @@ Remove an email alias from a Google Group
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `alias` | string | Yes | The email alias to remove from the group |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -282,13 +282,13 @@ Get the settings for a Google Group including access permissions, moderation, an
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `email` | string | The group |
|
| `email` | string | The group's email address |
|
||||||
| `name` | string | The group name \(max 75 characters\) |
|
| `name` | string | The group name \(max 75 characters\) |
|
||||||
| `description` | string | The group description \(max 4096 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\) |
|
| `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 |
|
| `whoCanPostMessage` | string | Who can post messages to the group |
|
||||||
| `allowExternalMembers` | string | Whether external users can be members |
|
| `allowExternalMembers` | string | Whether external users can be members |
|
||||||
| `allowWebPosting` | string | Whether web posting is allowed |
|
| `allowWebPosting` | string | Whether web posting is allowed |
|
||||||
| `primaryLanguage` | string | The group |
|
| `primaryLanguage` | string | The group's primary language |
|
||||||
| `isArchived` | string | Whether messages are archived |
|
| `isArchived` | string | Whether messages are archived |
|
||||||
| `archiveOnly` | string | Whether the group is archive-only \(inactive\) |
|
| `archiveOnly` | string | Whether the group is archive-only \(inactive\) |
|
||||||
| `messageModerationLevel` | string | Message moderation level |
|
| `messageModerationLevel` | string | Message moderation level |
|
||||||
@@ -330,7 +330,7 @@ Update the settings for a Google Group including access permissions, moderation,
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `name` | string | No | The group name \(max 75 characters\) |
|
||||||
| `description` | string | No | The group description \(max 4096 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 |
|
| `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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `email` | string | The group |
|
| `email` | string | The group's email address |
|
||||||
| `name` | string | The group name |
|
| `name` | string | The group name |
|
||||||
| `description` | string | The group description |
|
| `description` | string | The group description |
|
||||||
| `whoCanJoin` | string | Who can join the group |
|
| `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 |
|
| `whoCanPostMessage` | string | Who can post messages to the group |
|
||||||
| `allowExternalMembers` | string | Whether external users can be members |
|
| `allowExternalMembers` | string | Whether external users can be members |
|
||||||
| `allowWebPosting` | string | Whether web posting is allowed |
|
| `allowWebPosting` | string | Whether web posting is allowed |
|
||||||
| `primaryLanguage` | string | The group |
|
| `primaryLanguage` | string | The group's primary language |
|
||||||
| `isArchived` | string | Whether messages are archived |
|
| `isArchived` | string | Whether messages are archived |
|
||||||
| `archiveOnly` | string | Whether the group is archive-only |
|
| `archiveOnly` | string | Whether the group is archive-only |
|
||||||
| `messageModerationLevel` | string | Message moderation level |
|
| `messageModerationLevel` | string | Message moderation level |
|
||||||
|
|||||||
@@ -66,12 +66,12 @@ Search the web with the Custom Search API
|
|||||||
| ↳ `title` | string | Title of the search result |
|
| ↳ `title` | string | Title of the search result |
|
||||||
| ↳ `link` | string | URL of the search result |
|
| ↳ `link` | string | URL of the search result |
|
||||||
| ↳ `snippet` | string | Snippet or description of the search result |
|
| ↳ `snippet` | string | Snippet or description of the search result |
|
||||||
| ↳ `displayLink` | string | Display URL |
|
| ↳ `displayLink` | string | Display URL \(abbreviated form\) |
|
||||||
| ↳ `pagemap` | object | Additional page metadata |
|
| ↳ `pagemap` | object | PageMap information for the result \(structured data\) |
|
||||||
| `searchInformation` | object | Information about the search query and results |
|
| `searchInformation` | object | Information about the search query and results |
|
||||||
| ↳ `totalResults` | string | Total number of search results available |
|
| ↳ `totalResults` | string | Total number of search results available |
|
||||||
| ↳ `searchTime` | number | Time taken to perform the search in seconds |
|
| ↳ `searchTime` | number | Time taken to perform the search in seconds |
|
||||||
| ↳ `formattedSearchTime` | string | Formatted search time for display |
|
| ↳ `formattedSearchTime` | string | Formatted search time for display |
|
||||||
| ↳ `formattedTotalResults` | string | Formatted total results count 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 |
|
| `range` | string | The range of cells that was read |
|
||||||
| `values` | array | The cell values as a 2D array |
|
| `values` | array | The cell values as a 2D array |
|
||||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||||
|
|
||||||
### `google_sheets_write`
|
### `google_sheets_write`
|
||||||
|
|
||||||
@@ -79,8 +79,8 @@ Write data to a specific sheet in a Google Sheets spreadsheet
|
|||||||
| `updatedColumns` | number | Number of columns updated |
|
| `updatedColumns` | number | Number of columns updated |
|
||||||
| `updatedCells` | number | Number of cells updated |
|
| `updatedCells` | number | Number of cells updated |
|
||||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||||
|
|
||||||
### `google_sheets_update`
|
### `google_sheets_update`
|
||||||
|
|
||||||
@@ -105,8 +105,8 @@ Update data in a specific sheet in a Google Sheets spreadsheet
|
|||||||
| `updatedColumns` | number | Number of columns updated |
|
| `updatedColumns` | number | Number of columns updated |
|
||||||
| `updatedCells` | number | Number of cells updated |
|
| `updatedCells` | number | Number of cells updated |
|
||||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||||
|
|
||||||
### `google_sheets_append`
|
### `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 |
|
| `updatedColumns` | number | Number of columns updated |
|
||||||
| `updatedCells` | number | Number of cells updated |
|
| `updatedCells` | number | Number of cells updated |
|
||||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||||
|
|
||||||
### `google_sheets_clear`
|
### `google_sheets_clear`
|
||||||
|
|
||||||
@@ -144,7 +144,7 @@ Clear values from a specific range in a Google Sheets spreadsheet
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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. |
|
| `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 |
|
| `clearedRange` | string | The range that was cleared |
|
||||||
| `sheetName` | string | Name of the sheet that was cleared |
|
| `sheetName` | string | Name of the sheet that was cleared |
|
||||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||||
|
|
||||||
### `google_sheets_get_spreadsheet`
|
### `google_sheets_get_spreadsheet`
|
||||||
|
|
||||||
@@ -166,7 +166,7 @@ Get metadata about a Google Sheets spreadsheet including title and sheet list
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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. |
|
| `includeGridData` | boolean | No | Whether to include grid data \(cell values\). Defaults to false. |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -219,7 +219,7 @@ Read multiple ranges from a Google Sheets spreadsheet in a single request
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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. |
|
| `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" |
|
| `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" |
|
| `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\) |
|
| ↳ `majorDimension` | string | Major dimension \(ROWS or COLUMNS\) |
|
||||||
| ↳ `values` | array | The cell values as a 2D array |
|
| ↳ `values` | array | The cell values as a 2D array |
|
||||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||||
|
|
||||||
### `google_sheets_batch_update`
|
### `google_sheets_batch_update`
|
||||||
|
|
||||||
@@ -245,7 +245,7 @@ Update multiple ranges in a Google Sheets spreadsheet in a single request
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\). |
|
| `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. |
|
| `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 |
|
| ↳ `updatedColumns` | number | Number of columns updated in this range |
|
||||||
| ↳ `updatedCells` | number | Number of cells updated in this range |
|
| ↳ `updatedCells` | number | Number of cells updated in this range |
|
||||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||||
|
|
||||||
### `google_sheets_batch_clear`
|
### `google_sheets_batch_clear`
|
||||||
|
|
||||||
@@ -276,7 +276,7 @@ Clear multiple ranges in a Google Sheets spreadsheet in a single request
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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. |
|
| `ranges` | json | Yes | Array of ranges to clear \(e.g., \["Sheet1!A1:D10", "Sheet2!A1:B5"\]\). Each range should include sheet name. |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -286,8 +286,8 @@ Clear multiple ranges in a Google Sheets spreadsheet in a single request
|
|||||||
| `spreadsheetId` | string | The spreadsheet ID |
|
| `spreadsheetId` | string | The spreadsheet ID |
|
||||||
| `clearedRanges` | array | Array of ranges that were cleared |
|
| `clearedRanges` | array | Array of ranges that were cleared |
|
||||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||||
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID |
|
||||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||||
|
|
||||||
### `google_sheets_copy_sheet`
|
### `google_sheets_copy_sheet`
|
||||||
|
|
||||||
@@ -297,7 +297,7 @@ Copy a sheet from one spreadsheet to another
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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. |
|
| `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 |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `presentationId` | string | Yes | The ID of the presentation to read |
|
| `presentationId` | string | Yes | Google Slides presentation ID |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -52,13 +52,13 @@ Read content from a Google Slides presentation
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `slides` | json | Array of slides with their content |
|
| `slides` | json | Array of slides with their content |
|
||||||
| `metadata` | json | Presentation metadata including ID, title, and URL |
|
| `metadata` | json | Presentation metadata including ID, title, and URL |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `title` | string | The presentation title |
|
| ↳ `title` | string | The presentation title |
|
||||||
| ↳ `pageSize` | object | Presentation page size |
|
| ↳ `pageSize` | object | Presentation page size |
|
||||||
| ↳ `width` | json | Page width as a Dimension object |
|
| ↳ `width` | json | Page width as a Dimension object |
|
||||||
| ↳ `height` | json | Page height as a Dimension object |
|
| ↳ `height` | json | Page height as a Dimension object |
|
||||||
| ↳ `mimeType` | string | The mime type of the presentation |
|
| ↳ `mimeType` | string | The mime type of the presentation |
|
||||||
| ↳ `url` | string | URL to open the presentation |
|
| ↳ `url` | string | URL to open the presentation |
|
||||||
|
|
||||||
### `google_slides_write`
|
### `google_slides_write`
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ Write or update content in a Google Slides presentation
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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\) |
|
| `slideIndex` | number | No | The index of the slide to write to \(defaults to first slide\) |
|
||||||
|
|
||||||
@@ -78,10 +78,10 @@ Write or update content in a Google Slides presentation
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `updatedContent` | boolean | Indicates if presentation content was updated successfully |
|
| `updatedContent` | boolean | Indicates if presentation content was updated successfully |
|
||||||
| `metadata` | json | Updated presentation metadata including ID, title, and URL |
|
| `metadata` | json | Updated presentation metadata including ID, title, and URL |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `title` | string | The presentation title |
|
| ↳ `title` | string | The presentation title |
|
||||||
| ↳ `mimeType` | string | The mime type of the presentation |
|
| ↳ `mimeType` | string | The mime type of the presentation |
|
||||||
| ↳ `url` | string | URL to open the presentation |
|
| ↳ `url` | string | URL to open the presentation |
|
||||||
|
|
||||||
### `google_slides_create`
|
### `google_slides_create`
|
||||||
|
|
||||||
@@ -93,7 +93,7 @@ Create a new Google Slides presentation
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `title` | string | Yes | The title of the presentation to create |
|
| `title` | string | Yes | The title of the presentation to create |
|
||||||
| `content` | string | No | The content to add to the first slide |
|
| `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\) |
|
| `folderId` | string | No | The ID of the folder to create the presentation in \(internal use\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -101,10 +101,10 @@ Create a new Google Slides presentation
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `metadata` | json | Created presentation metadata including ID, title, and URL |
|
| `metadata` | json | Created presentation metadata including ID, title, and URL |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `title` | string | The presentation title |
|
| ↳ `title` | string | The presentation title |
|
||||||
| ↳ `mimeType` | string | The mime type of the presentation |
|
| ↳ `mimeType` | string | The mime type of the presentation |
|
||||||
| ↳ `url` | string | URL to open the presentation |
|
| ↳ `url` | string | URL to open the presentation |
|
||||||
|
|
||||||
### `google_slides_replace_all_text`
|
### `google_slides_replace_all_text`
|
||||||
|
|
||||||
@@ -114,7 +114,7 @@ Find and replace all occurrences of text throughout a Google Slides presentation
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\}\}\) |
|
| `findText` | string | Yes | The text to find \(e.g., \{\{placeholder\}\}\) |
|
||||||
| `replaceText` | string | Yes | The text to replace with |
|
| `replaceText` | string | Yes | The text to replace with |
|
||||||
| `matchCase` | boolean | No | Whether the search should be case-sensitive \(default: true\) |
|
| `matchCase` | boolean | No | Whether the search should be case-sensitive \(default: true\) |
|
||||||
@@ -126,10 +126,10 @@ Find and replace all occurrences of text throughout a Google Slides presentation
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `occurrencesChanged` | number | Number of text occurrences that were replaced |
|
| `occurrencesChanged` | number | Number of text occurrences that were replaced |
|
||||||
| `metadata` | json | Operation metadata including presentation ID and URL |
|
| `metadata` | json | Operation metadata including presentation ID and URL |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `findText` | string | The text that was searched for |
|
| ↳ `findText` | string | The text that was searched for |
|
||||||
| ↳ `replaceText` | string | The text that replaced the matches |
|
| ↳ `replaceText` | string | The text that replaced the matches |
|
||||||
| ↳ `url` | string | URL to open the presentation |
|
| ↳ `url` | string | URL to open the presentation |
|
||||||
|
|
||||||
### `google_slides_add_slide`
|
### `google_slides_add_slide`
|
||||||
|
|
||||||
@@ -139,7 +139,7 @@ Add a new slide to a Google Slides presentation with a specified layout
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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. |
|
| `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. |
|
| `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"\}\] |
|
| `placeholderIdMappings` | string | No | JSON array of placeholder mappings to assign custom object IDs to placeholders. Format: \[\{"layoutPlaceholder":\{"type":"TITLE"\},"objectId":"custom_title_id"\}\] |
|
||||||
@@ -150,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 |
|
| `slideId` | string | The object ID of the newly created slide |
|
||||||
| `metadata` | json | Operation metadata including presentation ID, layout, and URL |
|
| `metadata` | json | Operation metadata including presentation ID, layout, and URL |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `layout` | string | The layout used for the new slide |
|
| ↳ `layout` | string | The layout used for the new slide |
|
||||||
| ↳ `insertionIndex` | number | The zero-based index where the slide was inserted |
|
| ↳ `insertionIndex` | number | The zero-based index where the slide was inserted |
|
||||||
| ↳ `url` | string | URL to open the presentation |
|
| ↳ `url` | string | URL to open the presentation |
|
||||||
|
|
||||||
### `google_slides_add_image`
|
### `google_slides_add_image`
|
||||||
|
|
||||||
@@ -163,7 +163,7 @@ Insert an image into a specific slide in a Google Slides presentation
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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\) |
|
| `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\) |
|
| `width` | number | No | Width of the image in points \(default: 300\) |
|
||||||
@@ -177,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 |
|
| `imageId` | string | The object ID of the newly created image |
|
||||||
| `metadata` | json | Operation metadata including presentation ID and image URL |
|
| `metadata` | json | Operation metadata including presentation ID and image URL |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `pageObjectId` | string | The page object ID where the image was inserted |
|
| ↳ `pageObjectId` | string | The page object ID where the image was inserted |
|
||||||
| ↳ `imageUrl` | string | The source image URL |
|
| ↳ `imageUrl` | string | The source image URL |
|
||||||
| ↳ `url` | string | URL to open the presentation |
|
| ↳ `url` | string | URL to open the presentation |
|
||||||
|
|
||||||
### `google_slides_get_thumbnail`
|
### `google_slides_get_thumbnail`
|
||||||
|
|
||||||
@@ -190,7 +190,7 @@ Generate a thumbnail image of a specific slide in a Google Slides presentation
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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. |
|
| `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. |
|
| `mimeType` | string | No | The MIME type of the thumbnail image: PNG or GIF. Defaults to PNG. |
|
||||||
@@ -203,10 +203,10 @@ Generate a thumbnail image of a specific slide in a Google Slides presentation
|
|||||||
| `width` | number | Width of the thumbnail in pixels |
|
| `width` | number | Width of the thumbnail in pixels |
|
||||||
| `height` | number | Height of the thumbnail in pixels |
|
| `height` | number | Height of the thumbnail in pixels |
|
||||||
| `metadata` | json | Operation metadata including presentation ID and page object ID |
|
| `metadata` | json | Operation metadata including presentation ID and page object ID |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `pageObjectId` | string | The page object ID for the thumbnail |
|
| ↳ `pageObjectId` | string | The page object ID for the thumbnail |
|
||||||
| ↳ `thumbnailSize` | string | The requested thumbnail size |
|
| ↳ `thumbnailSize` | string | The requested thumbnail size |
|
||||||
| ↳ `mimeType` | string | The thumbnail MIME type |
|
| ↳ `mimeType` | string | The thumbnail MIME type |
|
||||||
|
|
||||||
### `google_slides_get_page`
|
### `google_slides_get_page`
|
||||||
|
|
||||||
@@ -216,7 +216,7 @@ Get detailed information about a specific slide/page in a Google Slides presenta
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `pageObjectId` | string | Yes | The object ID of the slide/page to retrieve |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -227,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\) |
|
| `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 |
|
| `pageElements` | array | Array of page elements \(shapes, images, tables, etc.\) on this page |
|
||||||
| `slideProperties` | object | Properties specific to slides \(layout, master, notes\) |
|
| `slideProperties` | object | Properties specific to slides \(layout, master, notes\) |
|
||||||
| ↳ `layoutObjectId` | string | Object ID of the layout this slide is based on |
|
| ↳ `layoutObjectId` | string | Object ID of the layout this slide is based on |
|
||||||
| ↳ `masterObjectId` | string | Object ID of the master 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 |
|
| ↳ `notesPage` | json | The notes page associated with the slide |
|
||||||
| `metadata` | object | Operation metadata including presentation ID and URL |
|
| `metadata` | object | Operation metadata including presentation ID and URL |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `url` | string | URL to the presentation |
|
| ↳ `url` | string | URL to the presentation |
|
||||||
|
|
||||||
### `google_slides_delete_object`
|
### `google_slides_delete_object`
|
||||||
|
|
||||||
@@ -242,7 +242,7 @@ Delete a page element (shape, image, table, etc.) or an entire slide from a Goog
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `objectId` | string | Yes | The object ID of the element or slide to delete |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -252,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 |
|
| `deleted` | boolean | Whether the object was successfully deleted |
|
||||||
| `objectId` | string | The object ID that was deleted |
|
| `objectId` | string | The object ID that was deleted |
|
||||||
| `metadata` | object | Operation metadata including presentation ID and URL |
|
| `metadata` | object | Operation metadata including presentation ID and URL |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `url` | string | URL to the presentation |
|
| ↳ `url` | string | URL to the presentation |
|
||||||
|
|
||||||
### `google_slides_duplicate_object`
|
### `google_slides_duplicate_object`
|
||||||
|
|
||||||
@@ -263,7 +263,7 @@ Duplicate an object (slide, shape, image, table, etc.) in a Google Slides presen
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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"\} |
|
| `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 |
|
| `Format` | string | No | No description |
|
||||||
@@ -274,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 |
|
| `duplicatedObjectId` | string | The object ID of the newly created duplicate |
|
||||||
| `metadata` | object | Operation metadata including presentation ID and source object ID |
|
| `metadata` | object | Operation metadata including presentation ID and source object ID |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `sourceObjectId` | string | The original object ID that was duplicated |
|
| ↳ `sourceObjectId` | string | The original object ID that was duplicated |
|
||||||
| ↳ `url` | string | URL to the presentation |
|
| ↳ `url` | string | URL to the presentation |
|
||||||
|
|
||||||
### `google_slides_update_slides_position`
|
### `google_slides_update_slides_position`
|
||||||
|
|
||||||
@@ -286,7 +286,7 @@ Move one or more slides to a new position in a Google Slides presentation
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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. |
|
| `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. |
|
| `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. |
|
||||||
|
|
||||||
@@ -298,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 |
|
| `slideObjectIds` | array | The slide object IDs that were moved |
|
||||||
| `insertionIndex` | number | The index where the slides were moved to |
|
| `insertionIndex` | number | The index where the slides were moved to |
|
||||||
| `metadata` | object | Operation metadata including presentation ID and URL |
|
| `metadata` | object | Operation metadata including presentation ID and URL |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `url` | string | URL to the presentation |
|
| ↳ `url` | string | URL to the presentation |
|
||||||
|
|
||||||
### `google_slides_create_table`
|
### `google_slides_create_table`
|
||||||
|
|
||||||
@@ -309,7 +309,7 @@ Create a new table on a slide in a Google Slides presentation
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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\) |
|
| `rows` | number | Yes | Number of rows in the table \(minimum 1\) |
|
||||||
| `columns` | number | Yes | Number of columns in the table \(minimum 1\) |
|
| `columns` | number | Yes | Number of columns in the table \(minimum 1\) |
|
||||||
@@ -326,9 +326,9 @@ Create a new table on a slide in a Google Slides presentation
|
|||||||
| `rows` | number | Number of rows in the table |
|
| `rows` | number | Number of rows in the table |
|
||||||
| `columns` | number | Number of columns in the table |
|
| `columns` | number | Number of columns in the table |
|
||||||
| `metadata` | object | Operation metadata including presentation ID and page object ID |
|
| `metadata` | object | Operation metadata including presentation ID and page object ID |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `pageObjectId` | string | The page object ID where the table was created |
|
| ↳ `pageObjectId` | string | The page object ID where the table was created |
|
||||||
| ↳ `url` | string | URL to the presentation |
|
| ↳ `url` | string | URL to the presentation |
|
||||||
|
|
||||||
### `google_slides_create_shape`
|
### `google_slides_create_shape`
|
||||||
|
|
||||||
@@ -338,7 +338,7 @@ Create a shape (rectangle, ellipse, text box, arrow, etc.) on a slide in a Googl
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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 |
|
| `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\) |
|
| `width` | number | No | Width of the shape in points \(default: 200\) |
|
||||||
@@ -353,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 |
|
| `shapeId` | string | The object ID of the newly created shape |
|
||||||
| `shapeType` | string | The type of shape that was created |
|
| `shapeType` | string | The type of shape that was created |
|
||||||
| `metadata` | object | Operation metadata including presentation ID and page object ID |
|
| `metadata` | object | Operation metadata including presentation ID and page object ID |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `pageObjectId` | string | The page object ID where the shape was created |
|
| ↳ `pageObjectId` | string | The page object ID where the shape was created |
|
||||||
| ↳ `url` | string | URL to the presentation |
|
| ↳ `url` | string | URL to the presentation |
|
||||||
|
|
||||||
### `google_slides_insert_text`
|
### `google_slides_insert_text`
|
||||||
|
|
||||||
@@ -365,7 +365,7 @@ Insert text into a shape or table cell in a Google Slides presentation. Use this
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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. |
|
| `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 |
|
| `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\). |
|
| `insertionIndex` | number | No | The zero-based index at which to insert the text. If not specified, text is inserted at the beginning \(index 0\). |
|
||||||
@@ -378,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 |
|
| `objectId` | string | The object ID where text was inserted |
|
||||||
| `text` | string | The text that was inserted |
|
| `text` | string | The text that was inserted |
|
||||||
| `metadata` | object | Operation metadata including presentation ID and URL |
|
| `metadata` | object | Operation metadata including presentation ID and URL |
|
||||||
| ↳ `presentationId` | string | The presentation ID |
|
| ↳ `presentationId` | string | The presentation ID |
|
||||||
| ↳ `url` | string | URL to the presentation |
|
| ↳ `url` | string | URL to the presentation |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -42,14 +42,14 @@ Create an export in a matter
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `exportName` | string | Yes | Name for the export \(avoid special characters\) |
|
||||||
| `corpus` | string | Yes | Data corpus to export \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) |
|
| `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 |
|
| `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 \(alternative to emails\) |
|
| `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\) |
|
| `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\) |
|
| `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 |
|
| `terms` | string | No | Search query terms to filter exported content \(e.g., "from:sender@example.com subject:invoice"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -65,10 +65,10 @@ List exports for a matter
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `pageSize` | number | No | Number of exports to return per page |
|
||||||
| `pageToken` | string | No | Token for pagination |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ Download a single file from a Google Vault export (GCS object)
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `bucketName` | string | Yes | GCS bucket name from cloudStorageSink.files.bucketName |
|
||||||
| `objectName` | string | Yes | GCS object name from cloudStorageSink.files.objectName |
|
| `objectName` | string | Yes | GCS object name from cloudStorageSink.files.objectName |
|
||||||
| `fileName` | string | No | Optional filename override for the downloaded file |
|
| `fileName` | string | No | Optional filename override for the downloaded file |
|
||||||
@@ -105,14 +105,14 @@ Create a hold in a matter
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `holdName` | string | Yes | Name for the hold |
|
||||||
| `corpus` | string | Yes | Data corpus to hold \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) |
|
| `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 |
|
| `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 \(alternative to accounts\) |
|
| `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 \(for MAIL and GROUPS corpus\) |
|
| `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, 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, 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\) |
|
| `includeSharedDrives` | boolean | No | Include files in shared drives \(for DRIVE corpus\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -129,10 +129,10 @@ List holds for a matter
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `pageSize` | number | No | Number of holds to return per page |
|
||||||
| `pageToken` | string | No | Token for pagination |
|
| `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
|
#### 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 |
|
| `pageSize` | number | No | Number of matters to return per page |
|
||||||
| `pageToken` | string | No | Token for pagination |
|
| `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
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -48,8 +48,8 @@ Get a dashboard by its UID
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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\) |
|
||||||
| `dashboardUid` | string | Yes | The UID of the dashboard to retrieve |
|
| `dashboardUid` | string | Yes | The UID of the dashboard to retrieve \(e.g., abc123def\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -68,10 +68,10 @@ Search and list all dashboards
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `query` | string | No | Search query to filter dashboards by title |
|
||||||
| `tag` | string | No | Filter by tag \(comma-separated for multiple tags\) |
|
| `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 |
|
| `starred` | boolean | No | Only return starred dashboards |
|
||||||
| `limit` | number | No | Maximum number of dashboards to return |
|
| `limit` | number | No | Maximum number of dashboards to return |
|
||||||
|
|
||||||
@@ -97,9 +97,9 @@ Create a new dashboard
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `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 |
|
| `tags` | string | No | Comma-separated list of tags |
|
||||||
| `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) |
|
| `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) |
|
||||||
| `refresh` | string | No | Auto-refresh interval \(e.g., 5s, 1m, 5m\) |
|
| `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 |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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\) |
|
||||||
| `dashboardUid` | string | Yes | The UID of the dashboard to update |
|
| `dashboardUid` | string | Yes | The UID of the dashboard to update \(e.g., abc123def\) |
|
||||||
| `title` | string | No | New title for the dashboard |
|
| `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 |
|
| `tags` | string | No | Comma-separated list of new tags |
|
||||||
| `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) |
|
| `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) |
|
||||||
| `refresh` | string | No | Auto-refresh interval \(e.g., 5s, 1m, 5m\) |
|
| `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 |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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\) |
|
||||||
| `dashboardUid` | string | Yes | The UID of the dashboard to delete |
|
| `dashboardUid` | string | Yes | The UID of the dashboard to delete \(e.g., abc123def\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -181,7 +181,7 @@ List all alert rules in the Grafana instance
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -206,7 +206,7 @@ Get a specific alert rule by its UID
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `alertRuleUid` | string | Yes | The UID of the alert rule to retrieve |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -234,9 +234,9 @@ Create a new alert rule
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `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 |
|
| `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 |
|
| `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 |
|
| `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 |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `alertRuleUid` | string | Yes | The UID of the alert rule to update |
|
||||||
| `title` | string | No | New title for the alert rule |
|
| `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 |
|
| `ruleGroup` | string | No | New rule group name |
|
||||||
| `condition` | string | No | New condition refId |
|
| `condition` | string | No | New condition refId |
|
||||||
| `data` | string | No | New JSON array of query/expression data objects |
|
| `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 |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `alertRuleUid` | string | Yes | The UID of the alert rule to delete |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -316,7 +316,7 @@ List all alert notification contact points
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -338,13 +338,13 @@ Create an annotation on a dashboard or as a global annotation
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `text` | string | Yes | The text content of the annotation |
|
||||||
| `tags` | string | No | Comma-separated list of tags |
|
| `tags` | string | No | Comma-separated list of tags |
|
||||||
| `dashboardUid` | string | Yes | UID of the dashboard to add the annotation to |
|
| `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 |
|
| `panelId` | number | No | ID of the panel to add the annotation to \(e.g., 1, 2\) |
|
||||||
| `time` | number | No | Start time in epoch milliseconds \(defaults to now\) |
|
| `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\) |
|
| `timeEnd` | number | No | End time in epoch milliseconds for range annotations \(e.g., 1704153600000\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -363,11 +363,11 @@ Query annotations by time range, dashboard, or tags
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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\) |
|
||||||
| `from` | number | No | Start time in epoch milliseconds |
|
| `from` | number | No | Start time in epoch milliseconds \(e.g., 1704067200000\) |
|
||||||
| `to` | number | No | End time in epoch milliseconds |
|
| `to` | number | No | End time in epoch milliseconds \(e.g., 1704153600000\) |
|
||||||
| `dashboardUid` | string | Yes | Dashboard UID to query annotations from |
|
| `dashboardUid` | string | Yes | Dashboard UID to query annotations from \(e.g., abc123def\) |
|
||||||
| `panelId` | number | No | Filter by panel ID |
|
| `panelId` | number | No | Filter by panel ID \(e.g., 1, 2\) |
|
||||||
| `tags` | string | No | Comma-separated list of tags to filter by |
|
| `tags` | string | No | Comma-separated list of tags to filter by |
|
||||||
| `type` | string | No | Filter by type \(alert or annotation\) |
|
| `type` | string | No | Filter by type \(alert or annotation\) |
|
||||||
| `limit` | number | No | Maximum number of annotations to return |
|
| `limit` | number | No | Maximum number of annotations to return |
|
||||||
@@ -401,12 +401,12 @@ Update an existing annotation
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `annotationId` | number | Yes | The ID of the annotation to update |
|
||||||
| `text` | string | Yes | New text content for the annotation |
|
| `text` | string | Yes | New text content for the annotation |
|
||||||
| `tags` | string | No | Comma-separated list of new tags |
|
| `tags` | string | No | Comma-separated list of new tags |
|
||||||
| `time` | number | No | New start 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 |
|
| `timeEnd` | number | No | New end time in epoch milliseconds \(e.g., 1704153600000\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -425,7 +425,7 @@ Delete an annotation by its ID
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `annotationId` | number | Yes | The ID of the annotation to delete |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -444,7 +444,7 @@ List all data sources configured in Grafana
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -468,8 +468,8 @@ Get a data source by its ID or UID
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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\) |
|
||||||
| `dataSourceId` | string | Yes | The ID or UID of the data source to retrieve |
|
| `dataSourceId` | string | Yes | The ID or UID of the data source to retrieve \(e.g., prometheus, P1234AB5678\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -494,7 +494,7 @@ List all folders in Grafana
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `limit` | number | No | Maximum number of folders to return |
|
||||||
| `page` | number | No | Page number for pagination |
|
| `page` | number | No | Page number for pagination |
|
||||||
|
|
||||||
@@ -527,7 +527,7 @@ Create a new folder in Grafana
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
| `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 |
|
| `title` | string | Yes | The title of the new folder |
|
||||||
| `uid` | string | No | Optional UID for the folder \(auto-generated if not provided\) |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
||||||
| `cursor` | string | No | Pagination cursor for next page |
|
| `cursor` | string | No | Pagination cursor for next page \(returned from previous response\) |
|
||||||
| `beforeDatetime` | string | No | Only recordings before this ISO8601 timestamp |
|
| `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 |
|
| `afterDatetime` | string | No | Only recordings after this ISO8601 timestamp \(e.g., "2024-01-01T00:00:00Z"\) |
|
||||||
| `participantScope` | string | No | Filter: "internal" or "external" |
|
| `participantScope` | string | No | Filter: "internal" or "external" |
|
||||||
| `titleSearch` | string | No | Search term to filter by recording title |
|
| `titleSearch` | string | No | Search term to filter by recording title \(e.g., "weekly standup"\) |
|
||||||
| `teamId` | string | No | Filter by team UUID |
|
| `teamId` | string | No | Filter by team UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||||
| `meetingTypeId` | string | No | Filter by meeting type UUID |
|
| `meetingTypeId` | string | No | Filter by meeting type UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||||
| `includeHighlights` | boolean | No | Include highlights/clips in response |
|
| `includeHighlights` | boolean | No | Include highlights/clips in response |
|
||||||
| `includeParticipants` | boolean | No | Include participant list in response |
|
| `includeParticipants` | boolean | No | Include participant list in response |
|
||||||
| `includeAiSummary` | boolean | No | Include AI-generated summary |
|
| `includeAiSummary` | boolean | No | Include AI-generated summary |
|
||||||
@@ -87,7 +87,7 @@ Get details of a single recording by ID
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
| `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 |
|
| `includeHighlights` | boolean | No | Include highlights/clips |
|
||||||
| `includeParticipants` | boolean | No | Include participant list |
|
| `includeParticipants` | boolean | No | Include participant list |
|
||||||
| `includeAiSummary` | boolean | No | Include AI summary |
|
| `includeAiSummary` | boolean | No | Include AI summary |
|
||||||
@@ -125,7 +125,7 @@ Get the full transcript of a recording
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -184,13 +184,13 @@ Create a webhook to receive recording events
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
| `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" |
|
| `hookType` | string | Yes | Type of webhook: "recording_added" or "upload_status" |
|
||||||
| `filterBeforeDatetime` | string | No | Filter: recordings before 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 date |
|
| `filterAfterDatetime` | string | No | Filter: recordings after this ISO8601 date \(e.g., "2024-01-01T00:00:00Z"\) |
|
||||||
| `filterParticipantScope` | string | No | Filter: "internal" or "external" |
|
| `filterParticipantScope` | string | No | Filter: "internal" or "external" |
|
||||||
| `filterTeamId` | string | No | Filter: specific team UUID |
|
| `filterTeamId` | string | No | Filter: specific team UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||||
| `filterMeetingTypeId` | string | No | Filter: specific meeting type |
|
| `filterMeetingTypeId` | string | No | Filter: specific meeting type UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) |
|
||||||
| `includeHighlights` | boolean | No | Include highlights in webhook payload |
|
| `includeHighlights` | boolean | No | Include highlights in webhook payload |
|
||||||
| `includeParticipants` | boolean | No | Include participants in webhook payload |
|
| `includeParticipants` | boolean | No | Include participants in webhook payload |
|
||||||
| `includeAiSummary` | boolean | No | Include AI summary 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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -46,9 +46,9 @@ Query repositories in natural language and get answers with relevant code refere
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | Yes | Natural language question about the codebase |
|
| `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\) |
|
| `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 |
|
| `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\) |
|
| `genius` | boolean | No | Enable genius mode for more thorough analysis \(slower but more accurate\) |
|
||||||
| `apiKey` | string | Yes | Greptile API key |
|
| `apiKey` | string | Yes | Greptile API key |
|
||||||
| `githubToken` | string | Yes | GitHub Personal Access Token with repo read access |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | Yes | Natural language search query to find relevant code |
|
| `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\) |
|
| `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 |
|
| `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\) |
|
| `genius` | boolean | No | Enable genius mode for more thorough search \(slower but more accurate\) |
|
||||||
| `apiKey` | string | Yes | Greptile API key |
|
| `apiKey` | string | Yes | Greptile API key |
|
||||||
| `githubToken` | string | Yes | GitHub Personal Access Token with repo read access |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `remote` | string | Yes | Git remote type: github or gitlab |
|
| `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"\) |
|
| `branch` | string | Yes | Branch to index \(e.g., "main" or "master"\) |
|
||||||
| `reload` | boolean | No | Force re-indexing even if already indexed |
|
| `reload` | boolean | No | Force re-indexing even if already indexed |
|
||||||
| `notify` | boolean | No | Send email notification when indexing completes |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `remote` | string | Yes | Git remote type: github or gitlab |
|
| `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"\) |
|
| `branch` | string | Yes | Branch name \(e.g., "main" or "master"\) |
|
||||||
| `apiKey` | string | Yes | Greptile API key |
|
| `apiKey` | string | Yes | Greptile API key |
|
||||||
| `githubToken` | string | Yes | GitHub Personal Access Token with repo read access |
|
| `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 |
|
| 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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `users` | array | Array of HubSpot user objects |
|
| `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 |
|
| `totalItems` | number | Total number of users returned |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -63,17 +69,41 @@ Retrieve all contacts from HubSpot account with pagination support
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
|
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
|
||||||
| `after` | string | No | Pagination cursor for next page of results |
|
| `after` | string | No | Pagination cursor for next page of results \(from previous response\) |
|
||||||
| `properties` | string | No | Comma-separated list of properties to return \(e.g., "email,firstname,lastname"\) |
|
| `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 |
|
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "companies,deals"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `contacts` | array | Array of HubSpot contact objects |
|
| `contacts` | array | Array of HubSpot contact records |
|
||||||
| `paging` | object | Pagination information |
|
| ↳ `email` | string | Contact email address |
|
||||||
| `metadata` | object | Metadata with totalReturned and hasMore |
|
| ↳ `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 |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
### `hubspot_get_contact`
|
### `hubspot_get_contact`
|
||||||
@@ -84,16 +114,36 @@ Retrieve a single contact by ID or email from HubSpot
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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 |
|
| `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 |
|
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "companies,deals"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `contactId` | string | The retrieved contact ID |
|
||||||
| `success` | boolean | Operation success status |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `properties` | object | Yes | Contact properties as JSON object. Must include at least one of: email, firstname, or lastname |
|
| `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 \(e.g., companies, deals\). Each object should have "to" \(with "id"\) and "types" \(with "associationCategory" and "associationTypeId"\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `contactId` | string | The created contact ID |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -124,15 +194,35 @@ Update an existing contact in HubSpot by ID or email
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `contactId` | string | The updated contact ID |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -144,21 +234,45 @@ Search for contacts in HubSpot using filters, sorting, and queries
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `filterGroups` | array | No | Array of filter groups. Each group contains filters with propertyName, operator, and value |
|
| `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 with propertyName and direction \("ASCENDING" or "DESCENDING"\) |
|
| `sorts` | array | No | Array of sort objects as JSON with "propertyName" and "direction" \("ASCENDING" or "DESCENDING"\) |
|
||||||
| `query` | string | No | Search query string |
|
| `query` | string | No | Search query string to match against contact name, email, and other text fields |
|
||||||
| `properties` | array | No | Array of property names to return |
|
| `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\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `total` | number | Total number of matching contacts |
|
||||||
| `paging` | object | Pagination information |
|
|
||||||
| `metadata` | object | Metadata with totalReturned and hasMore |
|
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
### `hubspot_list_companies`
|
### `hubspot_list_companies`
|
||||||
@@ -170,17 +284,42 @@ Retrieve all companies from HubSpot account with pagination support
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
|
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
|
||||||
| `after` | string | No | Pagination cursor for next page of results |
|
| `after` | string | No | Pagination cursor for next page of results \(from previous response\) |
|
||||||
| `properties` | string | No | Comma-separated list of properties to return |
|
| `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 |
|
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,deals"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `companies` | array | Array of HubSpot company objects |
|
| `companies` | array | Array of HubSpot company records |
|
||||||
| `paging` | object | Pagination information |
|
| ↳ `name` | string | Company name |
|
||||||
| `metadata` | object | Metadata with totalReturned and hasMore |
|
| ↳ `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 |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
### `hubspot_get_company`
|
### `hubspot_get_company`
|
||||||
@@ -191,16 +330,37 @@ Retrieve a single company by ID or domain from HubSpot
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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 |
|
| `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 |
|
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,deals"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `companyId` | string | The retrieved company ID |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -212,14 +372,35 @@ Create a new company in HubSpot
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `properties` | object | Yes | Company properties as JSON object \(e.g., name, domain, city, industry\) |
|
| `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 |
|
| `associations` | array | No | Array of associations to create with the company as JSON \(each with "to.id" and "types" containing "associationCategory" and "associationTypeId"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `companyId` | string | The created company ID |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -231,15 +412,36 @@ Update an existing company in HubSpot by ID or domain
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `companyId` | string | The updated company ID |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -251,21 +453,46 @@ Search for companies in HubSpot using filters, sorting, and queries
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `filterGroups` | array | No | Array of filter groups. Each group contains filters with propertyName, operator, and value |
|
| `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 with propertyName and direction \("ASCENDING" or "DESCENDING"\) |
|
| `sorts` | array | No | Array of sort objects as JSON with "propertyName" and "direction" \("ASCENDING" or "DESCENDING"\) |
|
||||||
| `query` | string | No | Search query string |
|
| `query` | string | No | Search query string to match against company name, domain, and other text fields |
|
||||||
| `properties` | array | No | Array of property names to return |
|
| `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\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `total` | number | Total number of matching companies |
|
||||||
| `paging` | object | Pagination information |
|
|
||||||
| `metadata` | object | Metadata with totalReturned and hasMore |
|
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
### `hubspot_list_deals`
|
### `hubspot_list_deals`
|
||||||
@@ -277,17 +504,33 @@ Retrieve all deals from HubSpot account with pagination support
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
|
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
|
||||||
| `after` | string | No | Pagination cursor for next page of results |
|
| `after` | string | No | Pagination cursor for next page of results \(from previous response\) |
|
||||||
| `properties` | string | No | Comma-separated list of properties to return |
|
| `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 |
|
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,companies"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `deals` | array | Array of HubSpot deal objects |
|
| `deals` | array | Array of HubSpot deal records |
|
||||||
| `paging` | object | Pagination information |
|
| ↳ `dealname` | string | Deal name |
|
||||||
| `metadata` | object | Metadata with totalReturned and hasMore |
|
| ↳ `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 |
|
| `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 |
|
| `systemPrompt` | string | No | System prompt to guide the model behavior |
|
||||||
| `content` | string | Yes | The user message content to send to the model |
|
| `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.\) |
|
| `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 |
|
| `maxTokens` | number | No | Maximum number of tokens to generate |
|
||||||
| `temperature` | number | No | Sampling temperature \(0-2\). Higher values make output more random |
|
| `temperature` | number | No | Sampling temperature \(0-2\). Higher values make output more random |
|
||||||
| `apiKey` | string | Yes | Hugging Face API token |
|
| `apiKey` | string | Yes | Hugging Face API token |
|
||||||
@@ -54,11 +54,11 @@ Generate completions using Hugging Face Inference API
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Chat completion results |
|
| `output` | object | Chat completion results |
|
||||||
| ↳ `content` | string | Generated text content |
|
| ↳ `content` | string | Generated text content |
|
||||||
| ↳ `model` | string | Model used for generation |
|
| ↳ `model` | string | Model used for generation |
|
||||||
| ↳ `usage` | object | Token usage information |
|
| ↳ `usage` | object | Token usage information |
|
||||||
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
||||||
| ↳ `completion_tokens` | number | Number of tokens in the completion |
|
| ↳ `completion_tokens` | number | Number of tokens in the completion |
|
||||||
| ↳ `total_tokens` | number | Total number of tokens used |
|
| ↳ `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | No | Natural language search query for companies |
|
| `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"\) |
|
| `headcount` | string | No | Company size filter \(e.g., "1-10", "11-50"\) |
|
||||||
| `company_type` | string | No | Type of organization |
|
| `company_type` | string | No | Type of organization |
|
||||||
| `technology` | string | No | Technology used by companies |
|
| `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 |
|
| 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`
|
### `hunter_domain_search`
|
||||||
|
|
||||||
@@ -62,38 +67,58 @@ Returns all the email addresses found using one given domain name, with sources.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `domain` | string | Yes | Domain name to search for email addresses |
|
| `domain` | string | Yes | Domain name to search for email addresses \(e.g., "stripe.com", "company.io"\) |
|
||||||
| `limit` | number | No | Maximum email addresses to return \(default: 10\) |
|
| `limit` | number | No | Maximum email addresses to return \(e.g., 10, 25, 50\). Default: 10 |
|
||||||
| `offset` | number | No | Number of email addresses to skip |
|
| `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 |
|
| `type` | string | No | Filter for personal or generic emails \(e.g., "personal", "generic", "all"\) |
|
||||||
| `seniority` | string | No | Filter by seniority level: junior, senior, or executive |
|
| `seniority` | string | No | Filter by seniority level \(e.g., "junior", "senior", "executive"\) |
|
||||||
| `department` | string | No | Filter by specific departments \(e.g., sales, marketing\) |
|
| `department` | string | No | Filter by specific department \(e.g., "sales", "marketing", "engineering", "hr"\) |
|
||||||
| `apiKey` | string | Yes | Hunter.io API Key |
|
| `apiKey` | string | Yes | Hunter.io API Key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `domain` | string | The searched domain name |
|
||||||
| `disposable` | boolean | Whether the domain accepts disposable email addresses |
|
| `disposable` | boolean | Whether the domain is a disposable email service |
|
||||||
| `webmail` | boolean | Whether the domain is a webmail provider |
|
| `webmail` | boolean | Whether the domain is a webmail provider \(e.g., Gmail\) |
|
||||||
| `accept_all` | boolean | Whether the domain accepts all email addresses |
|
| `accept_all` | boolean | Whether the server accepts all email addresses \(may cause false positives\) |
|
||||||
| `pattern` | string | The email pattern used by the organization |
|
| `pattern` | string | The email pattern used by the organization \(e.g., \{first\}, \{first\}.\{last\}\) |
|
||||||
| `organization` | string | The organization name |
|
| `organization` | string | The organization/company name |
|
||||||
| `description` | string | Description of the organization |
|
| `description` | string | Description of the organization |
|
||||||
| `industry` | string | Industry of the organization |
|
| `industry` | string | Industry classification of the organization |
|
||||||
| `twitter` | string | Twitter profile of the organization |
|
| `twitter` | string | Twitter handle of the organization |
|
||||||
| `facebook` | string | Facebook profile of the organization |
|
| `facebook` | string | Facebook page URL of the organization |
|
||||||
| `linkedin` | string | LinkedIn profile of the organization |
|
| `linkedin` | string | LinkedIn company page URL |
|
||||||
| `instagram` | string | Instagram profile of the organization |
|
| `instagram` | string | Instagram profile of the organization |
|
||||||
| `youtube` | string | YouTube channel of the organization |
|
| `youtube` | string | YouTube channel of the organization |
|
||||||
| `technologies` | array | Array of technologies used by the organization |
|
| `technologies` | array | Technologies used by the organization |
|
||||||
| `country` | string | Country where the organization is located |
|
| `country` | string | Country where the organization is headquartered |
|
||||||
| `state` | string | State where the organization is located |
|
| `state` | string | State/province where the organization is located |
|
||||||
| `city` | string | City where the organization is located |
|
| `city` | string | City where the organization is located |
|
||||||
| `postal_code` | string | Postal code of the organization |
|
| `postal_code` | string | Postal code of the organization |
|
||||||
| `street` | string | Street address 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`
|
### `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `domain` | string | Yes | Company domain name |
|
| `domain` | string | Yes | Company domain name \(e.g., "stripe.com", "company.io"\) |
|
||||||
| `first_name` | string | Yes | Person's first name |
|
| `first_name` | string | Yes | Person\'s first name \(e.g., "John", "Sarah"\) |
|
||||||
| `last_name` | string | Yes | Person's last name |
|
| `last_name` | string | Yes | Person\'s last name \(e.g., "Smith", "Johnson"\) |
|
||||||
| `company` | string | No | Company name |
|
| `company` | string | No | Company name \(e.g., "Stripe", "Acme Inc"\) |
|
||||||
| `apiKey` | string | Yes | Hunter.io API Key |
|
| `apiKey` | string | Yes | Hunter.io API Key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `email` | string | The found email address |
|
||||||
| `score` | number | Confidence score for the found email address |
|
| `score` | number | Confidence score \(0-100\) 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 |
|
|
||||||
|
|
||||||
### `hunter_email_verifier`
|
### `hunter_email_verifier`
|
||||||
|
|
||||||
@@ -133,20 +165,25 @@ Verifies the deliverability of an email address and provides detailed verificati
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `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 |
|
| `email` | string | The verified email address |
|
||||||
| `regexp` | boolean | Whether the email follows a valid regex pattern |
|
| `regexp` | boolean | Whether the email passes regular expression validation |
|
||||||
| `gibberish` | boolean | Whether the email appears to be gibberish |
|
| `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 provider |
|
| `disposable` | boolean | Whether the email is from a disposable email service |
|
||||||
| `webmail` | boolean | Whether the email is from a webmail provider |
|
| `webmail` | boolean | Whether the email is from a webmail provider \(e.g., Gmail\) |
|
||||||
| `mx_records` | boolean | Whether MX records exist for the domain |
|
| `mx_records` | boolean | Whether MX records exist for the domain |
|
||||||
| `smtp_server` | boolean | Whether the SMTP server is reachable |
|
| `smtp_server` | boolean | Whether connection to the SMTP server was successful |
|
||||||
| `smtp_check` | boolean | Whether the SMTP check was successful |
|
| `smtp_check` | boolean | Whether the email address doesn't bounce |
|
||||||
| `accept_all` | boolean | Whether the domain accepts all email addresses |
|
| `accept_all` | boolean | Whether the server accepts all email addresses \(may cause false positives\) |
|
||||||
| `block` | boolean | Whether the email is blocked |
|
| `block` | boolean | Whether the domain is blocking verification \(validity could not be determined\) |
|
||||||
| `status` | string | Verification status: valid, invalid, accept_all, webmail, disposable, or unknown |
|
| `status` | string | Verification status: valid, invalid, accept_all, webmail, disposable, unknown, or blocked |
|
||||||
| `sources` | array | Array of sources where the email was found |
|
|
||||||
|
|
||||||
### `hunter_companies_find`
|
### `hunter_companies_find`
|
||||||
|
|
||||||
@@ -156,15 +193,22 @@ Enriches company data using domain name.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `apiKey` | string | Yes | Hunter.io API Key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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\) |
|
| `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`
|
### `hunter_email_count`
|
||||||
|
|
||||||
@@ -174,19 +218,36 @@ Returns the total number of email addresses found for a domain or company.
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `domain` | string | No | Domain to count emails for \(required if company not provided\) |
|
| `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 \(required if domain 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 |
|
| `type` | string | No | Filter for personal or generic emails only \(e.g., "personal", "generic", "all"\) |
|
||||||
| `apiKey` | string | Yes | Hunter.io API Key |
|
| `apiKey` | string | Yes | Hunter.io API Key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `total` | number | Total number of email addresses found |
|
||||||
| `personal_emails` | number | Number of personal email addresses found |
|
| `personal_emails` | number | Number of personal email addresses \(individual employees\) |
|
||||||
| `generic_emails` | number | Number of generic email addresses found |
|
| `generic_emails` | number | Number of generic/role-based email addresses \(e.g., contact@, info@\) |
|
||||||
| `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\) |
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -58,9 +58,9 @@ Generate images using OpenAI
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Generated image data |
|
| `output` | object | Generated image data |
|
||||||
| ↳ `content` | string | Image URL or identifier |
|
| ↳ `content` | string | Image URL or identifier |
|
||||||
| ↳ `image` | string | Base64 encoded image data |
|
| ↳ `image` | string | Base64 encoded image data |
|
||||||
| ↳ `metadata` | object | Image generation metadata |
|
| ↳ `metadata` | object | Image generation metadata |
|
||||||
| ↳ `model` | string | Model used for image generation |
|
| ↳ `model` | string | Model used for image generation |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -61,50 +61,50 @@ Create a new contact in Intercom with email, external_id, or role. Returns API-a
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `contact` | object | Created contact object |
|
| `contact` | object | Created contact object |
|
||||||
| ↳ `id` | string | Unique identifier for the contact |
|
| ↳ `id` | string | Unique identifier for the contact |
|
||||||
| ↳ `type` | string | Object type \(contact\) |
|
| ↳ `type` | string | Object type \(contact\) |
|
||||||
| ↳ `role` | string | Role of the contact \(user or lead\) |
|
| ↳ `role` | string | Role of the contact \(user or lead\) |
|
||||||
| ↳ `email` | string | Email address of the contact |
|
| ↳ `email` | string | Email address of the contact |
|
||||||
| ↳ `phone` | string | Phone number of the contact |
|
| ↳ `phone` | string | Phone number of the contact |
|
||||||
| ↳ `name` | string | Name of the contact |
|
| ↳ `name` | string | Name of the contact |
|
||||||
| ↳ `avatar` | string | Avatar URL of the contact |
|
| ↳ `avatar` | string | Avatar URL of the contact |
|
||||||
| ↳ `owner_id` | string | ID of the admin assigned to this contact |
|
| ↳ `owner_id` | string | ID of the admin assigned to this contact |
|
||||||
| ↳ `external_id` | string | External identifier for the contact |
|
| ↳ `external_id` | string | External identifier for the contact |
|
||||||
| ↳ `created_at` | number | Unix timestamp when contact was created |
|
| ↳ `created_at` | number | Unix timestamp when contact was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when contact was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when contact was last updated |
|
||||||
| ↳ `signed_up_at` | number | Unix timestamp when user signed up |
|
| ↳ `signed_up_at` | number | Unix timestamp when user signed up |
|
||||||
| ↳ `last_seen_at` | number | Unix timestamp when user was last seen |
|
| ↳ `last_seen_at` | number | Unix timestamp when user was last seen |
|
||||||
| ↳ `workspace_id` | string | Workspace ID the contact belongs to |
|
| ↳ `workspace_id` | string | Workspace ID the contact belongs to |
|
||||||
| ↳ `custom_attributes` | object | Custom attributes set on the contact |
|
| ↳ `custom_attributes` | object | Custom attributes set on the contact |
|
||||||
| ↳ `tags` | object | Tags associated with the contact |
|
| ↳ `tags` | object | Tags associated with the contact |
|
||||||
| ↳ `type` | string | List type |
|
| ↳ `type` | string | List type |
|
||||||
| ↳ `url` | string | URL to fetch tags |
|
| ↳ `url` | string | URL to fetch tags |
|
||||||
| ↳ `data` | array | Array of tag objects |
|
| ↳ `data` | array | Array of tag objects |
|
||||||
| ↳ `has_more` | boolean | Whether there are more tags |
|
| ↳ `has_more` | boolean | Whether there are more tags |
|
||||||
| ↳ `total_count` | number | Total number of tags |
|
| ↳ `total_count` | number | Total number of tags |
|
||||||
| ↳ `notes` | object | Notes associated with the contact |
|
| ↳ `notes` | object | Notes associated with the contact |
|
||||||
| ↳ `type` | string | List type |
|
| ↳ `type` | string | List type |
|
||||||
| ↳ `url` | string | URL to fetch notes |
|
| ↳ `url` | string | URL to fetch notes |
|
||||||
| ↳ `data` | array | Array of note objects |
|
| ↳ `data` | array | Array of note objects |
|
||||||
| ↳ `has_more` | boolean | Whether there are more notes |
|
| ↳ `has_more` | boolean | Whether there are more notes |
|
||||||
| ↳ `total_count` | number | Total number of notes |
|
| ↳ `total_count` | number | Total number of notes |
|
||||||
| ↳ `companies` | object | Companies associated with the contact |
|
| ↳ `companies` | object | Companies associated with the contact |
|
||||||
| ↳ `type` | string | List type |
|
| ↳ `type` | string | List type |
|
||||||
| ↳ `url` | string | URL to fetch companies |
|
| ↳ `url` | string | URL to fetch companies |
|
||||||
| ↳ `data` | array | Array of company objects |
|
| ↳ `data` | array | Array of company objects |
|
||||||
| ↳ `has_more` | boolean | Whether there are more companies |
|
| ↳ `has_more` | boolean | Whether there are more companies |
|
||||||
| ↳ `total_count` | number | Total number of companies |
|
| ↳ `total_count` | number | Total number of companies |
|
||||||
| ↳ `location` | object | Location information for the contact |
|
| ↳ `location` | object | Location information for the contact |
|
||||||
| ↳ `type` | string | Location type |
|
| ↳ `type` | string | Location type |
|
||||||
| ↳ `city` | string | City |
|
| ↳ `city` | string | City |
|
||||||
| ↳ `region` | string | Region/State |
|
| ↳ `region` | string | Region/State |
|
||||||
| ↳ `country` | string | Country |
|
| ↳ `country` | string | Country |
|
||||||
| ↳ `country_code` | string | Country code |
|
| ↳ `country_code` | string | Country code |
|
||||||
| ↳ `continent_code` | string | Continent code |
|
| ↳ `continent_code` | string | Continent code |
|
||||||
| ↳ `social_profiles` | object | Social profiles of the contact |
|
| ↳ `social_profiles` | object | Social profiles of the contact |
|
||||||
| ↳ `type` | string | List type |
|
| ↳ `type` | string | List type |
|
||||||
| ↳ `data` | array | Array of social profile objects |
|
| ↳ `data` | array | Array of social profile objects |
|
||||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
||||||
| `contactId` | string | ID of the created contact |
|
| `contactId` | string | ID of the created contact |
|
||||||
|
|
||||||
### `intercom_get_contact`
|
### `intercom_get_contact`
|
||||||
@@ -122,25 +122,65 @@ Get a single contact by ID from Intercom. Returns API-aligned fields only.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `contact` | object | Contact object |
|
| `contact` | object | Contact object |
|
||||||
| ↳ `id` | string | Unique identifier for the contact |
|
| ↳ `id` | string | Unique identifier for the contact |
|
||||||
| ↳ `type` | string | Object type \(contact\) |
|
| ↳ `type` | string | Object type \(contact\) |
|
||||||
| ↳ `role` | string | Role of the contact \(user or lead\) |
|
| ↳ `role` | string | Role of the contact \(user or lead\) |
|
||||||
| ↳ `email` | string | Email address of the contact |
|
| ↳ `email` | string | Email address of the contact |
|
||||||
| ↳ `phone` | string | Phone number of the contact |
|
| ↳ `email_domain` | string | Email domain of the contact |
|
||||||
| ↳ `name` | string | Name of the contact |
|
| ↳ `phone` | string | Phone number of the contact |
|
||||||
| ↳ `avatar` | string | Avatar URL of the contact |
|
| ↳ `name` | string | Name of the contact |
|
||||||
| ↳ `owner_id` | string | ID of the admin assigned to this contact |
|
| ↳ `avatar` | string | Avatar URL of the contact |
|
||||||
| ↳ `external_id` | string | External identifier for the contact |
|
| ↳ `owner_id` | string | ID of the admin assigned account ownership |
|
||||||
| ↳ `created_at` | number | Unix timestamp when contact was created |
|
| ↳ `external_id` | string | External identifier provided by the client |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when contact was last updated |
|
| ↳ `workspace_id` | string | Workspace ID the contact belongs to |
|
||||||
| ↳ `workspace_id` | string | Workspace ID the contact belongs to |
|
| ↳ `created_at` | number | Unix timestamp when contact was created |
|
||||||
| ↳ `custom_attributes` | object | Custom attributes set on the contact |
|
| ↳ `updated_at` | number | Unix timestamp when contact was last updated |
|
||||||
| ↳ `tags` | object | Tags associated with the contact |
|
| ↳ `signed_up_at` | number | Unix timestamp when user signed up |
|
||||||
| ↳ `notes` | object | Notes associated with the contact |
|
| ↳ `last_seen_at` | number | Unix timestamp when user was last seen |
|
||||||
| ↳ `companies` | object | Companies associated with the contact |
|
| ↳ `last_contacted_at` | number | Unix timestamp when contact was last contacted |
|
||||||
| ↳ `location` | object | Location information for the contact |
|
| ↳ `last_replied_at` | number | Unix timestamp when contact last replied |
|
||||||
| ↳ `social_profiles` | object | Social profiles of the contact |
|
| ↳ `last_email_opened_at` | number | Unix timestamp when contact last opened an email |
|
||||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
| ↳ `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`
|
### `intercom_update_contact`
|
||||||
|
|
||||||
@@ -169,25 +209,25 @@ Update an existing contact in Intercom. Returns API-aligned fields only.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `contact` | object | Updated contact object |
|
| `contact` | object | Updated contact object |
|
||||||
| ↳ `id` | string | Unique identifier for the contact |
|
| ↳ `id` | string | Unique identifier for the contact |
|
||||||
| ↳ `type` | string | Object type \(contact\) |
|
| ↳ `type` | string | Object type \(contact\) |
|
||||||
| ↳ `role` | string | Role of the contact \(user or lead\) |
|
| ↳ `role` | string | Role of the contact \(user or lead\) |
|
||||||
| ↳ `email` | string | Email address of the contact |
|
| ↳ `email` | string | Email address of the contact |
|
||||||
| ↳ `phone` | string | Phone number of the contact |
|
| ↳ `phone` | string | Phone number of the contact |
|
||||||
| ↳ `name` | string | Name of the contact |
|
| ↳ `name` | string | Name of the contact |
|
||||||
| ↳ `avatar` | string | Avatar URL of the contact |
|
| ↳ `avatar` | string | Avatar URL of the contact |
|
||||||
| ↳ `owner_id` | string | ID of the admin assigned to this contact |
|
| ↳ `owner_id` | string | ID of the admin assigned to this contact |
|
||||||
| ↳ `external_id` | string | External identifier for the contact |
|
| ↳ `external_id` | string | External identifier for the contact |
|
||||||
| ↳ `created_at` | number | Unix timestamp when contact was created |
|
| ↳ `created_at` | number | Unix timestamp when contact was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when contact was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when contact was last updated |
|
||||||
| ↳ `workspace_id` | string | Workspace ID the contact belongs to |
|
| ↳ `workspace_id` | string | Workspace ID the contact belongs to |
|
||||||
| ↳ `custom_attributes` | object | Custom attributes set on the contact |
|
| ↳ `custom_attributes` | object | Custom attributes set on the contact |
|
||||||
| ↳ `tags` | object | Tags associated with the contact |
|
| ↳ `tags` | object | Tags associated with the contact |
|
||||||
| ↳ `notes` | object | Notes associated with the contact |
|
| ↳ `notes` | object | Notes associated with the contact |
|
||||||
| ↳ `companies` | object | Companies associated with the contact |
|
| ↳ `companies` | object | Companies associated with the contact |
|
||||||
| ↳ `location` | object | Location information for the contact |
|
| ↳ `location` | object | Location information for the contact |
|
||||||
| ↳ `social_profiles` | object | Social profiles of the contact |
|
| ↳ `social_profiles` | object | Social profiles of the contact |
|
||||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
||||||
| `contactId` | string | ID of the updated contact |
|
| `contactId` | string | ID of the updated contact |
|
||||||
|
|
||||||
### `intercom_list_contacts`
|
### `intercom_list_contacts`
|
||||||
@@ -220,10 +260,10 @@ List all contacts from Intercom with pagination support
|
|||||||
| ↳ `tags` | object | Tags associated with the contact |
|
| ↳ `tags` | object | Tags associated with the contact |
|
||||||
| ↳ `companies` | object | Companies associated with the contact |
|
| ↳ `companies` | object | Companies associated with the contact |
|
||||||
| `pages` | object | Pagination information |
|
| `pages` | object | Pagination information |
|
||||||
| ↳ `type` | string | Pages type identifier |
|
| ↳ `type` | string | Pages type identifier |
|
||||||
| ↳ `page` | number | Current page number |
|
| ↳ `page` | number | Current page number |
|
||||||
| ↳ `per_page` | number | Number of results per page |
|
| ↳ `per_page` | number | Number of results per page |
|
||||||
| ↳ `total_pages` | number | Total number of pages |
|
| ↳ `total_pages` | number | Total number of pages |
|
||||||
| `total_count` | number | Total number of contacts |
|
| `total_count` | number | Total number of contacts |
|
||||||
|
|
||||||
### `intercom_search_contacts`
|
### `intercom_search_contacts`
|
||||||
@@ -267,10 +307,10 @@ Search for contacts in Intercom using a query
|
|||||||
| ↳ `social_profiles` | object | Social profiles of the contact |
|
| ↳ `social_profiles` | object | Social profiles of the contact |
|
||||||
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
|
||||||
| `pages` | object | Pagination information |
|
| `pages` | object | Pagination information |
|
||||||
| ↳ `type` | string | Pages type identifier |
|
| ↳ `type` | string | Pages type identifier |
|
||||||
| ↳ `page` | number | Current page number |
|
| ↳ `page` | number | Current page number |
|
||||||
| ↳ `per_page` | number | Number of results per page |
|
| ↳ `per_page` | number | Number of results per page |
|
||||||
| ↳ `total_pages` | number | Total number of pages |
|
| ↳ `total_pages` | number | Total number of pages |
|
||||||
| `total_count` | number | Total number of matching contacts |
|
| `total_count` | number | Total number of matching contacts |
|
||||||
|
|
||||||
### `intercom_delete_contact`
|
### `intercom_delete_contact`
|
||||||
@@ -313,28 +353,28 @@ Create or update a company in Intercom
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `company` | object | Created or updated company object |
|
| `company` | object | Created or updated company object |
|
||||||
| ↳ `id` | string | Unique identifier for the company |
|
| ↳ `id` | string | Unique identifier for the company |
|
||||||
| ↳ `type` | string | Object type \(company\) |
|
| ↳ `type` | string | Object type \(company\) |
|
||||||
| ↳ `app_id` | string | Intercom app ID |
|
| ↳ `app_id` | string | Intercom app ID |
|
||||||
| ↳ `company_id` | string | Your unique identifier for the company |
|
| ↳ `company_id` | string | Your unique identifier for the company |
|
||||||
| ↳ `name` | string | Name of the company |
|
| ↳ `name` | string | Name of the company |
|
||||||
| ↳ `website` | string | Company website URL |
|
| ↳ `website` | string | Company website URL |
|
||||||
| ↳ `plan` | object | Company plan information |
|
| ↳ `plan` | object | Company plan information |
|
||||||
| ↳ `size` | number | Number of employees |
|
| ↳ `size` | number | Number of employees |
|
||||||
| ↳ `industry` | string | Industry the company operates in |
|
| ↳ `industry` | string | Industry the company operates in |
|
||||||
| ↳ `monthly_spend` | number | Monthly revenue from this company |
|
| ↳ `monthly_spend` | number | Monthly revenue from this company |
|
||||||
| ↳ `session_count` | number | Number of sessions |
|
| ↳ `session_count` | number | Number of sessions |
|
||||||
| ↳ `user_count` | number | Number of users in the company |
|
| ↳ `user_count` | number | Number of users in the company |
|
||||||
| ↳ `created_at` | number | Unix timestamp when company was created |
|
| ↳ `created_at` | number | Unix timestamp when company was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when company was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when company was last updated |
|
||||||
| ↳ `remote_created_at` | number | Unix timestamp when company was created by you |
|
| ↳ `remote_created_at` | number | Unix timestamp when company was created by you |
|
||||||
| ↳ `custom_attributes` | object | Custom attributes set on the company |
|
| ↳ `custom_attributes` | object | Custom attributes set on the company |
|
||||||
| ↳ `tags` | object | Tags associated with the company |
|
| ↳ `tags` | object | Tags associated with the company |
|
||||||
| ↳ `type` | string | Tag list type |
|
| ↳ `type` | string | Tag list type |
|
||||||
| ↳ `tags` | array | Array of tag objects |
|
| ↳ `tags` | array | Array of tag objects |
|
||||||
| ↳ `segments` | object | Segments the company belongs to |
|
| ↳ `segments` | object | Segments the company belongs to |
|
||||||
| ↳ `type` | string | Segment list type |
|
| ↳ `type` | string | Segment list type |
|
||||||
| ↳ `segments` | array | Array of segment objects |
|
| ↳ `segments` | array | Array of segment objects |
|
||||||
| `companyId` | string | ID of the created/updated company |
|
| `companyId` | string | ID of the created/updated company |
|
||||||
|
|
||||||
### `intercom_get_company`
|
### `intercom_get_company`
|
||||||
@@ -352,23 +392,23 @@ Retrieve a single company by ID from Intercom
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `company` | object | Company object |
|
| `company` | object | Company object |
|
||||||
| ↳ `id` | string | Unique identifier for the company |
|
| ↳ `id` | string | Unique identifier for the company |
|
||||||
| ↳ `type` | string | Object type \(company\) |
|
| ↳ `type` | string | Object type \(company\) |
|
||||||
| ↳ `app_id` | string | Intercom app ID |
|
| ↳ `app_id` | string | Intercom app ID |
|
||||||
| ↳ `company_id` | string | Your unique identifier for the company |
|
| ↳ `company_id` | string | Your unique identifier for the company |
|
||||||
| ↳ `name` | string | Name of the company |
|
| ↳ `name` | string | Name of the company |
|
||||||
| ↳ `website` | string | Company website URL |
|
| ↳ `website` | string | Company website URL |
|
||||||
| ↳ `plan` | object | Company plan information |
|
| ↳ `plan` | object | Company plan information |
|
||||||
| ↳ `size` | number | Number of employees |
|
| ↳ `size` | number | Number of employees |
|
||||||
| ↳ `industry` | string | Industry the company operates in |
|
| ↳ `industry` | string | Industry the company operates in |
|
||||||
| ↳ `monthly_spend` | number | Monthly revenue from this company |
|
| ↳ `monthly_spend` | number | Monthly revenue from this company |
|
||||||
| ↳ `session_count` | number | Number of sessions |
|
| ↳ `session_count` | number | Number of sessions |
|
||||||
| ↳ `user_count` | number | Number of users in the company |
|
| ↳ `user_count` | number | Number of users in the company |
|
||||||
| ↳ `created_at` | number | Unix timestamp when company was created |
|
| ↳ `created_at` | number | Unix timestamp when company was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when company was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when company was last updated |
|
||||||
| ↳ `custom_attributes` | object | Custom attributes set on the company |
|
| ↳ `custom_attributes` | object | Custom attributes set on the company |
|
||||||
| ↳ `tags` | object | Tags associated with the company |
|
| ↳ `tags` | object | Tags associated with the company |
|
||||||
| ↳ `segments` | object | Segments the company belongs to |
|
| ↳ `segments` | object | Segments the company belongs to |
|
||||||
|
|
||||||
### `intercom_list_companies`
|
### `intercom_list_companies`
|
||||||
|
|
||||||
@@ -403,10 +443,10 @@ List all companies from Intercom with pagination support. Note: This endpoint ha
|
|||||||
| ↳ `tags` | object | Tags associated with the company |
|
| ↳ `tags` | object | Tags associated with the company |
|
||||||
| ↳ `segments` | object | Segments the company belongs to |
|
| ↳ `segments` | object | Segments the company belongs to |
|
||||||
| `pages` | object | Pagination information |
|
| `pages` | object | Pagination information |
|
||||||
| ↳ `type` | string | Pages type identifier |
|
| ↳ `type` | string | Pages type identifier |
|
||||||
| ↳ `page` | number | Current page number |
|
| ↳ `page` | number | Current page number |
|
||||||
| ↳ `per_page` | number | Number of results per page |
|
| ↳ `per_page` | number | Number of results per page |
|
||||||
| ↳ `total_pages` | number | Total number of pages |
|
| ↳ `total_pages` | number | Total number of pages |
|
||||||
| `total_count` | number | Total number of companies |
|
| `total_count` | number | Total number of companies |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -427,25 +467,25 @@ Retrieve a single conversation by ID from Intercom
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `conversation` | object | Conversation object |
|
| `conversation` | object | Conversation object |
|
||||||
| ↳ `id` | string | Unique identifier for the conversation |
|
| ↳ `id` | string | Unique identifier for the conversation |
|
||||||
| ↳ `type` | string | Object type \(conversation\) |
|
| ↳ `type` | string | Object type \(conversation\) |
|
||||||
| ↳ `title` | string | Title of the conversation |
|
| ↳ `title` | string | Title of the conversation |
|
||||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||||
| ↳ `waiting_since` | number | Unix timestamp when waiting for reply |
|
| ↳ `waiting_since` | number | Unix timestamp when waiting for reply |
|
||||||
| ↳ `snoozed_until` | number | Unix timestamp when snooze ends |
|
| ↳ `snoozed_until` | number | Unix timestamp when snooze ends |
|
||||||
| ↳ `open` | boolean | Whether the conversation is open |
|
| ↳ `open` | boolean | Whether the conversation is open |
|
||||||
| ↳ `state` | string | State of the conversation |
|
| ↳ `state` | string | State of the conversation |
|
||||||
| ↳ `read` | boolean | Whether the conversation has been read |
|
| ↳ `read` | boolean | Whether the conversation has been read |
|
||||||
| ↳ `priority` | string | Priority of the conversation |
|
| ↳ `priority` | string | Priority of the conversation |
|
||||||
| ↳ `admin_assignee_id` | number | ID of assigned admin |
|
| ↳ `admin_assignee_id` | number | ID of assigned admin |
|
||||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||||
| ↳ `tags` | object | Tags on the conversation |
|
| ↳ `tags` | object | Tags on the conversation |
|
||||||
| ↳ `source` | object | Source of the conversation |
|
| ↳ `source` | object | Source of the conversation |
|
||||||
| ↳ `contacts` | object | Contacts in the conversation |
|
| ↳ `contacts` | object | Contacts in the conversation |
|
||||||
| ↳ `teammates` | object | Teammates in the conversation |
|
| ↳ `teammates` | object | Teammates in the conversation |
|
||||||
| ↳ `conversation_parts` | object | Parts of the conversation |
|
| ↳ `conversation_parts` | object | Parts of the conversation |
|
||||||
| ↳ `statistics` | object | Conversation statistics |
|
| ↳ `statistics` | object | Conversation statistics |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
### `intercom_list_conversations`
|
### `intercom_list_conversations`
|
||||||
@@ -482,10 +522,10 @@ List all conversations from Intercom with pagination support
|
|||||||
| ↳ `source` | object | Source of the conversation |
|
| ↳ `source` | object | Source of the conversation |
|
||||||
| ↳ `contacts` | object | Contacts in the conversation |
|
| ↳ `contacts` | object | Contacts in the conversation |
|
||||||
| `pages` | object | Pagination information |
|
| `pages` | object | Pagination information |
|
||||||
| ↳ `type` | string | Pages type identifier |
|
| ↳ `type` | string | Pages type identifier |
|
||||||
| ↳ `page` | number | Current page number |
|
| ↳ `page` | number | Current page number |
|
||||||
| ↳ `per_page` | number | Number of results per page |
|
| ↳ `per_page` | number | Number of results per page |
|
||||||
| ↳ `total_pages` | number | Total number of pages |
|
| ↳ `total_pages` | number | Total number of pages |
|
||||||
| `total_count` | number | Total number of conversations |
|
| `total_count` | number | Total number of conversations |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -509,22 +549,22 @@ Reply to a conversation as an admin in Intercom
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `conversation` | object | Updated conversation object |
|
| `conversation` | object | Updated conversation object |
|
||||||
| ↳ `id` | string | Unique identifier for the conversation |
|
| ↳ `id` | string | Unique identifier for the conversation |
|
||||||
| ↳ `type` | string | Object type \(conversation\) |
|
| ↳ `type` | string | Object type \(conversation\) |
|
||||||
| ↳ `title` | string | Title of the conversation |
|
| ↳ `title` | string | Title of the conversation |
|
||||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||||
| ↳ `waiting_since` | number | Unix timestamp when waiting for reply |
|
| ↳ `waiting_since` | number | Unix timestamp when waiting for reply |
|
||||||
| ↳ `open` | boolean | Whether the conversation is open |
|
| ↳ `open` | boolean | Whether the conversation is open |
|
||||||
| ↳ `state` | string | State of the conversation |
|
| ↳ `state` | string | State of the conversation |
|
||||||
| ↳ `read` | boolean | Whether the conversation has been read |
|
| ↳ `read` | boolean | Whether the conversation has been read |
|
||||||
| ↳ `priority` | string | Priority of the conversation |
|
| ↳ `priority` | string | Priority of the conversation |
|
||||||
| ↳ `admin_assignee_id` | number | ID of assigned admin |
|
| ↳ `admin_assignee_id` | number | ID of assigned admin |
|
||||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||||
| ↳ `tags` | object | Tags on the conversation |
|
| ↳ `tags` | object | Tags on the conversation |
|
||||||
| ↳ `source` | object | Source of the conversation |
|
| ↳ `source` | object | Source of the conversation |
|
||||||
| ↳ `contacts` | object | Contacts in the conversation |
|
| ↳ `contacts` | object | Contacts in the conversation |
|
||||||
| ↳ `conversation_parts` | object | Parts of the conversation |
|
| ↳ `conversation_parts` | object | Parts of the conversation |
|
||||||
| `conversationId` | string | ID of the conversation |
|
| `conversationId` | string | ID of the conversation |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -563,10 +603,10 @@ Search for conversations in Intercom using a query. Returns API-aligned fields o
|
|||||||
| ↳ `source` | object | Source of the conversation |
|
| ↳ `source` | object | Source of the conversation |
|
||||||
| ↳ `contacts` | object | Contacts in the conversation |
|
| ↳ `contacts` | object | Contacts in the conversation |
|
||||||
| `pages` | object | Pagination information |
|
| `pages` | object | Pagination information |
|
||||||
| ↳ `type` | string | Pages type identifier |
|
| ↳ `type` | string | Pages type identifier |
|
||||||
| ↳ `page` | number | Current page number |
|
| ↳ `page` | number | Current page number |
|
||||||
| ↳ `per_page` | number | Number of results per page |
|
| ↳ `per_page` | number | Number of results per page |
|
||||||
| ↳ `total_pages` | number | Total number of pages |
|
| ↳ `total_pages` | number | Total number of pages |
|
||||||
| `total_count` | number | Total number of matching conversations |
|
| `total_count` | number | Total number of matching conversations |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -591,21 +631,21 @@ Create a new ticket in Intercom. Returns API-aligned fields only.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `ticket` | object | Created ticket object |
|
| `ticket` | object | Created ticket object |
|
||||||
| ↳ `id` | string | Unique identifier for the ticket |
|
| ↳ `id` | string | Unique identifier for the ticket |
|
||||||
| ↳ `type` | string | Object type \(ticket\) |
|
| ↳ `type` | string | Object type \(ticket\) |
|
||||||
| ↳ `ticket_id` | string | Ticket ID |
|
| ↳ `ticket_id` | string | Ticket ID |
|
||||||
| ↳ `ticket_type` | object | Type of the ticket |
|
| ↳ `ticket_type` | object | Type of the ticket |
|
||||||
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
||||||
| ↳ `ticket_state` | string | State of the ticket |
|
| ↳ `ticket_state` | string | State of the ticket |
|
||||||
| ↳ `ticket_state_internal_label` | string | Internal label for ticket state |
|
| ↳ `ticket_state_internal_label` | string | Internal label for ticket state |
|
||||||
| ↳ `ticket_state_external_label` | string | External label for ticket state |
|
| ↳ `ticket_state_external_label` | string | External label for ticket state |
|
||||||
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
||||||
| ↳ `contacts` | object | Contacts associated with the ticket |
|
| ↳ `contacts` | object | Contacts associated with the ticket |
|
||||||
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
||||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||||
| ↳ `is_shared` | boolean | Whether the ticket is shared |
|
| ↳ `is_shared` | boolean | Whether the ticket is shared |
|
||||||
| ↳ `open` | boolean | Whether the ticket is open |
|
| ↳ `open` | boolean | Whether the ticket is open |
|
||||||
| `ticketId` | string | ID of the created ticket |
|
| `ticketId` | string | ID of the created ticket |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -624,21 +664,21 @@ Retrieve a single ticket by ID from Intercom. Returns API-aligned fields only.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `ticket` | object | Ticket object |
|
| `ticket` | object | Ticket object |
|
||||||
| ↳ `id` | string | Unique identifier for the ticket |
|
| ↳ `id` | string | Unique identifier for the ticket |
|
||||||
| ↳ `type` | string | Object type \(ticket\) |
|
| ↳ `type` | string | Object type \(ticket\) |
|
||||||
| ↳ `ticket_id` | string | Ticket ID |
|
| ↳ `ticket_id` | string | Ticket ID |
|
||||||
| ↳ `ticket_type` | object | Type of the ticket |
|
| ↳ `ticket_type` | object | Type of the ticket |
|
||||||
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
||||||
| ↳ `ticket_state` | string | State of the ticket |
|
| ↳ `ticket_state` | string | State of the ticket |
|
||||||
| ↳ `ticket_state_internal_label` | string | Internal label for ticket state |
|
| ↳ `ticket_state_internal_label` | string | Internal label for ticket state |
|
||||||
| ↳ `ticket_state_external_label` | string | External label for ticket state |
|
| ↳ `ticket_state_external_label` | string | External label for ticket state |
|
||||||
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
||||||
| ↳ `contacts` | object | Contacts associated with the ticket |
|
| ↳ `contacts` | object | Contacts associated with the ticket |
|
||||||
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
||||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||||
| ↳ `is_shared` | boolean | Whether the ticket is shared |
|
| ↳ `is_shared` | boolean | Whether the ticket is shared |
|
||||||
| ↳ `open` | boolean | Whether the ticket is open |
|
| ↳ `open` | boolean | Whether the ticket is open |
|
||||||
| `ticketId` | string | ID of the retrieved ticket |
|
| `ticketId` | string | ID of the retrieved ticket |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -663,18 +703,18 @@ Update a ticket in Intercom (change state, assignment, attributes)
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `ticket` | object | The updated ticket object |
|
| `ticket` | object | The updated ticket object |
|
||||||
| ↳ `id` | string | Unique identifier for the ticket |
|
| ↳ `id` | string | Unique identifier for the ticket |
|
||||||
| ↳ `type` | string | Object type \(ticket\) |
|
| ↳ `type` | string | Object type \(ticket\) |
|
||||||
| ↳ `ticket_id` | string | Ticket ID shown in Intercom UI |
|
| ↳ `ticket_id` | string | Ticket ID shown in Intercom UI |
|
||||||
| ↳ `ticket_state` | string | State of the ticket |
|
| ↳ `ticket_state` | string | State of the ticket |
|
||||||
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
| ↳ `ticket_attributes` | object | Attributes of the ticket |
|
||||||
| ↳ `open` | boolean | Whether the ticket is open |
|
| ↳ `open` | boolean | Whether the ticket is open |
|
||||||
| ↳ `is_shared` | boolean | Whether the ticket is visible to users |
|
| ↳ `is_shared` | boolean | Whether the ticket is visible to users |
|
||||||
| ↳ `snoozed_until` | number | Unix timestamp when ticket will reopen |
|
| ↳ `snoozed_until` | number | Unix timestamp when ticket will reopen |
|
||||||
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
| ↳ `admin_assignee_id` | string | ID of assigned admin |
|
||||||
| ↳ `team_assignee_id` | string | ID of assigned team |
|
| ↳ `team_assignee_id` | string | ID of assigned team |
|
||||||
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
| ↳ `created_at` | number | Unix timestamp when ticket was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
|
||||||
| `ticketId` | string | ID of the updated ticket |
|
| `ticketId` | string | ID of the updated ticket |
|
||||||
| `ticket_state` | string | Current state of the ticket |
|
| `ticket_state` | string | Current state of the ticket |
|
||||||
|
|
||||||
@@ -701,13 +741,13 @@ Create and send a new admin-initiated message in Intercom. Returns API-aligned f
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | object | Created message object |
|
| `message` | object | Created message object |
|
||||||
| ↳ `id` | string | Unique identifier for the message |
|
| ↳ `id` | string | Unique identifier for the message |
|
||||||
| ↳ `type` | string | Object type \(message\) |
|
| ↳ `type` | string | Object type \(message\) |
|
||||||
| ↳ `created_at` | number | Unix timestamp when message was created |
|
| ↳ `created_at` | number | Unix timestamp when message was created |
|
||||||
| ↳ `body` | string | Body of the message |
|
| ↳ `body` | string | Body of the message |
|
||||||
| ↳ `message_type` | string | Type of the message \(in_app or email\) |
|
| ↳ `message_type` | string | Type of the message \(in_app or email\) |
|
||||||
| ↳ `conversation_id` | string | ID of the conversation created |
|
| ↳ `conversation_id` | string | ID of the conversation created |
|
||||||
| ↳ `owner` | object | Owner of the message |
|
| ↳ `owner` | object | Owner of the message |
|
||||||
| `messageId` | string | ID of the created message |
|
| `messageId` | string | ID of the created message |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -755,13 +795,13 @@ Close a conversation in Intercom
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `conversation` | object | The closed conversation object |
|
| `conversation` | object | The closed conversation object |
|
||||||
| ↳ `id` | string | Unique identifier for the conversation |
|
| ↳ `id` | string | Unique identifier for the conversation |
|
||||||
| ↳ `type` | string | Object type \(conversation\) |
|
| ↳ `type` | string | Object type \(conversation\) |
|
||||||
| ↳ `state` | string | State of the conversation \(closed\) |
|
| ↳ `state` | string | State of the conversation \(closed\) |
|
||||||
| ↳ `open` | boolean | Whether the conversation is open \(false\) |
|
| ↳ `open` | boolean | Whether the conversation is open \(false\) |
|
||||||
| ↳ `read` | boolean | Whether the conversation has been read |
|
| ↳ `read` | boolean | Whether the conversation has been read |
|
||||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||||
| `conversationId` | string | ID of the closed conversation |
|
| `conversationId` | string | ID of the closed conversation |
|
||||||
| `state` | string | State of the conversation \(closed\) |
|
| `state` | string | State of the conversation \(closed\) |
|
||||||
|
|
||||||
@@ -781,13 +821,13 @@ Open a closed or snoozed conversation in Intercom
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `conversation` | object | The opened conversation object |
|
| `conversation` | object | The opened conversation object |
|
||||||
| ↳ `id` | string | Unique identifier for the conversation |
|
| ↳ `id` | string | Unique identifier for the conversation |
|
||||||
| ↳ `type` | string | Object type \(conversation\) |
|
| ↳ `type` | string | Object type \(conversation\) |
|
||||||
| ↳ `state` | string | State of the conversation \(open\) |
|
| ↳ `state` | string | State of the conversation \(open\) |
|
||||||
| ↳ `open` | boolean | Whether the conversation is open \(true\) |
|
| ↳ `open` | boolean | Whether the conversation is open \(true\) |
|
||||||
| ↳ `read` | boolean | Whether the conversation has been read |
|
| ↳ `read` | boolean | Whether the conversation has been read |
|
||||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||||
| `conversationId` | string | ID of the opened conversation |
|
| `conversationId` | string | ID of the opened conversation |
|
||||||
| `state` | string | State of the conversation \(open\) |
|
| `state` | string | State of the conversation \(open\) |
|
||||||
|
|
||||||
@@ -808,13 +848,13 @@ Snooze a conversation to reopen at a future time
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `conversation` | object | The snoozed conversation object |
|
| `conversation` | object | The snoozed conversation object |
|
||||||
| ↳ `id` | string | Unique identifier for the conversation |
|
| ↳ `id` | string | Unique identifier for the conversation |
|
||||||
| ↳ `type` | string | Object type \(conversation\) |
|
| ↳ `type` | string | Object type \(conversation\) |
|
||||||
| ↳ `state` | string | State of the conversation \(snoozed\) |
|
| ↳ `state` | string | State of the conversation \(snoozed\) |
|
||||||
| ↳ `open` | boolean | Whether the conversation is open |
|
| ↳ `open` | boolean | Whether the conversation is open |
|
||||||
| ↳ `snoozed_until` | number | Unix timestamp when conversation will reopen |
|
| ↳ `snoozed_until` | number | Unix timestamp when conversation will reopen |
|
||||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||||
| `conversationId` | string | ID of the snoozed conversation |
|
| `conversationId` | string | ID of the snoozed conversation |
|
||||||
| `state` | string | State of the conversation \(snoozed\) |
|
| `state` | string | State of the conversation \(snoozed\) |
|
||||||
| `snoozed_until` | number | Unix timestamp when conversation will reopen |
|
| `snoozed_until` | number | Unix timestamp when conversation will reopen |
|
||||||
@@ -837,14 +877,14 @@ Assign a conversation to an admin or team in Intercom
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `conversation` | object | The assigned conversation object |
|
| `conversation` | object | The assigned conversation object |
|
||||||
| ↳ `id` | string | Unique identifier for the conversation |
|
| ↳ `id` | string | Unique identifier for the conversation |
|
||||||
| ↳ `type` | string | Object type \(conversation\) |
|
| ↳ `type` | string | Object type \(conversation\) |
|
||||||
| ↳ `state` | string | State of the conversation |
|
| ↳ `state` | string | State of the conversation |
|
||||||
| ↳ `open` | boolean | Whether the conversation is open |
|
| ↳ `open` | boolean | Whether the conversation is open |
|
||||||
| ↳ `admin_assignee_id` | number | ID of the assigned admin |
|
| ↳ `admin_assignee_id` | number | ID of the assigned admin |
|
||||||
| ↳ `team_assignee_id` | string | ID of the assigned team |
|
| ↳ `team_assignee_id` | string | ID of the assigned team |
|
||||||
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
| ↳ `created_at` | number | Unix timestamp when conversation was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
|
||||||
| `conversationId` | string | ID of the assigned conversation |
|
| `conversationId` | string | ID of the assigned conversation |
|
||||||
| `admin_assignee_id` | number | ID of the assigned admin |
|
| `admin_assignee_id` | number | ID of the assigned admin |
|
||||||
| `team_assignee_id` | string | ID of the assigned team |
|
| `team_assignee_id` | string | ID of the assigned team |
|
||||||
@@ -966,13 +1006,13 @@ Add a note to a specific contact
|
|||||||
| `created_at` | number | Unix timestamp when the note was created |
|
| `created_at` | number | Unix timestamp when the note was created |
|
||||||
| `type` | string | Object type \(note\) |
|
| `type` | string | Object type \(note\) |
|
||||||
| `author` | object | The admin who created the note |
|
| `author` | object | The admin who created the note |
|
||||||
| ↳ `type` | string | Author type \(admin\) |
|
| ↳ `type` | string | Author type \(admin\) |
|
||||||
| ↳ `id` | string | Author ID |
|
| ↳ `id` | string | Author ID |
|
||||||
| ↳ `name` | string | Author name |
|
| ↳ `name` | string | Author name |
|
||||||
| ↳ `email` | string | Author email |
|
| ↳ `email` | string | Author email |
|
||||||
| `contact` | object | The contact the note was created for |
|
| `contact` | object | The contact the note was created for |
|
||||||
| ↳ `type` | string | Contact type |
|
| ↳ `type` | string | Contact type |
|
||||||
| ↳ `id` | string | Contact ID |
|
| ↳ `id` | string | Contact ID |
|
||||||
|
|
||||||
### `intercom_create_event`
|
### `intercom_create_event`
|
||||||
|
|
||||||
@@ -1011,16 +1051,16 @@ Attach a contact to a company in Intercom
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `company` | object | The company object the contact was attached to |
|
| `company` | object | The company object the contact was attached to |
|
||||||
| ↳ `id` | string | Unique identifier for the company |
|
| ↳ `id` | string | Unique identifier for the company |
|
||||||
| ↳ `type` | string | Object type \(company\) |
|
| ↳ `type` | string | Object type \(company\) |
|
||||||
| ↳ `company_id` | string | The company_id you defined |
|
| ↳ `company_id` | string | The company_id you defined |
|
||||||
| ↳ `name` | string | Name of the company |
|
| ↳ `name` | string | Name of the company |
|
||||||
| ↳ `created_at` | number | Unix timestamp when company was created |
|
| ↳ `created_at` | number | Unix timestamp when company was created |
|
||||||
| ↳ `updated_at` | number | Unix timestamp when company was updated |
|
| ↳ `updated_at` | number | Unix timestamp when company was updated |
|
||||||
| ↳ `user_count` | number | Number of users in the company |
|
| ↳ `user_count` | number | Number of users in the company |
|
||||||
| ↳ `session_count` | number | Number of sessions |
|
| ↳ `session_count` | number | Number of sessions |
|
||||||
| ↳ `monthly_spend` | number | Monthly spend amount |
|
| ↳ `monthly_spend` | number | Monthly spend amount |
|
||||||
| ↳ `plan` | object | Company plan details |
|
| ↳ `plan` | object | Company plan details |
|
||||||
| `companyId` | string | ID of the company |
|
| `companyId` | string | ID of the company |
|
||||||
| `name` | string | Name of the company |
|
| `name` | string | Name of the company |
|
||||||
|
|
||||||
@@ -1040,10 +1080,10 @@ Remove a contact from a company in Intercom
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `company` | object | The company object the contact was detached from |
|
| `company` | object | The company object the contact was detached from |
|
||||||
| ↳ `id` | string | Unique identifier for the company |
|
| ↳ `id` | string | Unique identifier for the company |
|
||||||
| ↳ `type` | string | Object type \(company\) |
|
| ↳ `type` | string | Object type \(company\) |
|
||||||
| ↳ `company_id` | string | The company_id you defined |
|
| ↳ `company_id` | string | The company_id you defined |
|
||||||
| ↳ `name` | string | Name of the company |
|
| ↳ `name` | string | Name of the company |
|
||||||
| `companyId` | string | ID of the company |
|
| `companyId` | string | ID of the company |
|
||||||
| `name` | string | Name 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 |
|
| 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\) |
|
| `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 |
|
| `gatherLinks` | boolean | No | Whether to gather all links at the end |
|
||||||
| `jsonResponse` | boolean | No | Whether to return response in JSON format |
|
| `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 |
|
| 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 |
|
| `apiKey` | string | Yes | Your Jina AI API key |
|
||||||
| `num` | number | No | Maximum number of results per page \(default: 5\) |
|
| `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"\) |
|
| `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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `results` | array | Array of search results, each containing title, description, url, and LLM-friendly content |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
| `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\) |
|
| `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. |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
| `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. |
|
| `projectId` | string | No | Jira project key \(e.g., PROJ\). Optional when updating a single issue. |
|
||||||
| `issueKey` | string | Yes | Jira issue key to update |
|
| `issueKey` | string | Yes | Jira issue key to update \(e.g., PROJ-123\) |
|
||||||
| `summary` | string | No | New summary for the issue |
|
| `summary` | string | No | New summary for the issue |
|
||||||
| `description` | string | No | New description for the issue |
|
| `description` | string | No | New description for the issue |
|
||||||
| `status` | string | No | New status for the issue |
|
| `status` | string | No | New status for the issue |
|
||||||
@@ -94,7 +94,7 @@ Write a Jira issue
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
| `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 |
|
| `summary` | string | Yes | Summary for the issue |
|
||||||
| `description` | string | No | Description 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"\) |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `projectId` | string | Yes | Jira project ID |
|
| `projectId` | string | Yes | Jira project key \(e.g., PROJ\) |
|
||||||
| `cloudId` | string | No | Jira cloud ID |
|
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -46,8 +46,8 @@ Get all service desks from Jira Service Management
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `serviceDeskId` | string | Yes | Service Desk ID to get request types for |
|
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `serviceDeskId` | string | Yes | Service Desk ID to create the request in |
|
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||||
| `requestTypeId` | string | Yes | Request Type ID for the new request |
|
| `requestTypeId` | string | Yes | Request Type ID \(e.g., "10", "15"\) |
|
||||||
| `summary` | string | Yes | Summary/title for the service request |
|
| `summary` | string | Yes | Summary/title for the service request |
|
||||||
| `description` | string | No | Description 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 |
|
| `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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `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 |
|
| `requestOwnership` | string | No | Filter by ownership: OWNED_REQUESTS, PARTICIPATED_REQUESTS, ORGANIZATION, ALL_REQUESTS |
|
||||||
| `requestStatus` | string | No | Filter by status: OPEN, CLOSED, ALL |
|
| `requestStatus` | string | No | Filter by status: OPEN, CLOSED, ALL |
|
||||||
| `searchTerm` | string | No | Search term to filter requests |
|
| `searchTerm` | string | No | Search term to filter requests \(e.g., "password reset", "laptop"\) |
|
||||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||||
| `body` | string | Yes | Comment body text |
|
| `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
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||||
| `isPublic` | boolean | No | Filter to only public comments |
|
| `isPublic` | boolean | No | Filter to only public comments \(true/false\) |
|
||||||
| `internal` | boolean | No | Filter to only internal comments |
|
| `internal` | boolean | No | Filter to only internal comments \(true/false\) |
|
||||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `serviceDeskId` | string | Yes | Service Desk ID to get customers for |
|
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||||
| `query` | string | No | Search query to filter customers |
|
| `query` | string | No | Search query to filter customers \(e.g., "john", "acme"\) |
|
||||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `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 |
|
| `emails` | string | Yes | Comma-separated email addresses to add as customers |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `serviceDeskId` | string | Yes | Service Desk ID to get organizations for |
|
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `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 |
|
| `organizationId` | string | Yes | Organization ID to add to the service desk |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `serviceDeskId` | string | Yes | Service Desk ID to get queues for |
|
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||||
| `includeCount` | boolean | No | Include issue count for each queue |
|
| `includeCount` | boolean | No | Include issue count for each queue \(true/false\) |
|
||||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||||
|
|
||||||
#### Output
|
#### 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\) |
|
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||||
| `start` | number | No | Start index for pagination \(default: 0\) |
|
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||||
| `limit` | number | No | Maximum results to return \(default: 50\) |
|
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -42,17 +42,44 @@ Retrieve a list of prediction markets from Kalshi with all filtering options (V2
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `status` | string | No | Filter by status \(unopened, open, closed, settled\) |
|
| `status` | string | No | Filter by market status: "unopened", "open", "closed", or "settled" |
|
||||||
| `seriesTicker` | string | No | Filter by series ticker |
|
| `seriesTicker` | string | No | Filter by series ticker \(e.g., "KXBTC", "INX", "FED-RATE"\) |
|
||||||
| `eventTicker` | string | No | Filter by event ticker |
|
| `eventTicker` | string | No | Filter by event ticker \(e.g., "KXBTC-24DEC31", "INX-25JAN03"\) |
|
||||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) |
|
||||||
| `cursor` | string | No | Pagination cursor for next page |
|
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `markets` | array | Array of market objects with all API fields |
|
| `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 |
|
| `cursor` | string | Pagination cursor for fetching more results |
|
||||||
|
|
||||||
### `kalshi_get_market`
|
### `kalshi_get_market`
|
||||||
@@ -63,64 +90,64 @@ Retrieve details of a specific prediction market by ticker (V2 - full API respon
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `market` | object | Market object with all API fields |
|
| `market` | object | Market object with all API fields |
|
||||||
| ↳ `ticker` | string | Market ticker |
|
| ↳ `ticker` | string | Market ticker |
|
||||||
| ↳ `event_ticker` | string | Event ticker |
|
| ↳ `event_ticker` | string | Event ticker |
|
||||||
| ↳ `market_type` | string | Market type |
|
| ↳ `market_type` | string | Market type |
|
||||||
| ↳ `title` | string | Market title |
|
| ↳ `title` | string | Market title |
|
||||||
| ↳ `subtitle` | string | Market subtitle |
|
| ↳ `subtitle` | string | Market subtitle |
|
||||||
| ↳ `yes_sub_title` | string | Yes outcome subtitle |
|
| ↳ `yes_sub_title` | string | Yes outcome subtitle |
|
||||||
| ↳ `no_sub_title` | string | No outcome subtitle |
|
| ↳ `no_sub_title` | string | No outcome subtitle |
|
||||||
| ↳ `open_time` | string | Market open time |
|
| ↳ `open_time` | string | Market open time |
|
||||||
| ↳ `close_time` | string | Market close time |
|
| ↳ `close_time` | string | Market close time |
|
||||||
| ↳ `expected_expiration_time` | string | Expected expiration time |
|
| ↳ `expected_expiration_time` | string | Expected expiration time |
|
||||||
| ↳ `expiration_time` | string | Expiration time |
|
| ↳ `expiration_time` | string | Expiration time |
|
||||||
| ↳ `latest_expiration_time` | string | Latest expiration time |
|
| ↳ `latest_expiration_time` | string | Latest expiration time |
|
||||||
| ↳ `settlement_timer_seconds` | number | Settlement timer in seconds |
|
| ↳ `settlement_timer_seconds` | number | Settlement timer in seconds |
|
||||||
| ↳ `status` | string | Market status |
|
| ↳ `status` | string | Market status |
|
||||||
| ↳ `response_price_units` | string | Response price units |
|
| ↳ `response_price_units` | string | Response price units |
|
||||||
| ↳ `notional_value` | number | Notional value |
|
| ↳ `notional_value` | number | Notional value |
|
||||||
| ↳ `tick_size` | number | Tick size |
|
| ↳ `tick_size` | number | Tick size |
|
||||||
| ↳ `yes_bid` | number | Current yes bid price |
|
| ↳ `yes_bid` | number | Current yes bid price |
|
||||||
| ↳ `yes_ask` | number | Current yes ask price |
|
| ↳ `yes_ask` | number | Current yes ask price |
|
||||||
| ↳ `no_bid` | number | Current no bid price |
|
| ↳ `no_bid` | number | Current no bid price |
|
||||||
| ↳ `no_ask` | number | Current no ask price |
|
| ↳ `no_ask` | number | Current no ask price |
|
||||||
| ↳ `last_price` | number | Last trade price |
|
| ↳ `last_price` | number | Last trade price |
|
||||||
| ↳ `previous_yes_bid` | number | Previous yes bid |
|
| ↳ `previous_yes_bid` | number | Previous yes bid |
|
||||||
| ↳ `previous_yes_ask` | number | Previous yes ask |
|
| ↳ `previous_yes_ask` | number | Previous yes ask |
|
||||||
| ↳ `previous_price` | number | Previous price |
|
| ↳ `previous_price` | number | Previous price |
|
||||||
| ↳ `volume` | number | Total volume |
|
| ↳ `volume` | number | Total volume |
|
||||||
| ↳ `volume_24h` | number | 24-hour volume |
|
| ↳ `volume_24h` | number | 24-hour volume |
|
||||||
| ↳ `liquidity` | number | Market liquidity |
|
| ↳ `liquidity` | number | Market liquidity |
|
||||||
| ↳ `open_interest` | number | Open interest |
|
| ↳ `open_interest` | number | Open interest |
|
||||||
| ↳ `result` | string | Market result |
|
| ↳ `result` | string | Market result |
|
||||||
| ↳ `cap_strike` | number | Cap strike |
|
| ↳ `cap_strike` | number | Cap strike |
|
||||||
| ↳ `floor_strike` | number | Floor strike |
|
| ↳ `floor_strike` | number | Floor strike |
|
||||||
| ↳ `can_close_early` | boolean | Can close early |
|
| ↳ `can_close_early` | boolean | Can close early |
|
||||||
| ↳ `expiration_value` | string | Expiration value |
|
| ↳ `expiration_value` | string | Expiration value |
|
||||||
| ↳ `category` | string | Market category |
|
| ↳ `category` | string | Market category |
|
||||||
| ↳ `risk_limit_cents` | number | Risk limit in cents |
|
| ↳ `risk_limit_cents` | number | Risk limit in cents |
|
||||||
| ↳ `strike_type` | string | Strike type |
|
| ↳ `strike_type` | string | Strike type |
|
||||||
| ↳ `rules_primary` | string | Primary rules |
|
| ↳ `rules_primary` | string | Primary rules |
|
||||||
| ↳ `rules_secondary` | string | Secondary rules |
|
| ↳ `rules_secondary` | string | Secondary rules |
|
||||||
| ↳ `settlement_source_url` | string | Settlement source URL |
|
| ↳ `settlement_source_url` | string | Settlement source URL |
|
||||||
| ↳ `custom_strike` | object | Custom strike object |
|
| ↳ `custom_strike` | object | Custom strike object |
|
||||||
| ↳ `underlying` | string | Underlying asset |
|
| ↳ `underlying` | string | Underlying asset |
|
||||||
| ↳ `settlement_value` | number | Settlement value |
|
| ↳ `settlement_value` | number | Settlement value |
|
||||||
| ↳ `cfd_contract_size` | number | CFD contract size |
|
| ↳ `cfd_contract_size` | number | CFD contract size |
|
||||||
| ↳ `yes_fee_fp` | number | Yes fee \(fixed-point\) |
|
| ↳ `yes_fee_fp` | number | Yes fee \(fixed-point\) |
|
||||||
| ↳ `no_fee_fp` | number | No fee \(fixed-point\) |
|
| ↳ `no_fee_fp` | number | No fee \(fixed-point\) |
|
||||||
| ↳ `last_price_fp` | number | Last price \(fixed-point\) |
|
| ↳ `last_price_fp` | number | Last price \(fixed-point\) |
|
||||||
| ↳ `yes_bid_fp` | number | Yes bid \(fixed-point\) |
|
| ↳ `yes_bid_fp` | number | Yes bid \(fixed-point\) |
|
||||||
| ↳ `yes_ask_fp` | number | Yes ask \(fixed-point\) |
|
| ↳ `yes_ask_fp` | number | Yes ask \(fixed-point\) |
|
||||||
| ↳ `no_bid_fp` | number | No bid \(fixed-point\) |
|
| ↳ `no_bid_fp` | number | No bid \(fixed-point\) |
|
||||||
| ↳ `no_ask_fp` | number | No ask \(fixed-point\) |
|
| ↳ `no_ask_fp` | number | No ask \(fixed-point\) |
|
||||||
|
|
||||||
### `kalshi_get_events`
|
### `kalshi_get_events`
|
||||||
|
|
||||||
@@ -130,18 +157,30 @@ Retrieve a list of events from Kalshi with optional filtering (V2 - exact API re
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `status` | string | No | Filter by status \(open, closed, settled\) |
|
| `status` | string | No | Filter by event status: "open", "closed", or "settled" |
|
||||||
| `seriesTicker` | string | No | Filter by series ticker |
|
| `seriesTicker` | string | No | Filter by series ticker \(e.g., "KXBTC", "INX", "FED-RATE"\) |
|
||||||
| `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) |
|
| `withNestedMarkets` | string | No | Include nested markets in response: "true" or "false" |
|
||||||
| `limit` | string | No | Number of results \(1-200, default: 200\) |
|
| `limit` | string | No | Number of results to return \(1-200, default: 200\) |
|
||||||
| `cursor` | string | No | Pagination cursor for next page |
|
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `events` | array | Array of event objects |
|
| `events` | array | Array of event objects |
|
||||||
|
| ↳ `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\) |
|
| `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 |
|
| `cursor` | string | Pagination cursor for fetching more results |
|
||||||
|
|
||||||
### `kalshi_get_event`
|
### `kalshi_get_event`
|
||||||
@@ -152,7 +191,7 @@ Retrieve details of a specific event by ticker (V2 - exact API response)
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -160,18 +199,18 @@ Retrieve details of a specific event by ticker (V2 - exact API response)
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `event` | object | Event object with full details matching Kalshi API response |
|
| `event` | object | Event object with full details matching Kalshi API response |
|
||||||
| ↳ `event_ticker` | string | Event ticker |
|
| ↳ `event_ticker` | string | Event ticker |
|
||||||
| ↳ `series_ticker` | string | Series ticker |
|
| ↳ `series_ticker` | string | Series ticker |
|
||||||
| ↳ `title` | string | Event title |
|
| ↳ `title` | string | Event title |
|
||||||
| ↳ `sub_title` | string | Event subtitle |
|
| ↳ `sub_title` | string | Event subtitle |
|
||||||
| ↳ `mutually_exclusive` | boolean | Mutually exclusive markets |
|
| ↳ `mutually_exclusive` | boolean | Mutually exclusive markets |
|
||||||
| ↳ `category` | string | Event category |
|
| ↳ `category` | string | Event category |
|
||||||
| ↳ `collateral_return_type` | string | Collateral return type |
|
| ↳ `collateral_return_type` | string | Collateral return type |
|
||||||
| ↳ `strike_date` | string | Strike date |
|
| ↳ `strike_date` | string | Strike date |
|
||||||
| ↳ `strike_period` | string | Strike period |
|
| ↳ `strike_period` | string | Strike period |
|
||||||
| ↳ `available_on_brokers` | boolean | Available on brokers |
|
| ↳ `available_on_brokers` | boolean | Available on brokers |
|
||||||
| ↳ `product_metadata` | object | Product metadata |
|
| ↳ `product_metadata` | object | Product metadata |
|
||||||
| ↳ `markets` | array | Nested markets \(if requested\) |
|
| ↳ `markets` | array | Nested markets \(if requested\) |
|
||||||
|
|
||||||
### `kalshi_get_balance`
|
### `kalshi_get_balance`
|
||||||
|
|
||||||
@@ -202,18 +241,32 @@ Retrieve your open positions from Kalshi (V2 - exact API response)
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||||
| `ticker` | string | No | Filter by market ticker |
|
| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) |
|
||||||
| `eventTicker` | string | No | Filter by event ticker \(max 10 comma-separated\) |
|
| `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, settled\). Default: unsettled |
|
| `settlementStatus` | string | No | Filter by settlement status: "all", "unsettled", or "settled" \(default: "unsettled"\) |
|
||||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) |
|
||||||
| `cursor` | string | No | Pagination cursor for next page |
|
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `market_positions` | array | Array of market position objects |
|
| `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_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 |
|
| `cursor` | string | Pagination cursor for fetching more results |
|
||||||
|
|
||||||
### `kalshi_get_orders`
|
### `kalshi_get_orders`
|
||||||
@@ -226,17 +279,35 @@ Retrieve your orders from Kalshi with optional filtering (V2 with full API respo
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||||
| `ticker` | string | No | Filter by market ticker |
|
| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) |
|
||||||
| `eventTicker` | string | No | Filter by event ticker \(max 10 comma-separated\) |
|
| `eventTicker` | string | No | Filter by event ticker, max 10 comma-separated \(e.g., "KXBTC-24DEC31,INX-25JAN03"\) |
|
||||||
| `status` | string | No | Filter by status \(resting, canceled, executed\) |
|
| `status` | string | No | Filter by order status: "resting", "canceled", or "executed" |
|
||||||
| `limit` | string | No | Number of results \(1-200, default: 100\) |
|
| `limit` | string | No | Number of results to return \(1-200, default: 100\) |
|
||||||
| `cursor` | string | No | Pagination cursor for next page |
|
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `orders` | array | Array of order objects with full API response fields |
|
| `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 |
|
| `cursor` | string | Pagination cursor for fetching more results |
|
||||||
|
|
||||||
### `kalshi_get_order`
|
### `kalshi_get_order`
|
||||||
@@ -249,46 +320,46 @@ Retrieve details of a specific order by ID from Kalshi (V2 with full API respons
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `order` | object | Order object with full API response fields |
|
| `order` | object | Order object with full API response fields |
|
||||||
| ↳ `order_id` | string | Order ID |
|
| ↳ `order_id` | string | Order ID |
|
||||||
| ↳ `user_id` | string | User ID |
|
| ↳ `user_id` | string | User ID |
|
||||||
| ↳ `client_order_id` | string | Client order ID |
|
| ↳ `client_order_id` | string | Client order ID |
|
||||||
| ↳ `ticker` | string | Market ticker |
|
| ↳ `ticker` | string | Market ticker |
|
||||||
| ↳ `side` | string | Order side \(yes/no\) |
|
| ↳ `side` | string | Order side \(yes/no\) |
|
||||||
| ↳ `action` | string | Action \(buy/sell\) |
|
| ↳ `action` | string | Action \(buy/sell\) |
|
||||||
| ↳ `type` | string | Order type \(limit/market\) |
|
| ↳ `type` | string | Order type \(limit/market\) |
|
||||||
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
|
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
|
||||||
| ↳ `yes_price` | number | Yes price in cents |
|
| ↳ `yes_price` | number | Yes price in cents |
|
||||||
| ↳ `no_price` | number | No price in cents |
|
| ↳ `no_price` | number | No price in cents |
|
||||||
| ↳ `yes_price_dollars` | string | Yes price in dollars |
|
| ↳ `yes_price_dollars` | string | Yes price in dollars |
|
||||||
| ↳ `no_price_dollars` | string | No price in dollars |
|
| ↳ `no_price_dollars` | string | No price in dollars |
|
||||||
| ↳ `fill_count` | number | Filled contract count |
|
| ↳ `fill_count` | number | Filled contract count |
|
||||||
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
|
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
|
||||||
| ↳ `remaining_count` | number | Remaining contracts |
|
| ↳ `remaining_count` | number | Remaining contracts |
|
||||||
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
|
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
|
||||||
| ↳ `initial_count` | number | Initial contract count |
|
| ↳ `initial_count` | number | Initial contract count |
|
||||||
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
|
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
|
||||||
| ↳ `taker_fees` | number | Taker fees in cents |
|
| ↳ `taker_fees` | number | Taker fees in cents |
|
||||||
| ↳ `maker_fees` | number | Maker fees in cents |
|
| ↳ `maker_fees` | number | Maker fees in cents |
|
||||||
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
|
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
|
||||||
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
|
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
|
||||||
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
|
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
|
||||||
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
|
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
|
||||||
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
|
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
|
||||||
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
|
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
|
||||||
| ↳ `queue_position` | number | Queue position \(deprecated\) |
|
| ↳ `queue_position` | number | Queue position \(deprecated\) |
|
||||||
| ↳ `expiration_time` | string | Order expiration time |
|
| ↳ `expiration_time` | string | Order expiration time |
|
||||||
| ↳ `created_time` | string | Order creation time |
|
| ↳ `created_time` | string | Order creation time |
|
||||||
| ↳ `last_update_time` | string | Last update time |
|
| ↳ `last_update_time` | string | Last update time |
|
||||||
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
|
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
|
||||||
| ↳ `order_group_id` | string | Order group ID |
|
| ↳ `order_group_id` | string | Order group ID |
|
||||||
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
|
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
|
||||||
|
|
||||||
### `kalshi_get_orderbook`
|
### `kalshi_get_orderbook`
|
||||||
|
|
||||||
@@ -298,20 +369,20 @@ Retrieve the orderbook (yes and no bids) for a specific market (V2 - includes de
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `orderbook` | object | Orderbook with yes/no bids \(legacy integer counts\) |
|
| `orderbook` | object | Orderbook with yes/no bids \(legacy integer counts\) |
|
||||||
| ↳ `yes` | array | Yes side bids as tuples \[price_cents, count\] |
|
| ↳ `yes` | array | Yes side bids as tuples \[price_cents, count\] |
|
||||||
| ↳ `no` | array | No 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\] |
|
| ↳ `yes_dollars` | array | Yes side bids as tuples \[dollars_string, count\] |
|
||||||
| ↳ `no_dollars` | array | No 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\) |
|
| `orderbook_fp` | object | Orderbook with fixed-point counts \(preferred\) |
|
||||||
| ↳ `yes_dollars` | array | Yes side bids as tuples \[dollars_string, fp_count_string\] |
|
| ↳ `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\] |
|
| ↳ `no_dollars` | array | No side bids as tuples \[dollars_string, fp_count_string\] |
|
||||||
|
|
||||||
### `kalshi_get_trades`
|
### `kalshi_get_trades`
|
||||||
|
|
||||||
@@ -321,14 +392,20 @@ Retrieve recent trades with additional filtering options (V2 - includes trade_id
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) |
|
||||||
| `cursor` | string | No | Pagination cursor for next page |
|
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `trades` | array | Array of trade objects with trade_id and count_fp |
|
| `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 |
|
| `cursor` | string | Pagination cursor for fetching more results |
|
||||||
|
|
||||||
### `kalshi_get_candlesticks`
|
### `kalshi_get_candlesticks`
|
||||||
@@ -339,11 +416,11 @@ Retrieve OHLC candlestick data for a specific market (V2 - full API response)
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `seriesTicker` | string | Yes | Series ticker |
|
| `seriesTicker` | string | Yes | Series ticker identifier \(e.g., "KXBTC", "INX", "FED-RATE"\) |
|
||||||
| `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) |
|
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) |
|
||||||
| `startTs` | number | Yes | Start timestamp \(Unix seconds\) |
|
| `startTs` | number | Yes | Start timestamp in Unix seconds \(e.g., 1704067200\) |
|
||||||
| `endTs` | number | Yes | End timestamp \(Unix seconds\) |
|
| `endTs` | number | Yes | End timestamp in Unix seconds \(e.g., 1704153600\) |
|
||||||
| `periodInterval` | number | Yes | Period interval: 1 \(1min\), 60 \(1hour\), or 1440 \(1day\) |
|
| `periodInterval` | number | Yes | Period interval: 1 \(1 minute\), 60 \(1 hour\), or 1440 \(1 day\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -362,18 +439,28 @@ Retrieve your portfolio
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||||
| `ticker` | string | No | Filter by market ticker |
|
| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) |
|
||||||
| `orderId` | string | No | Filter by order ID |
|
| `orderId` | string | No | Filter by order ID \(e.g., "abc123-def456-ghi789"\) |
|
||||||
| `minTs` | number | No | Minimum timestamp \(Unix milliseconds\) |
|
| `minTs` | number | No | Minimum timestamp in Unix milliseconds \(e.g., 1704067200000\) |
|
||||||
| `maxTs` | number | No | Maximum timestamp \(Unix milliseconds\) |
|
| `maxTs` | number | No | Maximum timestamp in Unix milliseconds \(e.g., 1704153600000\) |
|
||||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) |
|
||||||
| `cursor` | string | No | Pagination cursor for next page |
|
| `cursor` | string | No | Pagination cursor from previous response for fetching next page |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `fills` | array | Array of fill/trade objects with all API fields |
|
| `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 |
|
| `cursor` | string | Pagination cursor for fetching more results |
|
||||||
|
|
||||||
### `kalshi_get_series_by_ticker`
|
### `kalshi_get_series_by_ticker`
|
||||||
@@ -384,27 +471,27 @@ Retrieve details of a specific market series by ticker (V2 - exact API response)
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `seriesTicker` | string | Yes | Series ticker |
|
| `seriesTicker` | string | Yes | Series ticker identifier \(e.g., "KXBTC", "INX", "FED-RATE"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `series` | object | Series object with full details matching Kalshi API response |
|
| `series` | object | Series object with full details matching Kalshi API response |
|
||||||
| ↳ `ticker` | string | Series ticker |
|
| ↳ `ticker` | string | Series ticker |
|
||||||
| ↳ `title` | string | Series title |
|
| ↳ `title` | string | Series title |
|
||||||
| ↳ `frequency` | string | Event frequency |
|
| ↳ `frequency` | string | Event frequency |
|
||||||
| ↳ `category` | string | Series category |
|
| ↳ `category` | string | Series category |
|
||||||
| ↳ `tags` | array | Series tags |
|
| ↳ `tags` | array | Series tags |
|
||||||
| ↳ `settlement_sources` | array | Settlement sources |
|
| ↳ `settlement_sources` | array | Settlement sources |
|
||||||
| ↳ `contract_url` | string | Contract URL |
|
| ↳ `contract_url` | string | Contract URL |
|
||||||
| ↳ `contract_terms_url` | string | Contract terms URL |
|
| ↳ `contract_terms_url` | string | Contract terms URL |
|
||||||
| ↳ `fee_type` | string | Fee type |
|
| ↳ `fee_type` | string | Fee type |
|
||||||
| ↳ `fee_multiplier` | number | Fee multiplier |
|
| ↳ `fee_multiplier` | number | Fee multiplier |
|
||||||
| ↳ `additional_prohibitions` | array | Additional prohibitions |
|
| ↳ `additional_prohibitions` | array | Additional prohibitions |
|
||||||
| ↳ `product_metadata` | object | Product metadata |
|
| ↳ `product_metadata` | object | Product metadata |
|
||||||
| ↳ `volume` | number | Series volume |
|
| ↳ `volume` | number | Series volume |
|
||||||
| ↳ `volume_fp` | number | Volume \(fixed-point\) |
|
| ↳ `volume_fp` | number | Volume \(fixed-point\) |
|
||||||
|
|
||||||
### `kalshi_get_exchange_status`
|
### `kalshi_get_exchange_status`
|
||||||
|
|
||||||
@@ -433,11 +520,11 @@ Create a new order on a Kalshi prediction market (V2 with full API response)
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||||
| `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) |
|
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) |
|
||||||
| `side` | string | Yes | Side of the order: 'yes' or 'no' |
|
| `side` | string | Yes | Side of the order: "yes" or "no" |
|
||||||
| `action` | string | Yes | Action type: 'buy' or 'sell' |
|
| `action` | string | Yes | Action type: "buy" or "sell" |
|
||||||
| `count` | string | Yes | Number of contracts \(minimum 1\) |
|
| `count` | string | Yes | Number of contracts to trade \(e.g., "10", "100"\) |
|
||||||
| `type` | string | No | Order type: 'limit' or 'market' \(default: limit\) |
|
| `type` | string | No | Order type: "limit" or "market" \(default: "limit"\) |
|
||||||
| `yesPrice` | string | No | Yes price in cents \(1-99\) |
|
| `yesPrice` | string | No | Yes price in cents \(1-99\) |
|
||||||
| `noPrice` | string | No | No 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"\) |
|
| `yesPriceDollars` | string | No | Yes price in dollars \(e.g., "0.56"\) |
|
||||||
@@ -456,39 +543,39 @@ Create a new order on a Kalshi prediction market (V2 with full API response)
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `order` | object | The created order object with full API response fields |
|
| `order` | object | The created order object with full API response fields |
|
||||||
| ↳ `order_id` | string | Order ID |
|
| ↳ `order_id` | string | Order ID |
|
||||||
| ↳ `user_id` | string | User ID |
|
| ↳ `user_id` | string | User ID |
|
||||||
| ↳ `client_order_id` | string | Client order ID |
|
| ↳ `client_order_id` | string | Client order ID |
|
||||||
| ↳ `ticker` | string | Market ticker |
|
| ↳ `ticker` | string | Market ticker |
|
||||||
| ↳ `side` | string | Order side \(yes/no\) |
|
| ↳ `side` | string | Order side \(yes/no\) |
|
||||||
| ↳ `action` | string | Action \(buy/sell\) |
|
| ↳ `action` | string | Action \(buy/sell\) |
|
||||||
| ↳ `type` | string | Order type \(limit/market\) |
|
| ↳ `type` | string | Order type \(limit/market\) |
|
||||||
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
|
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
|
||||||
| ↳ `yes_price` | number | Yes price in cents |
|
| ↳ `yes_price` | number | Yes price in cents |
|
||||||
| ↳ `no_price` | number | No price in cents |
|
| ↳ `no_price` | number | No price in cents |
|
||||||
| ↳ `yes_price_dollars` | string | Yes price in dollars |
|
| ↳ `yes_price_dollars` | string | Yes price in dollars |
|
||||||
| ↳ `no_price_dollars` | string | No price in dollars |
|
| ↳ `no_price_dollars` | string | No price in dollars |
|
||||||
| ↳ `fill_count` | number | Filled contract count |
|
| ↳ `fill_count` | number | Filled contract count |
|
||||||
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
|
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
|
||||||
| ↳ `remaining_count` | number | Remaining contracts |
|
| ↳ `remaining_count` | number | Remaining contracts |
|
||||||
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
|
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
|
||||||
| ↳ `initial_count` | number | Initial contract count |
|
| ↳ `initial_count` | number | Initial contract count |
|
||||||
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
|
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
|
||||||
| ↳ `taker_fees` | number | Taker fees in cents |
|
| ↳ `taker_fees` | number | Taker fees in cents |
|
||||||
| ↳ `maker_fees` | number | Maker fees in cents |
|
| ↳ `maker_fees` | number | Maker fees in cents |
|
||||||
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
|
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
|
||||||
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
|
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
|
||||||
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
|
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
|
||||||
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
|
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
|
||||||
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
|
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
|
||||||
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
|
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
|
||||||
| ↳ `queue_position` | number | Queue position \(deprecated\) |
|
| ↳ `queue_position` | number | Queue position \(deprecated\) |
|
||||||
| ↳ `expiration_time` | string | Order expiration time |
|
| ↳ `expiration_time` | string | Order expiration time |
|
||||||
| ↳ `created_time` | string | Order creation time |
|
| ↳ `created_time` | string | Order creation time |
|
||||||
| ↳ `last_update_time` | string | Last update time |
|
| ↳ `last_update_time` | string | Last update time |
|
||||||
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
|
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
|
||||||
| ↳ `order_group_id` | string | Order group ID |
|
| ↳ `order_group_id` | string | Order group ID |
|
||||||
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
|
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
|
||||||
|
|
||||||
### `kalshi_cancel_order`
|
### `kalshi_cancel_order`
|
||||||
|
|
||||||
@@ -500,46 +587,46 @@ Cancel an existing order on Kalshi (V2 with full API response)
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `order` | object | The canceled order object with full API response fields |
|
| `order` | object | The canceled order object with full API response fields |
|
||||||
| ↳ `order_id` | string | Order ID |
|
| ↳ `order_id` | string | Order ID |
|
||||||
| ↳ `user_id` | string | User ID |
|
| ↳ `user_id` | string | User ID |
|
||||||
| ↳ `client_order_id` | string | Client order ID |
|
| ↳ `client_order_id` | string | Client order ID |
|
||||||
| ↳ `ticker` | string | Market ticker |
|
| ↳ `ticker` | string | Market ticker |
|
||||||
| ↳ `side` | string | Order side \(yes/no\) |
|
| ↳ `side` | string | Order side \(yes/no\) |
|
||||||
| ↳ `action` | string | Action \(buy/sell\) |
|
| ↳ `action` | string | Action \(buy/sell\) |
|
||||||
| ↳ `type` | string | Order type \(limit/market\) |
|
| ↳ `type` | string | Order type \(limit/market\) |
|
||||||
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
|
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
|
||||||
| ↳ `yes_price` | number | Yes price in cents |
|
| ↳ `yes_price` | number | Yes price in cents |
|
||||||
| ↳ `no_price` | number | No price in cents |
|
| ↳ `no_price` | number | No price in cents |
|
||||||
| ↳ `yes_price_dollars` | string | Yes price in dollars |
|
| ↳ `yes_price_dollars` | string | Yes price in dollars |
|
||||||
| ↳ `no_price_dollars` | string | No price in dollars |
|
| ↳ `no_price_dollars` | string | No price in dollars |
|
||||||
| ↳ `fill_count` | number | Filled contract count |
|
| ↳ `fill_count` | number | Filled contract count |
|
||||||
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
|
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
|
||||||
| ↳ `remaining_count` | number | Remaining contracts |
|
| ↳ `remaining_count` | number | Remaining contracts |
|
||||||
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
|
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
|
||||||
| ↳ `initial_count` | number | Initial contract count |
|
| ↳ `initial_count` | number | Initial contract count |
|
||||||
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
|
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
|
||||||
| ↳ `taker_fees` | number | Taker fees in cents |
|
| ↳ `taker_fees` | number | Taker fees in cents |
|
||||||
| ↳ `maker_fees` | number | Maker fees in cents |
|
| ↳ `maker_fees` | number | Maker fees in cents |
|
||||||
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
|
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
|
||||||
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
|
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
|
||||||
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
|
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
|
||||||
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
|
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
|
||||||
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
|
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
|
||||||
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
|
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
|
||||||
| ↳ `queue_position` | number | Queue position \(deprecated\) |
|
| ↳ `queue_position` | number | Queue position \(deprecated\) |
|
||||||
| ↳ `expiration_time` | string | Order expiration time |
|
| ↳ `expiration_time` | string | Order expiration time |
|
||||||
| ↳ `created_time` | string | Order creation time |
|
| ↳ `created_time` | string | Order creation time |
|
||||||
| ↳ `last_update_time` | string | Last update time |
|
| ↳ `last_update_time` | string | Last update time |
|
||||||
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
|
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
|
||||||
| ↳ `order_group_id` | string | Order group ID |
|
| ↳ `order_group_id` | string | Order group ID |
|
||||||
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
|
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
|
||||||
| `reduced_by` | number | Number of contracts canceled |
|
| `reduced_by` | number | Number of contracts canceled |
|
||||||
| `reduced_by_fp` | string | Number of contracts canceled in fixed-point format |
|
| `reduced_by_fp` | string | Number of contracts canceled in fixed-point format |
|
||||||
|
|
||||||
@@ -553,13 +640,13 @@ Modify the price or quantity of an existing order on Kalshi (V2 with full API re
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||||
| `orderId` | string | Yes | The order ID to amend |
|
| `orderId` | string | Yes | Order ID to amend \(e.g., "abc123-def456-ghi789"\) |
|
||||||
| `ticker` | string | Yes | Market ticker |
|
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) |
|
||||||
| `side` | string | Yes | Side of the order: 'yes' or 'no' |
|
| `side` | string | Yes | Side of the order: "yes" or "no" |
|
||||||
| `action` | string | Yes | Action type: 'buy' or 'sell' |
|
| `action` | string | Yes | Action type: "buy" or "sell" |
|
||||||
| `clientOrderId` | string | Yes | The original client-specified order ID |
|
| `clientOrderId` | string | Yes | Original client-specified order ID |
|
||||||
| `updatedClientOrderId` | string | Yes | The new client-specified order ID after amendment |
|
| `updatedClientOrderId` | string | Yes | New client-specified order ID after amendment |
|
||||||
| `count` | string | No | Updated quantity for the order |
|
| `count` | string | No | Updated quantity for the order \(e.g., "10", "100"\) |
|
||||||
| `yesPrice` | string | No | Updated yes price in cents \(1-99\) |
|
| `yesPrice` | string | No | Updated yes price in cents \(1-99\) |
|
||||||
| `noPrice` | string | No | Updated no 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"\) |
|
| `yesPriceDollars` | string | No | Updated yes price in dollars \(e.g., "0.56"\) |
|
||||||
@@ -570,62 +657,62 @@ Modify the price or quantity of an existing order on Kalshi (V2 with full API re
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `old_order` | object | The original order object before amendment |
|
| `old_order` | object | The original order object before amendment |
|
||||||
| ↳ `order_id` | string | Order ID |
|
| ↳ `order_id` | string | Order ID |
|
||||||
| ↳ `user_id` | string | User ID |
|
| ↳ `user_id` | string | User ID |
|
||||||
| ↳ `ticker` | string | Market ticker |
|
| ↳ `ticker` | string | Market ticker |
|
||||||
| ↳ `event_ticker` | string | Event ticker |
|
| ↳ `event_ticker` | string | Event ticker |
|
||||||
| ↳ `status` | string | Order status |
|
| ↳ `status` | string | Order status |
|
||||||
| ↳ `side` | string | Order side \(yes/no\) |
|
| ↳ `side` | string | Order side \(yes/no\) |
|
||||||
| ↳ `type` | string | Order type \(limit/market\) |
|
| ↳ `type` | string | Order type \(limit/market\) |
|
||||||
| ↳ `yes_price` | number | Yes price in cents |
|
| ↳ `yes_price` | number | Yes price in cents |
|
||||||
| ↳ `no_price` | number | No price in cents |
|
| ↳ `no_price` | number | No price in cents |
|
||||||
| ↳ `action` | string | Action \(buy/sell\) |
|
| ↳ `action` | string | Action \(buy/sell\) |
|
||||||
| ↳ `count` | number | Number of contracts |
|
| ↳ `count` | number | Number of contracts |
|
||||||
| ↳ `remaining_count` | number | Remaining contracts |
|
| ↳ `remaining_count` | number | Remaining contracts |
|
||||||
| ↳ `created_time` | string | Order creation time |
|
| ↳ `created_time` | string | Order creation time |
|
||||||
| ↳ `expiration_time` | string | Order expiration time |
|
| ↳ `expiration_time` | string | Order expiration time |
|
||||||
| ↳ `order_group_id` | string | Order group ID |
|
| ↳ `order_group_id` | string | Order group ID |
|
||||||
| ↳ `client_order_id` | string | Client order ID |
|
| ↳ `client_order_id` | string | Client order ID |
|
||||||
| ↳ `place_count` | number | Place count |
|
| ↳ `place_count` | number | Place count |
|
||||||
| ↳ `decrease_count` | number | Decrease count |
|
| ↳ `decrease_count` | number | Decrease count |
|
||||||
| ↳ `queue_position` | number | Queue position |
|
| ↳ `queue_position` | number | Queue position |
|
||||||
| ↳ `maker_fill_count` | number | Maker fill count |
|
| ↳ `maker_fill_count` | number | Maker fill count |
|
||||||
| ↳ `taker_fill_count` | number | Taker fill count |
|
| ↳ `taker_fill_count` | number | Taker fill count |
|
||||||
| ↳ `maker_fees` | number | Maker fees |
|
| ↳ `maker_fees` | number | Maker fees |
|
||||||
| ↳ `taker_fees` | number | Taker fees |
|
| ↳ `taker_fees` | number | Taker fees |
|
||||||
| ↳ `last_update_time` | string | Last update time |
|
| ↳ `last_update_time` | string | Last update time |
|
||||||
| ↳ `take_profit_order_id` | string | Take profit order ID |
|
| ↳ `take_profit_order_id` | string | Take profit order ID |
|
||||||
| ↳ `stop_loss_order_id` | string | Stop loss order ID |
|
| ↳ `stop_loss_order_id` | string | Stop loss order ID |
|
||||||
| ↳ `amend_count` | number | Amend count |
|
| ↳ `amend_count` | number | Amend count |
|
||||||
| ↳ `amend_taker_fill_count` | number | Amend taker fill count |
|
| ↳ `amend_taker_fill_count` | number | Amend taker fill count |
|
||||||
| `order` | object | The amended order object with full API response fields |
|
| `order` | object | The amended order object with full API response fields |
|
||||||
| ↳ `order_id` | string | Order ID |
|
| ↳ `order_id` | string | Order ID |
|
||||||
| ↳ `user_id` | string | User ID |
|
| ↳ `user_id` | string | User ID |
|
||||||
| ↳ `ticker` | string | Market ticker |
|
| ↳ `ticker` | string | Market ticker |
|
||||||
| ↳ `event_ticker` | string | Event ticker |
|
| ↳ `event_ticker` | string | Event ticker |
|
||||||
| ↳ `status` | string | Order status |
|
| ↳ `status` | string | Order status |
|
||||||
| ↳ `side` | string | Order side \(yes/no\) |
|
| ↳ `side` | string | Order side \(yes/no\) |
|
||||||
| ↳ `type` | string | Order type \(limit/market\) |
|
| ↳ `type` | string | Order type \(limit/market\) |
|
||||||
| ↳ `yes_price` | number | Yes price in cents |
|
| ↳ `yes_price` | number | Yes price in cents |
|
||||||
| ↳ `no_price` | number | No price in cents |
|
| ↳ `no_price` | number | No price in cents |
|
||||||
| ↳ `action` | string | Action \(buy/sell\) |
|
| ↳ `action` | string | Action \(buy/sell\) |
|
||||||
| ↳ `count` | number | Number of contracts |
|
| ↳ `count` | number | Number of contracts |
|
||||||
| ↳ `remaining_count` | number | Remaining contracts |
|
| ↳ `remaining_count` | number | Remaining contracts |
|
||||||
| ↳ `created_time` | string | Order creation time |
|
| ↳ `created_time` | string | Order creation time |
|
||||||
| ↳ `expiration_time` | string | Order expiration time |
|
| ↳ `expiration_time` | string | Order expiration time |
|
||||||
| ↳ `order_group_id` | string | Order group ID |
|
| ↳ `order_group_id` | string | Order group ID |
|
||||||
| ↳ `client_order_id` | string | Client order ID |
|
| ↳ `client_order_id` | string | Client order ID |
|
||||||
| ↳ `place_count` | number | Place count |
|
| ↳ `place_count` | number | Place count |
|
||||||
| ↳ `decrease_count` | number | Decrease count |
|
| ↳ `decrease_count` | number | Decrease count |
|
||||||
| ↳ `queue_position` | number | Queue position |
|
| ↳ `queue_position` | number | Queue position |
|
||||||
| ↳ `maker_fill_count` | number | Maker fill count |
|
| ↳ `maker_fill_count` | number | Maker fill count |
|
||||||
| ↳ `taker_fill_count` | number | Taker fill count |
|
| ↳ `taker_fill_count` | number | Taker fill count |
|
||||||
| ↳ `maker_fees` | number | Maker fees |
|
| ↳ `maker_fees` | number | Maker fees |
|
||||||
| ↳ `taker_fees` | number | Taker fees |
|
| ↳ `taker_fees` | number | Taker fees |
|
||||||
| ↳ `last_update_time` | string | Last update time |
|
| ↳ `last_update_time` | string | Last update time |
|
||||||
| ↳ `take_profit_order_id` | string | Take profit order ID |
|
| ↳ `take_profit_order_id` | string | Take profit order ID |
|
||||||
| ↳ `stop_loss_order_id` | string | Stop loss order ID |
|
| ↳ `stop_loss_order_id` | string | Stop loss order ID |
|
||||||
| ↳ `amend_count` | number | Amend count |
|
| ↳ `amend_count` | number | Amend count |
|
||||||
| ↳ `amend_taker_fill_count` | number | Amend taker fill 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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `data` | object | Information about the uploaded chunk |
|
| `data` | object | Information about the uploaded chunk |
|
||||||
| ↳ `chunkId` | string | Chunk ID |
|
| ↳ `chunkId` | string | Chunk ID |
|
||||||
| ↳ `chunkIndex` | number | Index of the chunk within the document |
|
| ↳ `chunkIndex` | number | Index of the chunk within the document |
|
||||||
| ↳ `content` | string | Content of the chunk |
|
| ↳ `content` | string | Content of the chunk |
|
||||||
| ↳ `contentLength` | number | Length of the content in characters |
|
| ↳ `contentLength` | number | Length of the content in characters |
|
||||||
| ↳ `tokenCount` | number | Number of tokens in the chunk |
|
| ↳ `tokenCount` | number | Number of tokens in the chunk |
|
||||||
| ↳ `enabled` | boolean | Whether the chunk is enabled |
|
| ↳ `enabled` | boolean | Whether the chunk is enabled |
|
||||||
| ↳ `createdAt` | string | Creation timestamp |
|
| ↳ `createdAt` | string | Creation timestamp |
|
||||||
| ↳ `updatedAt` | string | Last update timestamp |
|
| ↳ `updatedAt` | string | Last update timestamp |
|
||||||
| `message` | string | Success or error message describing the operation result |
|
| `message` | string | Success or error message describing the operation result |
|
||||||
| `documentId` | string | ID of the document the chunk was added to |
|
| `documentId` | string | ID of the document the chunk was added to |
|
||||||
| `documentName` | string | Name 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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `data` | object | Information about the created document |
|
| `data` | object | Information about the created document |
|
||||||
| ↳ `documentId` | string | Document ID |
|
| ↳ `documentId` | string | Document ID |
|
||||||
| ↳ `documentName` | string | Document name |
|
| ↳ `documentName` | string | Document name |
|
||||||
| ↳ `type` | string | Document type |
|
| ↳ `type` | string | Document type |
|
||||||
| ↳ `enabled` | boolean | Whether the document is enabled |
|
| ↳ `enabled` | boolean | Whether the document is enabled |
|
||||||
| ↳ `createdAt` | string | Creation timestamp |
|
| ↳ `createdAt` | string | Creation timestamp |
|
||||||
| ↳ `updatedAt` | string | Last update timestamp |
|
| ↳ `updatedAt` | string | Last update timestamp |
|
||||||
| `message` | string | Success or error message describing the operation result |
|
| `message` | string | Success or error message describing the operation result |
|
||||||
| `documentId` | string | ID of the created document |
|
| `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 |
|
| `apiKey` | string | Yes | Lemlist API key |
|
||||||
| `type` | string | No | Filter by activity type \(e.g., emailOpened, emailClicked, emailReplied, paused\) |
|
| `type` | string | No | Filter by activity type \(e.g., emailOpened, emailClicked, emailReplied, paused\) |
|
||||||
| `campaignId` | string | No | Filter by campaign ID |
|
| `campaignId` | string | No | Filter by campaign ID \(e.g., "cam_abc123def456"\) |
|
||||||
| `leadId` | string | No | Filter by lead ID |
|
| `leadId` | string | No | Filter by lead ID \(e.g., "lea_abc123def456"\) |
|
||||||
| `isFirst` | boolean | No | Filter for first activity only |
|
| `isFirst` | boolean | No | Filter for first activity only |
|
||||||
| `limit` | number | No | Number of results per request \(max 100, default 100\) |
|
| `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 |
|
| `offset` | number | No | Number of records to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -75,7 +75,7 @@ Retrieves lead information by email address or lead ID.
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Lemlist API key |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -102,11 +102,11 @@ Sends an email to a contact through the Lemlist inbox.
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Lemlist API key |
|
| `apiKey` | string | Yes | Lemlist API key |
|
||||||
| `sendUserId` | string | Yes | Identifier for the user sending the message |
|
| `sendUserId` | string | Yes | Identifier for the user sending the message \(e.g., "usr_abc123def456"\) |
|
||||||
| `sendUserEmail` | string | Yes | Email address of the sender |
|
| `sendUserEmail` | string | Yes | Email address of the sender \(e.g., "sales@company.com"\) |
|
||||||
| `sendUserMailboxId` | string | Yes | Mailbox identifier for the sender |
|
| `sendUserMailboxId` | string | Yes | Mailbox identifier for the sender \(e.g., "mbx_abc123def456"\) |
|
||||||
| `contactId` | string | Yes | Recipient contact identifier |
|
| `contactId` | string | Yes | Recipient contact identifier \(e.g., "con_abc123def456"\) |
|
||||||
| `leadId` | string | Yes | Associated lead identifier |
|
| `leadId` | string | Yes | Associated lead identifier \(e.g., "lea_abc123def456"\) |
|
||||||
| `subject` | string | Yes | Email subject line |
|
| `subject` | string | Yes | Email subject line |
|
||||||
| `message` | string | Yes | Email message body in HTML format |
|
| `message` | string | Yes | Email message body in HTML format |
|
||||||
| `cc` | json | No | Array of CC email addresses |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `q` | string | Yes | The search query |
|
| `q` | string | Yes | The search query \(e.g., "latest AI research papers 2024"\) |
|
||||||
| `depth` | string | Yes | Search depth \(has to either be "standard" or "deep"\) |
|
| `depth` | string | Yes | Search depth: "standard" for quick results, "deep" for comprehensive search |
|
||||||
| `outputType` | string | Yes | Type of output to return \(has to be "sourcedAnswer" or "searchResults"\) |
|
| `outputType` | string | Yes | Output format: "sourcedAnswer" for AI-generated answer with citations, "searchResults" for raw results |
|
||||||
| `apiKey` | string | Yes | Enter your Linkup API key |
|
| `apiKey` | string | Yes | Enter your Linkup API key |
|
||||||
| `includeImages` | boolean | No | Whether to include images in search results |
|
| `includeImages` | boolean | No | Whether to include images in search results |
|
||||||
| `fromDate` | string | No | Start date for filtering results \(YYYY-MM-DD format\) |
|
| `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Mailgun API key |
|
| `apiKey` | string | Yes | Mailgun API key |
|
||||||
| `domain` | string | Yes | Mailgun domain \(e.g., mg.example.com\) |
|
| `domain` | string | Yes | Mailgun sending domain \(e.g., mg.example.com\) |
|
||||||
| `from` | string | Yes | Sender email address |
|
| `from` | string | Yes | Sender email address \(e.g., sender@example.com or "Name <sender@example.com>"\) |
|
||||||
| `to` | string | Yes | Recipient email address \(comma-separated for multiple\) |
|
| `to` | string | Yes | Recipient email address \(e.g., user@example.com\). Use comma-separated values for multiple recipients |
|
||||||
| `subject` | string | Yes | Email subject |
|
| `subject` | string | Yes | Email subject line |
|
||||||
| `text` | string | No | Plain text body of the email |
|
| `text` | string | No | Plain text body of the email |
|
||||||
| `html` | string | No | HTML body of the email |
|
| `html` | string | No | HTML body of the email \(e.g., "<h1>Hello</h1><p>Message content</p>"\) |
|
||||||
| `cc` | string | No | CC email address \(comma-separated for multiple\) |
|
| `cc` | string | No | CC recipient email address \(e.g., cc@example.com\). Use comma-separated values for multiple recipients |
|
||||||
| `bcc` | string | No | BCC email address \(comma-separated for multiple\) |
|
| `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\) |
|
| `tags` | string | No | Tags for the email \(comma-separated\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -72,7 +72,7 @@ Retrieve a stored message by its key
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Mailgun API key |
|
| `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 |
|
| `messageKey` | string | Yes | Message storage key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -102,7 +102,7 @@ List events (logs) for messages sent through Mailgun
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Mailgun API key |
|
| `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.\) |
|
| `event` | string | No | Filter by event type \(accepted, delivered, failed, opened, clicked, etc.\) |
|
||||||
| `limit` | number | No | Maximum number of events to return \(default: 100\) |
|
| `limit` | number | No | Maximum number of events to return \(default: 100\) |
|
||||||
|
|
||||||
@@ -123,7 +123,7 @@ Create a new mailing list
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Mailgun API key |
|
| `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 |
|
| `name` | string | No | Mailing list name |
|
||||||
| `description` | string | No | Mailing list description |
|
| `description` | string | No | Mailing list description |
|
||||||
| `accessLevel` | string | No | Access level: readonly, members, or everyone |
|
| `accessLevel` | string | No | Access level: readonly, members, or everyone |
|
||||||
@@ -145,7 +145,7 @@ Get details of a mailing list
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Mailgun API key |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -163,8 +163,8 @@ Add a member to a mailing list
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Mailgun API key |
|
| `apiKey` | string | Yes | Mailgun API key |
|
||||||
| `listAddress` | string | Yes | Mailing list address |
|
| `listAddress` | string | Yes | Mailing list address \(e.g., list@mg.example.com\) |
|
||||||
| `address` | string | Yes | Member email address |
|
| `address` | string | Yes | Member email address to add \(e.g., user@example.com\) |
|
||||||
| `name` | string | No | Member name |
|
| `name` | string | No | Member name |
|
||||||
| `vars` | string | No | JSON string of custom variables |
|
| `vars` | string | No | JSON string of custom variables |
|
||||||
| `subscribed` | boolean | No | Whether the member is subscribed |
|
| `subscribed` | boolean | No | Whether the member is subscribed |
|
||||||
@@ -204,7 +204,7 @@ Get details of a specific domain
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Mailgun API key |
|
| `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
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -42,8 +42,8 @@ Add memories to Mem0 for persistent storage and retrieval
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `userId` | string | Yes | User ID associated with the memory |
|
| `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 |
|
| `messages` | json | Yes | Array of message objects with role and content \(e.g., \[\{"role": "user", "content": "Hello"\}\]\) |
|
||||||
| `apiKey` | string | Yes | Your Mem0 API key |
|
| `apiKey` | string | Yes | Your Mem0 API key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -52,6 +52,10 @@ Add memories to Mem0 for persistent storage and retrieval
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `ids` | array | Array of memory IDs that were created |
|
| `ids` | array | Array of memory IDs that were created |
|
||||||
| `memories` | array | Array of memory objects 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`
|
### `mem0_search_memories`
|
||||||
|
|
||||||
@@ -61,16 +65,28 @@ Search for memories in Mem0 using semantic search
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `userId` | string | Yes | User ID to search memories for |
|
| `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 |
|
| `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 |
|
| `limit` | number | No | Maximum number of results to return \(e.g., 10, 50, 100\) |
|
||||||
| `apiKey` | string | Yes | Your Mem0 API key |
|
| `apiKey` | string | Yes | Your Mem0 API key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `ids` | array | Array of memory IDs found in the search results |
|
||||||
|
|
||||||
### `mem0_get_memories`
|
### `mem0_get_memories`
|
||||||
@@ -81,11 +97,11 @@ Retrieve memories from Mem0 by ID or filter criteria
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `userId` | string | Yes | User ID to retrieve memories for |
|
| `userId` | string | Yes | User ID to retrieve memories for \(e.g., "user_123", "alice@example.com"\) |
|
||||||
| `memoryId` | string | No | Specific memory ID to retrieve |
|
| `memoryId` | string | No | Specific memory ID to retrieve \(e.g., "mem_abc123"\) |
|
||||||
| `startDate` | string | No | Start date for filtering by created_at \(format: YYYY-MM-DD\) |
|
| `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 \(format: YYYY-MM-DD\) |
|
| `endDate` | string | No | End date for filtering by created_at \(e.g., "2024-12-31"\) |
|
||||||
| `limit` | number | No | Maximum number of results to return |
|
| `limit` | number | No | Maximum number of results to return \(e.g., 10, 50, 100\) |
|
||||||
| `apiKey` | string | Yes | Your Mem0 API key |
|
| `apiKey` | string | Yes | Your Mem0 API key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -93,6 +109,21 @@ Retrieve memories from Mem0 by ID or filter criteria
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `memories` | array | Array of retrieved memory objects |
|
| `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 |
|
| `ids` | array | Array of memory IDs that were retrieved |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -9,6 +9,7 @@
|
|||||||
"arxiv",
|
"arxiv",
|
||||||
"asana",
|
"asana",
|
||||||
"browser_use",
|
"browser_use",
|
||||||
|
"calcom",
|
||||||
"calendly",
|
"calendly",
|
||||||
"circleback",
|
"circleback",
|
||||||
"clay",
|
"clay",
|
||||||
@@ -96,6 +97,7 @@
|
|||||||
"sftp",
|
"sftp",
|
||||||
"sharepoint",
|
"sharepoint",
|
||||||
"shopify",
|
"shopify",
|
||||||
|
"similarweb",
|
||||||
"slack",
|
"slack",
|
||||||
"smtp",
|
"smtp",
|
||||||
"sqs",
|
"sqs",
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ Read data from a specific sheet in a Microsoft Excel spreadsheet
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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. |
|
| `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
|
#### Output
|
||||||
@@ -55,8 +55,8 @@ Read data from a specific sheet in a Microsoft Excel spreadsheet
|
|||||||
| `range` | string | The range that was read |
|
| `range` | string | The range that was read |
|
||||||
| `values` | array | Array of rows containing cell values |
|
| `values` | array | Array of rows containing cell values |
|
||||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||||
| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID |
|
| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID |
|
||||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
||||||
|
|
||||||
### `microsoft_excel_write`
|
### `microsoft_excel_write`
|
||||||
|
|
||||||
@@ -66,9 +66,9 @@ Write data to a specific sheet in a Microsoft Excel spreadsheet
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet to write to |
|
| `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 |
|
| `range` | string | No | The range of cells to write to \(e.g., "Sheet1!A1:B2"\) |
|
||||||
| `values` | array | Yes | The data to write to the spreadsheet |
|
| `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 |
|
| `valueInputOption` | string | No | The format of the data to write |
|
||||||
| `includeValuesInResponse` | boolean | No | Whether to include the written values in the response |
|
| `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 |
|
| `updatedColumns` | number | Number of columns updated |
|
||||||
| `updatedCells` | number | Number of cells updated |
|
| `updatedCells` | number | Number of cells updated |
|
||||||
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
| `metadata` | json | Spreadsheet metadata including ID and URL |
|
||||||
| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID |
|
| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID |
|
||||||
| ↳ `spreadsheetUrl` | string | Spreadsheet URL |
|
| ↳ `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 |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `planId` | string | No | The ID of the plan to get tasks from \(if not provided, gets all user tasks\) |
|
| `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 |
|
| `taskId` | string | No | The ID of the task to get \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| `success` | boolean | Whether tasks were retrieved successfully |
|
||||||
| `tasks` | array | Array of task objects with filtered properties |
|
| `tasks` | array | Array of task objects with filtered properties |
|
||||||
| `metadata` | object | Metadata including planId, userId, and planUrl |
|
| `metadata` | object | Metadata including planId, userId, and planUrl |
|
||||||
| ↳ `planId` | string | Plan ID |
|
| ↳ `planId` | string | Plan ID |
|
||||||
| ↳ `userId` | string | User ID |
|
| ↳ `userId` | string | User ID |
|
||||||
| ↳ `planUrl` | string | Microsoft Graph API URL for the plan |
|
| ↳ `planUrl` | string | Microsoft Graph API URL for the plan |
|
||||||
|
|
||||||
### `microsoft_planner_create_task`
|
### `microsoft_planner_create_task`
|
||||||
|
|
||||||
@@ -62,12 +62,12 @@ Create a new task in Microsoft Planner
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `planId` | string | Yes | The ID of the plan where the task will be created |
|
| `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 |
|
| `title` | string | Yes | The title of the task \(e.g., "Review quarterly report"\) |
|
||||||
| `description` | string | No | The description of the task |
|
| `description` | string | No | The description of the task |
|
||||||
| `dueDateTime` | string | No | The due date and time for the task \(ISO 8601 format\) |
|
| `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 |
|
| `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 |
|
| `bucketId` | string | No | The bucket ID to place the task in \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -76,9 +76,9 @@ Create a new task in Microsoft Planner
|
|||||||
| `success` | boolean | Whether the task was created successfully |
|
| `success` | boolean | Whether the task was created successfully |
|
||||||
| `task` | object | The created task object with all properties |
|
| `task` | object | The created task object with all properties |
|
||||||
| `metadata` | object | Metadata including planId, taskId, and taskUrl |
|
| `metadata` | object | Metadata including planId, taskId, and taskUrl |
|
||||||
| ↳ `planId` | string | Parent plan ID |
|
| ↳ `planId` | string | Parent plan ID |
|
||||||
| ↳ `taskId` | string | Created task ID |
|
| ↳ `taskId` | string | Created task ID |
|
||||||
| ↳ `taskUrl` | string | Microsoft Graph API URL for the task |
|
| ↳ `taskUrl` | string | Microsoft Graph API URL for the task |
|
||||||
|
|
||||||
### `microsoft_planner_update_task`
|
### `microsoft_planner_update_task`
|
||||||
|
|
||||||
@@ -88,15 +88,15 @@ Update a task in Microsoft Planner
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `etag` | string | Yes | The ETag value from the task to update \(If-Match header\) |
|
||||||
| `title` | string | No | The new title of the task |
|
| `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 |
|
| `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 \(ISO 8601 format\) |
|
| `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\) |
|
| `startDateTime` | string | No | The start date and time for the task \(ISO 8601 format\) |
|
||||||
| `percentComplete` | number | No | The percentage of task completion \(0-100\) |
|
| `percentComplete` | number | No | The percentage of task completion \(0-100\) |
|
||||||
| `priority` | number | No | The priority of the task \(0-10\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -108,9 +108,9 @@ Update a task in Microsoft Planner
|
|||||||
| `taskId` | string | ID of the updated task |
|
| `taskId` | string | ID of the updated task |
|
||||||
| `etag` | string | New ETag after update - use this for subsequent operations |
|
| `etag` | string | New ETag after update - use this for subsequent operations |
|
||||||
| `metadata` | object | Metadata including taskId, planId, and taskUrl |
|
| `metadata` | object | Metadata including taskId, planId, and taskUrl |
|
||||||
| ↳ `taskId` | string | Updated task ID |
|
| ↳ `taskId` | string | Updated task ID |
|
||||||
| ↳ `planId` | string | Parent plan ID |
|
| ↳ `planId` | string | Parent plan ID |
|
||||||
| ↳ `taskUrl` | string | Microsoft Graph API URL for the task |
|
| ↳ `taskUrl` | string | Microsoft Graph API URL for the task |
|
||||||
|
|
||||||
### `microsoft_planner_delete_task`
|
### `microsoft_planner_delete_task`
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ Delete a task from Microsoft Planner
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `etag` | string | Yes | The ETag value from the task to delete \(If-Match header\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -147,8 +147,8 @@ List all plans shared with the current user
|
|||||||
| `success` | boolean | Whether plans were retrieved successfully |
|
| `success` | boolean | Whether plans were retrieved successfully |
|
||||||
| `plans` | array | Array of plan objects shared with the current user |
|
| `plans` | array | Array of plan objects shared with the current user |
|
||||||
| `metadata` | object | Metadata including userId and count |
|
| `metadata` | object | Metadata including userId and count |
|
||||||
| ↳ `count` | number | Number of plans returned |
|
| ↳ `count` | number | Number of plans returned |
|
||||||
| ↳ `userId` | string | User ID |
|
| ↳ `userId` | string | User ID |
|
||||||
|
|
||||||
### `microsoft_planner_read_plan`
|
### `microsoft_planner_read_plan`
|
||||||
|
|
||||||
@@ -158,7 +158,7 @@ Get details of a specific Microsoft Planner plan
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
@@ -167,8 +167,8 @@ Get details of a specific Microsoft Planner plan
|
|||||||
| `success` | boolean | Whether the plan was retrieved successfully |
|
| `success` | boolean | Whether the plan was retrieved successfully |
|
||||||
| `plan` | object | The plan object with all properties |
|
| `plan` | object | The plan object with all properties |
|
||||||
| `metadata` | object | Metadata including planId and planUrl |
|
| `metadata` | object | Metadata including planId and planUrl |
|
||||||
| ↳ `planId` | string | Plan ID |
|
| ↳ `planId` | string | Plan ID |
|
||||||
| ↳ `planUrl` | string | Microsoft Graph API URL for the plan |
|
| ↳ `planUrl` | string | Microsoft Graph API URL for the plan |
|
||||||
|
|
||||||
### `microsoft_planner_list_buckets`
|
### `microsoft_planner_list_buckets`
|
||||||
|
|
||||||
@@ -178,7 +178,7 @@ List all buckets in a Microsoft Planner plan
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
@@ -187,8 +187,8 @@ List all buckets in a Microsoft Planner plan
|
|||||||
| `success` | boolean | Whether buckets were retrieved successfully |
|
| `success` | boolean | Whether buckets were retrieved successfully |
|
||||||
| `buckets` | array | Array of bucket objects |
|
| `buckets` | array | Array of bucket objects |
|
||||||
| `metadata` | object | Metadata including planId and count |
|
| `metadata` | object | Metadata including planId and count |
|
||||||
| ↳ `planId` | string | Plan ID |
|
| ↳ `planId` | string | Plan ID |
|
||||||
| ↳ `count` | number | Number of buckets returned |
|
| ↳ `count` | number | Number of buckets returned |
|
||||||
|
|
||||||
### `microsoft_planner_read_bucket`
|
### `microsoft_planner_read_bucket`
|
||||||
|
|
||||||
@@ -198,7 +198,7 @@ Get details of a specific bucket
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
@@ -207,8 +207,8 @@ Get details of a specific bucket
|
|||||||
| `success` | boolean | Whether the bucket was retrieved successfully |
|
| `success` | boolean | Whether the bucket was retrieved successfully |
|
||||||
| `bucket` | object | The bucket object with all properties |
|
| `bucket` | object | The bucket object with all properties |
|
||||||
| `metadata` | object | Metadata including bucketId and planId |
|
| `metadata` | object | Metadata including bucketId and planId |
|
||||||
| ↳ `bucketId` | string | Bucket ID |
|
| ↳ `bucketId` | string | Bucket ID |
|
||||||
| ↳ `planId` | string | Parent plan ID |
|
| ↳ `planId` | string | Parent plan ID |
|
||||||
|
|
||||||
### `microsoft_planner_create_bucket`
|
### `microsoft_planner_create_bucket`
|
||||||
|
|
||||||
@@ -218,7 +218,7 @@ Create a new bucket in a Microsoft Planner plan
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `name` | string | Yes | The name of the bucket |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -228,8 +228,8 @@ Create a new bucket in a Microsoft Planner plan
|
|||||||
| `success` | boolean | Whether the bucket was created successfully |
|
| `success` | boolean | Whether the bucket was created successfully |
|
||||||
| `bucket` | object | The created bucket object with all properties |
|
| `bucket` | object | The created bucket object with all properties |
|
||||||
| `metadata` | object | Metadata including bucketId and planId |
|
| `metadata` | object | Metadata including bucketId and planId |
|
||||||
| ↳ `bucketId` | string | Created bucket ID |
|
| ↳ `bucketId` | string | Created bucket ID |
|
||||||
| ↳ `planId` | string | Parent plan ID |
|
| ↳ `planId` | string | Parent plan ID |
|
||||||
|
|
||||||
### `microsoft_planner_update_bucket`
|
### `microsoft_planner_update_bucket`
|
||||||
|
|
||||||
@@ -239,7 +239,7 @@ Update a bucket in Microsoft Planner
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `name` | string | No | The new name of the bucket |
|
||||||
| `etag` | string | Yes | The ETag value from the bucket to update \(If-Match header\) |
|
| `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 |
|
| `success` | boolean | Whether the bucket was updated successfully |
|
||||||
| `bucket` | object | The updated bucket object with all properties |
|
| `bucket` | object | The updated bucket object with all properties |
|
||||||
| `metadata` | object | Metadata including bucketId and planId |
|
| `metadata` | object | Metadata including bucketId and planId |
|
||||||
| ↳ `bucketId` | string | Updated bucket ID |
|
| ↳ `bucketId` | string | Updated bucket ID |
|
||||||
| ↳ `planId` | string | Parent plan ID |
|
| ↳ `planId` | string | Parent plan ID |
|
||||||
|
|
||||||
### `microsoft_planner_delete_bucket`
|
### `microsoft_planner_delete_bucket`
|
||||||
|
|
||||||
@@ -261,7 +261,7 @@ Delete a bucket from Microsoft Planner
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `etag` | string | Yes | The ETag value from the bucket to delete \(If-Match header\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -280,7 +280,7 @@ Get detailed information about a task including checklist and references
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `taskId` | string | Yes | The ID of the task |
|
| `taskId` | string | Yes | The ID of the task \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| `taskDetails` | object | The task details including description, checklist, and references |
|
||||||
| `etag` | string | The ETag value for this task details - use this for update operations |
|
| `etag` | string | The ETag value for this task details - use this for update operations |
|
||||||
| `metadata` | object | Metadata including taskId |
|
| `metadata` | object | Metadata including taskId |
|
||||||
| ↳ `taskId` | string | Task ID |
|
| ↳ `taskId` | string | Task ID |
|
||||||
|
|
||||||
### `microsoft_planner_update_task_details`
|
### `microsoft_planner_update_task_details`
|
||||||
|
|
||||||
@@ -300,7 +300,7 @@ Update task details including description, checklist items, and references in Mi
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `etag` | string | Yes | The ETag value from the task details to update \(If-Match header\) |
|
||||||
| `description` | string | No | The description of the task |
|
| `description` | string | No | The description of the task |
|
||||||
| `checklist` | object | No | Checklist items as a JSON object |
|
| `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 |
|
| `success` | boolean | Whether the task details were updated successfully |
|
||||||
| `taskDetails` | object | The updated task details object with all properties |
|
| `taskDetails` | object | The updated task details object with all properties |
|
||||||
| `metadata` | object | Metadata including taskId |
|
| `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 |
|
| 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 |
|
| `includeAttachments` | boolean | No | Download and include message attachments \(hosted contents\) into storage |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -67,8 +67,8 @@ Write or update content in a Microsoft Teams chat
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `chatId` | string | Yes | The ID of the chat to write to |
|
| `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 |
|
| `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 |
|
| `files` | file[] | No | Files to attach to the message |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -90,8 +90,8 @@ Read content from a Microsoft Teams channel
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `teamId` | string | Yes | The ID of the team 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 |
|
| `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 |
|
| `includeAttachments` | boolean | No | Download and include message attachments \(hosted contents\) into storage |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -116,9 +116,9 @@ Write or send a message to a Microsoft Teams channel
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `teamId` | string | Yes | The ID of the team to write to |
|
| `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 |
|
| `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 |
|
| `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 |
|
| `files` | file[] | No | Files to attach to the message |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -141,9 +141,9 @@ Update an existing message in a Microsoft Teams chat
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `chatId` | string | Yes | The ID of the chat containing 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 |
|
| `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 |
|
| `content` | string | Yes | The new content for the message \(plain text or HTML formatted\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -161,10 +161,10 @@ Update an existing message in a Microsoft Teams channel
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 or channel info\) |
|
||||||
| `channelId` | string | Yes | The ID of the channel containing the message |
|
| `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 |
|
| `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 |
|
| `content` | string | Yes | The new content for the message \(plain text or HTML formatted\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -182,8 +182,8 @@ Soft delete a message in a Microsoft Teams chat
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `chatId` | string | Yes | The ID of the chat containing 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 delete |
|
| `messageId` | string | Yes | The ID of the message to delete \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -201,9 +201,9 @@ Soft delete a message in a Microsoft Teams channel
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 or channel info\) |
|
||||||
| `channelId` | string | Yes | The ID of the channel containing the message |
|
| `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 |
|
| `messageId` | string | Yes | The ID of the message to delete \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -221,10 +221,10 @@ Reply to an existing message in a Microsoft Teams channel
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 or channel info\) |
|
||||||
| `channelId` | string | Yes | The ID of the channel |
|
| `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 |
|
| `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 |
|
| `content` | string | Yes | The reply content \(plain text or HTML formatted message\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -242,10 +242,10 @@ Get a specific message from a Microsoft Teams chat or channel
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `teamId` | string | No | The ID of the team \(for channel messages\) |
|
| `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\) |
|
| `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\) |
|
| `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 |
|
| `messageId` | string | Yes | The ID of the message to retrieve \(e.g., "1234567890123" - a numeric string from message responses\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -254,15 +254,15 @@ Get a specific message from a Microsoft Teams chat or channel
|
|||||||
| `success` | boolean | Whether the retrieval was successful |
|
| `success` | boolean | Whether the retrieval was successful |
|
||||||
| `content` | string | The message content |
|
| `content` | string | The message content |
|
||||||
| `metadata` | object | Message metadata including sender, timestamp, etc. |
|
| `metadata` | object | Message metadata including sender, timestamp, etc. |
|
||||||
| ↳ `messageId` | string | Message ID |
|
| ↳ `messageId` | string | Message ID |
|
||||||
| ↳ `content` | string | Message content |
|
| ↳ `content` | string | Message content |
|
||||||
| ↳ `createdTime` | string | Message creation timestamp |
|
| ↳ `createdTime` | string | Message creation timestamp |
|
||||||
| ↳ `url` | string | Web URL to the message |
|
| ↳ `url` | string | Web URL to the message |
|
||||||
| ↳ `teamId` | string | Team ID |
|
| ↳ `teamId` | string | Team ID |
|
||||||
| ↳ `channelId` | string | Channel ID |
|
| ↳ `channelId` | string | Channel ID |
|
||||||
| ↳ `chatId` | string | Chat ID |
|
| ↳ `chatId` | string | Chat ID |
|
||||||
| ↳ `messages` | array | Array of message details |
|
| ↳ `messages` | array | Array of message details |
|
||||||
| ↳ `messageCount` | number | Number of messages |
|
| ↳ `messageCount` | number | Number of messages |
|
||||||
|
|
||||||
### `microsoft_teams_set_reaction`
|
### `microsoft_teams_set_reaction`
|
||||||
|
|
||||||
@@ -272,10 +272,10 @@ Add an emoji reaction to a message in Microsoft Teams
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `teamId` | string | No | The ID of the team \(for channel messages\) |
|
| `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\) |
|
| `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\) |
|
| `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 |
|
| `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., ❤️, 👍, 😊\) |
|
| `reactionType` | string | Yes | The emoji reaction \(e.g., ❤️, 👍, 😊\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -294,10 +294,10 @@ Remove an emoji reaction from a message in Microsoft Teams
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `teamId` | string | No | The ID of the team \(for channel messages\) |
|
| `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\) |
|
| `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\) |
|
| `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 |
|
| `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., ❤️, 👍, 😊\) |
|
| `reactionType` | string | Yes | The emoji reaction to remove \(e.g., ❤️, 👍, 😊\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -316,7 +316,7 @@ List all members of a Microsoft Teams team
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
@@ -334,8 +334,8 @@ List all members of a Microsoft Teams channel
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
||||||
| `channelId` | string | Yes | The ID of the channel |
|
| `channelId` | string | Yes | The ID of the channel \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -58,24 +58,24 @@ Parse PDF documents using Mistral OCR API
|
|||||||
| ↳ `index` | number | Page index \(zero-based\) |
|
| ↳ `index` | number | Page index \(zero-based\) |
|
||||||
| ↳ `markdown` | string | Extracted markdown content |
|
| ↳ `markdown` | string | Extracted markdown content |
|
||||||
| ↳ `images` | array | Images extracted from this page with bounding boxes |
|
| ↳ `images` | array | Images extracted from this page with bounding boxes |
|
||||||
| ↳ `id` | string | Image identifier \(e.g., img-0.jpeg\) |
|
| ↳ `id` | string | Image identifier \(e.g., img-0.jpeg\) |
|
||||||
| ↳ `top_left_x` | number | Top-left X coordinate in pixels |
|
| ↳ `top_left_x` | number | Top-left X coordinate in pixels |
|
||||||
| ↳ `top_left_y` | number | Top-left Y 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_x` | number | Bottom-right X coordinate in pixels |
|
||||||
| ↳ `bottom_right_y` | number | Bottom-right Y 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\) |
|
| ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) |
|
||||||
| ↳ `dimensions` | object | Page dimensions |
|
| ↳ `dimensions` | object | Page dimensions |
|
||||||
| ↳ `dpi` | number | Dots per inch |
|
| ↳ `dpi` | number | Dots per inch |
|
||||||
| ↳ `height` | number | Page height in pixels |
|
| ↳ `height` | number | Page height in pixels |
|
||||||
| ↳ `width` | number | Page width 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\] |
|
| ↳ `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\) |
|
| ↳ `header` | string | Page header content \(when extract_header=true\) |
|
||||||
| ↳ `footer` | string | Page footer content \(when extract_footer=true\) |
|
| ↳ `footer` | string | Page footer content \(when extract_footer=true\) |
|
||||||
| `model` | string | Mistral OCR model identifier \(e.g., mistral-ocr-latest\) |
|
| `model` | string | Mistral OCR model identifier \(e.g., mistral-ocr-latest\) |
|
||||||
| `usage_info` | object | Usage and processing statistics |
|
| `usage_info` | object | Usage and processing statistics |
|
||||||
| ↳ `pages_processed` | number | Total number of pages processed |
|
| ↳ `pages_processed` | number | Total number of pages processed |
|
||||||
| ↳ `doc_size_bytes` | number | Document file size in bytes |
|
| ↳ `doc_size_bytes` | number | Document file size in bytes |
|
||||||
| `document_annotation` | string | Structured annotation data as JSON string \(when applicable\) |
|
| `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 |
|
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
| `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 |
|
| `username` | string | No | MongoDB username |
|
||||||
| `password` | string | No | MongoDB password |
|
| `password` | string | No | MongoDB password |
|
||||||
| `authSource` | string | No | Authentication database |
|
| `authSource` | string | No | Authentication database |
|
||||||
@@ -71,7 +71,7 @@ Insert documents into MongoDB collection
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `host` | string | Yes | MongoDB server hostname or IP address |
|
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
| `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 |
|
| `username` | string | No | MongoDB username |
|
||||||
| `password` | string | No | MongoDB password |
|
| `password` | string | No | MongoDB password |
|
||||||
| `authSource` | string | No | Authentication database |
|
| `authSource` | string | No | Authentication database |
|
||||||
@@ -98,7 +98,7 @@ Update documents in MongoDB collection
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `host` | string | Yes | MongoDB server hostname or IP address |
|
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
| `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 |
|
| `username` | string | No | MongoDB username |
|
||||||
| `password` | string | No | MongoDB password |
|
| `password` | string | No | MongoDB password |
|
||||||
| `authSource` | string | No | Authentication database |
|
| `authSource` | string | No | Authentication database |
|
||||||
@@ -129,7 +129,7 @@ Delete documents from MongoDB collection
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `host` | string | Yes | MongoDB server hostname or IP address |
|
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
| `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 |
|
| `username` | string | No | MongoDB username |
|
||||||
| `password` | string | No | MongoDB password |
|
| `password` | string | No | MongoDB password |
|
||||||
| `authSource` | string | No | Authentication database |
|
| `authSource` | string | No | Authentication database |
|
||||||
@@ -156,7 +156,7 @@ Execute MongoDB aggregation pipeline
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `host` | string | Yes | MongoDB server hostname or IP address |
|
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
| `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 |
|
| `username` | string | No | MongoDB username |
|
||||||
| `password` | string | No | MongoDB password |
|
| `password` | string | No | MongoDB password |
|
||||||
| `authSource` | string | No | Authentication database |
|
| `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 |
|
| `host` | string | Yes | MongoDB server hostname or IP address |
|
||||||
| `port` | number | Yes | MongoDB server port \(default: 27017\) |
|
| `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 |
|
| `username` | string | No | MongoDB username |
|
||||||
| `password` | string | No | MongoDB password |
|
| `password` | string | No | MongoDB password |
|
||||||
| `authSource` | string | No | Authentication database |
|
| `authSource` | string | No | Authentication database |
|
||||||
|
|||||||
@@ -43,11 +43,11 @@ Execute SELECT query on MySQL database
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `host` | string | Yes | MySQL server hostname or IP address |
|
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
| `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 |
|
| `username` | string | Yes | Database username |
|
||||||
| `password` | string | Yes | Database password |
|
| `password` | string | Yes | Database password |
|
||||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
| `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
|
#### Output
|
||||||
|
|
||||||
@@ -67,11 +67,11 @@ Insert new record into MySQL database
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `host` | string | Yes | MySQL server hostname or IP address |
|
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
| `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 |
|
| `username` | string | Yes | Database username |
|
||||||
| `password` | string | Yes | Database password |
|
| `password` | string | Yes | Database password |
|
||||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
| `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 |
|
| `data` | object | Yes | Data to insert as key-value pairs |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -92,11 +92,11 @@ Update existing records in MySQL database
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `host` | string | Yes | MySQL server hostname or IP address |
|
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
| `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 |
|
| `username` | string | Yes | Database username |
|
||||||
| `password` | string | Yes | Database password |
|
| `password` | string | Yes | Database password |
|
||||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
| `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 |
|
| `data` | object | Yes | Data to update as key-value pairs |
|
||||||
| `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) |
|
| `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 |
|
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
| `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 |
|
| `username` | string | Yes | Database username |
|
||||||
| `password` | string | Yes | Database password |
|
| `password` | string | Yes | Database password |
|
||||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
| `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\) |
|
| `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -143,11 +143,11 @@ Execute raw SQL query on MySQL database
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `host` | string | Yes | MySQL server hostname or IP address |
|
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
| `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 |
|
| `username` | string | Yes | Database username |
|
||||||
| `password` | string | Yes | Database password |
|
| `password` | string | Yes | Database password |
|
||||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
| `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
|
#### 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 |
|
| `host` | string | Yes | MySQL server hostname or IP address |
|
||||||
| `port` | number | Yes | MySQL server port \(default: 3306\) |
|
| `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 |
|
| `username` | string | Yes | Database username |
|
||||||
| `password` | string | Yes | Database password |
|
| `password` | string | Yes | Database password |
|
||||||
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
|
| `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 |
|
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
| `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 |
|
| `username` | string | Yes | Neo4j username |
|
||||||
| `password` | string | Yes | Neo4j password |
|
| `password` | string | Yes | Neo4j password |
|
||||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
| `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` | 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 |
|
| `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 |
|
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
| `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 |
|
| `username` | string | Yes | Neo4j username |
|
||||||
| `password` | string | Yes | Neo4j password |
|
| `password` | string | Yes | Neo4j password |
|
||||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||||
| `cypherQuery` | string | Yes | Cypher CREATE statement to execute |
|
| `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 |
|
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "age": 30\}\) |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
| `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 |
|
| `username` | string | Yes | Neo4j username |
|
||||||
| `password` | string | Yes | Neo4j password |
|
| `password` | string | Yes | Neo4j password |
|
||||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||||
| `cypherQuery` | string | Yes | Cypher MERGE statement to execute |
|
| `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 |
|
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "email": "alice@example.com"\}\) |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
| `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 |
|
| `username` | string | Yes | Neo4j username |
|
||||||
| `password` | string | Yes | Neo4j password |
|
| `password` | string | Yes | Neo4j password |
|
||||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||||
| `cypherQuery` | string | Yes | Cypher query with MATCH and SET statements to update properties |
|
| `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 |
|
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "age": 31, "props": \{"city": "NYC"\}\}\) |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
| `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 |
|
| `username` | string | Yes | Neo4j username |
|
||||||
| `password` | string | Yes | Neo4j password |
|
| `password` | string | Yes | Neo4j password |
|
||||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||||
| `cypherQuery` | string | Yes | Cypher query with MATCH and DELETE/DETACH DELETE statements |
|
| `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 |
|
| `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 |
|
| `detach` | boolean | No | Whether to use DETACH DELETE to remove relationships before deleting nodes |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
| `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 |
|
| `username` | string | Yes | Neo4j username |
|
||||||
| `password` | string | Yes | Neo4j password |
|
| `password` | string | Yes | Neo4j password |
|
||||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||||
| `cypherQuery` | string | Yes | Cypher query to execute \(any valid Cypher statement\) |
|
| `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 |
|
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "limit": 100\}\) |
|
||||||
|
|
||||||
#### Output
|
#### 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 |
|
| `host` | string | Yes | Neo4j server hostname or IP address |
|
||||||
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
|
| `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 |
|
| `username` | string | Yes | Neo4j username |
|
||||||
| `password` | string | Yes | Neo4j password |
|
| `password` | string | Yes | Neo4j password |
|
||||||
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
|
||||||
|
|||||||
@@ -26,17 +26,17 @@ Read content from a Notion page
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| 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 |
|
| `content` | string | Page content in markdown format |
|
||||||
| `title` | string | Page title |
|
| `title` | string | Page title |
|
||||||
| `url` | string | Page URL |
|
|
||||||
| `created_time` | string | Creation timestamp |
|
|
||||||
| `last_edited_time` | string | Last edit timestamp |
|
|
||||||
|
|
||||||
### `notion_read_database`
|
### `notion_read_database`
|
||||||
|
|
||||||
@@ -46,18 +46,18 @@ Read database information and structure from Notion
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `id` | string | Database ID |
|
| `id` | string | Database UUID |
|
||||||
| `title` | string | Database title |
|
| `url` | string | Notion database URL |
|
||||||
| `url` | string | Database URL |
|
| `created_time` | string | ISO 8601 creation timestamp |
|
||||||
| `created_time` | string | Creation timestamp |
|
| `last_edited_time` | string | ISO 8601 last edit timestamp |
|
||||||
| `last_edited_time` | string | Last edit timestamp |
|
|
||||||
| `properties` | object | Database properties schema |
|
| `properties` | object | Database properties schema |
|
||||||
|
| `title` | string | Database title |
|
||||||
|
|
||||||
### `notion_write`
|
### `notion_write`
|
||||||
|
|
||||||
@@ -67,7 +67,7 @@ Append content to a Notion page
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `content` | string | Yes | The content to append to the page |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -84,7 +84,7 @@ Create a new page in Notion
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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 |
|
| `title` | string | No | Title of the new page |
|
||||||
| `content` | string | No | Optional content to add to the page upon creation |
|
| `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 |
|
| 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 |
|
| `title` | string | Page title |
|
||||||
| `url` | string | Page URL |
|
|
||||||
| `created_time` | string | Creation timestamp |
|
|
||||||
| `last_edited_time` | string | Last edit timestamp |
|
|
||||||
|
|
||||||
### `notion_query_database`
|
### `notion_query_database`
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ Query and filter Notion database entries with advanced filtering
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `filter` | string | No | Filter conditions as JSON \(optional\) |
|
||||||
| `sorts` | string | No | Sort criteria as JSON array \(optional\) |
|
| `sorts` | string | No | Sort criteria as JSON array \(optional\) |
|
||||||
| `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) |
|
| `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 |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `results` | array | Array of Notion page objects from the database |
|
| `results` | array | Array of page objects from the database |
|
||||||
| ↳ `id` | string | Page ID |
|
| ↳ `object` | string | Always "page" |
|
||||||
| ↳ `created_time` | string | Creation timestamp |
|
| ↳ `id` | string | Page UUID |
|
||||||
| ↳ `last_edited_time` | string | Last edit timestamp |
|
| ↳ `created_time` | string | ISO 8601 creation timestamp |
|
||||||
| ↳ `url` | string | Page URL |
|
| ↳ `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 |
|
| `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 |
|
| `total_results` | number | Number of results returned |
|
||||||
|
|
||||||
### `notion_search`
|
### `notion_search`
|
||||||
@@ -132,22 +162,39 @@ Search across all pages and databases in Notion workspace
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | No | Search terms \(leave empty to get all pages\) |
|
| `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 |
|
| `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\) |
|
| `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `results` | array | Array of search results \(pages and databases\) |
|
| `results` | array | Array of search results \(pages and/or databases\) |
|
||||||
| ↳ `id` | string | Object ID |
|
| ↳ `object` | string | Object type: "page" or "database" |
|
||||||
| ↳ `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 |
|
| ↳ `url` | string | Object URL |
|
||||||
| ↳ `created_time` | string | Creation timestamp |
|
| ↳ `public_url` | string | Public web URL if shared |
|
||||||
| ↳ `last_edited_time` | string | Last edit timestamp |
|
| ↳ `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 |
|
| `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 |
|
| `total_results` | number | Number of results returned |
|
||||||
|
|
||||||
### `notion_create_database`
|
### `notion_create_database`
|
||||||
@@ -166,11 +213,11 @@ Create a new database in Notion with custom properties
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `id` | string | Database ID |
|
| `id` | string | Database UUID |
|
||||||
| `title` | string | Database title |
|
| `url` | string | Notion database URL |
|
||||||
| `url` | string | Database URL |
|
| `created_time` | string | ISO 8601 creation timestamp |
|
||||||
| `created_time` | string | Creation timestamp |
|
|
||||||
| `properties` | object | Database properties schema |
|
| `properties` | object | Database properties schema |
|
||||||
|
| `title` | string | Database title |
|
||||||
|
|
||||||
### `notion_add_database_row`
|
### `notion_add_database_row`
|
||||||
|
|
||||||
@@ -187,10 +234,10 @@ Add a new row to a Notion database with specified properties
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `id` | string | Page/row ID |
|
| `id` | string | Page UUID |
|
||||||
| `url` | string | Page/row URL |
|
| `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 |
|
| `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 |
|
| 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\) |
|
| `file` | file | No | The file to upload \(binary\) |
|
||||||
| `content` | string | No | The text content to upload \(if no file is provided\) |
|
| `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\) |
|
| `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\) |
|
| `manualFolderId` | string | No | Manually entered folder ID \(advanced mode\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -66,8 +66,8 @@ Create a new folder in OneDrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `folderName` | string | Yes | Name of the folder to create |
|
| `folderName` | string | Yes | Name of the folder to create \(e.g., "My Documents", "Project Files"\) |
|
||||||
| `folderSelector` | string | No | Select the parent folder to create the folder in |
|
| `folderSelector` | string | No | Parent folder ID to create the folder in \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||||||
| `manualFolderId` | string | No | Manually entered parent folder ID \(advanced mode\) |
|
| `manualFolderId` | string | No | Manually entered parent folder ID \(advanced mode\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -85,8 +85,8 @@ Download a file from OneDrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `fileId` | string | Yes | The ID of the file to download |
|
| `fileId` | string | Yes | The ID of the file to download \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||||||
| `fileName` | string | No | Optional filename override |
|
| `fileName` | string | No | Optional filename override \(e.g., "report.pdf", "data.xlsx"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -102,10 +102,10 @@ List files and folders in OneDrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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\) |
|
| `manualFolderId` | string | No | The manually entered folder ID \(advanced mode\) |
|
||||||
| `query` | string | No | A query to filter the files |
|
| `query` | string | No | Filter files by name prefix \(e.g., "report", "invoice_2024"\) |
|
||||||
| `pageSize` | number | No | The number of files to return |
|
| `pageSize` | number | No | Maximum number of files to return \(e.g., 10, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -123,7 +123,7 @@ Delete a file or folder from OneDrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| 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
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -54,10 +54,10 @@ Generate embeddings from text using OpenAI
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Embeddings generation results |
|
| `output` | object | Embeddings generation results |
|
||||||
| ↳ `embeddings` | array | Array of embedding vectors |
|
| ↳ `embeddings` | array | Array of embedding vectors |
|
||||||
| ↳ `model` | string | Model used for generating embeddings |
|
| ↳ `model` | string | Model used for generating embeddings |
|
||||||
| ↳ `usage` | object | Token usage information |
|
| ↳ `usage` | object | Token usage information |
|
||||||
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
||||||
| ↳ `total_tokens` | number | Total number of tokens used |
|
| ↳ `total_tokens` | number | Total number of tokens used |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ Send emails using Outlook
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `to` | string | Yes | Recipient email address |
|
| `to` | string | Yes | Recipient email address \(comma-separated for multiple recipients\) |
|
||||||
| `subject` | string | Yes | Email subject |
|
| `subject` | string | Yes | Email subject |
|
||||||
| `body` | string | Yes | Email body content |
|
| `body` | string | Yes | Email body content |
|
||||||
| `contentType` | string | No | Content type for the email body \(text or html\) |
|
| `contentType` | string | No | Content type for the email body \(text or html\) |
|
||||||
@@ -105,9 +105,9 @@ Read emails from Outlook
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `folder` | string | No | Folder ID to read emails from \(default: Inbox\) |
|
| `folder` | string | No | Folder ID to read emails from \(e.g., "Inbox", "Drafts", or a folder ID\) |
|
||||||
| `maxResults` | number | No | Maximum number of emails to retrieve \(default: 1, max: 10\) |
|
| `maxResults` | number | No | Maximum number of emails to retrieve \(default: 1, max: 10\) |
|
||||||
| `includeAttachments` | boolean | No | Download and include email attachments |
|
| `includeAttachments` | boolean | No | Whether to download and include email attachments |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -115,6 +115,29 @@ Read emails from Outlook
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or status message |
|
| `message` | string | Success or status message |
|
||||||
| `results` | array | Array of email message objects |
|
| `results` | array | Array of email message objects |
|
||||||
|
| ↳ `id` | string | Unique message identifier |
|
||||||
|
| ↳ `subject` | string | Email subject |
|
||||||
|
| ↳ `bodyPreview` | string | Preview of the message body |
|
||||||
|
| ↳ `body` | object | Message body |
|
||||||
|
| ↳ `contentType` | string | Body content type \(text or html\) |
|
||||||
|
| ↳ `content` | string | Body content |
|
||||||
|
| ↳ `sender` | object | Sender information |
|
||||||
|
| ↳ `name` | string | Display name of the person or entity |
|
||||||
|
| ↳ `address` | string | Email address |
|
||||||
|
| ↳ `from` | object | From address information |
|
||||||
|
| ↳ `name` | string | Display name of the person or entity |
|
||||||
|
| ↳ `address` | string | Email address |
|
||||||
|
| ↳ `toRecipients` | array | To recipients |
|
||||||
|
| ↳ `name` | string | Display name of the person or entity |
|
||||||
|
| ↳ `address` | string | Email address |
|
||||||
|
| ↳ `ccRecipients` | array | CC recipients |
|
||||||
|
| ↳ `name` | string | Display name of the person or entity |
|
||||||
|
| ↳ `address` | string | Email address |
|
||||||
|
| ↳ `receivedDateTime` | string | When the message was received \(ISO 8601\) |
|
||||||
|
| ↳ `sentDateTime` | string | When the message was sent \(ISO 8601\) |
|
||||||
|
| ↳ `hasAttachments` | boolean | Whether the message has attachments |
|
||||||
|
| ↳ `isRead` | boolean | Whether the message has been read |
|
||||||
|
| ↳ `importance` | string | Message importance \(low, normal, high\) |
|
||||||
| `attachments` | file[] | All email attachments flattened from all emails |
|
| `attachments` | file[] | All email attachments flattened from all emails |
|
||||||
|
|
||||||
### `outlook_forward`
|
### `outlook_forward`
|
||||||
@@ -135,12 +158,12 @@ Forward an existing Outlook message to specified recipients
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `results` | object | Delivery result details |
|
| `results` | object | Delivery result details |
|
||||||
| ↳ `status` | string | Delivery status of the email |
|
| ↳ `status` | string | Delivery status of the email |
|
||||||
| ↳ `timestamp` | string | Timestamp when email was forwarded |
|
| ↳ `timestamp` | string | Timestamp when email was forwarded |
|
||||||
| ↳ `httpStatus` | number | HTTP status code returned by the API |
|
| ↳ `httpStatus` | number | HTTP status code returned by the API |
|
||||||
| ↳ `requestId` | string | Microsoft Graph request-id header for tracing |
|
| ↳ `requestId` | string | Microsoft Graph request-id header for tracing |
|
||||||
| ↳ `messageId` | string | Forwarded message ID if provided by API |
|
| ↳ `messageId` | string | Forwarded message ID if provided by API |
|
||||||
| ↳ `internetMessageId` | string | RFC 822 Message-ID if provided |
|
| ↳ `internetMessageId` | string | RFC 822 Message-ID if provided |
|
||||||
|
|
||||||
### `outlook_move`
|
### `outlook_move`
|
||||||
|
|
||||||
|
|||||||
@@ -109,9 +109,9 @@ Conduct comprehensive deep research across the web using Parallel AI. Synthesize
|
|||||||
| ↳ `field` | string | Output field name |
|
| ↳ `field` | string | Output field name |
|
||||||
| ↳ `reasoning` | string | Explanation for the result |
|
| ↳ `reasoning` | string | Explanation for the result |
|
||||||
| ↳ `citations` | array | Array of sources |
|
| ↳ `citations` | array | Array of sources |
|
||||||
| ↳ `url` | string | Source URL |
|
| ↳ `url` | string | Source URL |
|
||||||
| ↳ `title` | string | Source title |
|
| ↳ `title` | string | Source title |
|
||||||
| ↳ `excerpts` | array | Relevant excerpts from the source |
|
| ↳ `excerpts` | array | Relevant excerpts from the source |
|
||||||
| ↳ `confidence` | string | Confidence level indicator |
|
| ↳ `confidence` | string | Confidence level indicator |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -45,9 +45,9 @@ Generate completions using Perplexity AI chat models
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `systemPrompt` | string | No | System prompt to guide the model behavior |
|
| `systemPrompt` | string | No | System prompt to guide the model behavior |
|
||||||
| `content` | string | Yes | The user message content to send to the model |
|
| `content` | string | Yes | The user message content to send to the model |
|
||||||
| `model` | string | Yes | Model to use for chat completions \(e.g., sonar, mistral\) |
|
| `model` | string | Yes | Model to use for chat completions \(e.g., "sonar", "sonar-pro", "sonar-reasoning"\) |
|
||||||
| `max_tokens` | number | No | Maximum number of tokens to generate |
|
| `max_tokens` | number | No | Maximum number of tokens to generate \(e.g., 1024, 2048, 4096\) |
|
||||||
| `temperature` | number | No | Sampling temperature between 0 and 1 |
|
| `temperature` | number | No | Sampling temperature between 0 and 1 \(e.g., 0.0 for deterministic, 0.7 for creative\) |
|
||||||
| `apiKey` | string | Yes | Perplexity API key |
|
| `apiKey` | string | Yes | Perplexity API key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -57,9 +57,9 @@ Generate completions using Perplexity AI chat models
|
|||||||
| `content` | string | Generated text content |
|
| `content` | string | Generated text content |
|
||||||
| `model` | string | Model used for generation |
|
| `model` | string | Model used for generation |
|
||||||
| `usage` | object | Token usage information |
|
| `usage` | object | Token usage information |
|
||||||
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
|
||||||
| ↳ `completion_tokens` | number | Number of tokens in the completion |
|
| ↳ `completion_tokens` | number | Number of tokens in the completion |
|
||||||
| ↳ `total_tokens` | number | Total number of tokens used |
|
| ↳ `total_tokens` | number | Total number of tokens used |
|
||||||
|
|
||||||
### `perplexity_search`
|
### `perplexity_search`
|
||||||
|
|
||||||
@@ -71,10 +71,10 @@ Get ranked search results from Perplexity
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | Yes | A search query or array of queries \(max 5 for multi-query search\) |
|
| `query` | string | Yes | A search query or array of queries \(max 5 for multi-query search\) |
|
||||||
| `max_results` | number | No | Maximum number of search results to return \(1-20, default: 10\) |
|
| `max_results` | number | No | Maximum number of search results to return \(1-20, default: 10\) |
|
||||||
| `search_domain_filter` | array | No | List of domains/URLs to limit search results to \(max 20\) |
|
| `search_domain_filter` | array | No | List of domains/URLs to limit search results to \(e.g., \["github.com", "stackoverflow.com"\], max 20\) |
|
||||||
| `max_tokens_per_page` | number | No | Maximum number of tokens retrieved from each webpage \(default: 1024\) |
|
| `max_tokens_per_page` | number | No | Maximum number of tokens retrieved from each webpage \(default: 1024\) |
|
||||||
| `country` | string | No | Country code to filter search results \(e.g., US, GB, DE\) |
|
| `country` | string | No | Country code to filter search results \(e.g., US, GB, DE\) |
|
||||||
| `search_recency_filter` | string | No | Filter results by recency: hour, day, week, month, or year |
|
| `search_recency_filter` | string | No | Filter results by recency \(e.g., "hour", "day", "week", "month", "year"\) |
|
||||||
| `search_after_date` | string | No | Include only content published after this date \(format: MM/DD/YYYY\) |
|
| `search_after_date` | string | No | Include only content published after this date \(format: MM/DD/YYYY\) |
|
||||||
| `search_before_date` | string | No | Include only content published before this date \(format: MM/DD/YYYY\) |
|
| `search_before_date` | string | No | Include only content published before this date \(format: MM/DD/YYYY\) |
|
||||||
| `apiKey` | string | Yes | Perplexity API key |
|
| `apiKey` | string | Yes | Perplexity API key |
|
||||||
@@ -87,7 +87,7 @@ Get ranked search results from Perplexity
|
|||||||
| ↳ `title` | string | Title of the search result |
|
| ↳ `title` | string | Title of the search result |
|
||||||
| ↳ `url` | string | URL of the search result |
|
| ↳ `url` | string | URL of the search result |
|
||||||
| ↳ `snippet` | string | Brief excerpt or summary of the content |
|
| ↳ `snippet` | string | Brief excerpt or summary of the content |
|
||||||
| ↳ `date` | string | Date the page was crawled and added to Perplexity |
|
| ↳ `date` | string | Date the page was crawled and added to Perplexity's index |
|
||||||
| ↳ `last_updated` | string | Date the page was last updated in Perplexity |
|
| ↳ `last_updated` | string | Date the page was last updated in Perplexity's index |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -64,8 +64,8 @@ Insert or update text records in a Pinecone index
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `indexHost` | string | Yes | Full Pinecone index host URL |
|
| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) |
|
||||||
| `namespace` | string | Yes | Namespace to upsert records into |
|
| `namespace` | string | Yes | Namespace to upsert records into \(e.g., "documents", "embeddings"\) |
|
||||||
| `records` | array | Yes | Record or array of records to upsert, each containing _id, text, and optional metadata |
|
| `records` | array | Yes | Record or array of records to upsert, each containing _id, text, and optional metadata |
|
||||||
| `apiKey` | string | Yes | Pinecone API key |
|
| `apiKey` | string | Yes | Pinecone API key |
|
||||||
|
|
||||||
@@ -83,12 +83,12 @@ Search for similar text in a Pinecone index
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `indexHost` | string | Yes | Full Pinecone index host URL |
|
| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) |
|
||||||
| `namespace` | string | No | Namespace to search in |
|
| `namespace` | string | No | Namespace to search in \(e.g., "documents", "embeddings"\) |
|
||||||
| `searchQuery` | string | Yes | Text to search for |
|
| `searchQuery` | string | Yes | Text to search for |
|
||||||
| `topK` | string | No | Number of results to return |
|
| `topK` | string | No | Number of results to return \(e.g., "10", "25"\) |
|
||||||
| `fields` | array | No | Fields to return in the results |
|
| `fields` | array | No | Fields to return in the results |
|
||||||
| `filter` | object | No | Filter to apply to the search |
|
| `filter` | object | No | Filter to apply to the search \(e.g., \{"category": "tech", "year": \{"$gte": 2020\}\}\) |
|
||||||
| `rerank` | object | No | Reranking parameters |
|
| `rerank` | object | No | Reranking parameters |
|
||||||
| `apiKey` | string | Yes | Pinecone API key |
|
| `apiKey` | string | Yes | Pinecone API key |
|
||||||
|
|
||||||
@@ -101,9 +101,9 @@ Search for similar text in a Pinecone index
|
|||||||
| ↳ `score` | number | Similarity score |
|
| ↳ `score` | number | Similarity score |
|
||||||
| ↳ `metadata` | object | Associated metadata |
|
| ↳ `metadata` | object | Associated metadata |
|
||||||
| `usage` | object | Usage statistics including tokens, read units, and rerank units |
|
| `usage` | object | Usage statistics including tokens, read units, and rerank units |
|
||||||
| ↳ `total_tokens` | number | Total tokens used for embedding |
|
| ↳ `total_tokens` | number | Total tokens used for embedding |
|
||||||
| ↳ `read_units` | number | Read units consumed |
|
| ↳ `read_units` | number | Read units consumed |
|
||||||
| ↳ `rerank_units` | number | Rerank units used |
|
| ↳ `rerank_units` | number | Rerank units used |
|
||||||
|
|
||||||
### `pinecone_search_vector`
|
### `pinecone_search_vector`
|
||||||
|
|
||||||
@@ -113,13 +113,13 @@ Search for similar vectors in a Pinecone index
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `indexHost` | string | Yes | Full Pinecone index host URL |
|
| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) |
|
||||||
| `namespace` | string | No | Namespace to search in |
|
| `namespace` | string | No | Namespace to search in \(e.g., "documents", "embeddings"\) |
|
||||||
| `vector` | array | Yes | Vector to search for |
|
| `vector` | array | Yes | Vector to search for |
|
||||||
| `topK` | number | No | Number of results to return |
|
| `topK` | number | No | Number of results to return \(e.g., 10, 25\) |
|
||||||
| `filter` | object | No | Filter to apply to the search |
|
| `filter` | object | No | Filter to apply to the search \(e.g., \{"category": "tech", "year": \{"$gte": 2020\}\}\) |
|
||||||
| `includeValues` | boolean | No | Include vector values in response |
|
| `includeValues` | boolean | No | Include vector values in response |
|
||||||
| `includeMetadata` | boolean | No | Include metadata in response |
|
| `includeMetadata` | boolean | No | Include metadata in response \(true/false\) |
|
||||||
| `apiKey` | string | Yes | Pinecone API key |
|
| `apiKey` | string | Yes | Pinecone API key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -137,9 +137,9 @@ Fetch vectors by ID from a Pinecone index
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `indexHost` | string | Yes | Full Pinecone index host URL |
|
| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) |
|
||||||
| `ids` | array | Yes | Array of vector IDs to fetch |
|
| `ids` | array | Yes | Array of vector IDs to fetch \(e.g., \["vec-001", "vec-002"\]\) |
|
||||||
| `namespace` | string | No | Namespace to fetch vectors from |
|
| `namespace` | string | No | Namespace to fetch vectors from \(e.g., "documents", "embeddings"\) |
|
||||||
| `apiKey` | string | Yes | Pinecone API key |
|
| `apiKey` | string | Yes | Pinecone API key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -155,6 +155,6 @@ Fetch vectors by ID from a Pinecone index
|
|||||||
| ↳ `values` | array | Vector values |
|
| ↳ `values` | array | Vector values |
|
||||||
| ↳ `vector_type` | string | Vector type \(dense/sparse\) |
|
| ↳ `vector_type` | string | Vector type \(dense/sparse\) |
|
||||||
| `usage` | object | Usage statistics including total read units |
|
| `usage` | object | Usage statistics including total read units |
|
||||||
| ↳ `total_tokens` | number | Read units consumed |
|
| ↳ `total_tokens` | number | Read units consumed |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -44,18 +44,36 @@ Retrieve all deals from Pipedrive with optional filters
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `status` | string | No | Only fetch deals with a specific status. Values: open, won, lost. If omitted, all not deleted deals are returned |
|
| `status` | string | No | Only fetch deals with a specific status. Values: open, won, lost. If omitted, all not deleted deals are returned |
|
||||||
| `person_id` | string | No | If supplied, only deals linked to the specified person are returned |
|
| `person_id` | string | No | If supplied, only deals linked to the specified person are returned \(e.g., "456"\) |
|
||||||
| `org_id` | string | No | If supplied, only deals linked to the specified organization are returned |
|
| `org_id` | string | No | If supplied, only deals linked to the specified organization are returned \(e.g., "789"\) |
|
||||||
| `pipeline_id` | string | No | If supplied, only deals in the specified pipeline are returned |
|
| `pipeline_id` | string | No | If supplied, only deals in the specified pipeline are returned \(e.g., "1"\) |
|
||||||
| `updated_since` | string | No | If set, only deals updated after this time are returned. Format: 2025-01-01T10:20:00Z |
|
| `updated_since` | string | No | If set, only deals updated after this time are returned. Format: 2025-01-01T10:20:00Z |
|
||||||
| `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
|
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `deals` | array | Array of deal objects from Pipedrive |
|
| `deals` | array | Array of deal objects from Pipedrive |
|
||||||
|
| ↳ `id` | number | Deal ID |
|
||||||
|
| ↳ `title` | string | Deal title |
|
||||||
|
| ↳ `value` | number | Deal value |
|
||||||
|
| ↳ `currency` | string | Currency code |
|
||||||
|
| ↳ `status` | string | Deal status \(open, won, lost, deleted\) |
|
||||||
|
| ↳ `stage_id` | number | Pipeline stage ID |
|
||||||
|
| ↳ `pipeline_id` | number | Pipeline ID |
|
||||||
|
| ↳ `person_id` | number | Associated person ID |
|
||||||
|
| ↳ `org_id` | number | Associated organization ID |
|
||||||
|
| ↳ `owner_id` | number | Deal owner user ID |
|
||||||
|
| ↳ `add_time` | string | When the deal was created \(ISO 8601\) |
|
||||||
|
| ↳ `update_time` | string | When the deal was last updated \(ISO 8601\) |
|
||||||
|
| ↳ `won_time` | string | When the deal was won |
|
||||||
|
| ↳ `lost_time` | string | When the deal was lost |
|
||||||
|
| ↳ `close_time` | string | When the deal was closed |
|
||||||
|
| ↳ `expected_close_date` | string | Expected close date |
|
||||||
| `metadata` | object | Pagination metadata for the response |
|
| `metadata` | object | Pagination metadata for the response |
|
||||||
|
| ↳ `total_items` | number | Total number of items |
|
||||||
|
| ↳ `has_more` | boolean | Whether more items are available |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
### `pipedrive_get_deal`
|
### `pipedrive_get_deal`
|
||||||
@@ -66,7 +84,7 @@ Retrieve detailed information about a specific deal
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `deal_id` | string | Yes | The ID of the deal to retrieve |
|
| `deal_id` | string | Yes | The ID of the deal to retrieve \(e.g., "123"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -83,15 +101,15 @@ Create a new deal in Pipedrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `title` | string | Yes | The title of the deal |
|
| `title` | string | Yes | The title of the deal \(e.g., "Enterprise Software License"\) |
|
||||||
| `value` | string | No | The monetary value of the deal |
|
| `value` | string | No | The monetary value of the deal \(e.g., "5000"\) |
|
||||||
| `currency` | string | No | Currency code \(e.g., USD, EUR\) |
|
| `currency` | string | No | Currency code \(e.g., "USD", "EUR", "GBP"\) |
|
||||||
| `person_id` | string | No | ID of the person this deal is associated with |
|
| `person_id` | string | No | ID of the person this deal is associated with \(e.g., "456"\) |
|
||||||
| `org_id` | string | No | ID of the organization this deal is associated with |
|
| `org_id` | string | No | ID of the organization this deal is associated with \(e.g., "789"\) |
|
||||||
| `pipeline_id` | string | No | ID of the pipeline this deal should be placed in |
|
| `pipeline_id` | string | No | ID of the pipeline this deal should be placed in \(e.g., "1"\) |
|
||||||
| `stage_id` | string | No | ID of the stage this deal should be placed in |
|
| `stage_id` | string | No | ID of the stage this deal should be placed in \(e.g., "2"\) |
|
||||||
| `status` | string | No | Status of the deal: open, won, lost |
|
| `status` | string | No | Status of the deal: open, won, lost |
|
||||||
| `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format |
|
| `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format \(e.g., "2025-06-30"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -108,12 +126,12 @@ Update an existing deal in Pipedrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `deal_id` | string | Yes | The ID of the deal to update |
|
| `deal_id` | string | Yes | The ID of the deal to update \(e.g., "123"\) |
|
||||||
| `title` | string | No | New title for the deal |
|
| `title` | string | No | New title for the deal \(e.g., "Updated Enterprise License"\) |
|
||||||
| `value` | string | No | New monetary value for the deal |
|
| `value` | string | No | New monetary value for the deal \(e.g., "7500"\) |
|
||||||
| `status` | string | No | New status: open, won, lost |
|
| `status` | string | No | New status: open, won, lost |
|
||||||
| `stage_id` | string | No | New stage ID for the deal |
|
| `stage_id` | string | No | New stage ID for the deal \(e.g., "3"\) |
|
||||||
| `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format |
|
| `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format \(e.g., "2025-07-15"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -130,16 +148,26 @@ Retrieve files from Pipedrive with optional filters
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `deal_id` | string | No | Filter files by deal ID |
|
| `deal_id` | string | No | Filter files by deal ID \(e.g., "123"\) |
|
||||||
| `person_id` | string | No | Filter files by person ID |
|
| `person_id` | string | No | Filter files by person ID \(e.g., "456"\) |
|
||||||
| `org_id` | string | No | Filter files by organization ID |
|
| `org_id` | string | No | Filter files by organization ID \(e.g., "789"\) |
|
||||||
| `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
|
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `files` | array | Array of file objects from Pipedrive |
|
| `files` | array | Array of file objects from Pipedrive |
|
||||||
|
| ↳ `id` | number | File ID |
|
||||||
|
| ↳ `name` | string | File name |
|
||||||
|
| ↳ `file_type` | string | File type/extension |
|
||||||
|
| ↳ `file_size` | number | File size in bytes |
|
||||||
|
| ↳ `add_time` | string | When the file was uploaded |
|
||||||
|
| ↳ `update_time` | string | When the file was last updated |
|
||||||
|
| ↳ `deal_id` | number | Associated deal ID |
|
||||||
|
| ↳ `person_id` | number | Associated person ID |
|
||||||
|
| ↳ `org_id` | number | Associated organization ID |
|
||||||
|
| ↳ `url` | string | File download URL |
|
||||||
| `total_items` | number | Total number of files returned |
|
| `total_items` | number | Total number of files returned |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -152,7 +180,7 @@ Retrieve mail threads from Pipedrive mailbox
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `folder` | string | No | Filter by folder: inbox, drafts, sent, archive \(default: inbox\) |
|
| `folder` | string | No | Filter by folder: inbox, drafts, sent, archive \(default: inbox\) |
|
||||||
| `limit` | string | No | Number of results to return \(default: 50\) |
|
| `limit` | string | No | Number of results to return \(e.g., "25", default: 50\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -170,7 +198,7 @@ Retrieve all messages from a specific mail thread
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `thread_id` | string | Yes | The ID of the mail thread |
|
| `thread_id` | string | Yes | The ID of the mail thread \(e.g., "12345"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -190,7 +218,7 @@ Retrieve all pipelines from Pipedrive
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `sort_by` | string | No | Field to sort by: id, update_time, add_time \(default: id\) |
|
| `sort_by` | string | No | Field to sort by: id, update_time, add_time \(default: id\) |
|
||||||
| `sort_direction` | string | No | Sorting direction: asc, desc \(default: asc\) |
|
| `sort_direction` | string | No | Sorting direction: asc, desc \(default: asc\) |
|
||||||
| `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
|
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) |
|
||||||
| `cursor` | string | No | For pagination, the marker representing the first item on the next page |
|
| `cursor` | string | No | For pagination, the marker representing the first item on the next page |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -198,6 +226,14 @@ Retrieve all pipelines from Pipedrive
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `pipelines` | array | Array of pipeline objects from Pipedrive |
|
| `pipelines` | array | Array of pipeline objects from Pipedrive |
|
||||||
|
| ↳ `id` | number | Pipeline ID |
|
||||||
|
| ↳ `name` | string | Pipeline name |
|
||||||
|
| ↳ `url_title` | string | URL-friendly title |
|
||||||
|
| ↳ `order_nr` | number | Pipeline order number |
|
||||||
|
| ↳ `active` | boolean | Whether the pipeline is active |
|
||||||
|
| ↳ `deal_probability` | boolean | Whether deal probability is enabled |
|
||||||
|
| ↳ `add_time` | string | When the pipeline was created |
|
||||||
|
| ↳ `update_time` | string | When the pipeline was last updated |
|
||||||
| `total_items` | number | Total number of pipelines returned |
|
| `total_items` | number | Total number of pipelines returned |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -209,10 +245,10 @@ Retrieve all deals in a specific pipeline
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `pipeline_id` | string | Yes | The ID of the pipeline |
|
| `pipeline_id` | string | Yes | The ID of the pipeline \(e.g., "1"\) |
|
||||||
| `stage_id` | string | No | Filter by specific stage within the pipeline |
|
| `stage_id` | string | No | Filter by specific stage within the pipeline \(e.g., "2"\) |
|
||||||
| `status` | string | No | Filter by deal status: open, won, lost |
|
| `status` | string | No | Filter by deal status: open, won, lost |
|
||||||
| `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
|
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -230,9 +266,9 @@ Retrieve all projects or a specific project from Pipedrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `project_id` | string | No | Optional: ID of a specific project to retrieve |
|
| `project_id` | string | No | Optional: ID of a specific project to retrieve \(e.g., "123"\) |
|
||||||
| `status` | string | No | Filter by project status: open, completed, deleted \(only for listing all\) |
|
| `status` | string | No | Filter by project status: open, completed, deleted \(only for listing all\) |
|
||||||
| `limit` | string | No | Number of results to return \(default: 100, max: 500, only for listing all\) |
|
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500, only for listing all\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -251,10 +287,10 @@ Create a new project in Pipedrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `title` | string | Yes | The title of the project |
|
| `title` | string | Yes | The title of the project \(e.g., "Q2 Marketing Campaign"\) |
|
||||||
| `description` | string | No | Description of the project |
|
| `description` | string | No | Description of the project |
|
||||||
| `start_date` | string | No | Project start date in YYYY-MM-DD format |
|
| `start_date` | string | No | Project start date in YYYY-MM-DD format \(e.g., "2025-04-01"\) |
|
||||||
| `end_date` | string | No | Project end date in YYYY-MM-DD format |
|
| `end_date` | string | No | Project end date in YYYY-MM-DD format \(e.g., "2025-06-30"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -271,18 +307,31 @@ Retrieve activities (tasks) from Pipedrive with optional filters
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `deal_id` | string | No | Filter activities by deal ID |
|
| `deal_id` | string | No | Filter activities by deal ID \(e.g., "123"\) |
|
||||||
| `person_id` | string | No | Filter activities by person ID |
|
| `person_id` | string | No | Filter activities by person ID \(e.g., "456"\) |
|
||||||
| `org_id` | string | No | Filter activities by organization ID |
|
| `org_id` | string | No | Filter activities by organization ID \(e.g., "789"\) |
|
||||||
| `type` | string | No | Filter by activity type \(call, meeting, task, deadline, email, lunch\) |
|
| `type` | string | No | Filter by activity type \(call, meeting, task, deadline, email, lunch\) |
|
||||||
| `done` | string | No | Filter by completion status: 0 for not done, 1 for done |
|
| `done` | string | No | Filter by completion status: 0 for not done, 1 for done |
|
||||||
| `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
|
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `activities` | array | Array of activity objects from Pipedrive |
|
| `activities` | array | Array of activity objects from Pipedrive |
|
||||||
|
| ↳ `id` | number | Activity ID |
|
||||||
|
| ↳ `subject` | string | Activity subject |
|
||||||
|
| ↳ `type` | string | Activity type \(call, meeting, task, etc.\) |
|
||||||
|
| ↳ `due_date` | string | Due date \(YYYY-MM-DD\) |
|
||||||
|
| ↳ `due_time` | string | Due time \(HH:MM\) |
|
||||||
|
| ↳ `duration` | string | Duration \(HH:MM\) |
|
||||||
|
| ↳ `deal_id` | number | Associated deal ID |
|
||||||
|
| ↳ `person_id` | number | Associated person ID |
|
||||||
|
| ↳ `org_id` | number | Associated organization ID |
|
||||||
|
| ↳ `done` | boolean | Whether the activity is done |
|
||||||
|
| ↳ `note` | string | Activity note |
|
||||||
|
| ↳ `add_time` | string | When the activity was created |
|
||||||
|
| ↳ `update_time` | string | When the activity was last updated |
|
||||||
| `total_items` | number | Total number of activities returned |
|
| `total_items` | number | Total number of activities returned |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -294,14 +343,14 @@ Create a new activity (task) in Pipedrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `subject` | string | Yes | The subject/title of the activity |
|
| `subject` | string | Yes | The subject/title of the activity \(e.g., "Follow up call with John"\) |
|
||||||
| `type` | string | Yes | Activity type: call, meeting, task, deadline, email, lunch |
|
| `type` | string | Yes | Activity type: call, meeting, task, deadline, email, lunch |
|
||||||
| `due_date` | string | Yes | Due date in YYYY-MM-DD format |
|
| `due_date` | string | Yes | Due date in YYYY-MM-DD format \(e.g., "2025-03-15"\) |
|
||||||
| `due_time` | string | No | Due time in HH:MM format |
|
| `due_time` | string | No | Due time in HH:MM format \(e.g., "14:30"\) |
|
||||||
| `duration` | string | No | Duration in HH:MM format |
|
| `duration` | string | No | Duration in HH:MM format \(e.g., "01:00" for 1 hour\) |
|
||||||
| `deal_id` | string | No | ID of the deal to associate with |
|
| `deal_id` | string | No | ID of the deal to associate with \(e.g., "123"\) |
|
||||||
| `person_id` | string | No | ID of the person to associate with |
|
| `person_id` | string | No | ID of the person to associate with \(e.g., "456"\) |
|
||||||
| `org_id` | string | No | ID of the organization to associate with |
|
| `org_id` | string | No | ID of the organization to associate with \(e.g., "789"\) |
|
||||||
| `note` | string | No | Notes for the activity |
|
| `note` | string | No | Notes for the activity |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -319,11 +368,11 @@ Update an existing activity (task) in Pipedrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `activity_id` | string | Yes | The ID of the activity to update |
|
| `activity_id` | string | Yes | The ID of the activity to update \(e.g., "12345"\) |
|
||||||
| `subject` | string | No | New subject/title for the activity |
|
| `subject` | string | No | New subject/title for the activity \(e.g., "Updated meeting with client"\) |
|
||||||
| `due_date` | string | No | New due date in YYYY-MM-DD format |
|
| `due_date` | string | No | New due date in YYYY-MM-DD format \(e.g., "2025-03-20"\) |
|
||||||
| `due_time` | string | No | New due time in HH:MM format |
|
| `due_time` | string | No | New due time in HH:MM format \(e.g., "15:00"\) |
|
||||||
| `duration` | string | No | New duration in HH:MM format |
|
| `duration` | string | No | New duration in HH:MM format \(e.g., "00:30" for 30 minutes\) |
|
||||||
| `done` | string | No | Mark as done: 0 for not done, 1 for done |
|
| `done` | string | No | Mark as done: 0 for not done, 1 for done |
|
||||||
| `note` | string | No | New notes for the activity |
|
| `note` | string | No | New notes for the activity |
|
||||||
|
|
||||||
@@ -342,19 +391,45 @@ Retrieve all leads or a specific lead from Pipedrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `lead_id` | string | No | Optional: ID of a specific lead to retrieve |
|
| `lead_id` | string | No | Optional: ID of a specific lead to retrieve \(e.g., "abc123-def456-ghi789"\) |
|
||||||
| `archived` | string | No | Get archived leads instead of active ones |
|
| `archived` | string | No | Get archived leads instead of active ones \(e.g., "true" or "false"\) |
|
||||||
| `owner_id` | string | No | Filter by owner user ID |
|
| `owner_id` | string | No | Filter by owner user ID \(e.g., "123"\) |
|
||||||
| `person_id` | string | No | Filter by person ID |
|
| `person_id` | string | No | Filter by person ID \(e.g., "456"\) |
|
||||||
| `organization_id` | string | No | Filter by organization ID |
|
| `organization_id` | string | No | Filter by organization ID \(e.g., "789"\) |
|
||||||
| `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
|
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `leads` | array | Array of lead objects \(when listing all\) |
|
| `leads` | array | Array of lead objects \(when listing all\) |
|
||||||
|
| ↳ `id` | string | Lead ID \(UUID\) |
|
||||||
|
| ↳ `title` | string | Lead title |
|
||||||
|
| ↳ `person_id` | number | ID of the associated person |
|
||||||
|
| ↳ `organization_id` | number | ID of the associated organization |
|
||||||
|
| ↳ `owner_id` | number | ID of the lead owner |
|
||||||
|
| ↳ `value` | object | Lead value |
|
||||||
|
| ↳ `amount` | number | Value amount |
|
||||||
|
| ↳ `currency` | string | Currency code \(e.g., USD, EUR\) |
|
||||||
|
| ↳ `expected_close_date` | string | Expected close date \(YYYY-MM-DD\) |
|
||||||
|
| ↳ `is_archived` | boolean | Whether the lead is archived |
|
||||||
|
| ↳ `was_seen` | boolean | Whether the lead was seen |
|
||||||
|
| ↳ `add_time` | string | When the lead was created \(ISO 8601\) |
|
||||||
|
| ↳ `update_time` | string | When the lead was last updated \(ISO 8601\) |
|
||||||
| `lead` | object | Single lead object \(when lead_id is provided\) |
|
| `lead` | object | Single lead object \(when lead_id is provided\) |
|
||||||
|
| ↳ `id` | string | Lead ID \(UUID\) |
|
||||||
|
| ↳ `title` | string | Lead title |
|
||||||
|
| ↳ `person_id` | number | ID of the associated person |
|
||||||
|
| ↳ `organization_id` | number | ID of the associated organization |
|
||||||
|
| ↳ `owner_id` | number | ID of the lead owner |
|
||||||
|
| ↳ `value` | object | Lead value |
|
||||||
|
| ↳ `amount` | number | Value amount |
|
||||||
|
| ↳ `currency` | string | Currency code \(e.g., USD, EUR\) |
|
||||||
|
| ↳ `expected_close_date` | string | Expected close date \(YYYY-MM-DD\) |
|
||||||
|
| ↳ `is_archived` | boolean | Whether the lead is archived |
|
||||||
|
| ↳ `was_seen` | boolean | Whether the lead was seen |
|
||||||
|
| ↳ `add_time` | string | When the lead was created \(ISO 8601\) |
|
||||||
|
| ↳ `update_time` | string | When the lead was last updated \(ISO 8601\) |
|
||||||
| `total_items` | number | Total number of leads returned |
|
| `total_items` | number | Total number of leads returned |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
|
|
||||||
@@ -366,13 +441,13 @@ Create a new lead in Pipedrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `title` | string | Yes | The name of the lead |
|
| `title` | string | Yes | The name of the lead \(e.g., "Acme Corp - Website Redesign"\) |
|
||||||
| `person_id` | string | No | ID of the person \(REQUIRED unless organization_id is provided\) |
|
| `person_id` | string | No | ID of the person \(REQUIRED unless organization_id is provided\) \(e.g., "456"\) |
|
||||||
| `organization_id` | string | No | ID of the organization \(REQUIRED unless person_id is provided\) |
|
| `organization_id` | string | No | ID of the organization \(REQUIRED unless person_id is provided\) \(e.g., "789"\) |
|
||||||
| `owner_id` | string | No | ID of the user who will own the lead |
|
| `owner_id` | string | No | ID of the user who will own the lead \(e.g., "123"\) |
|
||||||
| `value_amount` | string | No | Potential value amount |
|
| `value_amount` | string | No | Potential value amount \(e.g., "10000"\) |
|
||||||
| `value_currency` | string | No | Currency code \(e.g., USD, EUR\) |
|
| `value_currency` | string | No | Currency code \(e.g., "USD", "EUR", "GBP"\) |
|
||||||
| `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format |
|
| `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format \(e.g., "2025-04-15"\) |
|
||||||
| `visible_to` | string | No | Visibility: 1 \(Owner & followers\), 3 \(Entire company\) |
|
| `visible_to` | string | No | Visibility: 1 \(Owner & followers\), 3 \(Entire company\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -390,14 +465,14 @@ Update an existing lead in Pipedrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `lead_id` | string | Yes | The ID of the lead to update |
|
| `lead_id` | string | Yes | The ID of the lead to update \(e.g., "abc123-def456-ghi789"\) |
|
||||||
| `title` | string | No | New name for the lead |
|
| `title` | string | No | New name for the lead \(e.g., "Updated Lead - Premium Package"\) |
|
||||||
| `person_id` | string | No | New person ID |
|
| `person_id` | string | No | New person ID \(e.g., "456"\) |
|
||||||
| `organization_id` | string | No | New organization ID |
|
| `organization_id` | string | No | New organization ID \(e.g., "789"\) |
|
||||||
| `owner_id` | string | No | New owner user ID |
|
| `owner_id` | string | No | New owner user ID \(e.g., "123"\) |
|
||||||
| `value_amount` | string | No | New value amount |
|
| `value_amount` | string | No | New value amount \(e.g., "15000"\) |
|
||||||
| `value_currency` | string | No | New currency code \(e.g., USD, EUR\) |
|
| `value_currency` | string | No | New currency code \(e.g., "USD", "EUR", "GBP"\) |
|
||||||
| `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format |
|
| `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format \(e.g., "2025-05-01"\) |
|
||||||
| `is_archived` | string | No | Archive the lead: true or false |
|
| `is_archived` | string | No | Archive the lead: true or false |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -415,7 +490,7 @@ Delete a specific lead from Pipedrive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `lead_id` | string | Yes | The ID of the lead to delete |
|
| `lead_id` | string | Yes | The ID of the lead to delete \(e.g., "abc123-def456-ghi789"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -47,8 +47,8 @@ Retrieve a list of prediction markets from Polymarket with optional filtering
|
|||||||
| `order` | string | No | Sort field \(e.g., volumeNum, liquidityNum, startDate, endDate, createdAt\) |
|
| `order` | string | No | Sort field \(e.g., volumeNum, liquidityNum, startDate, endDate, createdAt\) |
|
||||||
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
|
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
|
||||||
| `tagId` | string | No | Filter by tag ID |
|
| `tagId` | string | No | Filter by tag ID |
|
||||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. |
|
||||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -79,36 +79,36 @@ Retrieve details of a specific prediction market by ID or slug
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `marketId` | string | No | The market ID. Required if slug is not provided. |
|
| `marketId` | string | No | The market ID \(e.g., "0x1234...abcd" condition ID format\). Required if slug is not provided. |
|
||||||
| `slug` | string | No | The market slug \(e.g., "will-trump-win"\). Required if marketId is not provided. |
|
| `slug` | string | No | The market slug \(e.g., "will-trump-win"\). URL-friendly identifier. Required if marketId is not provided. |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `market` | object | Market object with details |
|
| `market` | object | Market object with details |
|
||||||
| ↳ `id` | string | Market ID |
|
| ↳ `id` | string | Market ID |
|
||||||
| ↳ `question` | string | Market question |
|
| ↳ `question` | string | Market question |
|
||||||
| ↳ `conditionId` | string | Condition ID |
|
| ↳ `conditionId` | string | Condition ID |
|
||||||
| ↳ `slug` | string | Market slug |
|
| ↳ `slug` | string | Market slug |
|
||||||
| ↳ `resolutionSource` | string | Resolution source |
|
| ↳ `resolutionSource` | string | Resolution source |
|
||||||
| ↳ `endDate` | string | End date |
|
| ↳ `endDate` | string | End date |
|
||||||
| ↳ `startDate` | string | Start date |
|
| ↳ `startDate` | string | Start date |
|
||||||
| ↳ `image` | string | Market image URL |
|
| ↳ `image` | string | Market image URL |
|
||||||
| ↳ `icon` | string | Market icon URL |
|
| ↳ `icon` | string | Market icon URL |
|
||||||
| ↳ `description` | string | Market description |
|
| ↳ `description` | string | Market description |
|
||||||
| ↳ `outcomes` | string | Outcomes JSON string |
|
| ↳ `outcomes` | string | Outcomes JSON string |
|
||||||
| ↳ `outcomePrices` | string | Outcome prices JSON string |
|
| ↳ `outcomePrices` | string | Outcome prices JSON string |
|
||||||
| ↳ `volume` | string | Total volume |
|
| ↳ `volume` | string | Total volume |
|
||||||
| ↳ `liquidity` | string | Total liquidity |
|
| ↳ `liquidity` | string | Total liquidity |
|
||||||
| ↳ `active` | boolean | Whether market is active |
|
| ↳ `active` | boolean | Whether market is active |
|
||||||
| ↳ `closed` | boolean | Whether market is closed |
|
| ↳ `closed` | boolean | Whether market is closed |
|
||||||
| ↳ `archived` | boolean | Whether market is archived |
|
| ↳ `archived` | boolean | Whether market is archived |
|
||||||
| ↳ `volumeNum` | number | Volume as number |
|
| ↳ `volumeNum` | number | Volume as number |
|
||||||
| ↳ `liquidityNum` | number | Liquidity as number |
|
| ↳ `liquidityNum` | number | Liquidity as number |
|
||||||
| ↳ `clobTokenIds` | array | CLOB token IDs |
|
| ↳ `clobTokenIds` | array | CLOB token IDs |
|
||||||
| ↳ `acceptingOrders` | boolean | Whether accepting orders |
|
| ↳ `acceptingOrders` | boolean | Whether accepting orders |
|
||||||
| ↳ `negRisk` | boolean | Whether negative risk |
|
| ↳ `negRisk` | boolean | Whether negative risk |
|
||||||
|
|
||||||
### `polymarket_get_events`
|
### `polymarket_get_events`
|
||||||
|
|
||||||
@@ -122,8 +122,8 @@ Retrieve a list of events from Polymarket with optional filtering
|
|||||||
| `order` | string | No | Sort field \(e.g., volume, liquidity, startDate, endDate, createdAt\) |
|
| `order` | string | No | Sort field \(e.g., volume, liquidity, startDate, endDate, createdAt\) |
|
||||||
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
|
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
|
||||||
| `tagId` | string | No | Filter by tag ID |
|
| `tagId` | string | No | Filter by tag ID |
|
||||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. |
|
||||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -154,32 +154,32 @@ Retrieve details of a specific event by ID or slug
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `eventId` | string | No | The event ID. Required if slug is not provided. |
|
| `eventId` | string | No | The event ID \(e.g., "12345" or UUID format\). Required if slug is not provided. |
|
||||||
| `slug` | string | No | The event slug \(e.g., "2024-presidential-election"\). Required if eventId is not provided. |
|
| `slug` | string | No | The event slug \(e.g., "2024-presidential-election"\). URL-friendly identifier. Required if eventId is not provided. |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `event` | object | Event object with details |
|
| `event` | object | Event object with details |
|
||||||
| ↳ `id` | string | Event ID |
|
| ↳ `id` | string | Event ID |
|
||||||
| ↳ `ticker` | string | Event ticker |
|
| ↳ `ticker` | string | Event ticker |
|
||||||
| ↳ `slug` | string | Event slug |
|
| ↳ `slug` | string | Event slug |
|
||||||
| ↳ `title` | string | Event title |
|
| ↳ `title` | string | Event title |
|
||||||
| ↳ `description` | string | Event description |
|
| ↳ `description` | string | Event description |
|
||||||
| ↳ `startDate` | string | Start date |
|
| ↳ `startDate` | string | Start date |
|
||||||
| ↳ `creationDate` | string | Creation date |
|
| ↳ `creationDate` | string | Creation date |
|
||||||
| ↳ `endDate` | string | End date |
|
| ↳ `endDate` | string | End date |
|
||||||
| ↳ `image` | string | Event image URL |
|
| ↳ `image` | string | Event image URL |
|
||||||
| ↳ `icon` | string | Event icon URL |
|
| ↳ `icon` | string | Event icon URL |
|
||||||
| ↳ `active` | boolean | Whether event is active |
|
| ↳ `active` | boolean | Whether event is active |
|
||||||
| ↳ `closed` | boolean | Whether event is closed |
|
| ↳ `closed` | boolean | Whether event is closed |
|
||||||
| ↳ `archived` | boolean | Whether event is archived |
|
| ↳ `archived` | boolean | Whether event is archived |
|
||||||
| ↳ `liquidity` | number | Total liquidity |
|
| ↳ `liquidity` | number | Total liquidity |
|
||||||
| ↳ `volume` | number | Total volume |
|
| ↳ `volume` | number | Total volume |
|
||||||
| ↳ `openInterest` | number | Open interest |
|
| ↳ `openInterest` | number | Open interest |
|
||||||
| ↳ `commentCount` | number | Comment count |
|
| ↳ `commentCount` | number | Comment count |
|
||||||
| ↳ `markets` | array | Array of markets in this event |
|
| ↳ `markets` | array | Array of markets in this event |
|
||||||
|
|
||||||
### `polymarket_get_tags`
|
### `polymarket_get_tags`
|
||||||
|
|
||||||
@@ -189,8 +189,8 @@ Retrieve available tags for filtering markets from Polymarket
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. |
|
||||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -211,9 +211,9 @@ Search for markets, events, and profiles on Polymarket
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | Yes | Search query term |
|
| `query` | string | Yes | Search query term \(e.g., "presidential election", "bitcoin price"\). |
|
||||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. |
|
||||||
| `page` | string | No | Page number for pagination \(1-indexed\) |
|
| `page` | string | No | Page number for pagination \(e.g., "2"\). 1-indexed. |
|
||||||
| `cache` | string | No | Enable caching \(true/false\) |
|
| `cache` | string | No | Enable caching \(true/false\) |
|
||||||
| `eventsStatus` | string | No | Filter events by status |
|
| `eventsStatus` | string | No | Filter events by status |
|
||||||
| `limitPerType` | string | No | Limit results per type \(markets, events, profiles\) |
|
| `limitPerType` | string | No | Limit results per type \(markets, events, profiles\) |
|
||||||
@@ -231,10 +231,10 @@ Search for markets, events, and profiles on Polymarket
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `results` | object | Search results containing markets, events, tags, and profiles arrays |
|
| `results` | object | Search results containing markets, events, tags, and profiles arrays |
|
||||||
| ↳ `markets` | array | Array of matching market objects |
|
| ↳ `markets` | array | Array of matching market objects |
|
||||||
| ↳ `events` | array | Array of matching event objects |
|
| ↳ `events` | array | Array of matching event objects |
|
||||||
| ↳ `tags` | array | Array of matching tag objects |
|
| ↳ `tags` | array | Array of matching tag objects |
|
||||||
| ↳ `profiles` | array | Array of matching profile objects |
|
| ↳ `profiles` | array | Array of matching profile objects |
|
||||||
|
|
||||||
### `polymarket_get_series`
|
### `polymarket_get_series`
|
||||||
|
|
||||||
@@ -244,8 +244,8 @@ Retrieve series (related market groups) from Polymarket
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. |
|
||||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -276,30 +276,30 @@ Retrieve a specific series (related market group) by ID from Polymarket
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `seriesId` | string | Yes | The series ID |
|
| `seriesId` | string | Yes | The series ID \(e.g., "12345" or UUID format\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `series` | object | Series object with details |
|
| `series` | object | Series object with details |
|
||||||
| ↳ `id` | string | Series ID |
|
| ↳ `id` | string | Series ID |
|
||||||
| ↳ `ticker` | string | Series ticker |
|
| ↳ `ticker` | string | Series ticker |
|
||||||
| ↳ `slug` | string | Series slug |
|
| ↳ `slug` | string | Series slug |
|
||||||
| ↳ `title` | string | Series title |
|
| ↳ `title` | string | Series title |
|
||||||
| ↳ `seriesType` | string | Series type |
|
| ↳ `seriesType` | string | Series type |
|
||||||
| ↳ `recurrence` | string | Recurrence pattern |
|
| ↳ `recurrence` | string | Recurrence pattern |
|
||||||
| ↳ `image` | string | Series image URL |
|
| ↳ `image` | string | Series image URL |
|
||||||
| ↳ `icon` | string | Series icon URL |
|
| ↳ `icon` | string | Series icon URL |
|
||||||
| ↳ `active` | boolean | Whether series is active |
|
| ↳ `active` | boolean | Whether series is active |
|
||||||
| ↳ `closed` | boolean | Whether series is closed |
|
| ↳ `closed` | boolean | Whether series is closed |
|
||||||
| ↳ `archived` | boolean | Whether series is archived |
|
| ↳ `archived` | boolean | Whether series is archived |
|
||||||
| ↳ `featured` | boolean | Whether series is featured |
|
| ↳ `featured` | boolean | Whether series is featured |
|
||||||
| ↳ `volume` | number | Total volume |
|
| ↳ `volume` | number | Total volume |
|
||||||
| ↳ `liquidity` | number | Total liquidity |
|
| ↳ `liquidity` | number | Total liquidity |
|
||||||
| ↳ `commentCount` | number | Comment count |
|
| ↳ `commentCount` | number | Comment count |
|
||||||
| ↳ `eventCount` | number | Number of events in series |
|
| ↳ `eventCount` | number | Number of events in series |
|
||||||
| ↳ `events` | array | Array of events in this series |
|
| ↳ `events` | array | Array of events in this series |
|
||||||
|
|
||||||
### `polymarket_get_orderbook`
|
### `polymarket_get_orderbook`
|
||||||
|
|
||||||
@@ -309,26 +309,26 @@ Retrieve the order book summary for a specific token
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `orderbook` | object | Order book with bids and asks arrays |
|
| `orderbook` | object | Order book with bids and asks arrays |
|
||||||
| ↳ `market` | string | Market identifier |
|
| ↳ `market` | string | Market identifier |
|
||||||
| ↳ `asset_id` | string | Asset token ID |
|
| ↳ `asset_id` | string | Asset token ID |
|
||||||
| ↳ `hash` | string | Order book hash |
|
| ↳ `hash` | string | Order book hash |
|
||||||
| ↳ `timestamp` | string | Timestamp |
|
| ↳ `timestamp` | string | Timestamp |
|
||||||
| ↳ `bids` | array | Bid orders |
|
| ↳ `bids` | array | Bid orders |
|
||||||
| ↳ `price` | string | Bid price |
|
| ↳ `price` | string | Bid price |
|
||||||
| ↳ `size` | string | Bid size |
|
| ↳ `size` | string | Bid size |
|
||||||
| ↳ `asks` | array | Ask orders |
|
| ↳ `asks` | array | Ask orders |
|
||||||
| ↳ `price` | string | Ask price |
|
| ↳ `price` | string | Ask price |
|
||||||
| ↳ `size` | string | Ask size |
|
| ↳ `size` | string | Ask size |
|
||||||
| ↳ `min_order_size` | string | Minimum order size |
|
| ↳ `min_order_size` | string | Minimum order size |
|
||||||
| ↳ `tick_size` | string | Tick size |
|
| ↳ `tick_size` | string | Tick size |
|
||||||
| ↳ `neg_risk` | boolean | Whether negative risk |
|
| ↳ `neg_risk` | boolean | Whether negative risk |
|
||||||
|
|
||||||
### `polymarket_get_price`
|
### `polymarket_get_price`
|
||||||
|
|
||||||
@@ -338,8 +338,8 @@ Retrieve the market price for a specific token and side
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). |
|
||||||
| `side` | string | Yes | Order side: buy or sell |
|
| `side` | string | Yes | Order side: "buy" or "sell". |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -355,7 +355,7 @@ Retrieve the midpoint price for a specific token
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -371,7 +371,7 @@ Retrieve historical price data for a specific market token
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). |
|
||||||
| `interval` | string | No | Duration ending at current time \(1m, 1h, 6h, 1d, 1w, max\). Mutually exclusive with startTs/endTs. |
|
| `interval` | string | No | Duration ending at current time \(1m, 1h, 6h, 1d, 1w, max\). Mutually exclusive with startTs/endTs. |
|
||||||
| `fidelity` | number | No | Data resolution in minutes \(e.g., 60 for hourly\) |
|
| `fidelity` | number | No | Data resolution in minutes \(e.g., 60 for hourly\) |
|
||||||
| `startTs` | number | No | Start timestamp \(Unix seconds UTC\) |
|
| `startTs` | number | No | Start timestamp \(Unix seconds UTC\) |
|
||||||
@@ -393,7 +393,7 @@ Retrieve the last trade price for a specific token
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -410,14 +410,14 @@ Retrieve the bid-ask spread for a specific token
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `spread` | object | Spread value between bid and ask |
|
| `spread` | object | Spread value between bid and ask |
|
||||||
| ↳ `spread` | string | The spread value |
|
| ↳ `spread` | string | The spread value |
|
||||||
|
|
||||||
### `polymarket_get_tick_size`
|
### `polymarket_get_tick_size`
|
||||||
|
|
||||||
@@ -427,7 +427,7 @@ Retrieve the minimum tick size for a specific token
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -444,16 +444,16 @@ Retrieve user positions from Polymarket
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `user` | string | Yes | User wallet address |
|
| `user` | string | Yes | User wallet address |
|
||||||
| `market` | string | No | Condition IDs to filter positions \(comma-separated, mutually exclusive with eventId\) |
|
| `market` | string | No | Condition IDs to filter positions \(e.g., "0x1234...abcd,0x5678...efgh"\). Mutually exclusive with eventId. |
|
||||||
| `eventId` | string | No | Event ID to filter positions \(mutually exclusive with market\) |
|
| `eventId` | string | No | Event ID to filter positions \(e.g., "12345"\). Mutually exclusive with market. |
|
||||||
| `sizeThreshold` | string | No | Minimum position size threshold \(default: 1\) |
|
| `sizeThreshold` | string | No | Minimum position size threshold \(default: 1\) |
|
||||||
| `redeemable` | string | No | Filter for redeemable positions only \(true/false\) |
|
| `redeemable` | string | No | Filter for redeemable positions only \(true/false\) |
|
||||||
| `mergeable` | string | No | Filter for mergeable positions only \(true/false\) |
|
| `mergeable` | string | No | Filter for mergeable positions only \(true/false\) |
|
||||||
| `sortBy` | string | No | Sort field \(TOKENS, CURRENT, INITIAL, CASHPNL, PERCENTPNL, TITLE, RESOLVING, PRICE, AVGPRICE\) |
|
| `sortBy` | string | No | Sort field \(TOKENS, CURRENT, INITIAL, CASHPNL, PERCENTPNL, TITLE, RESOLVING, PRICE, AVGPRICE\) |
|
||||||
| `sortDirection` | string | No | Sort direction \(ASC or DESC\) |
|
| `sortDirection` | string | No | Sort direction \(ASC or DESC\) |
|
||||||
| `title` | string | No | Search filter by title |
|
| `title` | string | No | Search filter by title |
|
||||||
| `limit` | string | No | Number of results per page |
|
| `limit` | string | No | Number of results per page \(e.g., "25"\). |
|
||||||
| `offset` | string | No | Pagination offset |
|
| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -495,14 +495,14 @@ Retrieve trade history from Polymarket
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `user` | string | No | User wallet address to filter trades |
|
| `user` | string | No | User wallet address to filter trades |
|
||||||
| `market` | string | No | Market/condition ID to filter trades \(mutually exclusive with eventId\) |
|
| `market` | string | No | Market/condition ID to filter trades \(e.g., "0x1234...abcd"\). Mutually exclusive with eventId. |
|
||||||
| `eventId` | string | No | Event ID to filter trades \(mutually exclusive with market\) |
|
| `eventId` | string | No | Event ID to filter trades \(e.g., "12345"\). Mutually exclusive with market. |
|
||||||
| `side` | string | No | Trade direction filter \(BUY or SELL\) |
|
| `side` | string | No | Trade direction filter \(BUY or SELL\) |
|
||||||
| `takerOnly` | string | No | Filter for taker trades only \(true/false, default: true\) |
|
| `takerOnly` | string | No | Filter for taker trades only \(true/false, default: true\) |
|
||||||
| `filterType` | string | No | Filter type \(CASH or TOKENS\) - requires filterAmount |
|
| `filterType` | string | No | Filter type \(CASH or TOKENS\) - requires filterAmount |
|
||||||
| `filterAmount` | string | No | Filter amount threshold - requires filterType |
|
| `filterAmount` | string | No | Filter amount threshold - requires filterType |
|
||||||
| `limit` | string | No | Number of results per page \(default: 100, max: 10000\) |
|
| `limit` | string | No | Number of results per page \(e.g., "50"\). Default: 100, max: 10000. |
|
||||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
| `offset` | string | No | Number of results to skip for pagination \(e.g., "100"\). |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -538,10 +538,10 @@ Retrieve on-chain activity for a user including trades, splits, merges, redempti
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `user` | string | Yes | User wallet address \(0x-prefixed\) |
|
| `user` | string | Yes | User wallet address \(0x-prefixed\) |
|
||||||
| `limit` | string | No | Maximum results \(default: 100, max: 500\) |
|
| `limit` | string | No | Maximum results to return \(e.g., "50"\). Default: 100, max: 500. |
|
||||||
| `offset` | string | No | Pagination offset \(default: 0, max: 10000\) |
|
| `offset` | string | No | Number of results to skip for pagination \(e.g., "100"\). Default: 0, max: 10000. |
|
||||||
| `market` | string | No | Comma-separated condition IDs \(mutually exclusive with eventId\) |
|
| `market` | string | No | Comma-separated condition IDs \(e.g., "0x1234...abcd,0x5678...efgh"\). Mutually exclusive with eventId. |
|
||||||
| `eventId` | string | No | Comma-separated event IDs \(mutually exclusive with market\) |
|
| `eventId` | string | No | Comma-separated event IDs \(e.g., "12345,67890"\). Mutually exclusive with market. |
|
||||||
| `type` | string | No | Activity type filter: TRADE, SPLIT, MERGE, REDEEM, REWARD, CONVERSION, MAKER_REBATE |
|
| `type` | string | No | Activity type filter: TRADE, SPLIT, MERGE, REDEEM, REWARD, CONVERSION, MAKER_REBATE |
|
||||||
| `start` | number | No | Start timestamp \(Unix seconds\) |
|
| `start` | number | No | Start timestamp \(Unix seconds\) |
|
||||||
| `end` | number | No | End timestamp \(Unix seconds\) |
|
| `end` | number | No | End timestamp \(Unix seconds\) |
|
||||||
@@ -587,8 +587,8 @@ Retrieve trader leaderboard rankings by profit/loss or volume
|
|||||||
| `category` | string | No | Category filter: OVERALL, POLITICS, SPORTS, CRYPTO, CULTURE, MENTIONS, WEATHER, ECONOMICS, TECH, FINANCE \(default: OVERALL\) |
|
| `category` | string | No | Category filter: OVERALL, POLITICS, SPORTS, CRYPTO, CULTURE, MENTIONS, WEATHER, ECONOMICS, TECH, FINANCE \(default: OVERALL\) |
|
||||||
| `timePeriod` | string | No | Time period: DAY, WEEK, MONTH, ALL \(default: DAY\) |
|
| `timePeriod` | string | No | Time period: DAY, WEEK, MONTH, ALL \(default: DAY\) |
|
||||||
| `orderBy` | string | No | Order by: PNL or VOL \(default: PNL\) |
|
| `orderBy` | string | No | Order by: PNL or VOL \(default: PNL\) |
|
||||||
| `limit` | string | No | Number of results \(1-50, default: 25\) |
|
| `limit` | string | No | Number of results to return \(e.g., "10"\). Range: 1-50, default: 25. |
|
||||||
| `offset` | string | No | Pagination offset \(0-1000, default: 0\) |
|
| `offset` | string | No | Number of results to skip for pagination \(e.g., "25"\). Range: 0-1000, default: 0. |
|
||||||
| `user` | string | No | Filter by specific user wallet address |
|
| `user` | string | No | Filter by specific user wallet address |
|
||||||
| `userName` | string | No | Filter by username |
|
| `userName` | string | No | Filter by username |
|
||||||
|
|
||||||
@@ -614,8 +614,8 @@ Retrieve top holders of a specific market token
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `market` | string | Yes | Comma-separated list of condition IDs |
|
| `market` | string | Yes | Comma-separated list of condition IDs \(e.g., "0x1234...abcd" or "0x1234...abcd,0x5678...efgh"\). |
|
||||||
| `limit` | string | No | Number of holders to return \(0-20, default: 20\) |
|
| `limit` | string | No | Number of holders to return \(e.g., "10"\). Range: 0-20, default: 20. |
|
||||||
| `minBalance` | string | No | Minimum balance threshold \(default: 1\) |
|
| `minBalance` | string | No | Minimum balance threshold \(default: 1\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -625,15 +625,15 @@ Retrieve top holders of a specific market token
|
|||||||
| `holders` | array | Array of market holder groups by token |
|
| `holders` | array | Array of market holder groups by token |
|
||||||
| ↳ `token` | string | Token/asset ID |
|
| ↳ `token` | string | Token/asset ID |
|
||||||
| ↳ `holders` | array | Array of holders for this token |
|
| ↳ `holders` | array | Array of holders for this token |
|
||||||
| ↳ `proxyWallet` | string | Holder wallet address |
|
| ↳ `proxyWallet` | string | Holder wallet address |
|
||||||
| ↳ `bio` | string | Holder bio |
|
| ↳ `bio` | string | Holder bio |
|
||||||
| ↳ `asset` | string | Asset ID |
|
| ↳ `asset` | string | Asset ID |
|
||||||
| ↳ `pseudonym` | string | Holder pseudonym |
|
| ↳ `pseudonym` | string | Holder pseudonym |
|
||||||
| ↳ `amount` | number | Amount held |
|
| ↳ `amount` | number | Amount held |
|
||||||
| ↳ `displayUsernamePublic` | boolean | Whether username is publicly displayed |
|
| ↳ `displayUsernamePublic` | boolean | Whether username is publicly displayed |
|
||||||
| ↳ `outcomeIndex` | number | Outcome index |
|
| ↳ `outcomeIndex` | number | Outcome index |
|
||||||
| ↳ `name` | string | Holder display name |
|
| ↳ `name` | string | Holder display name |
|
||||||
| ↳ `profileImage` | string | Profile image URL |
|
| ↳ `profileImage` | string | Profile image URL |
|
||||||
| ↳ `profileImageOptimized` | string | Optimized profile image URL |
|
| ↳ `profileImageOptimized` | string | Optimized profile image URL |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -179,6 +179,27 @@ Introspect PostgreSQL database schema to retrieve table structures, columns, and
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | string | Operation status message |
|
| `message` | string | Operation status message |
|
||||||
| `tables` | array | Array of table schemas with columns, keys, and indexes |
|
| `tables` | array | Array of table schemas with columns, keys, and indexes |
|
||||||
|
| ↳ `name` | string | Table name |
|
||||||
|
| ↳ `schema` | string | Schema name \(e.g., public\) |
|
||||||
|
| ↳ `columns` | array | Table columns |
|
||||||
|
| ↳ `name` | string | Column name |
|
||||||
|
| ↳ `type` | string | Data type \(e.g., integer, varchar, timestamp\) |
|
||||||
|
| ↳ `nullable` | boolean | Whether the column allows NULL values |
|
||||||
|
| ↳ `default` | string | Default value expression |
|
||||||
|
| ↳ `isPrimaryKey` | boolean | Whether the column is part of the primary key |
|
||||||
|
| ↳ `isForeignKey` | boolean | Whether the column is a foreign key |
|
||||||
|
| ↳ `references` | object | Foreign key reference information |
|
||||||
|
| ↳ `table` | string | Referenced table name |
|
||||||
|
| ↳ `column` | string | Referenced column name |
|
||||||
|
| ↳ `primaryKey` | array | Primary key column names |
|
||||||
|
| ↳ `foreignKeys` | array | Foreign key constraints |
|
||||||
|
| ↳ `column` | string | Local column name |
|
||||||
|
| ↳ `referencesTable` | string | Referenced table name |
|
||||||
|
| ↳ `referencesColumn` | string | Referenced column name |
|
||||||
|
| ↳ `indexes` | array | Table indexes |
|
||||||
|
| ↳ `name` | string | Index name |
|
||||||
|
| ↳ `columns` | array | Columns included in the index |
|
||||||
|
| ↳ `unique` | boolean | Whether the index enforces uniqueness |
|
||||||
| `schemas` | array | List of available schemas in the database |
|
| `schemas` | array | List of available schemas in the database |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ Capture a single event in PostHog. Use this to track user actions, page views, o
|
|||||||
| `projectApiKey` | string | Yes | PostHog Project API Key \(public token for event ingestion\) |
|
| `projectApiKey` | string | Yes | PostHog Project API Key \(public token for event ingestion\) |
|
||||||
| `region` | string | No | PostHog region: us \(default\) or eu |
|
| `region` | string | No | PostHog region: us \(default\) or eu |
|
||||||
| `event` | string | Yes | The name of the event to capture \(e.g., "page_view", "button_clicked"\) |
|
| `event` | string | Yes | The name of the event to capture \(e.g., "page_view", "button_clicked"\) |
|
||||||
| `distinctId` | string | Yes | Unique identifier for the user or device. Can be user ID, device ID, or anonymous ID |
|
| `distinctId` | string | Yes | Unique identifier for the user or device \(e.g., "user123", email, or device UUID\) |
|
||||||
| `properties` | string | No | JSON string of event properties \(e.g., \{"button_name": "signup", "page": "homepage"\}\) |
|
| `properties` | string | No | JSON string of event properties \(e.g., \{"button_name": "signup", "page": "homepage"\}\) |
|
||||||
| `timestamp` | string | No | ISO 8601 timestamp for when the event occurred. If not provided, uses current time |
|
| `timestamp` | string | No | ISO 8601 timestamp for when the event occurred. If not provided, uses current time |
|
||||||
|
|
||||||
@@ -89,9 +89,9 @@ List persons (users) in PostHog. Returns user profiles with their properties and
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
|
| `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
|
||||||
| `region` | string | No | PostHog region: us \(default\) or eu |
|
| `region` | string | No | PostHog region: us \(default\) or eu |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `limit` | number | No | Number of persons to return \(default: 100, max: 100\) |
|
| `limit` | number | No | Number of persons to return \(default: 100, max: 100\) |
|
||||||
| `offset` | number | No | Number of persons to skip for pagination |
|
| `offset` | number | No | Number of persons to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
| `search` | string | No | Search persons by email, name, or distinct ID |
|
| `search` | string | No | Search persons by email, name, or distinct ID |
|
||||||
| `distinctId` | string | No | Filter by specific distinct_id |
|
| `distinctId` | string | No | Filter by specific distinct_id |
|
||||||
|
|
||||||
@@ -117,19 +117,19 @@ Get detailed information about a specific person in PostHog by their ID or UUID.
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
|
| `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
|
||||||
| `region` | string | No | PostHog region: us \(default\) or eu |
|
| `region` | string | No | PostHog region: us \(default\) or eu |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `personId` | string | Yes | Person ID or UUID to retrieve |
|
| `personId` | string | Yes | Person ID or UUID to retrieve \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `person` | object | Person details including properties and identifiers |
|
| `person` | object | Person details including properties and identifiers |
|
||||||
| ↳ `id` | string | Person ID |
|
| ↳ `id` | string | Person ID |
|
||||||
| ↳ `name` | string | Person name |
|
| ↳ `name` | string | Person name |
|
||||||
| ↳ `distinct_ids` | array | All distinct IDs associated with this person |
|
| ↳ `distinct_ids` | array | All distinct IDs associated with this person |
|
||||||
| ↳ `created_at` | string | When the person was first seen |
|
| ↳ `created_at` | string | When the person was first seen |
|
||||||
| ↳ `uuid` | string | Person UUID |
|
| ↳ `uuid` | string | Person UUID |
|
||||||
|
|
||||||
### `posthog_delete_person`
|
### `posthog_delete_person`
|
||||||
|
|
||||||
@@ -141,8 +141,8 @@ Delete a person from PostHog. This will remove all associated events and data. U
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
|
| `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
|
||||||
| `region` | string | No | PostHog region: us \(default\) or eu |
|
| `region` | string | No | PostHog region: us \(default\) or eu |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `personId` | string | Yes | Person ID or UUID to delete |
|
| `personId` | string | Yes | Person ID or UUID to delete \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ Execute a HogQL query in PostHog. HogQL is PostHog
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
|
| `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
|
||||||
| `region` | string | No | PostHog region: us \(default\) or eu |
|
| `region` | string | No | PostHog region: us \(default\) or eu |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `query` | string | Yes | HogQL query to execute. Example: \{"kind": "HogQLQuery", "query": "SELECT event, count\(\) FROM events WHERE timestamp > now\(\) - INTERVAL 1 DAY GROUP BY event"\} |
|
| `query` | string | Yes | HogQL query to execute. Example: \{"kind": "HogQLQuery", "query": "SELECT event, count\(\) FROM events WHERE timestamp > now\(\) - INTERVAL 1 DAY GROUP BY event"\} |
|
||||||
| `Example` | string | No | No description |
|
| `Example` | string | No | No description |
|
||||||
| `values` | string | No | Optional JSON string of parameter values for parameterized queries. Example: \{"user_id": "123"\} |
|
| `values` | string | No | Optional JSON string of parameter values for parameterized queries. Example: \{"user_id": "123"\} |
|
||||||
@@ -185,10 +185,10 @@ List all insights in a PostHog project. Returns insight configurations, filters,
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
| `limit` | number | No | Number of results to return per page \(default: 100\) |
|
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -219,8 +219,8 @@ Get a specific insight by ID from PostHog. Returns detailed insight configuratio
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `insightId` | string | Yes | The insight ID to retrieve |
|
| `insightId` | string | Yes | The insight ID to retrieve \(e.g., "42" or short ID like "abc123"\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -250,7 +250,7 @@ Create a new insight in PostHog. Requires insight name and configuration filters
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
| `name` | string | No | Name for the insight \(optional - PostHog will generate a derived name if not provided\) |
|
| `name` | string | No | Name for the insight \(optional - PostHog will generate a derived name if not provided\) |
|
||||||
| `description` | string | No | Description of the insight |
|
| `description` | string | No | Description of the insight |
|
||||||
@@ -284,10 +284,10 @@ List all dashboards in a PostHog project. Returns dashboard configurations, tile
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
| `limit` | number | No | Number of results to return per page \(default: 100\) |
|
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -318,8 +318,8 @@ Get a specific dashboard by ID from PostHog. Returns detailed dashboard configur
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `dashboardId` | string | Yes | The dashboard ID to retrieve |
|
| `dashboardId` | string | Yes | The dashboard ID to retrieve \(e.g., "42"\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -348,10 +348,10 @@ List all actions in a PostHog project. Returns action definitions, steps, and me
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
| `limit` | number | No | Number of results to return per page \(default: 100\) |
|
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -383,10 +383,10 @@ List all cohorts in a PostHog project. Returns cohort definitions, filters, and
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
| `limit` | number | No | Number of results to return per page \(default: 100\) |
|
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -420,8 +420,8 @@ Get a specific cohort by ID from PostHog. Returns detailed cohort definition, fi
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `cohortId` | string | Yes | The cohort ID to retrieve |
|
| `cohortId` | string | Yes | The cohort ID to retrieve \(e.g., "42"\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -453,7 +453,7 @@ Create a new cohort in PostHog. Requires cohort name and filter or query configu
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
| `name` | string | No | Name for the cohort \(optional - PostHog will use "Untitled cohort" if not provided\) |
|
| `name` | string | No | Name for the cohort \(optional - PostHog will use "Untitled cohort" if not provided\) |
|
||||||
| `description` | string | No | Description of the cohort |
|
| `description` | string | No | Description of the cohort |
|
||||||
@@ -489,10 +489,10 @@ List all annotations in a PostHog project. Returns annotation content, timestamp
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
| `limit` | number | No | Number of results to return per page \(default: 100\) |
|
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -523,7 +523,7 @@ Create a new annotation in PostHog. Mark important events on your graphs with da
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
|
||||||
| `content` | string | Yes | Content/text of the annotation |
|
| `content` | string | Yes | Content/text of the annotation |
|
||||||
| `date_marker` | string | Yes | ISO timestamp marking when the annotation applies \(e.g., "2024-01-15T10:00:00Z"\) |
|
| `date_marker` | string | Yes | ISO timestamp marking when the annotation applies \(e.g., "2024-01-15T10:00:00Z"\) |
|
||||||
@@ -555,11 +555,11 @@ List all feature flags in a PostHog project
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `limit` | number | No | Number of results to return |
|
| `limit` | number | No | Number of results to return \(e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | Number of results to skip |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -589,8 +589,8 @@ Get details of a specific feature flag
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `flagId` | string | Yes | The feature flag ID |
|
| `flagId` | string | Yes | The feature flag ID \(e.g., "42"\) |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
|
|
||||||
@@ -599,19 +599,19 @@ Get details of a specific feature flag
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `flag` | object | Feature flag details |
|
| `flag` | object | Feature flag details |
|
||||||
| ↳ `id` | number | Feature flag ID |
|
| ↳ `id` | number | Feature flag ID |
|
||||||
| ↳ `name` | string | Feature flag name |
|
| ↳ `name` | string | Feature flag name |
|
||||||
| ↳ `key` | string | Feature flag key |
|
| ↳ `key` | string | Feature flag key |
|
||||||
| ↳ `filters` | object | Feature flag filters |
|
| ↳ `filters` | object | Feature flag filters |
|
||||||
| ↳ `deleted` | boolean | Whether the flag is deleted |
|
| ↳ `deleted` | boolean | Whether the flag is deleted |
|
||||||
| ↳ `active` | boolean | Whether the flag is active |
|
| ↳ `active` | boolean | Whether the flag is active |
|
||||||
| ↳ `created_at` | string | Creation timestamp |
|
| ↳ `created_at` | string | Creation timestamp |
|
||||||
| ↳ `created_by` | object | Creator information |
|
| ↳ `created_by` | object | Creator information |
|
||||||
| ↳ `is_simple_flag` | boolean | Whether this is a simple flag |
|
| ↳ `is_simple_flag` | boolean | Whether this is a simple flag |
|
||||||
| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) |
|
| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) |
|
||||||
| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity |
|
| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity |
|
||||||
| ↳ `usage_dashboard` | number | Usage dashboard ID |
|
| ↳ `usage_dashboard` | number | Usage dashboard ID |
|
||||||
| ↳ `has_enriched_analytics` | boolean | Whether enriched analytics are enabled |
|
| ↳ `has_enriched_analytics` | boolean | Whether enriched analytics are enabled |
|
||||||
|
|
||||||
### `posthog_create_feature_flag`
|
### `posthog_create_feature_flag`
|
||||||
|
|
||||||
@@ -621,7 +621,7 @@ Create a new feature flag in PostHog
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `name` | string | No | Feature flag name \(optional - can be empty\) |
|
| `name` | string | No | Feature flag name \(optional - can be empty\) |
|
||||||
@@ -636,17 +636,17 @@ Create a new feature flag in PostHog
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `flag` | object | Created feature flag |
|
| `flag` | object | Created feature flag |
|
||||||
| ↳ `id` | number | Feature flag ID |
|
| ↳ `id` | number | Feature flag ID |
|
||||||
| ↳ `name` | string | Feature flag name |
|
| ↳ `name` | string | Feature flag name |
|
||||||
| ↳ `key` | string | Feature flag key |
|
| ↳ `key` | string | Feature flag key |
|
||||||
| ↳ `filters` | object | Feature flag filters |
|
| ↳ `filters` | object | Feature flag filters |
|
||||||
| ↳ `deleted` | boolean | Whether the flag is deleted |
|
| ↳ `deleted` | boolean | Whether the flag is deleted |
|
||||||
| ↳ `active` | boolean | Whether the flag is active |
|
| ↳ `active` | boolean | Whether the flag is active |
|
||||||
| ↳ `created_at` | string | Creation timestamp |
|
| ↳ `created_at` | string | Creation timestamp |
|
||||||
| ↳ `created_by` | object | Creator information |
|
| ↳ `created_by` | object | Creator information |
|
||||||
| ↳ `is_simple_flag` | boolean | Whether this is a simple flag |
|
| ↳ `is_simple_flag` | boolean | Whether this is a simple flag |
|
||||||
| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) |
|
| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) |
|
||||||
| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity |
|
| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity |
|
||||||
|
|
||||||
### `posthog_update_feature_flag`
|
### `posthog_update_feature_flag`
|
||||||
|
|
||||||
@@ -656,8 +656,8 @@ Update an existing feature flag in PostHog
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `flagId` | string | Yes | The feature flag ID |
|
| `flagId` | string | Yes | The feature flag ID \(e.g., "42"\) |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `name` | string | No | Feature flag name |
|
| `name` | string | No | Feature flag name |
|
||||||
@@ -672,17 +672,17 @@ Update an existing feature flag in PostHog
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `flag` | object | Updated feature flag |
|
| `flag` | object | Updated feature flag |
|
||||||
| ↳ `id` | number | Feature flag ID |
|
| ↳ `id` | number | Feature flag ID |
|
||||||
| ↳ `name` | string | Feature flag name |
|
| ↳ `name` | string | Feature flag name |
|
||||||
| ↳ `key` | string | Feature flag key |
|
| ↳ `key` | string | Feature flag key |
|
||||||
| ↳ `filters` | object | Feature flag filters |
|
| ↳ `filters` | object | Feature flag filters |
|
||||||
| ↳ `deleted` | boolean | Whether the flag is deleted |
|
| ↳ `deleted` | boolean | Whether the flag is deleted |
|
||||||
| ↳ `active` | boolean | Whether the flag is active |
|
| ↳ `active` | boolean | Whether the flag is active |
|
||||||
| ↳ `created_at` | string | Creation timestamp |
|
| ↳ `created_at` | string | Creation timestamp |
|
||||||
| ↳ `created_by` | object | Creator information |
|
| ↳ `created_by` | object | Creator information |
|
||||||
| ↳ `is_simple_flag` | boolean | Whether this is a simple flag |
|
| ↳ `is_simple_flag` | boolean | Whether this is a simple flag |
|
||||||
| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) |
|
| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) |
|
||||||
| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity |
|
| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity |
|
||||||
|
|
||||||
### `posthog_delete_feature_flag`
|
### `posthog_delete_feature_flag`
|
||||||
|
|
||||||
@@ -692,8 +692,8 @@ Delete a feature flag from PostHog
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `flagId` | string | Yes | The feature flag ID to delete |
|
| `flagId` | string | Yes | The feature flag ID to delete \(e.g., "42"\) |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
|
|
||||||
@@ -714,7 +714,7 @@ Evaluate feature flags for a specific user or group. This is a public endpoint t
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `projectApiKey` | string | Yes | PostHog Project API Key \(not personal API key\) |
|
| `projectApiKey` | string | Yes | PostHog Project API Key \(not personal API key\) |
|
||||||
| `distinctId` | string | Yes | The distinct ID of the user to evaluate flags for |
|
| `distinctId` | string | Yes | The distinct ID of the user to evaluate flags for \(e.g., "user123" or email\) |
|
||||||
| `groups` | string | No | Groups as JSON string \(e.g., \{"company": "company_id_in_your_db"\}\) |
|
| `groups` | string | No | Groups as JSON string \(e.g., \{"company": "company_id_in_your_db"\}\) |
|
||||||
| `personProperties` | string | No | Person properties as JSON string |
|
| `personProperties` | string | No | Person properties as JSON string |
|
||||||
| `groupProperties` | string | No | Group properties as JSON string |
|
| `groupProperties` | string | No | Group properties as JSON string |
|
||||||
@@ -735,11 +735,11 @@ List all experiments in a PostHog project
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `limit` | number | No | Number of results to return |
|
| `limit` | number | No | Number of results to return \(e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | Number of results to skip |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -771,8 +771,8 @@ Get details of a specific experiment
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `experimentId` | string | Yes | The experiment ID |
|
| `experimentId` | string | Yes | The experiment ID \(e.g., "42"\) |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
|
|
||||||
@@ -781,21 +781,21 @@ Get details of a specific experiment
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `experiment` | object | Experiment details |
|
| `experiment` | object | Experiment details |
|
||||||
| ↳ `id` | number | Experiment ID |
|
| ↳ `id` | number | Experiment ID |
|
||||||
| ↳ `name` | string | Experiment name |
|
| ↳ `name` | string | Experiment name |
|
||||||
| ↳ `description` | string | Experiment description |
|
| ↳ `description` | string | Experiment description |
|
||||||
| ↳ `feature_flag_key` | string | Associated feature flag key |
|
| ↳ `feature_flag_key` | string | Associated feature flag key |
|
||||||
| ↳ `feature_flag` | object | Feature flag details |
|
| ↳ `feature_flag` | object | Feature flag details |
|
||||||
| ↳ `parameters` | object | Experiment parameters |
|
| ↳ `parameters` | object | Experiment parameters |
|
||||||
| ↳ `filters` | object | Experiment filters |
|
| ↳ `filters` | object | Experiment filters |
|
||||||
| ↳ `variants` | object | Experiment variants |
|
| ↳ `variants` | object | Experiment variants |
|
||||||
| ↳ `start_date` | string | Start date |
|
| ↳ `start_date` | string | Start date |
|
||||||
| ↳ `end_date` | string | End date |
|
| ↳ `end_date` | string | End date |
|
||||||
| ↳ `created_at` | string | Creation timestamp |
|
| ↳ `created_at` | string | Creation timestamp |
|
||||||
| ↳ `created_by` | object | Creator information |
|
| ↳ `created_by` | object | Creator information |
|
||||||
| ↳ `archived` | boolean | Whether the experiment is archived |
|
| ↳ `archived` | boolean | Whether the experiment is archived |
|
||||||
| ↳ `metrics` | array | Primary metrics |
|
| ↳ `metrics` | array | Primary metrics |
|
||||||
| ↳ `metrics_secondary` | array | Secondary metrics |
|
| ↳ `metrics_secondary` | array | Secondary metrics |
|
||||||
|
|
||||||
### `posthog_create_experiment`
|
### `posthog_create_experiment`
|
||||||
|
|
||||||
@@ -805,7 +805,7 @@ Create a new experiment in PostHog
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | The PostHog project ID |
|
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `name` | string | No | Experiment name \(optional\) |
|
| `name` | string | No | Experiment name \(optional\) |
|
||||||
@@ -822,19 +822,19 @@ Create a new experiment in PostHog
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `experiment` | object | Created experiment |
|
| `experiment` | object | Created experiment |
|
||||||
| ↳ `id` | number | Experiment ID |
|
| ↳ `id` | number | Experiment ID |
|
||||||
| ↳ `name` | string | Experiment name |
|
| ↳ `name` | string | Experiment name |
|
||||||
| ↳ `description` | string | Experiment description |
|
| ↳ `description` | string | Experiment description |
|
||||||
| ↳ `feature_flag_key` | string | Associated feature flag key |
|
| ↳ `feature_flag_key` | string | Associated feature flag key |
|
||||||
| ↳ `feature_flag` | object | Feature flag details |
|
| ↳ `feature_flag` | object | Feature flag details |
|
||||||
| ↳ `parameters` | object | Experiment parameters |
|
| ↳ `parameters` | object | Experiment parameters |
|
||||||
| ↳ `filters` | object | Experiment filters |
|
| ↳ `filters` | object | Experiment filters |
|
||||||
| ↳ `variants` | object | Experiment variants |
|
| ↳ `variants` | object | Experiment variants |
|
||||||
| ↳ `start_date` | string | Start date |
|
| ↳ `start_date` | string | Start date |
|
||||||
| ↳ `end_date` | string | End date |
|
| ↳ `end_date` | string | End date |
|
||||||
| ↳ `created_at` | string | Creation timestamp |
|
| ↳ `created_at` | string | Creation timestamp |
|
||||||
| ↳ `created_by` | object | Creator information |
|
| ↳ `created_by` | object | Creator information |
|
||||||
| ↳ `archived` | boolean | Whether the experiment is archived |
|
| ↳ `archived` | boolean | Whether the experiment is archived |
|
||||||
|
|
||||||
### `posthog_list_surveys`
|
### `posthog_list_surveys`
|
||||||
|
|
||||||
@@ -845,10 +845,10 @@ List all surveys in a PostHog project. Surveys allow you to collect feedback fro
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
||||||
| `limit` | number | No | Number of results to return \(default: 100\) |
|
| `limit` | number | No | Number of results to return \(default: 100, e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -877,8 +877,8 @@ Get details of a specific survey in PostHog by ID.
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `surveyId` | string | Yes | Survey ID to retrieve |
|
| `surveyId` | string | Yes | Survey ID to retrieve \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) |
|
||||||
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -886,19 +886,19 @@ Get details of a specific survey in PostHog by ID.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `survey` | object | Survey details |
|
| `survey` | object | Survey details |
|
||||||
| ↳ `id` | string | Survey ID |
|
| ↳ `id` | string | Survey ID |
|
||||||
| ↳ `name` | string | Survey name |
|
| ↳ `name` | string | Survey name |
|
||||||
| ↳ `description` | string | Survey description |
|
| ↳ `description` | string | Survey description |
|
||||||
| ↳ `type` | string | Survey type \(popover or api\) |
|
| ↳ `type` | string | Survey type \(popover or api\) |
|
||||||
| ↳ `questions` | array | Survey questions |
|
| ↳ `questions` | array | Survey questions |
|
||||||
| ↳ `appearance` | object | Survey appearance configuration |
|
| ↳ `appearance` | object | Survey appearance configuration |
|
||||||
| ↳ `conditions` | object | Survey display conditions |
|
| ↳ `conditions` | object | Survey display conditions |
|
||||||
| ↳ `created_at` | string | Creation timestamp |
|
| ↳ `created_at` | string | Creation timestamp |
|
||||||
| ↳ `created_by` | object | Creator information |
|
| ↳ `created_by` | object | Creator information |
|
||||||
| ↳ `start_date` | string | Survey start date |
|
| ↳ `start_date` | string | Survey start date |
|
||||||
| ↳ `end_date` | string | Survey end date |
|
| ↳ `end_date` | string | Survey end date |
|
||||||
| ↳ `archived` | boolean | Whether survey is archived |
|
| ↳ `archived` | boolean | Whether survey is archived |
|
||||||
| ↳ `responses_limit` | number | Maximum number of responses |
|
| ↳ `responses_limit` | number | Maximum number of responses |
|
||||||
|
|
||||||
### `posthog_create_survey`
|
### `posthog_create_survey`
|
||||||
|
|
||||||
@@ -909,7 +909,7 @@ Create a new survey in PostHog. Supports question types: Basic (open), Link, Rat
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
||||||
| `name` | string | No | Survey name \(optional\) |
|
| `name` | string | No | Survey name \(optional\) |
|
||||||
| `description` | string | No | Survey description |
|
| `description` | string | No | Survey description |
|
||||||
@@ -928,14 +928,14 @@ Create a new survey in PostHog. Supports question types: Basic (open), Link, Rat
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `survey` | object | Created survey details |
|
| `survey` | object | Created survey details |
|
||||||
| ↳ `id` | string | Survey ID |
|
| ↳ `id` | string | Survey ID |
|
||||||
| ↳ `name` | string | Survey name |
|
| ↳ `name` | string | Survey name |
|
||||||
| ↳ `description` | string | Survey description |
|
| ↳ `description` | string | Survey description |
|
||||||
| ↳ `type` | string | Survey type \(popover or api\) |
|
| ↳ `type` | string | Survey type \(popover or api\) |
|
||||||
| ↳ `questions` | array | Survey questions |
|
| ↳ `questions` | array | Survey questions |
|
||||||
| ↳ `created_at` | string | Creation timestamp |
|
| ↳ `created_at` | string | Creation timestamp |
|
||||||
| ↳ `start_date` | string | Survey start date |
|
| ↳ `start_date` | string | Survey start date |
|
||||||
| ↳ `end_date` | string | Survey end date |
|
| ↳ `end_date` | string | Survey end date |
|
||||||
|
|
||||||
### `posthog_update_survey`
|
### `posthog_update_survey`
|
||||||
|
|
||||||
@@ -946,8 +946,8 @@ Update an existing survey in PostHog. Can modify questions, appearance, conditio
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `surveyId` | string | Yes | Survey ID to update |
|
| `surveyId` | string | Yes | Survey ID to update \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) |
|
||||||
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
||||||
| `name` | string | No | Survey name |
|
| `name` | string | No | Survey name |
|
||||||
| `description` | string | No | Survey description |
|
| `description` | string | No | Survey description |
|
||||||
@@ -967,15 +967,15 @@ Update an existing survey in PostHog. Can modify questions, appearance, conditio
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `survey` | object | Updated survey details |
|
| `survey` | object | Updated survey details |
|
||||||
| ↳ `id` | string | Survey ID |
|
| ↳ `id` | string | Survey ID |
|
||||||
| ↳ `name` | string | Survey name |
|
| ↳ `name` | string | Survey name |
|
||||||
| ↳ `description` | string | Survey description |
|
| ↳ `description` | string | Survey description |
|
||||||
| ↳ `type` | string | Survey type \(popover or api\) |
|
| ↳ `type` | string | Survey type \(popover or api\) |
|
||||||
| ↳ `questions` | array | Survey questions |
|
| ↳ `questions` | array | Survey questions |
|
||||||
| ↳ `created_at` | string | Creation timestamp |
|
| ↳ `created_at` | string | Creation timestamp |
|
||||||
| ↳ `start_date` | string | Survey start date |
|
| ↳ `start_date` | string | Survey start date |
|
||||||
| ↳ `end_date` | string | Survey end date |
|
| ↳ `end_date` | string | Survey end date |
|
||||||
| ↳ `archived` | boolean | Whether survey is archived |
|
| ↳ `archived` | boolean | Whether survey is archived |
|
||||||
|
|
||||||
### `posthog_list_session_recordings`
|
### `posthog_list_session_recordings`
|
||||||
|
|
||||||
@@ -986,10 +986,10 @@ List session recordings in a PostHog project. Session recordings capture user in
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
||||||
| `limit` | number | No | Number of results to return \(default: 50\) |
|
| `limit` | number | No | Number of results to return \(default: 50, e.g., 10, 25, 50\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 50, 100\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -1023,8 +1023,8 @@ Get details of a specific session recording in PostHog by ID.
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `recordingId` | string | Yes | Session recording ID to retrieve |
|
| `recordingId` | string | Yes | Session recording ID to retrieve \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) |
|
||||||
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -1032,22 +1032,22 @@ Get details of a specific session recording in PostHog by ID.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `recording` | object | Session recording details |
|
| `recording` | object | Session recording details |
|
||||||
| ↳ `id` | string | Recording ID |
|
| ↳ `id` | string | Recording ID |
|
||||||
| ↳ `distinct_id` | string | User distinct ID |
|
| ↳ `distinct_id` | string | User distinct ID |
|
||||||
| ↳ `viewed` | boolean | Whether recording has been viewed |
|
| ↳ `viewed` | boolean | Whether recording has been viewed |
|
||||||
| ↳ `recording_duration` | number | Recording duration in seconds |
|
| ↳ `recording_duration` | number | Recording duration in seconds |
|
||||||
| ↳ `active_seconds` | number | Active time in seconds |
|
| ↳ `active_seconds` | number | Active time in seconds |
|
||||||
| ↳ `inactive_seconds` | number | Inactive time in seconds |
|
| ↳ `inactive_seconds` | number | Inactive time in seconds |
|
||||||
| ↳ `start_time` | string | Recording start timestamp |
|
| ↳ `start_time` | string | Recording start timestamp |
|
||||||
| ↳ `end_time` | string | Recording end timestamp |
|
| ↳ `end_time` | string | Recording end timestamp |
|
||||||
| ↳ `click_count` | number | Number of clicks |
|
| ↳ `click_count` | number | Number of clicks |
|
||||||
| ↳ `keypress_count` | number | Number of keypresses |
|
| ↳ `keypress_count` | number | Number of keypresses |
|
||||||
| ↳ `console_log_count` | number | Number of console logs |
|
| ↳ `console_log_count` | number | Number of console logs |
|
||||||
| ↳ `console_warn_count` | number | Number of console warnings |
|
| ↳ `console_warn_count` | number | Number of console warnings |
|
||||||
| ↳ `console_error_count` | number | Number of console errors |
|
| ↳ `console_error_count` | number | Number of console errors |
|
||||||
| ↳ `start_url` | string | Starting URL of the recording |
|
| ↳ `start_url` | string | Starting URL of the recording |
|
||||||
| ↳ `person` | object | Person information |
|
| ↳ `person` | object | Person information |
|
||||||
| ↳ `matching_events` | array | Events that occurred during recording |
|
| ↳ `matching_events` | array | Events that occurred during recording |
|
||||||
|
|
||||||
### `posthog_list_recording_playlists`
|
### `posthog_list_recording_playlists`
|
||||||
|
|
||||||
@@ -1058,10 +1058,10 @@ List session recording playlists in a PostHog project. Playlists allow you to or
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
|
||||||
| `limit` | number | No | Number of results to return \(default: 100\) |
|
| `limit` | number | No | Number of results to return \(default: 100, e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | Number of results to skip for pagination |
|
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -1091,11 +1091,11 @@ List all event definitions in a PostHog project. Event definitions represent tra
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `limit` | number | No | Number of results to return per page \(default: 100\) |
|
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | The initial index from which to return results |
|
| `offset` | number | No | The initial index from which to return results \(e.g., 0, 100, 200\) |
|
||||||
| `search` | string | No | Search term to filter event definitions by name |
|
| `search` | string | No | Search term to filter event definitions by name |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -1125,7 +1125,7 @@ Get details of a specific event definition in PostHog. Returns comprehensive inf
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `eventDefinitionId` | string | Yes | Event Definition ID to retrieve |
|
| `eventDefinitionId` | string | Yes | Event Definition ID to retrieve |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
@@ -1156,7 +1156,7 @@ Update an event definition in PostHog. Can modify description, tags, and verific
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `eventDefinitionId` | string | Yes | Event Definition ID to update |
|
| `eventDefinitionId` | string | Yes | Event Definition ID to update |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
@@ -1190,11 +1190,11 @@ List all property definitions in a PostHog project. Property definitions represe
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `limit` | number | No | Number of results to return per page \(default: 100\) |
|
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) |
|
||||||
| `offset` | number | No | The initial index from which to return results |
|
| `offset` | number | No | The initial index from which to return results \(e.g., 0, 100, 200\) |
|
||||||
| `search` | string | No | Search term to filter property definitions by name |
|
| `search` | string | No | Search term to filter property definitions by name |
|
||||||
| `type` | string | No | Filter by property type: event, person, or group |
|
| `type` | string | No | Filter by property type: event, person, or group |
|
||||||
|
|
||||||
@@ -1228,7 +1228,7 @@ Get details of a specific property definition in PostHog. Returns comprehensive
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `propertyDefinitionId` | string | Yes | Property Definition ID to retrieve |
|
| `propertyDefinitionId` | string | Yes | Property Definition ID to retrieve |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
@@ -1263,7 +1263,7 @@ Update a property definition in PostHog. Can modify description, tags, property
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | PostHog Project ID |
|
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `propertyDefinitionId` | string | Yes | Property Definition ID to update |
|
| `propertyDefinitionId` | string | Yes | Property Definition ID to update |
|
||||||
| `region` | string | Yes | PostHog cloud region: us or eu |
|
| `region` | string | Yes | PostHog cloud region: us or eu |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
@@ -1335,7 +1335,7 @@ Get detailed information about a specific project by ID. Returns comprehensive p
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `projectId` | string | Yes | Project ID \(numeric ID or UUID\) |
|
| `projectId` | string | Yes | Project ID \(e.g., "12345" or project UUID\) |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `region` | string | No | Cloud region: us or eu \(default: us\) |
|
| `region` | string | No | Cloud region: us or eu \(default: us\) |
|
||||||
|
|
||||||
@@ -1344,29 +1344,29 @@ Get detailed information about a specific project by ID. Returns comprehensive p
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `project` | object | Detailed project information with all configuration settings |
|
| `project` | object | Detailed project information with all configuration settings |
|
||||||
| ↳ `id` | number | Project ID |
|
| ↳ `id` | number | Project ID |
|
||||||
| ↳ `uuid` | string | Project UUID |
|
| ↳ `uuid` | string | Project UUID |
|
||||||
| ↳ `organization` | string | Organization UUID |
|
| ↳ `organization` | string | Organization UUID |
|
||||||
| ↳ `api_token` | string | Project API token for ingestion |
|
| ↳ `api_token` | string | Project API token for ingestion |
|
||||||
| ↳ `app_urls` | array | Allowed app URLs |
|
| ↳ `app_urls` | array | Allowed app URLs |
|
||||||
| ↳ `name` | string | Project name |
|
| ↳ `name` | string | Project name |
|
||||||
| ↳ `slack_incoming_webhook` | string | Slack webhook URL for notifications |
|
| ↳ `slack_incoming_webhook` | string | Slack webhook URL for notifications |
|
||||||
| ↳ `created_at` | string | Project creation timestamp |
|
| ↳ `created_at` | string | Project creation timestamp |
|
||||||
| ↳ `updated_at` | string | Last update timestamp |
|
| ↳ `updated_at` | string | Last update timestamp |
|
||||||
| ↳ `anonymize_ips` | boolean | Whether IP anonymization is enabled |
|
| ↳ `anonymize_ips` | boolean | Whether IP anonymization is enabled |
|
||||||
| ↳ `completed_snippet_onboarding` | boolean | Whether snippet onboarding is completed |
|
| ↳ `completed_snippet_onboarding` | boolean | Whether snippet onboarding is completed |
|
||||||
| ↳ `ingested_event` | boolean | Whether any event has been ingested |
|
| ↳ `ingested_event` | boolean | Whether any event has been ingested |
|
||||||
| ↳ `test_account_filters` | array | Filters for test accounts |
|
| ↳ `test_account_filters` | array | Filters for test accounts |
|
||||||
| ↳ `is_demo` | boolean | Whether this is a demo project |
|
| ↳ `is_demo` | boolean | Whether this is a demo project |
|
||||||
| ↳ `timezone` | string | Project timezone |
|
| ↳ `timezone` | string | Project timezone |
|
||||||
| ↳ `data_attributes` | array | Custom data attributes |
|
| ↳ `data_attributes` | array | Custom data attributes |
|
||||||
| ↳ `person_display_name_properties` | array | Properties used for person display names |
|
| ↳ `person_display_name_properties` | array | Properties used for person display names |
|
||||||
| ↳ `correlation_config` | object | Configuration for correlation analysis |
|
| ↳ `correlation_config` | object | Configuration for correlation analysis |
|
||||||
| ↳ `autocapture_opt_out` | boolean | Whether autocapture is disabled |
|
| ↳ `autocapture_opt_out` | boolean | Whether autocapture is disabled |
|
||||||
| ↳ `autocapture_exceptions_opt_in` | boolean | Whether exception autocapture is enabled |
|
| ↳ `autocapture_exceptions_opt_in` | boolean | Whether exception autocapture is enabled |
|
||||||
| ↳ `session_recording_opt_in` | boolean | Whether session recording is enabled |
|
| ↳ `session_recording_opt_in` | boolean | Whether session recording is enabled |
|
||||||
| ↳ `capture_console_log_opt_in` | boolean | Whether console log capture is enabled |
|
| ↳ `capture_console_log_opt_in` | boolean | Whether console log capture is enabled |
|
||||||
| ↳ `capture_performance_opt_in` | boolean | Whether performance capture is enabled |
|
| ↳ `capture_performance_opt_in` | boolean | Whether performance capture is enabled |
|
||||||
|
|
||||||
### `posthog_list_organizations`
|
### `posthog_list_organizations`
|
||||||
|
|
||||||
@@ -1402,7 +1402,7 @@ Get detailed information about a specific organization by ID. Returns comprehens
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `organizationId` | string | Yes | Organization ID \(UUID\) |
|
| `organizationId` | string | Yes | Organization ID \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) |
|
||||||
| `apiKey` | string | Yes | PostHog Personal API Key |
|
| `apiKey` | string | Yes | PostHog Personal API Key |
|
||||||
| `region` | string | No | Cloud region: us or eu \(default: us\) |
|
| `region` | string | No | Cloud region: us or eu \(default: us\) |
|
||||||
|
|
||||||
@@ -1411,20 +1411,20 @@ Get detailed information about a specific organization by ID. Returns comprehens
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `organization` | object | Detailed organization information with settings and features |
|
| `organization` | object | Detailed organization information with settings and features |
|
||||||
| ↳ `id` | string | Organization ID \(UUID\) |
|
| ↳ `id` | string | Organization ID \(UUID\) |
|
||||||
| ↳ `name` | string | Organization name |
|
| ↳ `name` | string | Organization name |
|
||||||
| ↳ `slug` | string | Organization slug |
|
| ↳ `slug` | string | Organization slug |
|
||||||
| ↳ `created_at` | string | Organization creation timestamp |
|
| ↳ `created_at` | string | Organization creation timestamp |
|
||||||
| ↳ `updated_at` | string | Last update timestamp |
|
| ↳ `updated_at` | string | Last update timestamp |
|
||||||
| ↳ `membership_level` | number | User membership level in organization |
|
| ↳ `membership_level` | number | User membership level in organization |
|
||||||
| ↳ `plugins_access_level` | number | Access level for plugins/apps |
|
| ↳ `plugins_access_level` | number | Access level for plugins/apps |
|
||||||
| ↳ `teams` | array | List of team IDs in this organization |
|
| ↳ `teams` | array | List of team IDs in this organization |
|
||||||
| ↳ `available_product_features` | array | Available product features with their limits and descriptions |
|
| ↳ `available_product_features` | array | Available product features with their limits and descriptions |
|
||||||
| ↳ `domain_whitelist` | array | Whitelisted domains for organization |
|
| ↳ `domain_whitelist` | array | Whitelisted domains for organization |
|
||||||
| ↳ `is_member_join_email_enabled` | boolean | Whether member join emails are enabled |
|
| ↳ `is_member_join_email_enabled` | boolean | Whether member join emails are enabled |
|
||||||
| ↳ `metadata` | object | Organization metadata |
|
| ↳ `metadata` | object | Organization metadata |
|
||||||
| ↳ `customer_id` | string | Customer ID for billing |
|
| ↳ `customer_id` | string | Customer ID for billing |
|
||||||
| ↳ `available_features` | array | List of available feature flags for organization |
|
| ↳ `available_features` | array | List of available feature flags for organization |
|
||||||
| ↳ `usage` | object | Organization usage statistics |
|
| ↳ `usage` | object | Organization usage statistics |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -47,17 +47,19 @@ Insert or update points in a Qdrant collection
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `url` | string | Yes | Qdrant base URL |
|
| `url` | string | Yes | Qdrant instance URL \(e.g., https://your-cluster.qdrant.io\) |
|
||||||
| `apiKey` | string | No | Qdrant API key \(optional\) |
|
| `apiKey` | string | No | Qdrant API key for authentication |
|
||||||
| `collection` | string | Yes | Collection name |
|
| `collection` | string | Yes | Collection name for upsert \(e.g., "my_collection"\) |
|
||||||
| `points` | array | Yes | Array of points to upsert |
|
| `points` | array | Yes | Array of points to upsert |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `status` | string | Status of the upsert operation |
|
| `status` | string | Operation status \(ok, error\) |
|
||||||
| `data` | object | Result data from the upsert operation |
|
| `data` | object | Result data from the upsert operation |
|
||||||
|
| ↳ `operation_id` | number | Operation ID for async tracking |
|
||||||
|
| ↳ `status` | string | Operation status \(acknowledged, completed\) |
|
||||||
|
|
||||||
### `qdrant_search_vector`
|
### `qdrant_search_vector`
|
||||||
|
|
||||||
@@ -67,12 +69,12 @@ Search for similar vectors in a Qdrant collection
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `url` | string | Yes | Qdrant base URL |
|
| `url` | string | Yes | Qdrant instance URL \(e.g., https://your-cluster.qdrant.io\) |
|
||||||
| `apiKey` | string | No | Qdrant API key \(optional\) |
|
| `apiKey` | string | No | Qdrant API key for authentication |
|
||||||
| `collection` | string | Yes | Collection name |
|
| `collection` | string | Yes | Collection name to search \(e.g., "my_collection"\) |
|
||||||
| `vector` | array | Yes | Vector to search for |
|
| `vector` | array | Yes | Query vector for similarity search \(e.g., \[0.1, 0.2, 0.3, ...\]\) |
|
||||||
| `limit` | number | No | Number of results to return |
|
| `limit` | number | No | Maximum number of results to return \(e.g., 10\) |
|
||||||
| `filter` | object | No | Filter to apply to the search |
|
| `filter` | object | No | Qdrant filter object \(e.g., \{"must": \[\{"key": "field", "match": \{"value": "val"\}\}\]\}\) |
|
||||||
| `search_return_data` | string | No | Data to return from search |
|
| `search_return_data` | string | No | Data to return from search |
|
||||||
| `with_payload` | boolean | No | Include payload in response |
|
| `with_payload` | boolean | No | Include payload in response |
|
||||||
| `with_vector` | boolean | No | Include vector in response |
|
| `with_vector` | boolean | No | Include vector in response |
|
||||||
@@ -81,8 +83,15 @@ Search for similar vectors in a Qdrant collection
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
|
| `status` | string | Operation status \(ok, error\) |
|
||||||
| `data` | array | Vector search results with ID, score, payload, and optional vector data |
|
| `data` | array | Vector search results with ID, score, payload, and optional vector data |
|
||||||
| `status` | string | Status of the search operation |
|
| ↳ `id` | string | Point ID \(integer or UUID string\) |
|
||||||
|
| ↳ `version` | number | Point version number |
|
||||||
|
| ↳ `score` | number | Similarity score |
|
||||||
|
| ↳ `payload` | json | Point payload data \(key-value pairs\) |
|
||||||
|
| ↳ `vector` | json | Point vector\(s\) - single array or named vectors object |
|
||||||
|
| ↳ `shard_key` | string | Shard key for routing |
|
||||||
|
| ↳ `order_value` | number | Order value for sorting |
|
||||||
|
|
||||||
### `qdrant_fetch_points`
|
### `qdrant_fetch_points`
|
||||||
|
|
||||||
@@ -92,10 +101,10 @@ Fetch points by ID from a Qdrant collection
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `url` | string | Yes | Qdrant base URL |
|
| `url` | string | Yes | Qdrant instance URL \(e.g., https://your-cluster.qdrant.io\) |
|
||||||
| `apiKey` | string | No | Qdrant API key \(optional\) |
|
| `apiKey` | string | No | Qdrant API key for authentication |
|
||||||
| `collection` | string | Yes | Collection name |
|
| `collection` | string | Yes | Collection name to fetch from \(e.g., "my_collection"\) |
|
||||||
| `ids` | array | Yes | Array of point IDs to fetch |
|
| `ids` | array | Yes | Array of point IDs to fetch \(e.g., \["id1", "id2"\] or \[1, 2\]\) |
|
||||||
| `fetch_return_data` | string | No | Data to return from fetch |
|
| `fetch_return_data` | string | No | Data to return from fetch |
|
||||||
| `with_payload` | boolean | No | Include payload in response |
|
| `with_payload` | boolean | No | Include payload in response |
|
||||||
| `with_vector` | boolean | No | Include vector in response |
|
| `with_vector` | boolean | No | Include vector in response |
|
||||||
@@ -104,7 +113,12 @@ Fetch points by ID from a Qdrant collection
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
|
| `status` | string | Operation status \(ok, error\) |
|
||||||
| `data` | array | Fetched points with ID, payload, and optional vector data |
|
| `data` | array | Fetched points with ID, payload, and optional vector data |
|
||||||
| `status` | string | Status of the fetch operation |
|
| ↳ `id` | string | Point ID \(integer or UUID string\) |
|
||||||
|
| ↳ `payload` | json | Point payload data \(key-value pairs\) |
|
||||||
|
| ↳ `vector` | json | Point vector\(s\) - single array or named vectors object |
|
||||||
|
| ↳ `shard_key` | string | Shard key for routing |
|
||||||
|
| ↳ `order_value` | number | Order value for sorting |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -52,10 +52,10 @@ Execute a SELECT query on Amazon RDS using the Data API
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) |
|
||||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||||
| `database` | string | No | Database name \(optional\) |
|
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) |
|
||||||
| `query` | string | Yes | SQL SELECT query to execute |
|
| `query` | string | Yes | SQL SELECT query to execute \(e.g., SELECT * FROM users WHERE status = :status\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -76,9 +76,9 @@ Insert data into an Amazon RDS table using the Data API
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) |
|
||||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||||
| `database` | string | No | Database name \(optional\) |
|
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) |
|
||||||
| `table` | string | Yes | Table name to insert into |
|
| `table` | string | Yes | Table name to insert into |
|
||||||
| `data` | object | Yes | Data to insert as key-value pairs |
|
| `data` | object | Yes | Data to insert as key-value pairs |
|
||||||
|
|
||||||
@@ -101,9 +101,9 @@ Update data in an Amazon RDS table using the Data API
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) |
|
||||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||||
| `database` | string | No | Database name \(optional\) |
|
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) |
|
||||||
| `table` | string | Yes | Table name to update |
|
| `table` | string | Yes | Table name to update |
|
||||||
| `data` | object | Yes | Data to update as key-value pairs |
|
| `data` | object | Yes | Data to update as key-value pairs |
|
||||||
| `conditions` | object | Yes | Conditions for the update \(e.g., \{"id": 1\}\) |
|
| `conditions` | object | Yes | Conditions for the update \(e.g., \{"id": 1\}\) |
|
||||||
@@ -127,9 +127,9 @@ Delete data from an Amazon RDS table using the Data API
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) |
|
||||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||||
| `database` | string | No | Database name \(optional\) |
|
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) |
|
||||||
| `table` | string | Yes | Table name to delete from |
|
| `table` | string | Yes | Table name to delete from |
|
||||||
| `conditions` | object | Yes | Conditions for the delete \(e.g., \{"id": 1\}\) |
|
| `conditions` | object | Yes | Conditions for the delete \(e.g., \{"id": 1\}\) |
|
||||||
|
|
||||||
@@ -152,10 +152,10 @@ Execute raw SQL on Amazon RDS using the Data API
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) |
|
||||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||||
| `database` | string | No | Database name \(optional\) |
|
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) |
|
||||||
| `query` | string | Yes | Raw SQL query to execute |
|
| `query` | string | Yes | Raw SQL query to execute \(e.g., CREATE TABLE users \(id SERIAL PRIMARY KEY, name VARCHAR\(255\)\)\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -176,9 +176,9 @@ Introspect Amazon RDS Aurora database schema to retrieve table structures, colum
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) |
|
||||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||||
| `database` | string | No | Database name \(optional\) |
|
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) |
|
||||||
| `schema` | string | No | Schema to introspect \(default: public for PostgreSQL, database name for MySQL\) |
|
| `schema` | string | No | Schema to introspect \(default: public for PostgreSQL, database name for MySQL\) |
|
||||||
| `engine` | string | No | Database engine \(aurora-postgresql or aurora-mysql\). Auto-detected if not provided. |
|
| `engine` | string | No | Database engine \(aurora-postgresql or aurora-mysql\). Auto-detected if not provided. |
|
||||||
|
|
||||||
|
|||||||
@@ -38,9 +38,9 @@ Fetch posts from a subreddit with different sorting options
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `subreddit` | string | Yes | The name of the subreddit to fetch posts from \(without the r/ prefix\) |
|
| `subreddit` | string | Yes | The subreddit to fetch posts from \(e.g., "technology", "news"\) |
|
||||||
| `sort` | string | No | Sort method for posts: "hot", "new", "top", or "rising" \(default: "hot"\) |
|
| `sort` | string | No | Sort method for posts \(e.g., "hot", "new", "top", "rising"\). Default: "hot" |
|
||||||
| `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) |
|
| `limit` | number | No | Maximum number of posts to return \(e.g., 25\). Default: 10, max: 100 |
|
||||||
| `time` | string | No | Time filter for "top" sorted posts: "day", "week", "month", "year", or "all" \(default: "day"\) |
|
| `time` | string | No | Time filter for "top" sorted posts: "day", "week", "month", "year", or "all" \(default: "day"\) |
|
||||||
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
|
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
|
||||||
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
|
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
|
||||||
@@ -75,10 +75,10 @@ Fetch comments from a specific Reddit post
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `postId` | string | Yes | The ID of the Reddit post to fetch comments from |
|
| `postId` | string | Yes | The ID of the Reddit post to fetch comments from \(e.g., "abc123"\) |
|
||||||
| `subreddit` | string | Yes | The subreddit where the post is located \(without the r/ prefix\) |
|
| `subreddit` | string | Yes | The subreddit where the post is located \(e.g., "technology", "programming"\) |
|
||||||
| `sort` | string | No | Sort method for comments: "confidence", "top", "new", "controversial", "old", "random", "qa" \(default: "confidence"\) |
|
| `sort` | string | No | Sort method for comments: "confidence", "top", "new", "controversial", "old", "random", "qa" \(default: "confidence"\) |
|
||||||
| `limit` | number | No | Maximum number of comments to return \(default: 50, max: 100\) |
|
| `limit` | number | No | Maximum number of comments to return \(e.g., 25\). Default: 50, max: 100 |
|
||||||
| `depth` | number | No | Maximum depth of subtrees in the thread \(controls nested comment levels\) |
|
| `depth` | number | No | Maximum depth of subtrees in the thread \(controls nested comment levels\) |
|
||||||
| `context` | number | No | Number of parent comments to include |
|
| `context` | number | No | Number of parent comments to include |
|
||||||
| `showedits` | boolean | No | Show edit information for comments |
|
| `showedits` | boolean | No | Show edit information for comments |
|
||||||
@@ -95,13 +95,13 @@ Fetch comments from a specific Reddit post
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `post` | object | Post information including ID, title, author, content, and metadata |
|
| `post` | object | Post information including ID, title, author, content, and metadata |
|
||||||
| ↳ `id` | string | Post ID |
|
| ↳ `id` | string | Post ID |
|
||||||
| ↳ `title` | string | Post title |
|
| ↳ `title` | string | Post title |
|
||||||
| ↳ `author` | string | Post author |
|
| ↳ `author` | string | Post author |
|
||||||
| ↳ `selftext` | string | Post text content |
|
| ↳ `selftext` | string | Post text content |
|
||||||
| ↳ `score` | number | Post score |
|
| ↳ `score` | number | Post score |
|
||||||
| ↳ `created_utc` | number | Creation timestamp |
|
| ↳ `created_utc` | number | Creation timestamp |
|
||||||
| ↳ `permalink` | string | Reddit permalink |
|
| ↳ `permalink` | string | Reddit permalink |
|
||||||
| `comments` | array | Nested comments with author, body, score, timestamps, and replies |
|
| `comments` | array | Nested comments with author, body, score, timestamps, and replies |
|
||||||
| ↳ `id` | string | Comment ID |
|
| ↳ `id` | string | Comment ID |
|
||||||
| ↳ `author` | string | Comment author |
|
| ↳ `author` | string | Comment author |
|
||||||
@@ -119,9 +119,9 @@ Fetch controversial posts from a subreddit
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `subreddit` | string | Yes | The name of the subreddit to fetch posts from \(without the r/ prefix\) |
|
| `subreddit` | string | Yes | The subreddit to fetch posts from \(e.g., "technology", "news"\) |
|
||||||
| `time` | string | No | Time filter for controversial posts: "hour", "day", "week", "month", "year", or "all" \(default: "all"\) |
|
| `time` | string | No | Time filter for controversial posts: "hour", "day", "week", "month", "year", or "all" \(default: "all"\) |
|
||||||
| `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) |
|
| `limit` | number | No | Maximum number of posts to return \(e.g., 25\). Default: 10, max: 100 |
|
||||||
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
|
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
|
||||||
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
|
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
|
||||||
| `count` | number | No | A count of items already seen in the listing \(used for numbering\) |
|
| `count` | number | No | A count of items already seen in the listing \(used for numbering\) |
|
||||||
@@ -155,11 +155,11 @@ Search for posts within a subreddit
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `subreddit` | string | Yes | The name of the subreddit to search in \(without the r/ prefix\) |
|
| `subreddit` | string | Yes | The subreddit to search in \(e.g., "technology", "programming"\) |
|
||||||
| `query` | string | Yes | Search query text |
|
| `query` | string | Yes | Search query text \(e.g., "artificial intelligence", "machine learning tutorial"\) |
|
||||||
| `sort` | string | No | Sort method for search results: "relevance", "hot", "top", "new", or "comments" \(default: "relevance"\) |
|
| `sort` | string | No | Sort method for search results \(e.g., "relevance", "hot", "top", "new", "comments"\). Default: "relevance" |
|
||||||
| `time` | string | No | Time filter for search results: "hour", "day", "week", "month", "year", or "all" \(default: "all"\) |
|
| `time` | string | No | Time filter for search results: "hour", "day", "week", "month", "year", or "all" \(default: "all"\) |
|
||||||
| `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) |
|
| `limit` | number | No | Maximum number of posts to return \(e.g., 25\). Default: 10, max: 100 |
|
||||||
| `restrict_sr` | boolean | No | Restrict search to the specified subreddit only \(default: true\) |
|
| `restrict_sr` | boolean | No | Restrict search to the specified subreddit only \(default: true\) |
|
||||||
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
|
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
|
||||||
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
|
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
|
||||||
@@ -193,9 +193,9 @@ Submit a new post to a subreddit (text or link)
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `subreddit` | string | Yes | The name of the subreddit to post to \(without the r/ prefix\) |
|
| `subreddit` | string | Yes | The subreddit to post to \(e.g., "technology", "programming"\) |
|
||||||
| `title` | string | Yes | Title of the submission \(max 300 characters\) |
|
| `title` | string | Yes | Title of the submission \(e.g., "Check out this new AI tool"\). Max 300 characters |
|
||||||
| `text` | string | No | Text content for a self post \(markdown supported\) |
|
| `text` | string | No | Text content for a self post in markdown format \(e.g., "This is the **body** of my post"\) |
|
||||||
| `url` | string | No | URL for a link post \(cannot be used with text\) |
|
| `url` | string | No | URL for a link post \(cannot be used with text\) |
|
||||||
| `nsfw` | boolean | No | Mark post as NSFW |
|
| `nsfw` | boolean | No | Mark post as NSFW |
|
||||||
| `spoiler` | boolean | No | Mark post as spoiler |
|
| `spoiler` | boolean | No | Mark post as spoiler |
|
||||||
@@ -208,6 +208,10 @@ Submit a new post to a subreddit (text or link)
|
|||||||
| `success` | boolean | Whether the post was submitted successfully |
|
| `success` | boolean | Whether the post was submitted successfully |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Post data including ID, name, URL, and permalink |
|
| `data` | object | Post data including ID, name, URL, and permalink |
|
||||||
|
| ↳ `id` | string | New post ID |
|
||||||
|
| ↳ `name` | string | Thing fullname \(t3_xxxxx\) |
|
||||||
|
| ↳ `url` | string | Post URL from API response |
|
||||||
|
| ↳ `permalink` | string | Full Reddit permalink |
|
||||||
|
|
||||||
### `reddit_vote`
|
### `reddit_vote`
|
||||||
|
|
||||||
@@ -217,7 +221,7 @@ Upvote, downvote, or unvote a Reddit post or comment
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | string | Yes | Thing fullname to vote on \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
|
| `id` | string | Yes | Thing fullname to vote on \(e.g., "t3_abc123" for post, "t1_def456" for comment\) |
|
||||||
| `dir` | number | Yes | Vote direction: 1 \(upvote\), 0 \(unvote\), or -1 \(downvote\) |
|
| `dir` | number | Yes | Vote direction: 1 \(upvote\), 0 \(unvote\), or -1 \(downvote\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -235,7 +239,7 @@ Save a Reddit post or comment to your saved items
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | string | Yes | Thing fullname to save \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
|
| `id` | string | Yes | Thing fullname to save \(e.g., "t3_abc123" for post, "t1_def456" for comment\) |
|
||||||
| `category` | string | No | Category to save under \(Reddit Gold feature\) |
|
| `category` | string | No | Category to save under \(Reddit Gold feature\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -269,8 +273,8 @@ Add a comment reply to a Reddit post or comment
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `parent_id` | string | Yes | Thing fullname to reply to \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
|
| `parent_id` | string | Yes | Thing fullname to reply to \(e.g., "t3_abc123" for post, "t1_def456" for comment\) |
|
||||||
| `text` | string | Yes | Comment text in markdown format |
|
| `text` | string | Yes | Comment text in markdown format \(e.g., "Great post! Here is my **reply**"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -279,6 +283,10 @@ Add a comment reply to a Reddit post or comment
|
|||||||
| `success` | boolean | Whether the reply was posted successfully |
|
| `success` | boolean | Whether the reply was posted successfully |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Comment data including ID, name, permalink, and body |
|
| `data` | object | Comment data including ID, name, permalink, and body |
|
||||||
|
| ↳ `id` | string | New comment ID |
|
||||||
|
| ↳ `name` | string | Thing fullname \(t1_xxxxx\) |
|
||||||
|
| ↳ `permalink` | string | Comment permalink |
|
||||||
|
| ↳ `body` | string | Comment body text |
|
||||||
|
|
||||||
### `reddit_edit`
|
### `reddit_edit`
|
||||||
|
|
||||||
@@ -288,8 +296,8 @@ Edit the text of your own Reddit post or comment
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `thing_id` | string | Yes | Thing fullname to edit \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
|
| `thing_id` | string | Yes | Thing fullname to edit \(e.g., "t3_abc123" for post, "t1_def456" for comment\) |
|
||||||
| `text` | string | Yes | New text content in markdown format |
|
| `text` | string | Yes | New text content in markdown format \(e.g., "Updated **content** here"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -298,6 +306,9 @@ Edit the text of your own Reddit post or comment
|
|||||||
| `success` | boolean | Whether the edit was successful |
|
| `success` | boolean | Whether the edit was successful |
|
||||||
| `message` | string | Success or error message |
|
| `message` | string | Success or error message |
|
||||||
| `data` | object | Updated content data |
|
| `data` | object | Updated content data |
|
||||||
|
| ↳ `id` | string | Edited thing ID |
|
||||||
|
| ↳ `body` | string | Updated comment body \(for comments\) |
|
||||||
|
| ↳ `selftext` | string | Updated post text \(for self posts\) |
|
||||||
|
|
||||||
### `reddit_delete`
|
### `reddit_delete`
|
||||||
|
|
||||||
@@ -307,7 +318,7 @@ Delete your own Reddit post or comment
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | string | Yes | Thing fullname to delete \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
|
| `id` | string | Yes | Thing fullname to delete \(e.g., "t3_abc123" for post, "t1_def456" for comment\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -324,7 +335,7 @@ Subscribe or unsubscribe from a subreddit
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `subreddit` | string | Yes | The name of the subreddit \(without the r/ prefix\) |
|
| `subreddit` | string | Yes | The subreddit to subscribe to or unsubscribe from \(e.g., "technology", "programming"\) |
|
||||||
| `action` | string | Yes | Action to perform: "sub" to subscribe or "unsub" to unsubscribe |
|
| `action` | string | Yes | Action to perform: "sub" to subscribe or "unsub" to unsubscribe |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|||||||
@@ -41,11 +41,11 @@ Send an email using your own Resend API key and from address
|
|||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `fromAddress` | string | Yes | Email address to send from |
|
| `fromAddress` | string | Yes | Email address to send from \(e.g., "sender@example.com" or "Sender Name <sender@example.com>"\) |
|
||||||
| `to` | string | Yes | Recipient email address |
|
| `to` | string | Yes | Recipient email address \(e.g., "recipient@example.com" or "Recipient Name <recipient@example.com>"\) |
|
||||||
| `subject` | string | Yes | Email subject |
|
| `subject` | string | Yes | Email subject line |
|
||||||
| `body` | string | Yes | Email body content |
|
| `body` | string | Yes | Email body content \(plain text or HTML based on contentType\) |
|
||||||
| `contentType` | string | No | Content type for the email body \(text or html\) |
|
| `contentType` | string | No | Content type for the email body: "text" for plain text or "html" for HTML content |
|
||||||
| `resendApiKey` | string | Yes | Resend API key for sending emails |
|
| `resendApiKey` | string | Yes | Resend API key for sending emails |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ Upload a file to an AWS S3 bucket
|
|||||||
| `accessKeyId` | string | Yes | Your AWS Access Key ID |
|
| `accessKeyId` | string | Yes | Your AWS Access Key ID |
|
||||||
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
|
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
|
||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `bucketName` | string | Yes | S3 bucket name |
|
| `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) |
|
||||||
| `objectKey` | string | Yes | Object key/path in S3 \(e.g., folder/filename.ext\) |
|
| `objectKey` | string | Yes | Object key/path in S3 \(e.g., folder/filename.ext\) |
|
||||||
| `file` | file | No | File to upload |
|
| `file` | file | No | File to upload |
|
||||||
| `content` | string | No | Text content to upload \(alternative to file\) |
|
| `content` | string | No | Text content to upload \(alternative to file\) |
|
||||||
@@ -71,7 +71,7 @@ Retrieve an object from an AWS S3 bucket
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `accessKeyId` | string | Yes | Your AWS Access Key ID |
|
| `accessKeyId` | string | Yes | Your AWS Access Key ID |
|
||||||
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
|
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
|
||||||
| `s3Uri` | string | Yes | S3 Object URL |
|
| `s3Uri` | string | Yes | S3 Object URL \(e.g., https://bucket.s3.region.amazonaws.com/path/to/file\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -91,10 +91,10 @@ List objects in an AWS S3 bucket
|
|||||||
| `accessKeyId` | string | Yes | Your AWS Access Key ID |
|
| `accessKeyId` | string | Yes | Your AWS Access Key ID |
|
||||||
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
|
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
|
||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `bucketName` | string | Yes | S3 bucket name |
|
| `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) |
|
||||||
| `prefix` | string | No | Prefix to filter objects \(e.g., folder/\) |
|
| `prefix` | string | No | Prefix to filter objects \(e.g., folder/, images/2024/\) |
|
||||||
| `maxKeys` | number | No | Maximum number of objects to return \(default: 1000\) |
|
| `maxKeys` | number | No | Maximum number of objects to return \(default: 1000\) |
|
||||||
| `continuationToken` | string | No | Token for pagination |
|
| `continuationToken` | string | No | Token for pagination from previous list response |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -118,8 +118,8 @@ Delete an object from an AWS S3 bucket
|
|||||||
| `accessKeyId` | string | Yes | Your AWS Access Key ID |
|
| `accessKeyId` | string | Yes | Your AWS Access Key ID |
|
||||||
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
|
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
|
||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `bucketName` | string | Yes | S3 bucket name |
|
| `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) |
|
||||||
| `objectKey` | string | Yes | Object key/path to delete |
|
| `objectKey` | string | Yes | Object key/path to delete \(e.g., folder/file.txt\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -139,10 +139,10 @@ Copy an object within or between AWS S3 buckets
|
|||||||
| `accessKeyId` | string | Yes | Your AWS Access Key ID |
|
| `accessKeyId` | string | Yes | Your AWS Access Key ID |
|
||||||
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
|
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
|
||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `sourceBucket` | string | Yes | Source bucket name |
|
| `sourceBucket` | string | Yes | Source bucket name \(e.g., my-bucket\) |
|
||||||
| `sourceKey` | string | Yes | Source object key/path |
|
| `sourceKey` | string | Yes | Source object key/path \(e.g., folder/file.txt\) |
|
||||||
| `destinationBucket` | string | Yes | Destination bucket name |
|
| `destinationBucket` | string | Yes | Destination bucket name \(e.g., my-other-bucket\) |
|
||||||
| `destinationKey` | string | Yes | Destination object key/path |
|
| `destinationKey` | string | Yes | Destination object key/path \(e.g., backup/file.txt\) |
|
||||||
| `acl` | string | No | Access control list for the copied object \(e.g., private, public-read\) |
|
| `acl` | string | No | Access control list for the copied object \(e.g., private, public-read\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|||||||
@@ -43,9 +43,9 @@ Retrieve accounts from Salesforce CRM
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | The ID token from Salesforce OAuth \(contains instance URL\) |
|
| `idToken` | string | No | The ID token from Salesforce OAuth \(contains instance URL\) |
|
||||||
| `instanceUrl` | string | No | The Salesforce instance URL |
|
| `instanceUrl` | string | No | The Salesforce instance URL |
|
||||||
| `limit` | string | No | Number of results to return \(default: 100, max: 2000\) |
|
| `limit` | string | No | Maximum number of results \(default: 100, max: 2000\) |
|
||||||
| `fields` | string | No | Comma-separated list of fields to return \(e.g., "Id,Name,Industry,Phone"\) |
|
| `fields` | string | No | Comma-separated field API names \(e.g., "Id,Name,Industry,Phone"\) |
|
||||||
| `orderBy` | string | No | Field to order by \(e.g., "Name ASC" or "CreatedDate DESC"\) |
|
| `orderBy` | string | No | Field and direction for sorting \(e.g., "Name ASC" or "CreatedDate DESC"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -53,15 +53,15 @@ Retrieve accounts from Salesforce CRM
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Accounts data |
|
| `output` | object | Accounts data |
|
||||||
| ↳ `accounts` | array | Array of account objects |
|
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||||
| ↳ `paging` | object | Pagination information |
|
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||||
| ↳ `totalSize` | number | Total number of records |
|
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||||
| ↳ `done` | boolean | Whether all records returned |
|
| ↳ `metadata` | object | Response metadata |
|
||||||
| ↳ `metadata` | object | Response metadata |
|
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||||
| ↳ `totalReturned` | number | Number of accounts returned |
|
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
| ↳ `accounts` | array | Array of account objects |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
|
|
||||||
### `salesforce_create_account`
|
### `salesforce_create_account`
|
||||||
|
|
||||||
@@ -84,8 +84,8 @@ Create a new account in Salesforce CRM
|
|||||||
| `billingPostalCode` | string | No | Billing postal code |
|
| `billingPostalCode` | string | No | Billing postal code |
|
||||||
| `billingCountry` | string | No | Billing country |
|
| `billingCountry` | string | No | Billing country |
|
||||||
| `description` | string | No | Account description |
|
| `description` | string | No | Account description |
|
||||||
| `annualRevenue` | string | No | Annual revenue \(number\) |
|
| `annualRevenue` | string | No | Annual revenue as a number |
|
||||||
| `numberOfEmployees` | string | No | Number of employees \(number\) |
|
| `numberOfEmployees` | string | No | Number of employees as an integer |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -93,9 +93,9 @@ Create a new account in Salesforce CRM
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Created account data |
|
| `output` | object | Created account data |
|
||||||
| ↳ `id` | string | Created account ID |
|
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||||
| ↳ `created` | boolean | Whether account was created |
|
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_update_account`
|
### `salesforce_update_account`
|
||||||
|
|
||||||
@@ -107,10 +107,10 @@ Update an existing account in Salesforce CRM
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `accountId` | string | Yes | Account ID to update \(required\) |
|
| `accountId` | string | Yes | Salesforce Account ID to update \(18-character string starting with 001\) |
|
||||||
| `name` | string | No | Account name |
|
| `name` | string | No | Account name |
|
||||||
| `type` | string | No | Account type |
|
| `type` | string | No | Account type \(e.g., Customer, Partner, Prospect\) |
|
||||||
| `industry` | string | No | Industry |
|
| `industry` | string | No | Industry \(e.g., Technology, Healthcare, Finance\) |
|
||||||
| `phone` | string | No | Phone number |
|
| `phone` | string | No | Phone number |
|
||||||
| `website` | string | No | Website URL |
|
| `website` | string | No | Website URL |
|
||||||
| `billingStreet` | string | No | Billing street address |
|
| `billingStreet` | string | No | Billing street address |
|
||||||
@@ -119,8 +119,8 @@ Update an existing account in Salesforce CRM
|
|||||||
| `billingPostalCode` | string | No | Billing postal code |
|
| `billingPostalCode` | string | No | Billing postal code |
|
||||||
| `billingCountry` | string | No | Billing country |
|
| `billingCountry` | string | No | Billing country |
|
||||||
| `description` | string | No | Account description |
|
| `description` | string | No | Account description |
|
||||||
| `annualRevenue` | string | No | Annual revenue \(number\) |
|
| `annualRevenue` | string | No | Annual revenue as a number |
|
||||||
| `numberOfEmployees` | string | No | Number of employees \(number\) |
|
| `numberOfEmployees` | string | No | Number of employees as an integer |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -128,8 +128,8 @@ Update an existing account in Salesforce CRM
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Updated account data |
|
| `output` | object | Updated account data |
|
||||||
| ↳ `id` | string | Updated account ID |
|
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||||
| ↳ `updated` | boolean | Whether account was updated |
|
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_delete_account`
|
### `salesforce_delete_account`
|
||||||
|
|
||||||
@@ -141,7 +141,7 @@ Delete an account from Salesforce CRM
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `accountId` | string | Yes | Account ID to delete \(required\) |
|
| `accountId` | string | Yes | Salesforce Account ID to delete \(18-character string starting with 001\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -149,8 +149,8 @@ Delete an account from Salesforce CRM
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Deleted account data |
|
| `output` | object | Deleted account data |
|
||||||
| ↳ `id` | string | Deleted account ID |
|
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||||
| ↳ `deleted` | boolean | Whether account was deleted |
|
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_get_contacts`
|
### `salesforce_get_contacts`
|
||||||
|
|
||||||
@@ -162,10 +162,10 @@ Get contact(s) from Salesforce - single contact if ID provided, or list if not
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `contactId` | string | No | Contact ID \(if provided, returns single contact\) |
|
| `contactId` | string | No | Salesforce Contact ID \(18-character string starting with 003\) to get a single contact |
|
||||||
| `limit` | string | No | Number of results \(default: 100, max: 2000\). Only for list query. |
|
| `limit` | string | No | Maximum number of results \(default: 100, max: 2000\). Only for list query. |
|
||||||
| `fields` | string | No | Comma-separated fields \(e.g., "Id,FirstName,LastName,Email,Phone"\) |
|
| `fields` | string | No | Comma-separated field API names \(e.g., "Id,FirstName,LastName,Email,Phone"\) |
|
||||||
| `orderBy` | string | No | Order by field \(e.g., "LastName ASC"\). Only for list query. |
|
| `orderBy` | string | No | Field and direction for sorting \(e.g., "LastName ASC"\). Only for list query. |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -173,17 +173,17 @@ Get contact(s) from Salesforce - single contact if ID provided, or list if not
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Contact\(s\) data |
|
| `output` | object | Contact\(s\) data |
|
||||||
| ↳ `contacts` | array | Array of contacts \(list query\) |
|
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||||
| ↳ `contact` | object | Single contact \(by ID\) |
|
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||||
| ↳ `paging` | object | Pagination information |
|
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||||
| ↳ `totalSize` | number | Total number of records |
|
| ↳ `metadata` | object | Response metadata |
|
||||||
| ↳ `done` | boolean | Whether all records returned |
|
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||||
| ↳ `metadata` | object | Response metadata |
|
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||||
| ↳ `totalReturned` | number | Number of contacts returned |
|
| ↳ `contacts` | array | Array of contacts \(list query\) |
|
||||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
| ↳ `contact` | object | Single contact \(by ID\) |
|
||||||
| ↳ `singleContact` | boolean | Whether single contact was returned |
|
| ↳ `singleContact` | boolean | Whether single contact was returned |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
|
|
||||||
### `salesforce_create_contact`
|
### `salesforce_create_contact`
|
||||||
|
|
||||||
@@ -199,7 +199,7 @@ Create a new contact in Salesforce CRM
|
|||||||
| `firstName` | string | No | First name |
|
| `firstName` | string | No | First name |
|
||||||
| `email` | string | No | Email address |
|
| `email` | string | No | Email address |
|
||||||
| `phone` | string | No | Phone number |
|
| `phone` | string | No | Phone number |
|
||||||
| `accountId` | string | No | Account ID to associate contact with |
|
| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) |
|
||||||
| `title` | string | No | No description |
|
| `title` | string | No | No description |
|
||||||
| `department` | string | No | Department |
|
| `department` | string | No | Department |
|
||||||
| `mailingStreet` | string | No | Mailing street |
|
| `mailingStreet` | string | No | Mailing street |
|
||||||
@@ -215,9 +215,9 @@ Create a new contact in Salesforce CRM
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Created contact data |
|
| `output` | object | Created contact data |
|
||||||
| ↳ `id` | string | Created contact ID |
|
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||||
| ↳ `created` | boolean | Whether contact was created |
|
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_update_contact`
|
### `salesforce_update_contact`
|
||||||
|
|
||||||
@@ -229,12 +229,12 @@ Update an existing contact in Salesforce CRM
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `contactId` | string | Yes | Contact ID to update \(required\) |
|
| `contactId` | string | Yes | Salesforce Contact ID to update \(18-character string starting with 003\) |
|
||||||
| `lastName` | string | No | Last name |
|
| `lastName` | string | No | Last name |
|
||||||
| `firstName` | string | No | First name |
|
| `firstName` | string | No | First name |
|
||||||
| `email` | string | No | Email address |
|
| `email` | string | No | Email address |
|
||||||
| `phone` | string | No | Phone number |
|
| `phone` | string | No | Phone number |
|
||||||
| `accountId` | string | No | Account ID to associate with |
|
| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) |
|
||||||
| `title` | string | No | No description |
|
| `title` | string | No | No description |
|
||||||
| `department` | string | No | Department |
|
| `department` | string | No | Department |
|
||||||
| `mailingStreet` | string | No | Mailing street |
|
| `mailingStreet` | string | No | Mailing street |
|
||||||
@@ -242,7 +242,7 @@ Update an existing contact in Salesforce CRM
|
|||||||
| `mailingState` | string | No | Mailing state |
|
| `mailingState` | string | No | Mailing state |
|
||||||
| `mailingPostalCode` | string | No | Mailing postal code |
|
| `mailingPostalCode` | string | No | Mailing postal code |
|
||||||
| `mailingCountry` | string | No | Mailing country |
|
| `mailingCountry` | string | No | Mailing country |
|
||||||
| `description` | string | No | Description |
|
| `description` | string | No | Contact description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -250,8 +250,8 @@ Update an existing contact in Salesforce CRM
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Updated contact data |
|
| `output` | object | Updated contact data |
|
||||||
| ↳ `id` | string | Updated contact ID |
|
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||||
| ↳ `updated` | boolean | Whether contact was updated |
|
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_delete_contact`
|
### `salesforce_delete_contact`
|
||||||
|
|
||||||
@@ -263,7 +263,7 @@ Delete a contact from Salesforce CRM
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `contactId` | string | Yes | Contact ID to delete \(required\) |
|
| `contactId` | string | Yes | Salesforce Contact ID to delete \(18-character string starting with 003\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -271,8 +271,8 @@ Delete a contact from Salesforce CRM
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Deleted contact data |
|
| `output` | object | Deleted contact data |
|
||||||
| ↳ `id` | string | Deleted contact ID |
|
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||||
| ↳ `deleted` | boolean | Whether contact was deleted |
|
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_get_leads`
|
### `salesforce_get_leads`
|
||||||
|
|
||||||
@@ -284,10 +284,10 @@ Get lead(s) from Salesforce
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `leadId` | string | No | Lead ID \(optional\) |
|
| `leadId` | string | No | Salesforce Lead ID \(18-character string starting with 00Q\) to get a single lead |
|
||||||
| `limit` | string | No | Max results \(default: 100\) |
|
| `limit` | string | No | Maximum number of results to return \(default: 100\) |
|
||||||
| `fields` | string | No | Comma-separated fields |
|
| `fields` | string | No | Comma-separated list of field API names to return |
|
||||||
| `orderBy` | string | No | Order by field |
|
| `orderBy` | string | No | Field and direction for sorting \(e.g., LastName ASC\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -295,17 +295,17 @@ Get lead(s) from Salesforce
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Lead data |
|
| `output` | object | Lead data |
|
||||||
| ↳ `lead` | object | Single lead object \(when leadId provided\) |
|
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||||
| ↳ `leads` | array | Array of lead objects \(when listing\) |
|
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||||
| ↳ `paging` | object | Pagination information |
|
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||||
| ↳ `totalSize` | number | Total number of records |
|
| ↳ `metadata` | object | Response metadata |
|
||||||
| ↳ `done` | boolean | Whether all records returned |
|
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||||
| ↳ `metadata` | object | Response metadata |
|
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||||
| ↳ `totalReturned` | number | Number of leads returned |
|
| ↳ `lead` | object | Single lead object \(when leadId provided\) |
|
||||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
| ↳ `leads` | array | Array of lead objects \(when listing\) |
|
||||||
| ↳ `singleLead` | boolean | Whether single lead was returned |
|
| ↳ `singleLead` | boolean | Whether single lead was returned |
|
||||||
| ↳ `success` | boolean | Operation success status |
|
| ↳ `success` | boolean | Operation success status |
|
||||||
|
|
||||||
### `salesforce_create_lead`
|
### `salesforce_create_lead`
|
||||||
|
|
||||||
@@ -318,14 +318,14 @@ Create a new lead
|
|||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `lastName` | string | Yes | Last name \(required\) |
|
| `lastName` | string | Yes | Last name \(required\) |
|
||||||
| `company` | string | Yes | Company \(required\) |
|
| `company` | string | Yes | Company name \(required\) |
|
||||||
| `firstName` | string | No | First name |
|
| `firstName` | string | No | First name |
|
||||||
| `email` | string | No | No description |
|
| `email` | string | No | Email address |
|
||||||
| `phone` | string | No | No description |
|
| `phone` | string | No | Phone number |
|
||||||
| `status` | string | No | Lead status |
|
| `status` | string | No | Lead status \(e.g., Open, Working, Closed\) |
|
||||||
| `leadSource` | string | No | Lead source |
|
| `leadSource` | string | No | Lead source \(e.g., Web, Referral, Campaign\) |
|
||||||
| `title` | string | No | No description |
|
| `title` | string | No | No description |
|
||||||
| `description` | string | No | Description |
|
| `description` | string | No | Lead description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -333,9 +333,9 @@ Create a new lead
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Created lead data |
|
| `output` | object | Created lead data |
|
||||||
| ↳ `id` | string | Created lead ID |
|
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||||
| ↳ `created` | boolean | Whether lead was created |
|
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_update_lead`
|
### `salesforce_update_lead`
|
||||||
|
|
||||||
@@ -347,16 +347,16 @@ Update an existing lead
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `leadId` | string | Yes | Lead ID \(required\) |
|
| `leadId` | string | Yes | Salesforce Lead ID to update \(18-character string starting with 00Q\) |
|
||||||
| `lastName` | string | No | Last name |
|
| `lastName` | string | No | Last name |
|
||||||
| `company` | string | No | No description |
|
| `company` | string | No | Company name |
|
||||||
| `firstName` | string | No | First name |
|
| `firstName` | string | No | First name |
|
||||||
| `email` | string | No | No description |
|
| `email` | string | No | Email address |
|
||||||
| `phone` | string | No | No description |
|
| `phone` | string | No | Phone number |
|
||||||
| `status` | string | No | Lead status |
|
| `status` | string | No | Lead status \(e.g., Open, Working, Closed\) |
|
||||||
| `leadSource` | string | No | Lead source |
|
| `leadSource` | string | No | Lead source \(e.g., Web, Referral, Campaign\) |
|
||||||
| `title` | string | No | No description |
|
| `title` | string | No | No description |
|
||||||
| `description` | string | No | Description |
|
| `description` | string | No | Lead description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -364,8 +364,8 @@ Update an existing lead
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Updated lead data |
|
| `output` | object | Updated lead data |
|
||||||
| ↳ `id` | string | Updated lead ID |
|
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||||
| ↳ `updated` | boolean | Whether lead was updated |
|
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_delete_lead`
|
### `salesforce_delete_lead`
|
||||||
|
|
||||||
@@ -377,7 +377,7 @@ Delete a lead
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `leadId` | string | Yes | Lead ID \(required\) |
|
| `leadId` | string | Yes | Salesforce Lead ID to delete \(18-character string starting with 00Q\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -385,8 +385,8 @@ Delete a lead
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Deleted lead data |
|
| `output` | object | Deleted lead data |
|
||||||
| ↳ `id` | string | Deleted lead ID |
|
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||||
| ↳ `deleted` | boolean | Whether lead was deleted |
|
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_get_opportunities`
|
### `salesforce_get_opportunities`
|
||||||
|
|
||||||
@@ -398,10 +398,10 @@ Get opportunity(ies) from Salesforce
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `opportunityId` | string | No | Opportunity ID \(optional\) |
|
| `opportunityId` | string | No | Salesforce Opportunity ID \(18-character string starting with 006\) to get a single opportunity |
|
||||||
| `limit` | string | No | Max results \(default: 100\) |
|
| `limit` | string | No | Maximum number of results to return \(default: 100\) |
|
||||||
| `fields` | string | No | Comma-separated fields |
|
| `fields` | string | No | Comma-separated list of field API names to return |
|
||||||
| `orderBy` | string | No | Order by field |
|
| `orderBy` | string | No | Field and direction for sorting \(e.g., CloseDate DESC\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -409,16 +409,16 @@ Get opportunity(ies) from Salesforce
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Opportunity data |
|
| `output` | object | Opportunity data |
|
||||||
| ↳ `opportunity` | object | Single opportunity object \(when opportunityId provided\) |
|
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||||
| ↳ `opportunities` | array | Array of opportunity objects \(when listing\) |
|
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||||
| ↳ `paging` | object | Pagination information |
|
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||||
| ↳ `totalSize` | number | Total number of records |
|
| ↳ `metadata` | object | Response metadata |
|
||||||
| ↳ `done` | boolean | Whether all records returned |
|
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||||
| ↳ `metadata` | object | Response metadata |
|
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||||
| ↳ `totalReturned` | number | Number of opportunities returned |
|
| ↳ `opportunity` | object | Single opportunity object \(when opportunityId provided\) |
|
||||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
| ↳ `opportunities` | array | Array of opportunity objects \(when listing\) |
|
||||||
| ↳ `success` | boolean | Operation success status |
|
| ↳ `success` | boolean | Operation success status |
|
||||||
|
|
||||||
### `salesforce_create_opportunity`
|
### `salesforce_create_opportunity`
|
||||||
|
|
||||||
@@ -431,12 +431,12 @@ Create a new opportunity
|
|||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `name` | string | Yes | Opportunity name \(required\) |
|
| `name` | string | Yes | Opportunity name \(required\) |
|
||||||
| `stageName` | string | Yes | Stage name \(required\) |
|
| `stageName` | string | Yes | Stage name \(required, e.g., Prospecting, Qualification, Closed Won\) |
|
||||||
| `closeDate` | string | Yes | Close date YYYY-MM-DD \(required\) |
|
| `closeDate` | string | Yes | Close date in YYYY-MM-DD format \(required\) |
|
||||||
| `accountId` | string | No | Account ID |
|
| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) |
|
||||||
| `amount` | string | No | Amount \(number\) |
|
| `amount` | string | No | Deal amount as a number |
|
||||||
| `probability` | string | No | Probability \(0-100\) |
|
| `probability` | string | No | Win probability as integer \(0-100\) |
|
||||||
| `description` | string | No | Description |
|
| `description` | string | No | Opportunity description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -444,9 +444,9 @@ Create a new opportunity
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Created opportunity data |
|
| `output` | object | Created opportunity data |
|
||||||
| ↳ `id` | string | Created opportunity ID |
|
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||||
| ↳ `created` | boolean | Whether opportunity was created |
|
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_update_opportunity`
|
### `salesforce_update_opportunity`
|
||||||
|
|
||||||
@@ -458,14 +458,14 @@ Update an existing opportunity
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `opportunityId` | string | Yes | Opportunity ID \(required\) |
|
| `opportunityId` | string | Yes | Salesforce Opportunity ID to update \(18-character string starting with 006\) |
|
||||||
| `name` | string | No | Opportunity name |
|
| `name` | string | No | Opportunity name |
|
||||||
| `stageName` | string | No | Stage name |
|
| `stageName` | string | No | Stage name \(e.g., Prospecting, Qualification, Closed Won\) |
|
||||||
| `closeDate` | string | No | Close date YYYY-MM-DD |
|
| `closeDate` | string | No | Close date in YYYY-MM-DD format |
|
||||||
| `accountId` | string | No | Account ID |
|
| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) |
|
||||||
| `amount` | string | No | No description |
|
| `amount` | string | No | Deal amount as a number |
|
||||||
| `probability` | string | No | Probability \(0-100\) |
|
| `probability` | string | No | Win probability as integer \(0-100\) |
|
||||||
| `description` | string | No | Description |
|
| `description` | string | No | Opportunity description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -473,8 +473,8 @@ Update an existing opportunity
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Updated opportunity data |
|
| `output` | object | Updated opportunity data |
|
||||||
| ↳ `id` | string | Updated opportunity ID |
|
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||||
| ↳ `updated` | boolean | Whether opportunity was updated |
|
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_delete_opportunity`
|
### `salesforce_delete_opportunity`
|
||||||
|
|
||||||
@@ -486,7 +486,7 @@ Delete an opportunity
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `opportunityId` | string | Yes | Opportunity ID \(required\) |
|
| `opportunityId` | string | Yes | Salesforce Opportunity ID to delete \(18-character string starting with 006\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -494,8 +494,8 @@ Delete an opportunity
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Deleted opportunity data |
|
| `output` | object | Deleted opportunity data |
|
||||||
| ↳ `id` | string | Deleted opportunity ID |
|
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||||
| ↳ `deleted` | boolean | Whether opportunity was deleted |
|
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_get_cases`
|
### `salesforce_get_cases`
|
||||||
|
|
||||||
@@ -507,10 +507,10 @@ Get case(s) from Salesforce
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `caseId` | string | No | Case ID \(optional\) |
|
| `caseId` | string | No | Salesforce Case ID \(18-character string starting with 500\) to get a single case |
|
||||||
| `limit` | string | No | Max results \(default: 100\) |
|
| `limit` | string | No | Maximum number of results to return \(default: 100\) |
|
||||||
| `fields` | string | No | Comma-separated fields |
|
| `fields` | string | No | Comma-separated list of field API names to return |
|
||||||
| `orderBy` | string | No | Order by field |
|
| `orderBy` | string | No | Field and direction for sorting \(e.g., CreatedDate DESC\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -518,16 +518,16 @@ Get case(s) from Salesforce
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Case data |
|
| `output` | object | Case data |
|
||||||
| ↳ `case` | object | Single case object \(when caseId provided\) |
|
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||||
| ↳ `cases` | array | Array of case objects \(when listing\) |
|
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||||
| ↳ `paging` | object | Pagination information |
|
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||||
| ↳ `totalSize` | number | Total number of records |
|
| ↳ `metadata` | object | Response metadata |
|
||||||
| ↳ `done` | boolean | Whether all records returned |
|
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||||
| ↳ `metadata` | object | Response metadata |
|
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||||
| ↳ `totalReturned` | number | Number of cases returned |
|
| ↳ `case` | object | Single case object \(when caseId provided\) |
|
||||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
| ↳ `cases` | array | Array of case objects \(when listing\) |
|
||||||
| ↳ `success` | boolean | Operation success status |
|
| ↳ `success` | boolean | Operation success status |
|
||||||
|
|
||||||
### `salesforce_create_case`
|
### `salesforce_create_case`
|
||||||
|
|
||||||
@@ -543,9 +543,9 @@ Create a new case
|
|||||||
| `status` | string | No | Status \(e.g., New, Working, Escalated\) |
|
| `status` | string | No | Status \(e.g., New, Working, Escalated\) |
|
||||||
| `priority` | string | No | Priority \(e.g., Low, Medium, High\) |
|
| `priority` | string | No | Priority \(e.g., Low, Medium, High\) |
|
||||||
| `origin` | string | No | Origin \(e.g., Phone, Email, Web\) |
|
| `origin` | string | No | Origin \(e.g., Phone, Email, Web\) |
|
||||||
| `contactId` | string | No | Contact ID |
|
| `contactId` | string | No | Salesforce Contact ID \(18-character string starting with 003\) |
|
||||||
| `accountId` | string | No | Account ID |
|
| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) |
|
||||||
| `description` | string | No | Description |
|
| `description` | string | No | Case description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -553,9 +553,9 @@ Create a new case
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Created case data |
|
| `output` | object | Created case data |
|
||||||
| ↳ `id` | string | Created case ID |
|
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||||
| ↳ `created` | boolean | Whether case was created |
|
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_update_case`
|
### `salesforce_update_case`
|
||||||
|
|
||||||
@@ -567,11 +567,11 @@ Update an existing case
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `caseId` | string | Yes | Case ID \(required\) |
|
| `caseId` | string | Yes | Salesforce Case ID to update \(18-character string starting with 500\) |
|
||||||
| `subject` | string | No | Case subject |
|
| `subject` | string | No | Case subject |
|
||||||
| `status` | string | No | Status |
|
| `status` | string | No | Status \(e.g., New, Working, Escalated, Closed\) |
|
||||||
| `priority` | string | No | Priority |
|
| `priority` | string | No | Priority \(e.g., Low, Medium, High\) |
|
||||||
| `description` | string | No | Description |
|
| `description` | string | No | Case description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -579,8 +579,8 @@ Update an existing case
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Updated case data |
|
| `output` | object | Updated case data |
|
||||||
| ↳ `id` | string | Updated case ID |
|
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||||
| ↳ `updated` | boolean | Whether case was updated |
|
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_delete_case`
|
### `salesforce_delete_case`
|
||||||
|
|
||||||
@@ -592,7 +592,7 @@ Delete a case
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `caseId` | string | Yes | Case ID \(required\) |
|
| `caseId` | string | Yes | Salesforce Case ID to delete \(18-character string starting with 500\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -600,8 +600,8 @@ Delete a case
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Deleted case data |
|
| `output` | object | Deleted case data |
|
||||||
| ↳ `id` | string | Deleted case ID |
|
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||||
| ↳ `deleted` | boolean | Whether case was deleted |
|
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_get_tasks`
|
### `salesforce_get_tasks`
|
||||||
|
|
||||||
@@ -613,10 +613,10 @@ Get task(s) from Salesforce
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `taskId` | string | No | Task ID \(optional\) |
|
| `taskId` | string | No | Salesforce Task ID \(18-character string starting with 00T\) to get a single task |
|
||||||
| `limit` | string | No | Max results \(default: 100\) |
|
| `limit` | string | No | Maximum number of results to return \(default: 100\) |
|
||||||
| `fields` | string | No | Comma-separated fields |
|
| `fields` | string | No | Comma-separated list of field API names to return |
|
||||||
| `orderBy` | string | No | Order by field |
|
| `orderBy` | string | No | Field and direction for sorting \(e.g., ActivityDate DESC\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -624,16 +624,16 @@ Get task(s) from Salesforce
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Task data |
|
| `output` | object | Task data |
|
||||||
| ↳ `task` | object | Single task object \(when taskId provided\) |
|
| ↳ `paging` | object | Pagination information from Salesforce API |
|
||||||
| ↳ `tasks` | array | Array of task objects \(when listing\) |
|
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
|
||||||
| ↳ `paging` | object | Pagination information |
|
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
|
||||||
| ↳ `nextRecordsUrl` | string | URL for next page of results |
|
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
|
||||||
| ↳ `totalSize` | number | Total number of records |
|
| ↳ `metadata` | object | Response metadata |
|
||||||
| ↳ `done` | boolean | Whether all records returned |
|
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||||
| ↳ `metadata` | object | Response metadata |
|
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||||
| ↳ `totalReturned` | number | Number of tasks returned |
|
| ↳ `task` | object | Single task object \(when taskId provided\) |
|
||||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
| ↳ `tasks` | array | Array of task objects \(when listing\) |
|
||||||
| ↳ `success` | boolean | Operation success status |
|
| ↳ `success` | boolean | Operation success status |
|
||||||
|
|
||||||
### `salesforce_create_task`
|
### `salesforce_create_task`
|
||||||
|
|
||||||
@@ -648,10 +648,10 @@ Create a new task
|
|||||||
| `subject` | string | Yes | Task subject \(required\) |
|
| `subject` | string | Yes | Task subject \(required\) |
|
||||||
| `status` | string | No | Status \(e.g., Not Started, In Progress, Completed\) |
|
| `status` | string | No | Status \(e.g., Not Started, In Progress, Completed\) |
|
||||||
| `priority` | string | No | Priority \(e.g., Low, Normal, High\) |
|
| `priority` | string | No | Priority \(e.g., Low, Normal, High\) |
|
||||||
| `activityDate` | string | No | Due date YYYY-MM-DD |
|
| `activityDate` | string | No | Due date in YYYY-MM-DD format |
|
||||||
| `whoId` | string | No | Related Contact/Lead ID |
|
| `whoId` | string | No | Related Contact ID \(003...\) or Lead ID \(00Q...\) |
|
||||||
| `whatId` | string | No | Related Account/Opportunity ID |
|
| `whatId` | string | No | Related Account ID \(001...\) or Opportunity ID \(006...\) |
|
||||||
| `description` | string | No | Description |
|
| `description` | string | No | Task description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -659,9 +659,9 @@ Create a new task
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Created task data |
|
| `output` | object | Created task data |
|
||||||
| ↳ `id` | string | Created task ID |
|
| ↳ `id` | string | The Salesforce ID of the newly created record |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Whether the create operation was successful |
|
||||||
| ↳ `created` | boolean | Whether task was created |
|
| ↳ `created` | boolean | Whether the record was created \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_update_task`
|
### `salesforce_update_task`
|
||||||
|
|
||||||
@@ -673,12 +673,12 @@ Update an existing task
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `taskId` | string | Yes | Task ID \(required\) |
|
| `taskId` | string | Yes | Salesforce Task ID to update \(18-character string starting with 00T\) |
|
||||||
| `subject` | string | No | Task subject |
|
| `subject` | string | No | Task subject |
|
||||||
| `status` | string | No | Status |
|
| `status` | string | No | Status \(e.g., Not Started, In Progress, Completed\) |
|
||||||
| `priority` | string | No | Priority |
|
| `priority` | string | No | Priority \(e.g., Low, Normal, High\) |
|
||||||
| `activityDate` | string | No | Due date YYYY-MM-DD |
|
| `activityDate` | string | No | Due date in YYYY-MM-DD format |
|
||||||
| `description` | string | No | Description |
|
| `description` | string | No | Task description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -686,8 +686,8 @@ Update an existing task
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Updated task data |
|
| `output` | object | Updated task data |
|
||||||
| ↳ `id` | string | Updated task ID |
|
| ↳ `id` | string | The Salesforce ID of the updated record |
|
||||||
| ↳ `updated` | boolean | Whether task was updated |
|
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_delete_task`
|
### `salesforce_delete_task`
|
||||||
|
|
||||||
@@ -699,7 +699,7 @@ Delete a task
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `taskId` | string | Yes | Task ID \(required\) |
|
| `taskId` | string | Yes | Salesforce Task ID to delete \(18-character string starting with 00T\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -707,8 +707,8 @@ Delete a task
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Deleted task data |
|
| `output` | object | Deleted task data |
|
||||||
| ↳ `id` | string | Deleted task ID |
|
| ↳ `id` | string | The Salesforce ID of the deleted record |
|
||||||
| ↳ `deleted` | boolean | Whether task was deleted |
|
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) |
|
||||||
|
|
||||||
### `salesforce_list_reports`
|
### `salesforce_list_reports`
|
||||||
|
|
||||||
@@ -720,8 +720,8 @@ Get a list of reports accessible by the current user
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `folderName` | string | No | Filter by folder name |
|
| `folderName` | string | No | Filter reports by folder name \(case-insensitive partial match\) |
|
||||||
| `searchTerm` | string | No | Search term to filter reports by name |
|
| `searchTerm` | string | No | Search term to filter reports by name or description |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -729,9 +729,9 @@ Get a list of reports accessible by the current user
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Reports data |
|
| `output` | object | Reports data |
|
||||||
| ↳ `reports` | array | Array of report objects |
|
| ↳ `totalReturned` | number | Number of items returned |
|
||||||
| ↳ `totalReturned` | number | Number of reports returned |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `reports` | array | Array of report objects |
|
||||||
|
|
||||||
### `salesforce_get_report`
|
### `salesforce_get_report`
|
||||||
|
|
||||||
@@ -743,7 +743,7 @@ Get metadata and describe information for a specific report
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `reportId` | string | Yes | Report ID \(required\) |
|
| `reportId` | string | Yes | Salesforce Report ID \(18-character string starting with 00O\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -751,9 +751,9 @@ Get metadata and describe information for a specific report
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Report metadata |
|
| `output` | object | Report metadata |
|
||||||
| ↳ `report` | object | Report metadata object |
|
| ↳ `report` | object | Report metadata object |
|
||||||
| ↳ `reportId` | string | Report ID |
|
| ↳ `reportId` | string | Report ID |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
|
|
||||||
### `salesforce_run_report`
|
### `salesforce_run_report`
|
||||||
|
|
||||||
@@ -765,9 +765,9 @@ Execute a report and retrieve the results
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `reportId` | string | Yes | Report ID \(required\) |
|
| `reportId` | string | Yes | Salesforce Report ID \(18-character string starting with 00O\) |
|
||||||
| `includeDetails` | string | No | Include detail rows \(true/false, default: true\) |
|
| `includeDetails` | string | No | Include detail rows \(true/false, default: true\) |
|
||||||
| `filters` | string | No | JSON string of report filters to apply |
|
| `filters` | string | No | JSON array of report filter objects to apply |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -775,17 +775,17 @@ Execute a report and retrieve the results
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Report results |
|
| `output` | object | Report results |
|
||||||
| ↳ `reportId` | string | Report ID |
|
| ↳ `reportId` | string | Report ID |
|
||||||
| ↳ `reportMetadata` | object | Report metadata |
|
| ↳ `reportMetadata` | object | Report metadata including name, format, and filter definitions |
|
||||||
| ↳ `reportExtendedMetadata` | object | Extended metadata |
|
| ↳ `reportExtendedMetadata` | object | Extended metadata for aggregate columns and groupings |
|
||||||
| ↳ `factMap` | object | Report data organized by groupings |
|
| ↳ `factMap` | object | Report data organized by groupings with aggregates and row data |
|
||||||
| ↳ `groupingsDown` | object | Row groupings |
|
| ↳ `groupingsDown` | object | Row grouping hierarchy and values |
|
||||||
| ↳ `groupingsAcross` | object | Column groupings |
|
| ↳ `groupingsAcross` | object | Column grouping hierarchy and values |
|
||||||
| ↳ `hasDetailRows` | boolean | Whether report has detail rows |
|
| ↳ `hasDetailRows` | boolean | Whether the report includes detail-level row data |
|
||||||
| ↳ `allData` | boolean | Whether all data is returned |
|
| ↳ `allData` | boolean | Whether all data is returned \(false if truncated due to size limits\) |
|
||||||
| ↳ `reportName` | string | Report name |
|
| ↳ `reportName` | string | Display name of the report |
|
||||||
| ↳ `reportFormat` | string | Report format type |
|
| ↳ `reportFormat` | string | Report format type \(TABULAR, SUMMARY, MATRIX, JOINED\) |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
|
|
||||||
### `salesforce_list_report_types`
|
### `salesforce_list_report_types`
|
||||||
|
|
||||||
@@ -804,9 +804,9 @@ Get a list of available report types
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Report types data |
|
| `output` | object | Report types data |
|
||||||
| ↳ `reportTypes` | array | Array of report type objects |
|
| ↳ `totalReturned` | number | Number of items returned |
|
||||||
| ↳ `totalReturned` | number | Number of report types returned |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `reportTypes` | array | Array of report type objects |
|
||||||
|
|
||||||
### `salesforce_list_dashboards`
|
### `salesforce_list_dashboards`
|
||||||
|
|
||||||
@@ -818,7 +818,7 @@ Get a list of dashboards accessible by the current user
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `folderName` | string | No | Filter by folder name |
|
| `folderName` | string | No | Filter dashboards by folder name \(case-insensitive partial match\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -826,9 +826,9 @@ Get a list of dashboards accessible by the current user
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Dashboards data |
|
| `output` | object | Dashboards data |
|
||||||
| ↳ `dashboards` | array | Array of dashboard objects |
|
| ↳ `totalReturned` | number | Number of items returned |
|
||||||
| ↳ `totalReturned` | number | Number of dashboards returned |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `dashboards` | array | Array of dashboard objects |
|
||||||
|
|
||||||
### `salesforce_get_dashboard`
|
### `salesforce_get_dashboard`
|
||||||
|
|
||||||
@@ -840,7 +840,7 @@ Get details and results for a specific dashboard
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `dashboardId` | string | Yes | Dashboard ID \(required\) |
|
| `dashboardId` | string | Yes | Salesforce Dashboard ID \(18-character string starting with 01Z\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -848,13 +848,13 @@ Get details and results for a specific dashboard
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Dashboard data |
|
| `output` | object | Dashboard data |
|
||||||
| ↳ `dashboard` | object | Dashboard details |
|
| ↳ `dashboard` | object | Full dashboard details object |
|
||||||
| ↳ `dashboardId` | string | Dashboard ID |
|
| ↳ `dashboardId` | string | Dashboard ID |
|
||||||
| ↳ `components` | array | Dashboard component data |
|
| ↳ `components` | array | Array of dashboard component data with visualizations and filters |
|
||||||
| ↳ `dashboardName` | string | Dashboard name |
|
| ↳ `dashboardName` | string | Display name of the dashboard |
|
||||||
| ↳ `folderId` | string | Folder ID containing the dashboard |
|
| ↳ `folderId` | string | ID of the folder containing the dashboard |
|
||||||
| ↳ `runningUser` | object | Running user information |
|
| ↳ `runningUser` | object | User context under which the dashboard data was retrieved |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
|
|
||||||
### `salesforce_refresh_dashboard`
|
### `salesforce_refresh_dashboard`
|
||||||
|
|
||||||
@@ -866,7 +866,7 @@ Refresh a dashboard to get the latest data
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `dashboardId` | string | Yes | Dashboard ID \(required\) |
|
| `dashboardId` | string | Yes | Salesforce Dashboard ID \(18-character string starting with 01Z\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -874,13 +874,13 @@ Refresh a dashboard to get the latest data
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Refreshed dashboard data |
|
| `output` | object | Refreshed dashboard data |
|
||||||
| ↳ `dashboard` | object | Dashboard details |
|
| ↳ `dashboard` | object | Full dashboard details object |
|
||||||
| ↳ `dashboardId` | string | Dashboard ID |
|
| ↳ `dashboardId` | string | Dashboard ID |
|
||||||
| ↳ `components` | array | Dashboard component data |
|
| ↳ `components` | array | Array of dashboard component data with fresh visualizations |
|
||||||
| ↳ `status` | object | Dashboard status |
|
| ↳ `status` | object | Dashboard refresh status information |
|
||||||
| ↳ `dashboardName` | string | Dashboard name |
|
| ↳ `dashboardName` | string | Display name of the dashboard |
|
||||||
| ↳ `refreshDate` | string | Date when dashboard was refreshed |
|
| ↳ `refreshDate` | string | ISO 8601 timestamp when the dashboard was last refreshed |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
|
|
||||||
### `salesforce_query`
|
### `salesforce_query`
|
||||||
|
|
||||||
@@ -900,15 +900,12 @@ Execute a custom SOQL query to retrieve data from Salesforce
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Query results |
|
| `output` | object | Query results |
|
||||||
| ↳ `records` | array | Array of record objects |
|
| ↳ `records` | array | Array of sObject records matching the query |
|
||||||
| ↳ `totalSize` | number | Total number of records matching query |
|
| ↳ `query` | string | The executed SOQL query |
|
||||||
| ↳ `done` | boolean | Whether all records have been returned |
|
| ↳ `metadata` | object | Response metadata |
|
||||||
| ↳ `nextRecordsUrl` | string | URL to fetch next batch of records |
|
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||||
| ↳ `query` | string | The executed SOQL query |
|
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||||
| ↳ `metadata` | object | Response metadata |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
|
||||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
|
||||||
|
|
||||||
### `salesforce_query_more`
|
### `salesforce_query_more`
|
||||||
|
|
||||||
@@ -920,7 +917,7 @@ Retrieve additional query results using the nextRecordsUrl from a previous query
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `nextRecordsUrl` | string | Yes | The nextRecordsUrl from a previous query response |
|
| `nextRecordsUrl` | string | Yes | The nextRecordsUrl value from a previous query response \(e.g., /services/data/v59.0/query/01g...\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -928,14 +925,11 @@ Retrieve additional query results using the nextRecordsUrl from a previous query
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Query results |
|
| `output` | object | Query results |
|
||||||
| ↳ `records` | array | Array of record objects |
|
| ↳ `records` | array | Array of sObject records matching the query |
|
||||||
| ↳ `totalSize` | number | Total number of records matching query |
|
| ↳ `metadata` | object | Response metadata |
|
||||||
| ↳ `done` | boolean | Whether all records have been returned |
|
| ↳ `totalReturned` | number | Number of records returned in this response |
|
||||||
| ↳ `nextRecordsUrl` | string | URL to fetch next batch of records |
|
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
|
||||||
| ↳ `metadata` | object | Response metadata |
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
| ↳ `totalReturned` | number | Number of records returned in this response |
|
|
||||||
| ↳ `hasMore` | boolean | Whether more records exist |
|
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
|
||||||
|
|
||||||
### `salesforce_describe_object`
|
### `salesforce_describe_object`
|
||||||
|
|
||||||
@@ -947,7 +941,7 @@ Get metadata and field information for a Salesforce object
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `idToken` | string | No | No description |
|
| `idToken` | string | No | No description |
|
||||||
| `instanceUrl` | string | No | No description |
|
| `instanceUrl` | string | No | No description |
|
||||||
| `objectName` | string | Yes | API name of the object \(e.g., Account, Contact, Lead, Custom_Object__c\) |
|
| `objectName` | string | Yes | Salesforce object API name \(e.g., Account, Contact, Lead, Custom_Object__c\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -955,19 +949,42 @@ Get metadata and field information for a Salesforce object
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Object metadata |
|
| `output` | object | Object metadata |
|
||||||
| ↳ `objectName` | string | API name of the object |
|
| ↳ `objectName` | string | API name of the object \(e.g., Account, Contact\) |
|
||||||
| ↳ `label` | string | Display label |
|
| ↳ `label` | string | Human-readable singular label for the object |
|
||||||
| ↳ `labelPlural` | string | Plural display label |
|
| ↳ `labelPlural` | string | Human-readable plural label for the object |
|
||||||
| ↳ `fields` | array | Array of field definitions |
|
| ↳ `fields` | array | Array of field metadata objects |
|
||||||
| ↳ `keyPrefix` | string | ID prefix for this object type |
|
| ↳ `name` | string | API name of the field |
|
||||||
| ↳ `queryable` | boolean | Whether object can be queried |
|
| ↳ `label` | string | Display label of the field |
|
||||||
| ↳ `createable` | boolean | Whether records can be created |
|
| ↳ `type` | string | Field data type \(string, boolean, int, double, date, etc.\) |
|
||||||
| ↳ `updateable` | boolean | Whether records can be updated |
|
| ↳ `length` | number | Maximum length for text fields |
|
||||||
| ↳ `deletable` | boolean | Whether records can be deleted |
|
| ↳ `precision` | number | Precision for numeric fields |
|
||||||
| ↳ `childRelationships` | array | Child relationship definitions |
|
| ↳ `scale` | number | Scale for numeric fields |
|
||||||
| ↳ `recordTypeInfos` | array | Record type information |
|
| ↳ `nillable` | boolean | Whether the field can be null |
|
||||||
| ↳ `fieldCount` | number | Number of fields in the object |
|
| ↳ `unique` | boolean | Whether values must be unique |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `createable` | boolean | Whether field can be set on create |
|
||||||
|
| ↳ `updateable` | boolean | Whether field can be updated |
|
||||||
|
| ↳ `defaultedOnCreate` | boolean | Whether field has default value on create |
|
||||||
|
| ↳ `calculated` | boolean | Whether field is a formula field |
|
||||||
|
| ↳ `autoNumber` | boolean | Whether field is auto-number |
|
||||||
|
| ↳ `externalId` | boolean | Whether field is an external ID |
|
||||||
|
| ↳ `idLookup` | boolean | Whether field can be used in ID lookup |
|
||||||
|
| ↳ `inlineHelpText` | string | Help text for the field |
|
||||||
|
| ↳ `picklistValues` | array | Available picklist values for picklist fields |
|
||||||
|
| ↳ `referenceTo` | array | Objects this field can reference \(for lookup fields\) |
|
||||||
|
| ↳ `relationshipName` | string | Relationship name for lookup fields |
|
||||||
|
| ↳ `custom` | boolean | Whether this is a custom field |
|
||||||
|
| ↳ `filterable` | boolean | Whether field can be used in SOQL filter |
|
||||||
|
| ↳ `groupable` | boolean | Whether field can be used in GROUP BY |
|
||||||
|
| ↳ `sortable` | boolean | Whether field can be used in ORDER BY |
|
||||||
|
| ↳ `keyPrefix` | string | Three-character prefix used in record IDs \(e.g., "001" for Account\) |
|
||||||
|
| ↳ `queryable` | boolean | Whether the object can be queried via SOQL |
|
||||||
|
| ↳ `createable` | boolean | Whether records can be created for this object |
|
||||||
|
| ↳ `updateable` | boolean | Whether records can be updated for this object |
|
||||||
|
| ↳ `deletable` | boolean | Whether records can be deleted for this object |
|
||||||
|
| ↳ `childRelationships` | array | Array of child relationship metadata for related objects |
|
||||||
|
| ↳ `recordTypeInfos` | array | Array of record type information for the object |
|
||||||
|
| ↳ `fieldCount` | number | Total number of fields on the object |
|
||||||
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
|
|
||||||
### `salesforce_list_objects`
|
### `salesforce_list_objects`
|
||||||
|
|
||||||
@@ -986,10 +1003,26 @@ Get a list of all available Salesforce objects
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `success` | boolean | Operation success status |
|
| `success` | boolean | Operation success status |
|
||||||
| `output` | object | Objects list |
|
| `output` | object | Objects list |
|
||||||
| ↳ `objects` | array | Array of available Salesforce objects |
|
| ↳ `objects` | array | Array of sObject metadata |
|
||||||
| ↳ `encoding` | string | Encoding used |
|
| ↳ `name` | string | API name of the object |
|
||||||
| ↳ `maxBatchSize` | number | Maximum batch size |
|
| ↳ `label` | string | Display label of the object |
|
||||||
| ↳ `totalReturned` | number | Number of objects returned |
|
| ↳ `labelPlural` | string | Plural display label |
|
||||||
| ↳ `success` | boolean | Salesforce operation success |
|
| ↳ `keyPrefix` | string | Three-character ID prefix |
|
||||||
|
| ↳ `custom` | boolean | Whether this is a custom object |
|
||||||
|
| ↳ `queryable` | boolean | Whether object can be queried |
|
||||||
|
| ↳ `createable` | boolean | Whether records can be created |
|
||||||
|
| ↳ `updateable` | boolean | Whether records can be updated |
|
||||||
|
| ↳ `deletable` | boolean | Whether records can be deleted |
|
||||||
|
| ↳ `searchable` | boolean | Whether object is searchable |
|
||||||
|
| ↳ `triggerable` | boolean | Whether triggers are supported |
|
||||||
|
| ↳ `layoutable` | boolean | Whether page layouts are supported |
|
||||||
|
| ↳ `replicateable` | boolean | Whether object can be replicated |
|
||||||
|
| ↳ `retrieveable` | boolean | Whether records can be retrieved |
|
||||||
|
| ↳ `undeletable` | boolean | Whether records can be undeleted |
|
||||||
|
| ↳ `urls` | object | URLs for accessing object resources |
|
||||||
|
| ↳ `encoding` | string | Character encoding for the organization \(e.g., UTF-8\) |
|
||||||
|
| ↳ `maxBatchSize` | number | Maximum number of records that can be returned in a single query batch \(typically 200\) |
|
||||||
|
| ↳ `totalReturned` | number | Number of objects returned |
|
||||||
|
| ↳ `success` | boolean | Salesforce operation success |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ Send an email using SendGrid API
|
|||||||
| `bcc` | string | No | BCC email address |
|
| `bcc` | string | No | BCC email address |
|
||||||
| `replyTo` | string | No | Reply-to email address |
|
| `replyTo` | string | No | Reply-to email address |
|
||||||
| `replyToName` | string | No | Reply-to name |
|
| `replyToName` | string | No | Reply-to name |
|
||||||
| `attachments` | file[] | No | Files to attach to the email |
|
| `attachments` | file[] | No | Files to attach to the email as an array of attachment objects |
|
||||||
| `templateId` | string | No | SendGrid template ID to use |
|
| `templateId` | string | No | SendGrid template ID to use |
|
||||||
| `dynamicTemplateData` | json | No | JSON object of dynamic template data |
|
| `dynamicTemplateData` | json | No | JSON object of dynamic template data |
|
||||||
|
|
||||||
|
|||||||
@@ -54,8 +54,8 @@ List issues from Sentry for a specific organization and optionally a specific pr
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `projectSlug` | string | No | Filter issues by specific project slug \(optional\) |
|
| `projectSlug` | string | No | Filter issues by specific project slug \(e.g., "my-project"\) |
|
||||||
| `query` | string | No | Search query to filter issues. Supports Sentry search syntax \(e.g., "is:unresolved", "level:error"\) |
|
| `query` | string | No | Search query to filter issues. Supports Sentry search syntax \(e.g., "is:unresolved", "level:error"\) |
|
||||||
| `statsPeriod` | string | No | Time period for stats \(e.g., "24h", "7d", "30d"\). Defaults to 24h if not specified. |
|
| `statsPeriod` | string | No | Time period for stats \(e.g., "24h", "7d", "30d"\). Defaults to 24h if not specified. |
|
||||||
| `cursor` | string | No | Pagination cursor for retrieving next page of results |
|
| `cursor` | string | No | Pagination cursor for retrieving next page of results |
|
||||||
@@ -80,20 +80,20 @@ List issues from Sentry for a specific organization and optionally a specific pr
|
|||||||
| ↳ `isPublic` | boolean | Whether the issue is publicly visible |
|
| ↳ `isPublic` | boolean | Whether the issue is publicly visible |
|
||||||
| ↳ `platform` | string | Platform where the issue occurred |
|
| ↳ `platform` | string | Platform where the issue occurred |
|
||||||
| ↳ `project` | object | Project information |
|
| ↳ `project` | object | Project information |
|
||||||
| ↳ `id` | string | Project ID |
|
| ↳ `id` | string | Project ID |
|
||||||
| ↳ `name` | string | Project name |
|
| ↳ `name` | string | Project name |
|
||||||
| ↳ `slug` | string | Project slug |
|
| ↳ `slug` | string | Project slug |
|
||||||
| ↳ `platform` | string | Project platform |
|
| ↳ `platform` | string | Project platform |
|
||||||
| ↳ `type` | string | Issue type |
|
| ↳ `type` | string | Issue type |
|
||||||
| ↳ `metadata` | object | Error metadata |
|
| ↳ `metadata` | object | Error metadata |
|
||||||
| ↳ `type` | string | Type of error \(e.g., TypeError\) |
|
| ↳ `type` | string | Type of error \(e.g., TypeError\) |
|
||||||
| ↳ `value` | string | Error message or value |
|
| ↳ `value` | string | Error message or value |
|
||||||
| ↳ `function` | string | Function where the error occurred |
|
| ↳ `function` | string | Function where the error occurred |
|
||||||
| ↳ `numComments` | number | Number of comments on the issue |
|
| ↳ `numComments` | number | Number of comments on the issue |
|
||||||
| ↳ `assignedTo` | object | User assigned to the issue |
|
| ↳ `assignedTo` | object | User assigned to the issue |
|
||||||
| ↳ `id` | string | User ID |
|
| ↳ `id` | string | User ID |
|
||||||
| ↳ `name` | string | User name |
|
| ↳ `name` | string | User name |
|
||||||
| ↳ `email` | string | User email |
|
| ↳ `email` | string | User email |
|
||||||
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
|
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
|
||||||
| ↳ `isSubscribed` | boolean | Whether subscribed to updates |
|
| ↳ `isSubscribed` | boolean | Whether subscribed to updates |
|
||||||
| ↳ `hasSeen` | boolean | Whether the user has seen this issue |
|
| ↳ `hasSeen` | boolean | Whether the user has seen this issue |
|
||||||
@@ -105,8 +105,8 @@ List issues from Sentry for a specific organization and optionally a specific pr
|
|||||||
| ↳ `lastSeen` | string | When the issue was last seen \(ISO timestamp\) |
|
| ↳ `lastSeen` | string | When the issue was last seen \(ISO timestamp\) |
|
||||||
| ↳ `stats` | object | Statistical information about the issue |
|
| ↳ `stats` | object | Statistical information about the issue |
|
||||||
| `metadata` | object | Pagination metadata |
|
| `metadata` | object | Pagination metadata |
|
||||||
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
|
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
|
||||||
| ↳ `hasMore` | boolean | Whether there are more results available |
|
| ↳ `hasMore` | boolean | Whether there are more results available |
|
||||||
|
|
||||||
### `sentry_issues_get`
|
### `sentry_issues_get`
|
||||||
|
|
||||||
@@ -117,50 +117,50 @@ Retrieve detailed information about a specific Sentry issue by its ID. Returns c
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `issueId` | string | Yes | The unique ID of the issue to retrieve |
|
| `issueId` | string | Yes | The unique ID of the issue to retrieve \(e.g., "12345"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `issue` | object | Detailed information about the Sentry issue |
|
| `issue` | object | Detailed information about the Sentry issue |
|
||||||
| ↳ `id` | string | Unique issue ID |
|
| ↳ `id` | string | Unique issue ID |
|
||||||
| ↳ `shortId` | string | Short issue identifier |
|
| ↳ `shortId` | string | Short issue identifier |
|
||||||
| ↳ `title` | string | Issue title |
|
| ↳ `title` | string | Issue title |
|
||||||
| ↳ `culprit` | string | Function or location that caused the issue |
|
| ↳ `culprit` | string | Function or location that caused the issue |
|
||||||
| ↳ `permalink` | string | Direct link to the issue in Sentry |
|
| ↳ `permalink` | string | Direct link to the issue in Sentry |
|
||||||
| ↳ `logger` | string | Logger name that reported the issue |
|
| ↳ `logger` | string | Logger name that reported the issue |
|
||||||
| ↳ `level` | string | Severity level \(error, warning, info, etc.\) |
|
| ↳ `level` | string | Severity level \(error, warning, info, etc.\) |
|
||||||
| ↳ `status` | string | Current issue status |
|
| ↳ `status` | string | Current issue status |
|
||||||
| ↳ `statusDetails` | object | Additional details about the status |
|
| ↳ `statusDetails` | object | Additional details about the status |
|
||||||
| ↳ `isPublic` | boolean | Whether the issue is publicly visible |
|
| ↳ `isPublic` | boolean | Whether the issue is publicly visible |
|
||||||
| ↳ `platform` | string | Platform where the issue occurred |
|
| ↳ `platform` | string | Platform where the issue occurred |
|
||||||
| ↳ `project` | object | Project information |
|
| ↳ `project` | object | Project information |
|
||||||
| ↳ `id` | string | Project ID |
|
| ↳ `id` | string | Project ID |
|
||||||
| ↳ `name` | string | Project name |
|
| ↳ `name` | string | Project name |
|
||||||
| ↳ `slug` | string | Project slug |
|
| ↳ `slug` | string | Project slug |
|
||||||
| ↳ `platform` | string | Project platform |
|
| ↳ `platform` | string | Project platform |
|
||||||
| ↳ `type` | string | Issue type |
|
| ↳ `type` | string | Issue type |
|
||||||
| ↳ `metadata` | object | Error metadata |
|
| ↳ `metadata` | object | Error metadata |
|
||||||
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
|
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
|
||||||
| ↳ `value` | string | Error message or value |
|
| ↳ `value` | string | Error message or value |
|
||||||
| ↳ `function` | string | Function where the error occurred |
|
| ↳ `function` | string | Function where the error occurred |
|
||||||
| ↳ `numComments` | number | Number of comments on the issue |
|
| ↳ `numComments` | number | Number of comments on the issue |
|
||||||
| ↳ `assignedTo` | object | User assigned to the issue \(if any\) |
|
| ↳ `assignedTo` | object | User assigned to the issue \(if any\) |
|
||||||
| ↳ `id` | string | User ID |
|
| ↳ `id` | string | User ID |
|
||||||
| ↳ `name` | string | User name |
|
| ↳ `name` | string | User name |
|
||||||
| ↳ `email` | string | User email |
|
| ↳ `email` | string | User email |
|
||||||
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
|
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
|
||||||
| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates |
|
| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates |
|
||||||
| ↳ `hasSeen` | boolean | Whether the user has seen this issue |
|
| ↳ `hasSeen` | boolean | Whether the user has seen this issue |
|
||||||
| ↳ `annotations` | array | Issue annotations |
|
| ↳ `annotations` | array | Issue annotations |
|
||||||
| ↳ `isUnhandled` | boolean | Whether the issue is unhandled |
|
| ↳ `isUnhandled` | boolean | Whether the issue is unhandled |
|
||||||
| ↳ `count` | string | Total number of occurrences |
|
| ↳ `count` | string | Total number of occurrences |
|
||||||
| ↳ `userCount` | number | Number of unique users affected |
|
| ↳ `userCount` | number | Number of unique users affected |
|
||||||
| ↳ `firstSeen` | string | When the issue was first seen \(ISO timestamp\) |
|
| ↳ `firstSeen` | string | When the issue was first seen \(ISO timestamp\) |
|
||||||
| ↳ `lastSeen` | string | When the issue was last seen \(ISO timestamp\) |
|
| ↳ `lastSeen` | string | When the issue was last seen \(ISO timestamp\) |
|
||||||
| ↳ `stats` | object | Statistical information about the issue |
|
| ↳ `stats` | object | Statistical information about the issue |
|
||||||
|
|
||||||
### `sentry_issues_update`
|
### `sentry_issues_update`
|
||||||
|
|
||||||
@@ -171,8 +171,8 @@ Update a Sentry issue by changing its status, assignment, bookmark state, or oth
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `issueId` | string | Yes | The unique ID of the issue to update |
|
| `issueId` | string | Yes | The unique ID of the issue to update \(e.g., "12345"\) |
|
||||||
| `status` | string | No | New status for the issue: resolved, unresolved, ignored, or resolvedInNextRelease |
|
| `status` | string | No | New status for the issue: resolved, unresolved, ignored, or resolvedInNextRelease |
|
||||||
| `assignedTo` | string | No | User ID or email to assign the issue to. Use empty string to unassign. |
|
| `assignedTo` | string | No | User ID or email to assign the issue to. Use empty string to unassign. |
|
||||||
| `isBookmarked` | boolean | No | Whether to bookmark the issue |
|
| `isBookmarked` | boolean | No | Whether to bookmark the issue |
|
||||||
@@ -184,18 +184,18 @@ Update a Sentry issue by changing its status, assignment, bookmark state, or oth
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `issue` | object | The updated Sentry issue |
|
| `issue` | object | The updated Sentry issue |
|
||||||
| ↳ `id` | string | Unique issue ID |
|
| ↳ `id` | string | Unique issue ID |
|
||||||
| ↳ `shortId` | string | Short issue identifier |
|
| ↳ `shortId` | string | Short issue identifier |
|
||||||
| ↳ `title` | string | Issue title |
|
| ↳ `title` | string | Issue title |
|
||||||
| ↳ `status` | string | Updated issue status |
|
| ↳ `status` | string | Updated issue status |
|
||||||
| ↳ `assignedTo` | object | User assigned to the issue \(if any\) |
|
| ↳ `assignedTo` | object | User assigned to the issue \(if any\) |
|
||||||
| ↳ `id` | string | User ID |
|
| ↳ `id` | string | User ID |
|
||||||
| ↳ `name` | string | User name |
|
| ↳ `name` | string | User name |
|
||||||
| ↳ `email` | string | User email |
|
| ↳ `email` | string | User email |
|
||||||
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
|
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
|
||||||
| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates |
|
| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates |
|
||||||
| ↳ `isPublic` | boolean | Whether the issue is publicly visible |
|
| ↳ `isPublic` | boolean | Whether the issue is publicly visible |
|
||||||
| ↳ `permalink` | string | Direct link to the issue in Sentry |
|
| ↳ `permalink` | string | Direct link to the issue in Sentry |
|
||||||
|
|
||||||
### `sentry_projects_list`
|
### `sentry_projects_list`
|
||||||
|
|
||||||
@@ -206,7 +206,7 @@ List all projects in a Sentry organization. Returns project details including na
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `cursor` | string | No | Pagination cursor for retrieving next page of results |
|
| `cursor` | string | No | Pagination cursor for retrieving next page of results |
|
||||||
| `limit` | number | No | Number of projects to return per page \(default: 25, max: 100\) |
|
| `limit` | number | No | Number of projects to return per page \(default: 25, max: 100\) |
|
||||||
|
|
||||||
@@ -224,18 +224,18 @@ List all projects in a Sentry organization. Returns project details including na
|
|||||||
| ↳ `isMember` | boolean | Whether the user is a member of the project |
|
| ↳ `isMember` | boolean | Whether the user is a member of the project |
|
||||||
| ↳ `features` | array | Enabled features for the project |
|
| ↳ `features` | array | Enabled features for the project |
|
||||||
| ↳ `organization` | object | Organization information |
|
| ↳ `organization` | object | Organization information |
|
||||||
| ↳ `id` | string | Organization ID |
|
| ↳ `id` | string | Organization ID |
|
||||||
| ↳ `slug` | string | Organization slug |
|
| ↳ `slug` | string | Organization slug |
|
||||||
| ↳ `name` | string | Organization name |
|
| ↳ `name` | string | Organization name |
|
||||||
| ↳ `teams` | array | Teams associated with the project |
|
| ↳ `teams` | array | Teams associated with the project |
|
||||||
| ↳ `id` | string | Team ID |
|
| ↳ `id` | string | Team ID |
|
||||||
| ↳ `name` | string | Team name |
|
| ↳ `name` | string | Team name |
|
||||||
| ↳ `slug` | string | Team slug |
|
| ↳ `slug` | string | Team slug |
|
||||||
| ↳ `status` | string | Project status |
|
| ↳ `status` | string | Project status |
|
||||||
| ↳ `isPublic` | boolean | Whether the project is publicly visible |
|
| ↳ `isPublic` | boolean | Whether the project is publicly visible |
|
||||||
| `metadata` | object | Pagination metadata |
|
| `metadata` | object | Pagination metadata |
|
||||||
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
|
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
|
||||||
| ↳ `hasMore` | boolean | Whether there are more results available |
|
| ↳ `hasMore` | boolean | Whether there are more results available |
|
||||||
|
|
||||||
### `sentry_projects_get`
|
### `sentry_projects_get`
|
||||||
|
|
||||||
@@ -246,47 +246,47 @@ Retrieve detailed information about a specific Sentry project by its slug. Retur
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `projectSlug` | string | Yes | The ID or slug of the project to retrieve |
|
| `projectSlug` | string | Yes | The slug of the project to retrieve \(e.g., "my-project"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `project` | object | Detailed information about the Sentry project |
|
| `project` | object | Detailed information about the Sentry project |
|
||||||
| ↳ `id` | string | Unique project ID |
|
| ↳ `id` | string | Unique project ID |
|
||||||
| ↳ `slug` | string | URL-friendly project identifier |
|
| ↳ `slug` | string | URL-friendly project identifier |
|
||||||
| ↳ `name` | string | Project name |
|
| ↳ `name` | string | Project name |
|
||||||
| ↳ `platform` | string | Platform/language \(e.g., javascript, python\) |
|
| ↳ `platform` | string | Platform/language \(e.g., javascript, python\) |
|
||||||
| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) |
|
| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) |
|
||||||
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
|
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
|
||||||
| ↳ `isMember` | boolean | Whether the user is a member of the project |
|
| ↳ `isMember` | boolean | Whether the user is a member of the project |
|
||||||
| ↳ `features` | array | Enabled features for the project |
|
| ↳ `features` | array | Enabled features for the project |
|
||||||
| ↳ `firstEvent` | string | When the first event was received \(ISO timestamp\) |
|
| ↳ `firstEvent` | string | When the first event was received \(ISO timestamp\) |
|
||||||
| ↳ `firstTransactionEvent` | string | When the first transaction event was received |
|
| ↳ `firstTransactionEvent` | string | When the first transaction event was received |
|
||||||
| ↳ `access` | array | Access permissions |
|
| ↳ `access` | array | Access permissions |
|
||||||
| ↳ `organization` | object | Organization information |
|
| ↳ `organization` | object | Organization information |
|
||||||
| ↳ `id` | string | Organization ID |
|
| ↳ `id` | string | Organization ID |
|
||||||
| ↳ `slug` | string | Organization slug |
|
| ↳ `slug` | string | Organization slug |
|
||||||
| ↳ `name` | string | Organization name |
|
| ↳ `name` | string | Organization name |
|
||||||
| ↳ `team` | object | Primary team for the project |
|
| ↳ `team` | object | Primary team for the project |
|
||||||
| ↳ `id` | string | Team ID |
|
| ↳ `id` | string | Team ID |
|
||||||
| ↳ `name` | string | Team name |
|
| ↳ `name` | string | Team name |
|
||||||
| ↳ `slug` | string | Team slug |
|
| ↳ `slug` | string | Team slug |
|
||||||
| ↳ `teams` | array | Teams associated with the project |
|
| ↳ `teams` | array | Teams associated with the project |
|
||||||
| ↳ `id` | string | Team ID |
|
| ↳ `id` | string | Team ID |
|
||||||
| ↳ `name` | string | Team name |
|
| ↳ `name` | string | Team name |
|
||||||
| ↳ `slug` | string | Team slug |
|
| ↳ `slug` | string | Team slug |
|
||||||
| ↳ `status` | string | Project status |
|
| ↳ `status` | string | Project status |
|
||||||
| ↳ `color` | string | Project color code |
|
| ↳ `color` | string | Project color code |
|
||||||
| ↳ `isPublic` | boolean | Whether the project is publicly visible |
|
| ↳ `isPublic` | boolean | Whether the project is publicly visible |
|
||||||
| ↳ `isInternal` | boolean | Whether the project is internal |
|
| ↳ `isInternal` | boolean | Whether the project is internal |
|
||||||
| ↳ `hasAccess` | boolean | Whether the user has access to this project |
|
| ↳ `hasAccess` | boolean | Whether the user has access to this project |
|
||||||
| ↳ `hasMinifiedStackTrace` | boolean | Whether minified stack traces are available |
|
| ↳ `hasMinifiedStackTrace` | boolean | Whether minified stack traces are available |
|
||||||
| ↳ `hasMonitors` | boolean | Whether the project has monitors configured |
|
| ↳ `hasMonitors` | boolean | Whether the project has monitors configured |
|
||||||
| ↳ `hasProfiles` | boolean | Whether the project has profiling enabled |
|
| ↳ `hasProfiles` | boolean | Whether the project has profiling enabled |
|
||||||
| ↳ `hasReplays` | boolean | Whether the project has session replays enabled |
|
| ↳ `hasReplays` | boolean | Whether the project has session replays enabled |
|
||||||
| ↳ `hasSessions` | boolean | Whether the project has sessions enabled |
|
| ↳ `hasSessions` | boolean | Whether the project has sessions enabled |
|
||||||
|
|
||||||
### `sentry_projects_create`
|
### `sentry_projects_create`
|
||||||
|
|
||||||
@@ -297,7 +297,7 @@ Create a new Sentry project in an organization. Requires a team to associate the
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `name` | string | Yes | The name of the project |
|
| `name` | string | Yes | The name of the project |
|
||||||
| `teamSlug` | string | Yes | The slug of the team that will own this project |
|
| `teamSlug` | string | Yes | The slug of the team that will own this project |
|
||||||
| `slug` | string | No | URL-friendly project identifier \(auto-generated from name if not provided\) |
|
| `slug` | string | No | URL-friendly project identifier \(auto-generated from name if not provided\) |
|
||||||
@@ -309,31 +309,31 @@ Create a new Sentry project in an organization. Requires a team to associate the
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `project` | object | The newly created Sentry project |
|
| `project` | object | The newly created Sentry project |
|
||||||
| ↳ `id` | string | Unique project ID |
|
| ↳ `id` | string | Unique project ID |
|
||||||
| ↳ `slug` | string | URL-friendly project identifier |
|
| ↳ `slug` | string | URL-friendly project identifier |
|
||||||
| ↳ `name` | string | Project name |
|
| ↳ `name` | string | Project name |
|
||||||
| ↳ `platform` | string | Platform/language |
|
| ↳ `platform` | string | Platform/language |
|
||||||
| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) |
|
| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) |
|
||||||
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
|
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
|
||||||
| ↳ `isMember` | boolean | Whether the user is a member |
|
| ↳ `isMember` | boolean | Whether the user is a member |
|
||||||
| ↳ `hasAccess` | boolean | Whether the user has access |
|
| ↳ `hasAccess` | boolean | Whether the user has access |
|
||||||
| ↳ `features` | array | Enabled features |
|
| ↳ `features` | array | Enabled features |
|
||||||
| ↳ `firstEvent` | string | First event timestamp |
|
| ↳ `firstEvent` | string | First event timestamp |
|
||||||
| ↳ `organization` | object | Organization information |
|
| ↳ `organization` | object | Organization information |
|
||||||
| ↳ `id` | string | Organization ID |
|
| ↳ `id` | string | Organization ID |
|
||||||
| ↳ `slug` | string | Organization slug |
|
| ↳ `slug` | string | Organization slug |
|
||||||
| ↳ `name` | string | Organization name |
|
| ↳ `name` | string | Organization name |
|
||||||
| ↳ `team` | object | Primary team for the project |
|
| ↳ `team` | object | Primary team for the project |
|
||||||
| ↳ `id` | string | Team ID |
|
| ↳ `id` | string | Team ID |
|
||||||
| ↳ `name` | string | Team name |
|
| ↳ `name` | string | Team name |
|
||||||
| ↳ `slug` | string | Team slug |
|
| ↳ `slug` | string | Team slug |
|
||||||
| ↳ `teams` | array | Teams associated with the project |
|
| ↳ `teams` | array | Teams associated with the project |
|
||||||
| ↳ `id` | string | Team ID |
|
| ↳ `id` | string | Team ID |
|
||||||
| ↳ `name` | string | Team name |
|
| ↳ `name` | string | Team name |
|
||||||
| ↳ `slug` | string | Team slug |
|
| ↳ `slug` | string | Team slug |
|
||||||
| ↳ `status` | string | Project status |
|
| ↳ `status` | string | Project status |
|
||||||
| ↳ `color` | string | Project color code |
|
| ↳ `color` | string | Project color code |
|
||||||
| ↳ `isPublic` | boolean | Whether the project is public |
|
| ↳ `isPublic` | boolean | Whether the project is public |
|
||||||
|
|
||||||
### `sentry_projects_update`
|
### `sentry_projects_update`
|
||||||
|
|
||||||
@@ -344,8 +344,8 @@ Update a Sentry project by changing its name, slug, platform, or other settings.
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `projectSlug` | string | Yes | The slug of the project to update |
|
| `projectSlug` | string | Yes | The slug of the project to update \(e.g., "my-project"\) |
|
||||||
| `name` | string | No | New name for the project |
|
| `name` | string | No | New name for the project |
|
||||||
| `slug` | string | No | New URL-friendly project identifier |
|
| `slug` | string | No | New URL-friendly project identifier |
|
||||||
| `platform` | string | No | New platform/language for the project \(e.g., javascript, python, node\) |
|
| `platform` | string | No | New platform/language for the project \(e.g., javascript, python, node\) |
|
||||||
@@ -358,19 +358,19 @@ Update a Sentry project by changing its name, slug, platform, or other settings.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `project` | object | The updated Sentry project |
|
| `project` | object | The updated Sentry project |
|
||||||
| ↳ `id` | string | Unique project ID |
|
| ↳ `id` | string | Unique project ID |
|
||||||
| ↳ `slug` | string | URL-friendly project identifier |
|
| ↳ `slug` | string | URL-friendly project identifier |
|
||||||
| ↳ `name` | string | Project name |
|
| ↳ `name` | string | Project name |
|
||||||
| ↳ `platform` | string | Platform/language |
|
| ↳ `platform` | string | Platform/language |
|
||||||
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
|
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
|
||||||
| ↳ `organization` | object | Organization information |
|
| ↳ `organization` | object | Organization information |
|
||||||
| ↳ `id` | string | Organization ID |
|
| ↳ `id` | string | Organization ID |
|
||||||
| ↳ `slug` | string | Organization slug |
|
| ↳ `slug` | string | Organization slug |
|
||||||
| ↳ `name` | string | Organization name |
|
| ↳ `name` | string | Organization name |
|
||||||
| ↳ `teams` | array | Teams associated with the project |
|
| ↳ `teams` | array | Teams associated with the project |
|
||||||
| ↳ `id` | string | Team ID |
|
| ↳ `id` | string | Team ID |
|
||||||
| ↳ `name` | string | Team name |
|
| ↳ `name` | string | Team name |
|
||||||
| ↳ `slug` | string | Team slug |
|
| ↳ `slug` | string | Team slug |
|
||||||
|
|
||||||
### `sentry_events_list`
|
### `sentry_events_list`
|
||||||
|
|
||||||
@@ -381,9 +381,9 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `projectSlug` | string | Yes | The slug of the project to list events from |
|
| `projectSlug` | string | Yes | The slug of the project to list events from \(e.g., "my-project"\) |
|
||||||
| `issueId` | string | No | Filter events by a specific issue ID |
|
| `issueId` | string | No | Filter events by a specific issue ID \(e.g., "12345"\) |
|
||||||
| `query` | string | No | Search query to filter events. Supports Sentry search syntax \(e.g., "user.email:*@example.com"\) |
|
| `query` | string | No | Search query to filter events. Supports Sentry search syntax \(e.g., "user.email:*@example.com"\) |
|
||||||
| `cursor` | string | No | Pagination cursor for retrieving next page of results |
|
| `cursor` | string | No | Pagination cursor for retrieving next page of results |
|
||||||
| `limit` | number | No | Number of events to return per page \(default: 50, max: 100\) |
|
| `limit` | number | No | Number of events to return per page \(default: 50, max: 100\) |
|
||||||
@@ -405,31 +405,31 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p
|
|||||||
| ↳ `dateCreated` | string | When the event was created \(ISO timestamp\) |
|
| ↳ `dateCreated` | string | When the event was created \(ISO timestamp\) |
|
||||||
| ↳ `dateReceived` | string | When Sentry received the event \(ISO timestamp\) |
|
| ↳ `dateReceived` | string | When Sentry received the event \(ISO timestamp\) |
|
||||||
| ↳ `user` | object | User information associated with the event |
|
| ↳ `user` | object | User information associated with the event |
|
||||||
| ↳ `id` | string | User ID |
|
| ↳ `id` | string | User ID |
|
||||||
| ↳ `email` | string | User email |
|
| ↳ `email` | string | User email |
|
||||||
| ↳ `username` | string | Username |
|
| ↳ `username` | string | Username |
|
||||||
| ↳ `ipAddress` | string | IP address |
|
| ↳ `ipAddress` | string | IP address |
|
||||||
| ↳ `name` | string | User display name |
|
| ↳ `name` | string | User display name |
|
||||||
| ↳ `tags` | array | Tags associated with the event |
|
| ↳ `tags` | array | Tags associated with the event |
|
||||||
| ↳ `key` | string | Tag key |
|
| ↳ `key` | string | Tag key |
|
||||||
| ↳ `value` | string | Tag value |
|
| ↳ `value` | string | Tag value |
|
||||||
| ↳ `contexts` | object | Additional context data \(device, OS, etc.\) |
|
| ↳ `contexts` | object | Additional context data \(device, OS, etc.\) |
|
||||||
| ↳ `platform` | string | Platform where the event occurred |
|
| ↳ `platform` | string | Platform where the event occurred |
|
||||||
| ↳ `type` | string | Event type |
|
| ↳ `type` | string | Event type |
|
||||||
| ↳ `metadata` | object | Error metadata |
|
| ↳ `metadata` | object | Error metadata |
|
||||||
| ↳ `type` | string | Type of error \(e.g., TypeError\) |
|
| ↳ `type` | string | Type of error \(e.g., TypeError\) |
|
||||||
| ↳ `value` | string | Error message or value |
|
| ↳ `value` | string | Error message or value |
|
||||||
| ↳ `function` | string | Function where the error occurred |
|
| ↳ `function` | string | Function where the error occurred |
|
||||||
| ↳ `entries` | array | Event entries \(exception, breadcrumbs, etc.\) |
|
| ↳ `entries` | array | Event entries \(exception, breadcrumbs, etc.\) |
|
||||||
| ↳ `errors` | array | Processing errors |
|
| ↳ `errors` | array | Processing errors |
|
||||||
| ↳ `dist` | string | Distribution identifier |
|
| ↳ `dist` | string | Distribution identifier |
|
||||||
| ↳ `fingerprints` | array | Fingerprints for grouping |
|
| ↳ `fingerprints` | array | Fingerprints for grouping |
|
||||||
| ↳ `sdk` | object | SDK information |
|
| ↳ `sdk` | object | SDK information |
|
||||||
| ↳ `name` | string | SDK name |
|
| ↳ `name` | string | SDK name |
|
||||||
| ↳ `version` | string | SDK version |
|
| ↳ `version` | string | SDK version |
|
||||||
| `metadata` | object | Pagination metadata |
|
| `metadata` | object | Pagination metadata |
|
||||||
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
|
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
|
||||||
| ↳ `hasMore` | boolean | Whether there are more results available |
|
| ↳ `hasMore` | boolean | Whether there are more results available |
|
||||||
|
|
||||||
### `sentry_events_get`
|
### `sentry_events_get`
|
||||||
|
|
||||||
@@ -440,48 +440,48 @@ Retrieve detailed information about a specific Sentry event by its ID. Returns c
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `projectSlug` | string | Yes | The slug of the project |
|
| `projectSlug` | string | Yes | The slug of the project \(e.g., "my-project"\) |
|
||||||
| `eventId` | string | Yes | The unique ID of the event to retrieve |
|
| `eventId` | string | Yes | The unique ID of the event to retrieve \(e.g., "abc123def456"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `event` | object | Detailed information about the Sentry event |
|
| `event` | object | Detailed information about the Sentry event |
|
||||||
| ↳ `id` | string | Unique event ID |
|
| ↳ `id` | string | Unique event ID |
|
||||||
| ↳ `eventID` | string | Event identifier |
|
| ↳ `eventID` | string | Event identifier |
|
||||||
| ↳ `projectID` | string | Project ID |
|
| ↳ `projectID` | string | Project ID |
|
||||||
| ↳ `groupID` | string | Issue group ID this event belongs to |
|
| ↳ `groupID` | string | Issue group ID this event belongs to |
|
||||||
| ↳ `message` | string | Event message |
|
| ↳ `message` | string | Event message |
|
||||||
| ↳ `title` | string | Event title |
|
| ↳ `title` | string | Event title |
|
||||||
| ↳ `location` | string | Location information |
|
| ↳ `location` | string | Location information |
|
||||||
| ↳ `culprit` | string | Function or location that caused the event |
|
| ↳ `culprit` | string | Function or location that caused the event |
|
||||||
| ↳ `dateCreated` | string | When the event was created \(ISO timestamp\) |
|
| ↳ `dateCreated` | string | When the event was created \(ISO timestamp\) |
|
||||||
| ↳ `dateReceived` | string | When Sentry received the event \(ISO timestamp\) |
|
| ↳ `dateReceived` | string | When Sentry received the event \(ISO timestamp\) |
|
||||||
| ↳ `user` | object | User information associated with the event |
|
| ↳ `user` | object | User information associated with the event |
|
||||||
| ↳ `id` | string | User ID |
|
| ↳ `id` | string | User ID |
|
||||||
| ↳ `email` | string | User email |
|
| ↳ `email` | string | User email |
|
||||||
| ↳ `username` | string | Username |
|
| ↳ `username` | string | Username |
|
||||||
| ↳ `ipAddress` | string | IP address |
|
| ↳ `ipAddress` | string | IP address |
|
||||||
| ↳ `name` | string | User display name |
|
| ↳ `name` | string | User display name |
|
||||||
| ↳ `tags` | array | Tags associated with the event |
|
| ↳ `tags` | array | Tags associated with the event |
|
||||||
| ↳ `key` | string | Tag key |
|
| ↳ `key` | string | Tag key |
|
||||||
| ↳ `value` | string | Tag value |
|
| ↳ `value` | string | Tag value |
|
||||||
| ↳ `contexts` | object | Additional context data \(device, OS, browser, etc.\) |
|
| ↳ `contexts` | object | Additional context data \(device, OS, browser, etc.\) |
|
||||||
| ↳ `platform` | string | Platform where the event occurred |
|
| ↳ `platform` | string | Platform where the event occurred |
|
||||||
| ↳ `type` | string | Event type \(error, transaction, etc.\) |
|
| ↳ `type` | string | Event type \(error, transaction, etc.\) |
|
||||||
| ↳ `metadata` | object | Error metadata |
|
| ↳ `metadata` | object | Error metadata |
|
||||||
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
|
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
|
||||||
| ↳ `value` | string | Error message or value |
|
| ↳ `value` | string | Error message or value |
|
||||||
| ↳ `function` | string | Function where the error occurred |
|
| ↳ `function` | string | Function where the error occurred |
|
||||||
| ↳ `entries` | array | Event entries including exception, breadcrumbs, and request data |
|
| ↳ `entries` | array | Event entries including exception, breadcrumbs, and request data |
|
||||||
| ↳ `errors` | array | Processing errors that occurred |
|
| ↳ `errors` | array | Processing errors that occurred |
|
||||||
| ↳ `dist` | string | Distribution identifier |
|
| ↳ `dist` | string | Distribution identifier |
|
||||||
| ↳ `fingerprints` | array | Fingerprints used for grouping events |
|
| ↳ `fingerprints` | array | Fingerprints used for grouping events |
|
||||||
| ↳ `sdk` | object | SDK information |
|
| ↳ `sdk` | object | SDK information |
|
||||||
| ↳ `name` | string | SDK name |
|
| ↳ `name` | string | SDK name |
|
||||||
| ↳ `version` | string | SDK version |
|
| ↳ `version` | string | SDK version |
|
||||||
|
|
||||||
### `sentry_releases_list`
|
### `sentry_releases_list`
|
||||||
|
|
||||||
@@ -492,9 +492,9 @@ List releases for a Sentry organization or project. Returns release details incl
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `projectSlug` | string | No | Filter releases by specific project slug \(optional\) |
|
| `projectSlug` | string | No | Filter releases by specific project slug \(e.g., "my-project"\) |
|
||||||
| `query` | string | No | Search query to filter releases \(e.g., version name pattern\) |
|
| `query` | string | No | Search query to filter releases \(e.g., "1.0" to match version patterns\) |
|
||||||
| `cursor` | string | No | Pagination cursor for retrieving next page of results |
|
| `cursor` | string | No | Pagination cursor for retrieving next page of results |
|
||||||
| `limit` | number | No | Number of releases to return per page \(default: 25, max: 100\) |
|
| `limit` | number | No | Number of releases to return per page \(default: 25, max: 100\) |
|
||||||
|
|
||||||
@@ -513,39 +513,39 @@ List releases for a Sentry organization or project. Returns release details incl
|
|||||||
| ↳ `dateStarted` | string | When the release started \(ISO timestamp\) |
|
| ↳ `dateStarted` | string | When the release started \(ISO timestamp\) |
|
||||||
| ↳ `newGroups` | number | Number of new issues introduced in this release |
|
| ↳ `newGroups` | number | Number of new issues introduced in this release |
|
||||||
| ↳ `owner` | object | Owner of the release |
|
| ↳ `owner` | object | Owner of the release |
|
||||||
| ↳ `id` | string | User ID |
|
| ↳ `id` | string | User ID |
|
||||||
| ↳ `name` | string | User name |
|
| ↳ `name` | string | User name |
|
||||||
| ↳ `email` | string | User email |
|
| ↳ `email` | string | User email |
|
||||||
| ↳ `commitCount` | number | Number of commits in this release |
|
| ↳ `commitCount` | number | Number of commits in this release |
|
||||||
| ↳ `deployCount` | number | Number of deploys for this release |
|
| ↳ `deployCount` | number | Number of deploys for this release |
|
||||||
| ↳ `lastCommit` | object | Last commit in the release |
|
| ↳ `lastCommit` | object | Last commit in the release |
|
||||||
| ↳ `id` | string | Commit SHA |
|
| ↳ `id` | string | Commit SHA |
|
||||||
| ↳ `message` | string | Commit message |
|
| ↳ `message` | string | Commit message |
|
||||||
| ↳ `dateCreated` | string | Commit timestamp |
|
| ↳ `dateCreated` | string | Commit timestamp |
|
||||||
| ↳ `lastDeploy` | object | Last deploy of the release |
|
| ↳ `lastDeploy` | object | Last deploy of the release |
|
||||||
| ↳ `id` | string | Deploy ID |
|
| ↳ `id` | string | Deploy ID |
|
||||||
| ↳ `environment` | string | Deploy environment |
|
| ↳ `environment` | string | Deploy environment |
|
||||||
| ↳ `dateStarted` | string | Deploy start timestamp |
|
| ↳ `dateStarted` | string | Deploy start timestamp |
|
||||||
| ↳ `dateFinished` | string | Deploy finish timestamp |
|
| ↳ `dateFinished` | string | Deploy finish timestamp |
|
||||||
| ↳ `authors` | array | Authors of commits in the release |
|
| ↳ `authors` | array | Authors of commits in the release |
|
||||||
| ↳ `id` | string | Author ID |
|
| ↳ `id` | string | Author ID |
|
||||||
| ↳ `name` | string | Author name |
|
| ↳ `name` | string | Author name |
|
||||||
| ↳ `email` | string | Author email |
|
| ↳ `email` | string | Author email |
|
||||||
| ↳ `projects` | array | Projects associated with this release |
|
| ↳ `projects` | array | Projects associated with this release |
|
||||||
| ↳ `id` | string | Project ID |
|
| ↳ `id` | string | Project ID |
|
||||||
| ↳ `name` | string | Project name |
|
| ↳ `name` | string | Project name |
|
||||||
| ↳ `slug` | string | Project slug |
|
| ↳ `slug` | string | Project slug |
|
||||||
| ↳ `platform` | string | Project platform |
|
| ↳ `platform` | string | Project platform |
|
||||||
| ↳ `firstEvent` | string | First event timestamp |
|
| ↳ `firstEvent` | string | First event timestamp |
|
||||||
| ↳ `lastEvent` | string | Last event timestamp |
|
| ↳ `lastEvent` | string | Last event timestamp |
|
||||||
| ↳ `versionInfo` | object | Version metadata |
|
| ↳ `versionInfo` | object | Version metadata |
|
||||||
| ↳ `buildHash` | string | Build hash |
|
| ↳ `buildHash` | string | Build hash |
|
||||||
| ↳ `version` | object | Version details |
|
| ↳ `version` | object | Version details |
|
||||||
| ↳ `raw` | string | Raw version string |
|
| ↳ `raw` | string | Raw version string |
|
||||||
| ↳ `package` | string | Package name |
|
| ↳ `package` | string | Package name |
|
||||||
| `metadata` | object | Pagination metadata |
|
| `metadata` | object | Pagination metadata |
|
||||||
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
|
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
|
||||||
| ↳ `hasMore` | boolean | Whether there are more results available |
|
| ↳ `hasMore` | boolean | Whether there are more results available |
|
||||||
|
|
||||||
### `sentry_releases_create`
|
### `sentry_releases_create`
|
||||||
|
|
||||||
@@ -556,7 +556,7 @@ Create a new release in Sentry. A release is a version of your code deployed to
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `version` | string | Yes | Version identifier for the release \(e.g., "2.0.0", "my-app@1.0.0", or a git commit SHA\) |
|
| `version` | string | Yes | Version identifier for the release \(e.g., "2.0.0", "my-app@1.0.0", or a git commit SHA\) |
|
||||||
| `projects` | string | Yes | Comma-separated list of project slugs to associate with this release |
|
| `projects` | string | Yes | Comma-separated list of project slugs to associate with this release |
|
||||||
| `ref` | string | No | Git reference \(commit SHA, tag, or branch\) for this release |
|
| `ref` | string | No | Git reference \(commit SHA, tag, or branch\) for this release |
|
||||||
@@ -569,46 +569,46 @@ Create a new release in Sentry. A release is a version of your code deployed to
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `release` | object | The newly created Sentry release |
|
| `release` | object | The newly created Sentry release |
|
||||||
| ↳ `id` | string | Unique release ID |
|
| ↳ `id` | string | Unique release ID |
|
||||||
| ↳ `version` | string | Release version identifier |
|
| ↳ `version` | string | Release version identifier |
|
||||||
| ↳ `shortVersion` | string | Shortened version identifier |
|
| ↳ `shortVersion` | string | Shortened version identifier |
|
||||||
| ↳ `ref` | string | Git reference \(commit SHA, tag, or branch\) |
|
| ↳ `ref` | string | Git reference \(commit SHA, tag, or branch\) |
|
||||||
| ↳ `url` | string | URL to the release |
|
| ↳ `url` | string | URL to the release |
|
||||||
| ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) |
|
| ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) |
|
||||||
| ↳ `dateCreated` | string | When the release was created \(ISO timestamp\) |
|
| ↳ `dateCreated` | string | When the release was created \(ISO timestamp\) |
|
||||||
| ↳ `dateStarted` | string | When the release started \(ISO timestamp\) |
|
| ↳ `dateStarted` | string | When the release started \(ISO timestamp\) |
|
||||||
| ↳ `newGroups` | number | Number of new issues introduced |
|
| ↳ `newGroups` | number | Number of new issues introduced |
|
||||||
| ↳ `commitCount` | number | Number of commits in this release |
|
| ↳ `commitCount` | number | Number of commits in this release |
|
||||||
| ↳ `deployCount` | number | Number of deploys for this release |
|
| ↳ `deployCount` | number | Number of deploys for this release |
|
||||||
| ↳ `owner` | object | Release owner |
|
| ↳ `owner` | object | Release owner |
|
||||||
| ↳ `id` | string | Owner ID |
|
| ↳ `id` | string | Owner ID |
|
||||||
| ↳ `name` | string | Owner name |
|
| ↳ `name` | string | Owner name |
|
||||||
| ↳ `email` | string | Owner email |
|
| ↳ `email` | string | Owner email |
|
||||||
| ↳ `lastCommit` | object | Last commit in the release |
|
| ↳ `lastCommit` | object | Last commit in the release |
|
||||||
| ↳ `id` | string | Commit SHA |
|
| ↳ `id` | string | Commit SHA |
|
||||||
| ↳ `message` | string | Commit message |
|
| ↳ `message` | string | Commit message |
|
||||||
| ↳ `dateCreated` | string | Commit timestamp |
|
| ↳ `dateCreated` | string | Commit timestamp |
|
||||||
| ↳ `lastDeploy` | object | Last deploy of the release |
|
| ↳ `lastDeploy` | object | Last deploy of the release |
|
||||||
| ↳ `id` | string | Deploy ID |
|
| ↳ `id` | string | Deploy ID |
|
||||||
| ↳ `environment` | string | Deploy environment |
|
| ↳ `environment` | string | Deploy environment |
|
||||||
| ↳ `dateStarted` | string | Deploy start timestamp |
|
| ↳ `dateStarted` | string | Deploy start timestamp |
|
||||||
| ↳ `dateFinished` | string | Deploy finish timestamp |
|
| ↳ `dateFinished` | string | Deploy finish timestamp |
|
||||||
| ↳ `authors` | array | Authors of commits in the release |
|
| ↳ `authors` | array | Authors of commits in the release |
|
||||||
| ↳ `id` | string | Author ID |
|
| ↳ `id` | string | Author ID |
|
||||||
| ↳ `name` | string | Author name |
|
| ↳ `name` | string | Author name |
|
||||||
| ↳ `email` | string | Author email |
|
| ↳ `email` | string | Author email |
|
||||||
| ↳ `projects` | array | Projects associated with this release |
|
| ↳ `projects` | array | Projects associated with this release |
|
||||||
| ↳ `id` | string | Project ID |
|
| ↳ `id` | string | Project ID |
|
||||||
| ↳ `name` | string | Project name |
|
| ↳ `name` | string | Project name |
|
||||||
| ↳ `slug` | string | Project slug |
|
| ↳ `slug` | string | Project slug |
|
||||||
| ↳ `platform` | string | Project platform |
|
| ↳ `platform` | string | Project platform |
|
||||||
| ↳ `firstEvent` | string | First event timestamp |
|
| ↳ `firstEvent` | string | First event timestamp |
|
||||||
| ↳ `lastEvent` | string | Last event timestamp |
|
| ↳ `lastEvent` | string | Last event timestamp |
|
||||||
| ↳ `versionInfo` | object | Version metadata |
|
| ↳ `versionInfo` | object | Version metadata |
|
||||||
| ↳ `buildHash` | string | Build hash |
|
| ↳ `buildHash` | string | Build hash |
|
||||||
| ↳ `version` | object | Version details |
|
| ↳ `version` | object | Version details |
|
||||||
| ↳ `raw` | string | Raw version string |
|
| ↳ `raw` | string | Raw version string |
|
||||||
| ↳ `package` | string | Package name |
|
| ↳ `package` | string | Package name |
|
||||||
|
|
||||||
### `sentry_releases_deploy`
|
### `sentry_releases_deploy`
|
||||||
|
|
||||||
@@ -619,8 +619,8 @@ Create a deploy record for a Sentry release in a specific environment. Deploys t
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `apiKey` | string | Yes | Sentry API authentication token |
|
| `apiKey` | string | Yes | Sentry API authentication token |
|
||||||
| `organizationSlug` | string | Yes | The slug of the organization |
|
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) |
|
||||||
| `version` | string | Yes | Version identifier of the release being deployed |
|
| `version` | string | Yes | Version identifier of the release being deployed \(e.g., "1.0.0" or "abc123"\) |
|
||||||
| `environment` | string | Yes | Environment name where the release is being deployed \(e.g., "production", "staging"\) |
|
| `environment` | string | Yes | Environment name where the release is being deployed \(e.g., "production", "staging"\) |
|
||||||
| `name` | string | No | Optional name for this deploy \(e.g., "Deploy v2.0 to Production"\) |
|
| `name` | string | No | Optional name for this deploy \(e.g., "Deploy v2.0 to Production"\) |
|
||||||
| `url` | string | No | URL pointing to the deploy \(e.g., CI/CD pipeline URL\) |
|
| `url` | string | No | URL pointing to the deploy \(e.g., CI/CD pipeline URL\) |
|
||||||
@@ -632,11 +632,11 @@ Create a deploy record for a Sentry release in a specific environment. Deploys t
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `deploy` | object | The newly created deploy record |
|
| `deploy` | object | The newly created deploy record |
|
||||||
| ↳ `id` | string | Unique deploy ID |
|
| ↳ `id` | string | Unique deploy ID |
|
||||||
| ↳ `environment` | string | Environment name where the release was deployed |
|
| ↳ `environment` | string | Environment name where the release was deployed |
|
||||||
| ↳ `name` | string | Name of the deploy |
|
| ↳ `name` | string | Name of the deploy |
|
||||||
| ↳ `url` | string | URL pointing to the deploy |
|
| ↳ `url` | string | URL pointing to the deploy |
|
||||||
| ↳ `dateStarted` | string | When the deploy started \(ISO timestamp\) |
|
| ↳ `dateStarted` | string | When the deploy started \(ISO timestamp\) |
|
||||||
| ↳ `dateFinished` | string | When the deploy finished \(ISO timestamp\) |
|
| ↳ `dateFinished` | string | When the deploy finished \(ISO timestamp\) |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -35,17 +35,17 @@ Integrate Serper into the workflow. Can search the web.
|
|||||||
|
|
||||||
### `serper_search`
|
### `serper_search`
|
||||||
|
|
||||||
A powerful web search tool that provides access to Google search results through Serper.dev API. Supports different types of searches including regular web search, news, places, and images, with each result containing relevant metadata like titles, URLs, snippets, and type-specific information.
|
A powerful web search tool that provides access to Google search results through Serper.dev API. Supports different types of searches including regular web search, news, places, images, videos, and shopping. Returns comprehensive results including organic results, knowledge graph, answer box, people also ask, related searches, and top stories.
|
||||||
|
|
||||||
#### Input
|
#### Input
|
||||||
|
|
||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `query` | string | Yes | The search query |
|
| `query` | string | Yes | The search query \(e.g., "latest AI news", "best restaurants in NYC"\) |
|
||||||
| `num` | number | No | Number of results to return |
|
| `num` | number | No | Number of results to return \(e.g., 10, 20, 50\) |
|
||||||
| `gl` | string | No | Country code for search results |
|
| `gl` | string | No | Country code for search results \(e.g., "us", "uk", "de", "fr"\) |
|
||||||
| `hl` | string | No | Language code for search results |
|
| `hl` | string | No | Language code for search results \(e.g., "en", "es", "de", "fr"\) |
|
||||||
| `type` | string | No | Type of search to perform |
|
| `type` | string | No | Type of search to perform \(e.g., "search", "news", "images", "videos", "places", "shopping"\) |
|
||||||
| `apiKey` | string | Yes | Serper API Key |
|
| `apiKey` | string | Yes | Serper API Key |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -53,5 +53,17 @@ A powerful web search tool that provides access to Google search results through
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `searchResults` | array | Search results with titles, links, snippets, and type-specific metadata \(date for news, rating for places, imageUrl for images\) |
|
| `searchResults` | array | Search results with titles, links, snippets, and type-specific metadata \(date for news, rating for places, imageUrl for images\) |
|
||||||
|
| ↳ `title` | string | Result title |
|
||||||
|
| ↳ `link` | string | Result URL |
|
||||||
|
| ↳ `snippet` | string | Result description/snippet |
|
||||||
|
| ↳ `position` | number | Position in search results |
|
||||||
|
| ↳ `date` | string | Publication date \(news/videos\) |
|
||||||
|
| ↳ `imageUrl` | string | Image URL \(images/news/shopping\) |
|
||||||
|
| ↳ `source` | string | Source name \(news/videos/shopping\) |
|
||||||
|
| ↳ `rating` | number | Rating \(places\) |
|
||||||
|
| ↳ `ratingCount` | number | Number of reviews \(places\) |
|
||||||
|
| ↳ `address` | string | Address \(places\) |
|
||||||
|
| ↳ `price` | string | Price \(shopping\) |
|
||||||
|
| ↳ `duration` | string | Duration \(videos\) |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ Create a new record in a ServiceNow table
|
|||||||
| `username` | string | Yes | ServiceNow username |
|
| `username` | string | Yes | ServiceNow username |
|
||||||
| `password` | string | Yes | ServiceNow password |
|
| `password` | string | Yes | ServiceNow password |
|
||||||
| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user\) |
|
| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user\) |
|
||||||
| `fields` | json | Yes | Fields to set on the record \(JSON object\) |
|
| `fields` | json | Yes | Fields to set on the record as JSON object \(e.g., \{"short_description": "Issue title", "priority": "1"\}\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -64,12 +64,12 @@ Read records from a ServiceNow table
|
|||||||
| `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) |
|
| `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) |
|
||||||
| `username` | string | Yes | ServiceNow username |
|
| `username` | string | Yes | ServiceNow username |
|
||||||
| `password` | string | Yes | ServiceNow password |
|
| `password` | string | Yes | ServiceNow password |
|
||||||
| `tableName` | string | Yes | Table name |
|
| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user, change_request\) |
|
||||||
| `sysId` | string | No | Specific record sys_id |
|
| `sysId` | string | No | Specific record sys_id \(e.g., 6816f79cc0a8016401c5a33be04be441\) |
|
||||||
| `number` | string | No | Record number \(e.g., INC0010001\) |
|
| `number` | string | No | Record number \(e.g., INC0010001\) |
|
||||||
| `query` | string | No | Encoded query string \(e.g., "active=true^priority=1"\) |
|
| `query` | string | No | Encoded query string \(e.g., "active=true^priority=1"\) |
|
||||||
| `limit` | number | No | Maximum number of records to return |
|
| `limit` | number | No | Maximum number of records to return \(e.g., 10, 50, 100\) |
|
||||||
| `fields` | string | No | Comma-separated list of fields to return |
|
| `fields` | string | No | Comma-separated list of fields to return \(e.g., sys_id,number,short_description,state\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -89,9 +89,9 @@ Update an existing record in a ServiceNow table
|
|||||||
| `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) |
|
| `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) |
|
||||||
| `username` | string | Yes | ServiceNow username |
|
| `username` | string | Yes | ServiceNow username |
|
||||||
| `password` | string | Yes | ServiceNow password |
|
| `password` | string | Yes | ServiceNow password |
|
||||||
| `tableName` | string | Yes | Table name |
|
| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user, change_request\) |
|
||||||
| `sysId` | string | Yes | Record sys_id to update |
|
| `sysId` | string | Yes | Record sys_id to update \(e.g., 6816f79cc0a8016401c5a33be04be441\) |
|
||||||
| `fields` | json | Yes | Fields to update \(JSON object\) |
|
| `fields` | json | Yes | Fields to update as JSON object \(e.g., \{"state": "2", "priority": "1"\}\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -111,8 +111,8 @@ Delete a record from a ServiceNow table
|
|||||||
| `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) |
|
| `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) |
|
||||||
| `username` | string | Yes | ServiceNow username |
|
| `username` | string | Yes | ServiceNow username |
|
||||||
| `password` | string | Yes | ServiceNow password |
|
| `password` | string | Yes | ServiceNow password |
|
||||||
| `tableName` | string | Yes | Table name |
|
| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user, change_request\) |
|
||||||
| `sysId` | string | Yes | Record sys_id to delete |
|
| `sysId` | string | Yes | Record sys_id to delete \(e.g., 6816f79cc0a8016401c5a33be04be441\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ Create a new page in a SharePoint site
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
||||||
| `siteSelector` | string | No | Select the SharePoint site |
|
| `siteSelector` | string | No | Select the SharePoint site |
|
||||||
| `pageName` | string | Yes | The name of the page to create |
|
| `pageName` | string | Yes | The name of the page to create. Example: My-New-Page.aspx or Report-2024.aspx |
|
||||||
| `pageTitle` | string | No | The title of the page \(defaults to page name if not provided\) |
|
| `pageTitle` | string | No | The title of the page \(defaults to page name if not provided\) |
|
||||||
| `pageContent` | string | No | The content of the page |
|
| `pageContent` | string | No | The content of the page |
|
||||||
|
|
||||||
@@ -52,13 +52,13 @@ Create a new page in a SharePoint site
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `page` | object | Created SharePoint page information |
|
| `page` | object | Created SharePoint page information |
|
||||||
| ↳ `id` | string | The unique ID of the created page |
|
| ↳ `id` | string | The unique ID of the created page |
|
||||||
| ↳ `name` | string | The name of the created page |
|
| ↳ `name` | string | The name of the created page |
|
||||||
| ↳ `title` | string | The title of the created page |
|
| ↳ `title` | string | The title of the created page |
|
||||||
| ↳ `webUrl` | string | The URL to access the page |
|
| ↳ `webUrl` | string | The URL to access the page |
|
||||||
| ↳ `pageLayout` | string | The layout type of the page |
|
| ↳ `pageLayout` | string | The layout type of the page |
|
||||||
| ↳ `createdDateTime` | string | When the page was created |
|
| ↳ `createdDateTime` | string | When the page was created |
|
||||||
| ↳ `lastModifiedDateTime` | string | When the page was last modified |
|
| ↳ `lastModifiedDateTime` | string | When the page was last modified |
|
||||||
|
|
||||||
### `sharepoint_read_page`
|
### `sharepoint_read_page`
|
||||||
|
|
||||||
@@ -70,8 +70,8 @@ Read a specific page from a SharePoint site
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `siteSelector` | string | No | Select the SharePoint site |
|
| `siteSelector` | string | No | Select the SharePoint site |
|
||||||
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
||||||
| `pageId` | string | No | The ID of the page to read |
|
| `pageId` | string | No | The ID of the page to read. Example: a GUID like 12345678-1234-1234-1234-123456789012 |
|
||||||
| `pageName` | string | No | The name of the page to read \(alternative to pageId\) |
|
| `pageName` | string | No | The name of the page to read \(alternative to pageId\). Example: Home.aspx or About-Us.aspx |
|
||||||
| `maxPages` | number | No | Maximum number of pages to return when listing all pages \(default: 10, max: 50\) |
|
| `maxPages` | number | No | Maximum number of pages to return when listing all pages \(default: 10, max: 50\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -79,15 +79,6 @@ Read a specific page from a SharePoint site
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `page` | object | Information about the SharePoint page |
|
| `page` | object | Information about the SharePoint page |
|
||||||
| ↳ `id` | string | The unique ID of the page |
|
|
||||||
| ↳ `name` | string | The name of the page |
|
|
||||||
| ↳ `title` | string | The title of the page |
|
|
||||||
| ↳ `webUrl` | string | The URL to access the page |
|
|
||||||
| ↳ `pageLayout` | string | The layout type of the page |
|
|
||||||
| ↳ `createdDateTime` | string | When the page was created |
|
|
||||||
| ↳ `lastModifiedDateTime` | string | When the page was last modified |
|
|
||||||
| `pages` | array | List of SharePoint pages |
|
|
||||||
| ↳ `page` | object | The unique ID of the page |
|
|
||||||
| ↳ `id` | string | The unique ID of the page |
|
| ↳ `id` | string | The unique ID of the page |
|
||||||
| ↳ `name` | string | The name of the page |
|
| ↳ `name` | string | The name of the page |
|
||||||
| ↳ `title` | string | The title of the page |
|
| ↳ `title` | string | The title of the page |
|
||||||
@@ -95,12 +86,21 @@ Read a specific page from a SharePoint site
|
|||||||
| ↳ `pageLayout` | string | The layout type of the page |
|
| ↳ `pageLayout` | string | The layout type of the page |
|
||||||
| ↳ `createdDateTime` | string | When the page was created |
|
| ↳ `createdDateTime` | string | When the page was created |
|
||||||
| ↳ `lastModifiedDateTime` | string | When the page was last modified |
|
| ↳ `lastModifiedDateTime` | string | When the page was last modified |
|
||||||
|
| `pages` | array | List of SharePoint pages |
|
||||||
|
| ↳ `page` | object | The unique ID of the page |
|
||||||
|
| ↳ `id` | string | The unique ID of the page |
|
||||||
|
| ↳ `name` | string | The name of the page |
|
||||||
|
| ↳ `title` | string | The title of the page |
|
||||||
|
| ↳ `webUrl` | string | The URL to access the page |
|
||||||
|
| ↳ `pageLayout` | string | The layout type of the page |
|
||||||
|
| ↳ `createdDateTime` | string | When the page was created |
|
||||||
|
| ↳ `lastModifiedDateTime` | string | When the page was last modified |
|
||||||
| ↳ `content` | object | Extracted text content from the page |
|
| ↳ `content` | object | Extracted text content from the page |
|
||||||
|
| ↳ `content` | string | Extracted text content from the page |
|
||||||
|
| ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure |
|
||||||
|
| `content` | object | Content of the SharePoint page |
|
||||||
| ↳ `content` | string | Extracted text content from the page |
|
| ↳ `content` | string | Extracted text content from the page |
|
||||||
| ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure |
|
| ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure |
|
||||||
| `content` | object | Content of the SharePoint page |
|
|
||||||
| ↳ `content` | string | Extracted text content from the page |
|
|
||||||
| ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure |
|
|
||||||
| `totalPages` | number | Total number of pages found |
|
| `totalPages` | number | Total number of pages found |
|
||||||
|
|
||||||
### `sharepoint_list_sites`
|
### `sharepoint_list_sites`
|
||||||
@@ -112,25 +112,25 @@ List details of all SharePoint sites
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `siteSelector` | string | No | Select the SharePoint site |
|
| `siteSelector` | string | No | Select the SharePoint site |
|
||||||
| `groupId` | string | No | The group ID for accessing a group team site |
|
| `groupId` | string | No | The group ID for accessing a group team site. Example: a GUID like 12345678-1234-1234-1234-123456789012 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `site` | object | Information about the current SharePoint site |
|
| `site` | object | Information about the current SharePoint site |
|
||||||
| ↳ `id` | string | The unique ID of the site |
|
| ↳ `id` | string | The unique ID of the site |
|
||||||
| ↳ `name` | string | The name of the site |
|
| ↳ `name` | string | The name of the site |
|
||||||
| ↳ `displayName` | string | The display name of the site |
|
| ↳ `displayName` | string | The display name of the site |
|
||||||
| ↳ `webUrl` | string | The URL to access the site |
|
| ↳ `webUrl` | string | The URL to access the site |
|
||||||
| ↳ `description` | string | The description of the site |
|
| ↳ `description` | string | The description of the site |
|
||||||
| ↳ `createdDateTime` | string | When the site was created |
|
| ↳ `createdDateTime` | string | When the site was created |
|
||||||
| ↳ `lastModifiedDateTime` | string | When the site was last modified |
|
| ↳ `lastModifiedDateTime` | string | When the site was last modified |
|
||||||
| ↳ `isPersonalSite` | boolean | Whether this is a personal site |
|
| ↳ `isPersonalSite` | boolean | Whether this is a personal site |
|
||||||
| ↳ `root` | object | Server relative URL |
|
| ↳ `root` | object | Server relative URL |
|
||||||
| ↳ `serverRelativeUrl` | string | Server relative URL |
|
| ↳ `serverRelativeUrl` | string | Server relative URL |
|
||||||
| ↳ `siteCollection` | object | Site collection hostname |
|
| ↳ `siteCollection` | object | Site collection hostname |
|
||||||
| ↳ `hostname` | string | Site collection hostname |
|
| ↳ `hostname` | string | Site collection hostname |
|
||||||
| `sites` | array | List of all accessible SharePoint sites |
|
| `sites` | array | List of all accessible SharePoint sites |
|
||||||
| ↳ `id` | string | The unique ID of the site |
|
| ↳ `id` | string | The unique ID of the site |
|
||||||
| ↳ `name` | string | The name of the site |
|
| ↳ `name` | string | The name of the site |
|
||||||
@@ -150,7 +150,7 @@ Create a new list in a SharePoint site
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
||||||
| `siteSelector` | string | No | Select the SharePoint site |
|
| `siteSelector` | string | No | Select the SharePoint site |
|
||||||
| `listDisplayName` | string | Yes | Display name of the list to create |
|
| `listDisplayName` | string | Yes | Display name of the list to create. Example: Project Tasks or Customer Contacts |
|
||||||
| `listDescription` | string | No | Description of the list |
|
| `listDescription` | string | No | Description of the list |
|
||||||
| `listTemplate` | string | No | List template name \(e.g., 'genericList'\) |
|
| `listTemplate` | string | No | List template name \(e.g., 'genericList'\) |
|
||||||
| `pageContent` | string | No | Optional JSON of columns. Either a top-level array of column definitions or an object with \{ columns: \[...\] \}. |
|
| `pageContent` | string | No | Optional JSON of columns. Either a top-level array of column definitions or an object with \{ columns: \[...\] \}. |
|
||||||
@@ -160,13 +160,13 @@ Create a new list in a SharePoint site
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `list` | object | Created SharePoint list information |
|
| `list` | object | Created SharePoint list information |
|
||||||
| ↳ `id` | string | The unique ID of the list |
|
| ↳ `id` | string | The unique ID of the list |
|
||||||
| ↳ `displayName` | string | The display name of the list |
|
| ↳ `displayName` | string | The display name of the list |
|
||||||
| ↳ `name` | string | The internal name of the list |
|
| ↳ `name` | string | The internal name of the list |
|
||||||
| ↳ `webUrl` | string | The web URL of the list |
|
| ↳ `webUrl` | string | The web URL of the list |
|
||||||
| ↳ `createdDateTime` | string | When the list was created |
|
| ↳ `createdDateTime` | string | When the list was created |
|
||||||
| ↳ `lastModifiedDateTime` | string | When the list was last modified |
|
| ↳ `lastModifiedDateTime` | string | When the list was last modified |
|
||||||
| ↳ `list` | object | List properties \(e.g., template\) |
|
| ↳ `list` | object | List properties \(e.g., template\) |
|
||||||
|
|
||||||
### `sharepoint_get_list`
|
### `sharepoint_get_list`
|
||||||
|
|
||||||
@@ -178,21 +178,21 @@ Get metadata (and optionally columns/items) for a SharePoint list
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `siteSelector` | string | No | Select the SharePoint site |
|
| `siteSelector` | string | No | Select the SharePoint site |
|
||||||
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
||||||
| `listId` | string | No | The ID of the list to retrieve |
|
| `listId` | string | No | The ID of the list to retrieve. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `list` | object | Information about the SharePoint list |
|
| `list` | object | Information about the SharePoint list |
|
||||||
| ↳ `id` | string | The unique ID of the list |
|
| ↳ `id` | string | The unique ID of the list |
|
||||||
| ↳ `displayName` | string | The display name of the list |
|
| ↳ `displayName` | string | The display name of the list |
|
||||||
| ↳ `name` | string | The internal name of the list |
|
| ↳ `name` | string | The internal name of the list |
|
||||||
| ↳ `webUrl` | string | The web URL of the list |
|
| ↳ `webUrl` | string | The web URL of the list |
|
||||||
| ↳ `createdDateTime` | string | When the list was created |
|
| ↳ `createdDateTime` | string | When the list was created |
|
||||||
| ↳ `lastModifiedDateTime` | string | When the list was last modified |
|
| ↳ `lastModifiedDateTime` | string | When the list was last modified |
|
||||||
| ↳ `list` | object | List properties \(e.g., template\) |
|
| ↳ `list` | object | List properties \(e.g., template\) |
|
||||||
| ↳ `columns` | array | List column definitions |
|
| ↳ `columns` | array | List column definitions |
|
||||||
| `lists` | array | All lists in the site when no listId/title provided |
|
| `lists` | array | All lists in the site when no listId/title provided |
|
||||||
|
|
||||||
### `sharepoint_update_list`
|
### `sharepoint_update_list`
|
||||||
@@ -205,8 +205,8 @@ Update the properties (fields) on a SharePoint list item
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `siteSelector` | string | No | Select the SharePoint site |
|
| `siteSelector` | string | No | Select the SharePoint site |
|
||||||
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
||||||
| `listId` | string | No | The ID of the list containing the item |
|
| `listId` | string | No | The ID of the list containing the item. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 |
|
||||||
| `itemId` | string | Yes | The ID of the list item to update |
|
| `itemId` | string | Yes | The ID of the list item to update. Example: 1, 42, or 123 |
|
||||||
| `listItemFields` | object | Yes | Field values to update on the list item |
|
| `listItemFields` | object | Yes | Field values to update on the list item |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -214,8 +214,8 @@ Update the properties (fields) on a SharePoint list item
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `item` | object | Updated SharePoint list item |
|
| `item` | object | Updated SharePoint list item |
|
||||||
| ↳ `id` | string | Item ID |
|
| ↳ `id` | string | Item ID |
|
||||||
| ↳ `fields` | object | Updated field values |
|
| ↳ `fields` | object | Updated field values |
|
||||||
|
|
||||||
### `sharepoint_add_list_items`
|
### `sharepoint_add_list_items`
|
||||||
|
|
||||||
@@ -227,7 +227,7 @@ Add a new item to a SharePoint list
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `siteSelector` | string | No | Select the SharePoint site |
|
| `siteSelector` | string | No | Select the SharePoint site |
|
||||||
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
|
||||||
| `listId` | string | Yes | The ID of the list to add the item to |
|
| `listId` | string | Yes | The ID of the list to add the item to. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 |
|
||||||
| `listItemFields` | object | Yes | Field values for the new list item |
|
| `listItemFields` | object | Yes | Field values for the new list item |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
@@ -235,8 +235,8 @@ Add a new item to a SharePoint list
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `item` | object | Created SharePoint list item |
|
| `item` | object | Created SharePoint list item |
|
||||||
| ↳ `id` | string | Item ID |
|
| ↳ `id` | string | Item ID |
|
||||||
| ↳ `fields` | object | Field values for the new item |
|
| ↳ `fields` | object | Field values for the new item |
|
||||||
|
|
||||||
### `sharepoint_upload_file`
|
### `sharepoint_upload_file`
|
||||||
|
|
||||||
@@ -247,9 +247,9 @@ Upload files to a SharePoint document library
|
|||||||
| Parameter | Type | Required | Description |
|
| Parameter | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `siteId` | string | No | The ID of the SharePoint site |
|
| `siteId` | string | No | The ID of the SharePoint site |
|
||||||
| `driveId` | string | No | The ID of the document library \(drive\). If not provided, uses default drive. |
|
| `driveId` | string | No | The ID of the document library \(drive\). If not provided, uses default drive. Example: b!abc123def456 |
|
||||||
| `folderPath` | string | No | Optional folder path within the document library \(e.g., /Documents/Subfolder\) |
|
| `folderPath` | string | No | Optional folder path within the document library. Example: /Documents/Subfolder or /Shared Documents/Reports |
|
||||||
| `fileName` | string | No | Optional: override the uploaded file name |
|
| `fileName` | string | No | Optional: override the uploaded file name. Example: report-2024.pdf |
|
||||||
| `files` | file[] | No | Files to upload to SharePoint |
|
| `files` | file[] | No | Files to upload to SharePoint |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|||||||
@@ -53,6 +53,18 @@ Create a new product in your Shopify store
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `product` | object | The created product |
|
| `product` | object | The created product |
|
||||||
|
| ↳ `id` | string | Unique product identifier \(GID\) |
|
||||||
|
| ↳ `title` | string | Product title |
|
||||||
|
| ↳ `handle` | string | URL-friendly product identifier |
|
||||||
|
| ↳ `descriptionHtml` | string | Product description in HTML format |
|
||||||
|
| ↳ `vendor` | string | Product vendor or manufacturer |
|
||||||
|
| ↳ `productType` | string | Product type classification |
|
||||||
|
| ↳ `tags` | array | Product tags for categorization |
|
||||||
|
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||||
|
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `variants` | object | Product variants with edges/nodes structure |
|
||||||
|
| ↳ `images` | object | Product images with edges/nodes structure |
|
||||||
|
|
||||||
### `shopify_get_product`
|
### `shopify_get_product`
|
||||||
|
|
||||||
@@ -70,6 +82,18 @@ Get a single product by ID from your Shopify store
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `product` | object | The product details |
|
| `product` | object | The product details |
|
||||||
|
| ↳ `id` | string | Unique product identifier \(GID\) |
|
||||||
|
| ↳ `title` | string | Product title |
|
||||||
|
| ↳ `handle` | string | URL-friendly product identifier |
|
||||||
|
| ↳ `descriptionHtml` | string | Product description in HTML format |
|
||||||
|
| ↳ `vendor` | string | Product vendor or manufacturer |
|
||||||
|
| ↳ `productType` | string | Product type classification |
|
||||||
|
| ↳ `tags` | array | Product tags for categorization |
|
||||||
|
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||||
|
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `variants` | object | Product variants with edges/nodes structure |
|
||||||
|
| ↳ `images` | object | Product images with edges/nodes structure |
|
||||||
|
|
||||||
### `shopify_list_products`
|
### `shopify_list_products`
|
||||||
|
|
||||||
@@ -88,7 +112,21 @@ List products from your Shopify store with optional filtering
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `products` | array | List of products |
|
| `products` | array | List of products |
|
||||||
|
| ↳ `id` | string | Unique product identifier \(GID\) |
|
||||||
|
| ↳ `title` | string | Product title |
|
||||||
|
| ↳ `handle` | string | URL-friendly product identifier |
|
||||||
|
| ↳ `descriptionHtml` | string | Product description in HTML format |
|
||||||
|
| ↳ `vendor` | string | Product vendor or manufacturer |
|
||||||
|
| ↳ `productType` | string | Product type classification |
|
||||||
|
| ↳ `tags` | array | Product tags for categorization |
|
||||||
|
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||||
|
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `variants` | object | Product variants with edges/nodes structure |
|
||||||
|
| ↳ `images` | object | Product images with edges/nodes structure |
|
||||||
| `pageInfo` | object | Pagination information |
|
| `pageInfo` | object | Pagination information |
|
||||||
|
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||||
|
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||||
|
|
||||||
### `shopify_update_product`
|
### `shopify_update_product`
|
||||||
|
|
||||||
@@ -112,6 +150,18 @@ Update an existing product in your Shopify store
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `product` | object | The updated product |
|
| `product` | object | The updated product |
|
||||||
|
| ↳ `id` | string | Unique product identifier \(GID\) |
|
||||||
|
| ↳ `title` | string | Product title |
|
||||||
|
| ↳ `handle` | string | URL-friendly product identifier |
|
||||||
|
| ↳ `descriptionHtml` | string | Product description in HTML format |
|
||||||
|
| ↳ `vendor` | string | Product vendor or manufacturer |
|
||||||
|
| ↳ `productType` | string | Product type classification |
|
||||||
|
| ↳ `tags` | array | Product tags for categorization |
|
||||||
|
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||||
|
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `variants` | object | Product variants with edges/nodes structure |
|
||||||
|
| ↳ `images` | object | Product images with edges/nodes structure |
|
||||||
|
|
||||||
### `shopify_delete_product`
|
### `shopify_delete_product`
|
||||||
|
|
||||||
@@ -146,6 +196,27 @@ Get a single order by ID from your Shopify store
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `order` | object | The order details |
|
| `order` | object | The order details |
|
||||||
|
| ↳ `id` | string | Unique order identifier \(GID\) |
|
||||||
|
| ↳ `name` | string | Order name \(e.g., #1001\) |
|
||||||
|
| ↳ `email` | string | Customer email for the order |
|
||||||
|
| ↳ `phone` | string | Customer phone for the order |
|
||||||
|
| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) |
|
||||||
|
| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) |
|
||||||
|
| ↳ `totalPriceSet` | object | Total order price |
|
||||||
|
| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) |
|
||||||
|
| ↳ `totalTaxSet` | object | Total tax amount |
|
||||||
|
| ↳ `totalShippingPriceSet` | object | Total shipping price |
|
||||||
|
| ↳ `note` | string | Order note |
|
||||||
|
| ↳ `tags` | array | Order tags |
|
||||||
|
| ↳ `customer` | object | Customer who placed the order |
|
||||||
|
| ↳ `lineItems` | object | Order line items with edges/nodes structure |
|
||||||
|
| ↳ `shippingAddress` | object | Shipping address |
|
||||||
|
| ↳ `billingAddress` | object | Billing address |
|
||||||
|
| ↳ `fulfillments` | array | Order fulfillments |
|
||||||
|
|
||||||
### `shopify_list_orders`
|
### `shopify_list_orders`
|
||||||
|
|
||||||
@@ -165,7 +236,30 @@ List orders from your Shopify store with optional filtering
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `orders` | array | List of orders |
|
| `orders` | array | List of orders |
|
||||||
|
| ↳ `id` | string | Unique order identifier \(GID\) |
|
||||||
|
| ↳ `name` | string | Order name \(e.g., #1001\) |
|
||||||
|
| ↳ `email` | string | Customer email for the order |
|
||||||
|
| ↳ `phone` | string | Customer phone for the order |
|
||||||
|
| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) |
|
||||||
|
| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) |
|
||||||
|
| ↳ `totalPriceSet` | object | Total order price |
|
||||||
|
| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) |
|
||||||
|
| ↳ `totalTaxSet` | object | Total tax amount |
|
||||||
|
| ↳ `totalShippingPriceSet` | object | Total shipping price |
|
||||||
|
| ↳ `note` | string | Order note |
|
||||||
|
| ↳ `tags` | array | Order tags |
|
||||||
|
| ↳ `customer` | object | Customer who placed the order |
|
||||||
|
| ↳ `lineItems` | object | Order line items with edges/nodes structure |
|
||||||
|
| ↳ `shippingAddress` | object | Shipping address |
|
||||||
|
| ↳ `billingAddress` | object | Billing address |
|
||||||
|
| ↳ `fulfillments` | array | Order fulfillments |
|
||||||
| `pageInfo` | object | Pagination information |
|
| `pageInfo` | object | Pagination information |
|
||||||
|
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||||
|
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||||
|
|
||||||
### `shopify_update_order`
|
### `shopify_update_order`
|
||||||
|
|
||||||
@@ -186,6 +280,27 @@ Update an existing order in your Shopify store (note, tags, email)
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `order` | object | The updated order |
|
| `order` | object | The updated order |
|
||||||
|
| ↳ `id` | string | Unique order identifier \(GID\) |
|
||||||
|
| ↳ `name` | string | Order name \(e.g., #1001\) |
|
||||||
|
| ↳ `email` | string | Customer email for the order |
|
||||||
|
| ↳ `phone` | string | Customer phone for the order |
|
||||||
|
| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) |
|
||||||
|
| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) |
|
||||||
|
| ↳ `totalPriceSet` | object | Total order price |
|
||||||
|
| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) |
|
||||||
|
| ↳ `totalTaxSet` | object | Total tax amount |
|
||||||
|
| ↳ `totalShippingPriceSet` | object | Total shipping price |
|
||||||
|
| ↳ `note` | string | Order note |
|
||||||
|
| ↳ `tags` | array | Order tags |
|
||||||
|
| ↳ `customer` | object | Customer who placed the order |
|
||||||
|
| ↳ `lineItems` | object | Order line items with edges/nodes structure |
|
||||||
|
| ↳ `shippingAddress` | object | Shipping address |
|
||||||
|
| ↳ `billingAddress` | object | Billing address |
|
||||||
|
| ↳ `fulfillments` | array | Order fulfillments |
|
||||||
|
|
||||||
### `shopify_cancel_order`
|
### `shopify_cancel_order`
|
||||||
|
|
||||||
@@ -208,6 +323,9 @@ Cancel an order in your Shopify store
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `order` | object | The cancellation result |
|
| `order` | object | The cancellation result |
|
||||||
|
| ↳ `id` | string | Job identifier for the cancellation |
|
||||||
|
| ↳ `cancelled` | boolean | Whether the cancellation completed |
|
||||||
|
| ↳ `message` | string | Status message |
|
||||||
|
|
||||||
### `shopify_create_customer`
|
### `shopify_create_customer`
|
||||||
|
|
||||||
@@ -231,6 +349,18 @@ Create a new customer in your Shopify store
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `customer` | object | The created customer |
|
| `customer` | object | The created customer |
|
||||||
|
| ↳ `id` | string | Unique customer identifier \(GID\) |
|
||||||
|
| ↳ `email` | string | Customer email address |
|
||||||
|
| ↳ `firstName` | string | Customer first name |
|
||||||
|
| ↳ `lastName` | string | Customer last name |
|
||||||
|
| ↳ `phone` | string | Customer phone number |
|
||||||
|
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `note` | string | Internal notes about the customer |
|
||||||
|
| ↳ `tags` | array | Customer tags for categorization |
|
||||||
|
| ↳ `amountSpent` | object | Total amount spent by customer |
|
||||||
|
| ↳ `addresses` | array | Customer addresses |
|
||||||
|
| ↳ `defaultAddress` | object | Customer default address |
|
||||||
|
|
||||||
### `shopify_get_customer`
|
### `shopify_get_customer`
|
||||||
|
|
||||||
@@ -248,6 +378,18 @@ Get a single customer by ID from your Shopify store
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `customer` | object | The customer details |
|
| `customer` | object | The customer details |
|
||||||
|
| ↳ `id` | string | Unique customer identifier \(GID\) |
|
||||||
|
| ↳ `email` | string | Customer email address |
|
||||||
|
| ↳ `firstName` | string | Customer first name |
|
||||||
|
| ↳ `lastName` | string | Customer last name |
|
||||||
|
| ↳ `phone` | string | Customer phone number |
|
||||||
|
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `note` | string | Internal notes about the customer |
|
||||||
|
| ↳ `tags` | array | Customer tags for categorization |
|
||||||
|
| ↳ `amountSpent` | object | Total amount spent by customer |
|
||||||
|
| ↳ `addresses` | array | Customer addresses |
|
||||||
|
| ↳ `defaultAddress` | object | Customer default address |
|
||||||
|
|
||||||
### `shopify_list_customers`
|
### `shopify_list_customers`
|
||||||
|
|
||||||
@@ -266,7 +408,21 @@ List customers from your Shopify store with optional filtering
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `customers` | array | List of customers |
|
| `customers` | array | List of customers |
|
||||||
|
| ↳ `id` | string | Unique customer identifier \(GID\) |
|
||||||
|
| ↳ `email` | string | Customer email address |
|
||||||
|
| ↳ `firstName` | string | Customer first name |
|
||||||
|
| ↳ `lastName` | string | Customer last name |
|
||||||
|
| ↳ `phone` | string | Customer phone number |
|
||||||
|
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `note` | string | Internal notes about the customer |
|
||||||
|
| ↳ `tags` | array | Customer tags for categorization |
|
||||||
|
| ↳ `amountSpent` | object | Total amount spent by customer |
|
||||||
|
| ↳ `addresses` | array | Customer addresses |
|
||||||
|
| ↳ `defaultAddress` | object | Customer default address |
|
||||||
| `pageInfo` | object | Pagination information |
|
| `pageInfo` | object | Pagination information |
|
||||||
|
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||||
|
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||||
|
|
||||||
### `shopify_update_customer`
|
### `shopify_update_customer`
|
||||||
|
|
||||||
@@ -290,6 +446,18 @@ Update an existing customer in your Shopify store
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `customer` | object | The updated customer |
|
| `customer` | object | The updated customer |
|
||||||
|
| ↳ `id` | string | Unique customer identifier \(GID\) |
|
||||||
|
| ↳ `email` | string | Customer email address |
|
||||||
|
| ↳ `firstName` | string | Customer first name |
|
||||||
|
| ↳ `lastName` | string | Customer last name |
|
||||||
|
| ↳ `phone` | string | Customer phone number |
|
||||||
|
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `note` | string | Internal notes about the customer |
|
||||||
|
| ↳ `tags` | array | Customer tags for categorization |
|
||||||
|
| ↳ `amountSpent` | object | Total amount spent by customer |
|
||||||
|
| ↳ `addresses` | array | Customer addresses |
|
||||||
|
| ↳ `defaultAddress` | object | Customer default address |
|
||||||
|
|
||||||
### `shopify_delete_customer`
|
### `shopify_delete_customer`
|
||||||
|
|
||||||
@@ -325,7 +493,26 @@ List inventory items from your Shopify store. Use this to find inventory item ID
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `inventoryItems` | array | List of inventory items with their IDs, SKUs, and stock levels |
|
| `inventoryItems` | array | List of inventory items with their IDs, SKUs, and stock levels |
|
||||||
|
| ↳ `id` | string | Unique inventory item identifier \(GID\) |
|
||||||
|
| ↳ `sku` | string | Stock keeping unit |
|
||||||
|
| ↳ `tracked` | boolean | Whether inventory is tracked |
|
||||||
|
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `variant` | object | Associated product variant |
|
||||||
|
| ↳ `id` | string | Variant identifier \(GID\) |
|
||||||
|
| ↳ `title` | string | Variant title |
|
||||||
|
| ↳ `product` | object | Associated product |
|
||||||
|
| ↳ `id` | string | Product identifier \(GID\) |
|
||||||
|
| ↳ `title` | string | Product title |
|
||||||
|
| ↳ `inventoryLevels` | array | Inventory levels at different locations |
|
||||||
|
| ↳ `id` | string | Inventory level identifier \(GID\) |
|
||||||
|
| ↳ `available` | number | Available quantity |
|
||||||
|
| ↳ `location` | object | Location for this inventory level |
|
||||||
|
| ↳ `id` | string | Location identifier \(GID\) |
|
||||||
|
| ↳ `name` | string | Location name |
|
||||||
| `pageInfo` | object | Pagination information |
|
| `pageInfo` | object | Pagination information |
|
||||||
|
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||||
|
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||||
|
|
||||||
### `shopify_get_inventory_level`
|
### `shopify_get_inventory_level`
|
||||||
|
|
||||||
@@ -344,6 +531,19 @@ Get inventory level for a product variant at a specific location
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `inventoryLevel` | object | The inventory level details |
|
| `inventoryLevel` | object | The inventory level details |
|
||||||
|
| ↳ `id` | string | Inventory item identifier \(GID\) |
|
||||||
|
| ↳ `sku` | string | Stock keeping unit |
|
||||||
|
| ↳ `tracked` | boolean | Whether inventory is tracked |
|
||||||
|
| ↳ `levels` | array | Inventory levels at different locations |
|
||||||
|
| ↳ `id` | string | Inventory level identifier \(GID\) |
|
||||||
|
| ↳ `available` | number | Available quantity |
|
||||||
|
| ↳ `onHand` | number | On-hand quantity |
|
||||||
|
| ↳ `committed` | number | Committed quantity |
|
||||||
|
| ↳ `incoming` | number | Incoming quantity |
|
||||||
|
| ↳ `reserved` | number | Reserved quantity |
|
||||||
|
| ↳ `location` | object | Location for this inventory level |
|
||||||
|
| ↳ `id` | string | Location identifier \(GID\) |
|
||||||
|
| ↳ `name` | string | Location name |
|
||||||
|
|
||||||
### `shopify_adjust_inventory`
|
### `shopify_adjust_inventory`
|
||||||
|
|
||||||
@@ -363,6 +563,19 @@ Adjust inventory quantity for a product variant at a specific location
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `inventoryLevel` | object | The inventory adjustment result |
|
| `inventoryLevel` | object | The inventory adjustment result |
|
||||||
|
| ↳ `adjustmentGroup` | object | Inventory adjustment group details |
|
||||||
|
| ↳ `createdAt` | string | Adjustment timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `reason` | string | Adjustment reason |
|
||||||
|
| ↳ `changes` | array | Inventory changes applied |
|
||||||
|
| ↳ `name` | string | Quantity name \(e.g., available\) |
|
||||||
|
| ↳ `delta` | number | Quantity change amount |
|
||||||
|
| ↳ `quantityAfterChange` | number | Quantity after adjustment |
|
||||||
|
| ↳ `item` | object | Inventory item |
|
||||||
|
| ↳ `id` | string | Inventory item identifier \(GID\) |
|
||||||
|
| ↳ `sku` | string | Stock keeping unit |
|
||||||
|
| ↳ `location` | object | Location of the adjustment |
|
||||||
|
| ↳ `id` | string | Location identifier \(GID\) |
|
||||||
|
| ↳ `name` | string | Location name |
|
||||||
|
|
||||||
### `shopify_list_locations`
|
### `shopify_list_locations`
|
||||||
|
|
||||||
@@ -381,7 +594,14 @@ List inventory locations from your Shopify store. Use this to find location IDs
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `locations` | array | List of locations with their IDs, names, and addresses |
|
| `locations` | array | List of locations with their IDs, names, and addresses |
|
||||||
|
| ↳ `id` | string | Unique location identifier \(GID\) |
|
||||||
|
| ↳ `name` | string | Location name |
|
||||||
|
| ↳ `isActive` | boolean | Whether the location is active |
|
||||||
|
| ↳ `fulfillsOnlineOrders` | boolean | Whether the location fulfills online orders |
|
||||||
|
| ↳ `address` | object | Location address |
|
||||||
| `pageInfo` | object | Pagination information |
|
| `pageInfo` | object | Pagination information |
|
||||||
|
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||||
|
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||||
|
|
||||||
### `shopify_create_fulfillment`
|
### `shopify_create_fulfillment`
|
||||||
|
|
||||||
@@ -403,6 +623,16 @@ Create a fulfillment to mark order items as shipped. Requires a fulfillment orde
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `fulfillment` | object | The created fulfillment with tracking info and fulfilled items |
|
| `fulfillment` | object | The created fulfillment with tracking info and fulfilled items |
|
||||||
|
| ↳ `id` | string | Unique fulfillment identifier \(GID\) |
|
||||||
|
| ↳ `status` | string | Fulfillment status \(pending, open, success, cancelled, error, failure\) |
|
||||||
|
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `trackingInfo` | array | Tracking information for shipments |
|
||||||
|
| ↳ `fulfillmentLineItems` | array | Fulfilled line items |
|
||||||
|
| ↳ `id` | string | Fulfillment line item identifier \(GID\) |
|
||||||
|
| ↳ `quantity` | number | Quantity fulfilled |
|
||||||
|
| ↳ `lineItem` | object | Associated order line item |
|
||||||
|
| ↳ `title` | string | Product title |
|
||||||
|
|
||||||
### `shopify_list_collections`
|
### `shopify_list_collections`
|
||||||
|
|
||||||
@@ -421,7 +651,18 @@ List product collections from your Shopify store. Filter by title, type (custom/
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `collections` | array | List of collections with their IDs, titles, and product counts |
|
| `collections` | array | List of collections with their IDs, titles, and product counts |
|
||||||
|
| ↳ `id` | string | Unique collection identifier \(GID\) |
|
||||||
|
| ↳ `title` | string | Collection title |
|
||||||
|
| ↳ `handle` | string | URL-friendly collection identifier |
|
||||||
|
| ↳ `description` | string | Plain text description |
|
||||||
|
| ↳ `descriptionHtml` | string | HTML-formatted description |
|
||||||
|
| ↳ `productsCount` | number | Number of products in the collection |
|
||||||
|
| ↳ `sortOrder` | string | Product sort order in the collection |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `image` | object | Collection image |
|
||||||
| `pageInfo` | object | Pagination information |
|
| `pageInfo` | object | Pagination information |
|
||||||
|
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
|
||||||
|
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
|
||||||
|
|
||||||
### `shopify_get_collection`
|
### `shopify_get_collection`
|
||||||
|
|
||||||
@@ -440,5 +681,15 @@ Get a specific collection by ID, including its products. Use this to retrieve pr
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `collection` | object | The collection details including its products |
|
| `collection` | object | The collection details including its products |
|
||||||
|
| ↳ `id` | string | Unique collection identifier \(GID\) |
|
||||||
|
| ↳ `title` | string | Collection title |
|
||||||
|
| ↳ `handle` | string | URL-friendly collection identifier |
|
||||||
|
| ↳ `description` | string | Plain text description |
|
||||||
|
| ↳ `descriptionHtml` | string | HTML-formatted description |
|
||||||
|
| ↳ `productsCount` | number | Number of products in the collection |
|
||||||
|
| ↳ `sortOrder` | string | Product sort order in the collection |
|
||||||
|
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
|
||||||
|
| ↳ `image` | object | Collection image |
|
||||||
|
| ↳ `products` | array | Products in the collection |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
183
apps/docs/content/docs/en/tools/similarweb.mdx
Normal file
183
apps/docs/content/docs/en/tools/similarweb.mdx
Normal file
@@ -0,0 +1,183 @@
|
|||||||
|
---
|
||||||
|
title: Similarweb
|
||||||
|
description: Website traffic and analytics data
|
||||||
|
---
|
||||||
|
|
||||||
|
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||||
|
|
||||||
|
<BlockInfoCard
|
||||||
|
type="similarweb"
|
||||||
|
color="#000922"
|
||||||
|
/>
|
||||||
|
|
||||||
|
{/* MANUAL-CONTENT-START:intro */}
|
||||||
|
[Similarweb](https://www.similarweb.com/) is a leading platform for web analytics that provides in-depth traffic and engagement data for millions of websites. Similarweb gives you insights into website visits, traffic sources, audience behavior, and competitive benchmarks.
|
||||||
|
|
||||||
|
With Similarweb in Sim, your agents can:
|
||||||
|
|
||||||
|
- **Analyze website traffic**: Retrieve key metrics such as monthly visits, average duration, bounce rates, and top countries.
|
||||||
|
- **Understand audience engagement**: Gain insights into how users interact with websites, including pages per visit and engagement duration.
|
||||||
|
- **Track rankings and performance**: Access global, country, and category ranks to benchmark sites against competitors.
|
||||||
|
- **Discover traffic sources**: Break down traffic by channels like direct, search, social, referrals, and more.
|
||||||
|
|
||||||
|
Use Sim's Similarweb integration to automate the monitoring of competitors, track your site’s performance, or surface actionable market research—all integrated directly into your workflows and automations. Empower your agents to access and utilize reliable web analytics data easily and programmatically.
|
||||||
|
{/* MANUAL-CONTENT-END */}
|
||||||
|
|
||||||
|
|
||||||
|
## Usage Instructions
|
||||||
|
|
||||||
|
Access comprehensive website analytics including traffic estimates, engagement metrics, rankings, and traffic sources using the Similarweb API.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Tools
|
||||||
|
|
||||||
|
### `similarweb_website_overview`
|
||||||
|
|
||||||
|
Get comprehensive website analytics including traffic, rankings, engagement, and traffic sources
|
||||||
|
|
||||||
|
#### Input
|
||||||
|
|
||||||
|
| Parameter | Type | Required | Description |
|
||||||
|
| --------- | ---- | -------- | ----------- |
|
||||||
|
| `apiKey` | string | Yes | SimilarWeb API key |
|
||||||
|
| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) |
|
||||||
|
|
||||||
|
#### Output
|
||||||
|
|
||||||
|
| Parameter | Type | Description |
|
||||||
|
| --------- | ---- | ----------- |
|
||||||
|
| `siteName` | string | Website name |
|
||||||
|
| `description` | string | Website description |
|
||||||
|
| `globalRank` | number | Global traffic rank |
|
||||||
|
| `countryRank` | number | Country traffic rank |
|
||||||
|
| `categoryRank` | number | Category traffic rank |
|
||||||
|
| `category` | string | Website category |
|
||||||
|
| `monthlyVisits` | number | Estimated monthly visits |
|
||||||
|
| `engagementVisitDuration` | number | Average visit duration in seconds |
|
||||||
|
| `engagementPagesPerVisit` | number | Average pages per visit |
|
||||||
|
| `engagementBounceRate` | number | Bounce rate \(0-1\) |
|
||||||
|
| `topCountries` | array | Top countries by traffic share |
|
||||||
|
| ↳ `country` | string | Country code |
|
||||||
|
| ↳ `share` | number | Traffic share \(0-1\) |
|
||||||
|
| `trafficSources` | json | Traffic source breakdown |
|
||||||
|
| ↳ `direct` | number | Direct traffic share |
|
||||||
|
| ↳ `referrals` | number | Referral traffic share |
|
||||||
|
| ↳ `search` | number | Search traffic share |
|
||||||
|
| ↳ `social` | number | Social traffic share |
|
||||||
|
| ↳ `mail` | number | Email traffic share |
|
||||||
|
| ↳ `paidReferrals` | number | Paid referral traffic share |
|
||||||
|
|
||||||
|
### `similarweb_traffic_visits`
|
||||||
|
|
||||||
|
Get total website visits over time (desktop and mobile combined)
|
||||||
|
|
||||||
|
#### Input
|
||||||
|
|
||||||
|
| Parameter | Type | Required | Description |
|
||||||
|
| --------- | ---- | -------- | ----------- |
|
||||||
|
| `apiKey` | string | Yes | SimilarWeb API key |
|
||||||
|
| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) |
|
||||||
|
| `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data |
|
||||||
|
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
|
||||||
|
| `startDate` | string | No | Start date in YYYY-MM format \(e.g., "2024-01"\) |
|
||||||
|
| `endDate` | string | No | End date in YYYY-MM format \(e.g., "2024-12"\) |
|
||||||
|
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
|
||||||
|
|
||||||
|
#### Output
|
||||||
|
|
||||||
|
| Parameter | Type | Description |
|
||||||
|
| --------- | ---- | ----------- |
|
||||||
|
| `domain` | string | Analyzed domain |
|
||||||
|
| `country` | string | Country filter applied |
|
||||||
|
| `granularity` | string | Data granularity |
|
||||||
|
| `lastUpdated` | string | Data last updated timestamp |
|
||||||
|
| `visits` | array | Visit data over time |
|
||||||
|
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
|
||||||
|
| ↳ `visits` | number | Number of visits |
|
||||||
|
|
||||||
|
### `similarweb_bounce_rate`
|
||||||
|
|
||||||
|
Get website bounce rate over time (desktop and mobile combined)
|
||||||
|
|
||||||
|
#### Input
|
||||||
|
|
||||||
|
| Parameter | Type | Required | Description |
|
||||||
|
| --------- | ---- | -------- | ----------- |
|
||||||
|
| `apiKey` | string | Yes | SimilarWeb API key |
|
||||||
|
| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) |
|
||||||
|
| `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data |
|
||||||
|
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
|
||||||
|
| `startDate` | string | No | Start date in YYYY-MM format \(e.g., "2024-01"\) |
|
||||||
|
| `endDate` | string | No | End date in YYYY-MM format \(e.g., "2024-12"\) |
|
||||||
|
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
|
||||||
|
|
||||||
|
#### Output
|
||||||
|
|
||||||
|
| Parameter | Type | Description |
|
||||||
|
| --------- | ---- | ----------- |
|
||||||
|
| `domain` | string | Analyzed domain |
|
||||||
|
| `country` | string | Country filter applied |
|
||||||
|
| `granularity` | string | Data granularity |
|
||||||
|
| `lastUpdated` | string | Data last updated timestamp |
|
||||||
|
| `bounceRate` | array | Bounce rate data over time |
|
||||||
|
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
|
||||||
|
| ↳ `bounceRate` | number | Bounce rate \(0-1\) |
|
||||||
|
|
||||||
|
### `similarweb_pages_per_visit`
|
||||||
|
|
||||||
|
Get average pages per visit over time (desktop and mobile combined)
|
||||||
|
|
||||||
|
#### Input
|
||||||
|
|
||||||
|
| Parameter | Type | Required | Description |
|
||||||
|
| --------- | ---- | -------- | ----------- |
|
||||||
|
| `apiKey` | string | Yes | SimilarWeb API key |
|
||||||
|
| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) |
|
||||||
|
| `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data |
|
||||||
|
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
|
||||||
|
| `startDate` | string | No | Start date in YYYY-MM format \(e.g., "2024-01"\) |
|
||||||
|
| `endDate` | string | No | End date in YYYY-MM format \(e.g., "2024-12"\) |
|
||||||
|
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
|
||||||
|
|
||||||
|
#### Output
|
||||||
|
|
||||||
|
| Parameter | Type | Description |
|
||||||
|
| --------- | ---- | ----------- |
|
||||||
|
| `domain` | string | Analyzed domain |
|
||||||
|
| `country` | string | Country filter applied |
|
||||||
|
| `granularity` | string | Data granularity |
|
||||||
|
| `lastUpdated` | string | Data last updated timestamp |
|
||||||
|
| `pagesPerVisit` | array | Pages per visit data over time |
|
||||||
|
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
|
||||||
|
| ↳ `pagesPerVisit` | number | Average pages per visit |
|
||||||
|
|
||||||
|
### `similarweb_visit_duration`
|
||||||
|
|
||||||
|
Get average desktop visit duration over time (in seconds)
|
||||||
|
|
||||||
|
#### Input
|
||||||
|
|
||||||
|
| Parameter | Type | Required | Description |
|
||||||
|
| --------- | ---- | -------- | ----------- |
|
||||||
|
| `apiKey` | string | Yes | SimilarWeb API key |
|
||||||
|
| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) |
|
||||||
|
| `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data |
|
||||||
|
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
|
||||||
|
| `startDate` | string | No | Start date in YYYY-MM format \(e.g., "2024-01"\) |
|
||||||
|
| `endDate` | string | No | End date in YYYY-MM format \(e.g., "2024-12"\) |
|
||||||
|
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
|
||||||
|
|
||||||
|
#### Output
|
||||||
|
|
||||||
|
| Parameter | Type | Description |
|
||||||
|
| --------- | ---- | ----------- |
|
||||||
|
| `domain` | string | Analyzed domain |
|
||||||
|
| `country` | string | Country filter applied |
|
||||||
|
| `granularity` | string | Data granularity |
|
||||||
|
| `lastUpdated` | string | Data last updated timestamp |
|
||||||
|
| `averageVisitDuration` | array | Desktop visit duration data over time |
|
||||||
|
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
|
||||||
|
| ↳ `durationSeconds` | number | Average visit duration in seconds |
|
||||||
|
|
||||||
|
|
||||||
@@ -86,8 +86,8 @@ Send messages to Slack channels or direct messages. Supports Slack mrkdwn format
|
|||||||
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
||||||
| `destinationType` | string | No | Destination type: channel or dm |
|
| `destinationType` | string | No | Destination type: channel or dm |
|
||||||
| `botToken` | string | No | Bot token for Custom Bot |
|
| `botToken` | string | No | Bot token for Custom Bot |
|
||||||
| `channel` | string | No | Target Slack channel \(e.g., #general\) |
|
| `channel` | string | No | Slack channel ID \(e.g., C1234567890\) |
|
||||||
| `dmUserId` | string | No | Target Slack user for direct messages |
|
| `dmUserId` | string | No | Slack user ID for direct messages \(e.g., U1234567890\) |
|
||||||
| `text` | string | Yes | Message text to send \(supports Slack mrkdwn formatting\) |
|
| `text` | string | Yes | Message text to send \(supports Slack mrkdwn formatting\) |
|
||||||
| `thread_ts` | string | No | Thread timestamp to reply to \(creates thread reply\) |
|
| `thread_ts` | string | No | Thread timestamp to reply to \(creates thread reply\) |
|
||||||
| `files` | file[] | No | Files to attach to the message |
|
| `files` | file[] | No | Files to attach to the message |
|
||||||
@@ -97,6 +97,60 @@ Send messages to Slack channels or direct messages. Supports Slack mrkdwn format
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | object | Complete message object with all properties returned by Slack |
|
| `message` | object | Complete message object with all properties returned by Slack |
|
||||||
|
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||||
|
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||||
|
| ↳ `text` | string | Message text content |
|
||||||
|
| ↳ `user` | string | User ID who sent the message |
|
||||||
|
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||||
|
| ↳ `username` | string | Display username |
|
||||||
|
| ↳ `channel` | string | Channel ID |
|
||||||
|
| ↳ `team` | string | Team/workspace ID |
|
||||||
|
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||||
|
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||||
|
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||||
|
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||||
|
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||||
|
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||||
|
| ↳ `last_read` | string | Timestamp of last read message |
|
||||||
|
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||||
|
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||||
|
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||||
|
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||||
|
| ↳ `permalink` | string | Permanent URL to the message |
|
||||||
|
| ↳ `reactions` | array | Reactions on this message |
|
||||||
|
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||||
|
| ↳ `count` | number | Number of times this reaction was added |
|
||||||
|
| ↳ `users` | array | Array of user IDs who reacted |
|
||||||
|
| ↳ `files` | array | Files attached to the message |
|
||||||
|
| ↳ `id` | string | Unique file identifier |
|
||||||
|
| ↳ `name` | string | File name |
|
||||||
|
| ↳ `mimetype` | string | MIME type of the file |
|
||||||
|
| ↳ `size` | number | File size in bytes |
|
||||||
|
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||||
|
| ↳ `permalink` | string | Permanent link to the file |
|
||||||
|
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||||
|
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||||
|
| ↳ `id` | number | Attachment ID |
|
||||||
|
| ↳ `fallback` | string | Plain text summary |
|
||||||
|
| ↳ `text` | string | Main attachment text |
|
||||||
|
| ↳ `pretext` | string | Text shown before attachment |
|
||||||
|
| ↳ `color` | string | Color bar hex code or preset |
|
||||||
|
| ↳ `author_name` | string | Author display name |
|
||||||
|
| ↳ `author_link` | string | Author link URL |
|
||||||
|
| ↳ `author_icon` | string | Author icon URL |
|
||||||
|
| ↳ `title` | string | Attachment title |
|
||||||
|
| ↳ `title_link` | string | Title link URL |
|
||||||
|
| ↳ `image_url` | string | Image URL |
|
||||||
|
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||||
|
| ↳ `footer` | string | Footer text |
|
||||||
|
| ↳ `footer_icon` | string | Footer icon URL |
|
||||||
|
| ↳ `ts` | string | Timestamp shown in footer |
|
||||||
|
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||||
|
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||||
|
| ↳ `block_id` | string | Unique block identifier |
|
||||||
|
| ↳ `edited` | object | Edit information if message was edited |
|
||||||
|
| ↳ `user` | string | User ID who edited the message |
|
||||||
|
| ↳ `ts` | string | Timestamp of the edit |
|
||||||
| `ts` | string | Message timestamp |
|
| `ts` | string | Message timestamp |
|
||||||
| `channel` | string | Channel ID where message was sent |
|
| `channel` | string | Channel ID where message was sent |
|
||||||
| `fileCount` | number | Number of files uploaded \(when files are attached\) |
|
| `fileCount` | number | Number of files uploaded \(when files are attached\) |
|
||||||
@@ -111,7 +165,7 @@ Create and share Slack canvases in channels. Canvases are collaborative document
|
|||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
||||||
| `botToken` | string | No | Bot token for Custom Bot |
|
| `botToken` | string | No | Bot token for Custom Bot |
|
||||||
| `channel` | string | Yes | Target Slack channel \(e.g., #general\) |
|
| `channel` | string | Yes | Slack channel ID \(e.g., C1234567890\) |
|
||||||
| `title` | string | Yes | Title of the canvas |
|
| `title` | string | Yes | Title of the canvas |
|
||||||
| `content` | string | Yes | Canvas content in markdown format |
|
| `content` | string | Yes | Canvas content in markdown format |
|
||||||
| `document_content` | object | No | Structured canvas document content |
|
| `document_content` | object | No | Structured canvas document content |
|
||||||
@@ -120,9 +174,9 @@ Create and share Slack canvases in channels. Canvases are collaborative document
|
|||||||
|
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `canvas_id` | string | ID of the created canvas |
|
| `canvas_id` | string | Unique canvas identifier |
|
||||||
| `channel` | string | Channel where canvas was created |
|
| `channel` | string | Channel where canvas was created |
|
||||||
| `title` | string | Title of the canvas |
|
| `title` | string | Canvas title |
|
||||||
|
|
||||||
### `slack_message_reader`
|
### `slack_message_reader`
|
||||||
|
|
||||||
@@ -135,8 +189,8 @@ Read the latest messages from Slack channels. Retrieve conversation history with
|
|||||||
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
||||||
| `destinationType` | string | No | Destination type: channel or dm |
|
| `destinationType` | string | No | Destination type: channel or dm |
|
||||||
| `botToken` | string | No | Bot token for Custom Bot |
|
| `botToken` | string | No | Bot token for Custom Bot |
|
||||||
| `channel` | string | No | Slack channel to read messages from \(e.g., #general\) |
|
| `channel` | string | No | Slack channel ID to read messages from \(e.g., C1234567890\) |
|
||||||
| `dmUserId` | string | No | Target Slack user for DM conversation |
|
| `dmUserId` | string | No | Slack user ID for DM conversation \(e.g., U1234567890\) |
|
||||||
| `limit` | number | No | Number of messages to retrieve \(default: 10, max: 15\) |
|
| `limit` | number | No | Number of messages to retrieve \(default: 10, max: 15\) |
|
||||||
| `oldest` | string | No | Start of time range \(timestamp\) |
|
| `oldest` | string | No | Start of time range \(timestamp\) |
|
||||||
| `latest` | string | No | End of time range \(timestamp\) |
|
| `latest` | string | No | End of time range \(timestamp\) |
|
||||||
@@ -146,43 +200,60 @@ Read the latest messages from Slack channels. Retrieve conversation history with
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `messages` | array | Array of message objects from the channel |
|
| `messages` | array | Array of message objects from the channel |
|
||||||
| ↳ `type` | string | Message type |
|
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||||
| ↳ `ts` | string | Message timestamp |
|
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||||
| ↳ `text` | string | Message text content |
|
| ↳ `text` | string | Message text content |
|
||||||
| ↳ `user` | string | User ID who sent the message |
|
| ↳ `user` | string | User ID who sent the message |
|
||||||
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||||
| ↳ `username` | string | Display username |
|
| ↳ `username` | string | Display username |
|
||||||
| ↳ `channel` | string | Channel ID |
|
| ↳ `channel` | string | Channel ID |
|
||||||
| ↳ `team` | string | Team ID |
|
| ↳ `team` | string | Team/workspace ID |
|
||||||
| ↳ `thread_ts` | string | Thread parent message timestamp |
|
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||||
| ↳ `parent_user_id` | string | User ID of thread parent |
|
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||||
| ↳ `reply_count` | number | Number of thread replies |
|
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||||
| ↳ `reply_users_count` | number | Number of users who replied |
|
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||||
| ↳ `latest_reply` | string | Timestamp of latest reply |
|
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||||
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||||
| ↳ `last_read` | string | Last read timestamp |
|
| ↳ `last_read` | string | Timestamp of last read message |
|
||||||
| ↳ `unread_count` | number | Number of unread messages |
|
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||||
| ↳ `subtype` | string | Message subtype |
|
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||||
| ↳ `reactions` | array | Array of reactions on this message |
|
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||||
| ↳ `name` | string | Emoji name |
|
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||||
| ↳ `count` | number | Number of reactions |
|
| ↳ `permalink` | string | Permanent URL to the message |
|
||||||
| ↳ `users` | array | Array of user IDs who reacted |
|
| ↳ `reactions` | array | Reactions on this message |
|
||||||
| ↳ `is_starred` | boolean | Whether message is starred |
|
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||||
| ↳ `pinned_to` | array | Array of channel IDs where message is pinned |
|
| ↳ `count` | number | Number of times this reaction was added |
|
||||||
| ↳ `files` | array | Array of files attached to message |
|
| ↳ `users` | array | Array of user IDs who reacted |
|
||||||
| ↳ `id` | string | File ID |
|
| ↳ `files` | array | Files attached to the message |
|
||||||
| ↳ `name` | string | File name |
|
| ↳ `id` | string | Unique file identifier |
|
||||||
| ↳ `mimetype` | string | MIME type |
|
| ↳ `name` | string | File name |
|
||||||
| ↳ `size` | number | File size in bytes |
|
| ↳ `mimetype` | string | MIME type of the file |
|
||||||
| ↳ `url_private` | string | Private download URL |
|
| ↳ `size` | number | File size in bytes |
|
||||||
| ↳ `permalink` | string | Permanent link to file |
|
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||||
| ↳ `mode` | string | File mode |
|
| ↳ `permalink` | string | Permanent link to the file |
|
||||||
| ↳ `attachments` | array | Array of legacy attachments |
|
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||||
| ↳ `blocks` | array | Array of Block Kit blocks |
|
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||||
|
| ↳ `id` | number | Attachment ID |
|
||||||
|
| ↳ `fallback` | string | Plain text summary |
|
||||||
|
| ↳ `text` | string | Main attachment text |
|
||||||
|
| ↳ `pretext` | string | Text shown before attachment |
|
||||||
|
| ↳ `color` | string | Color bar hex code or preset |
|
||||||
|
| ↳ `author_name` | string | Author display name |
|
||||||
|
| ↳ `author_link` | string | Author link URL |
|
||||||
|
| ↳ `author_icon` | string | Author icon URL |
|
||||||
|
| ↳ `title` | string | Attachment title |
|
||||||
|
| ↳ `title_link` | string | Title link URL |
|
||||||
|
| ↳ `image_url` | string | Image URL |
|
||||||
|
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||||
|
| ↳ `footer` | string | Footer text |
|
||||||
|
| ↳ `footer_icon` | string | Footer icon URL |
|
||||||
|
| ↳ `ts` | string | Timestamp shown in footer |
|
||||||
|
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||||
|
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||||
|
| ↳ `block_id` | string | Unique block identifier |
|
||||||
| ↳ `edited` | object | Edit information if message was edited |
|
| ↳ `edited` | object | Edit information if message was edited |
|
||||||
| ↳ `user` | string | User ID who edited |
|
| ↳ `user` | string | User ID who edited the message |
|
||||||
| ↳ `ts` | string | Edit timestamp |
|
| ↳ `ts` | string | Timestamp of the edit |
|
||||||
| ↳ `permalink` | string | Permanent link to message |
|
|
||||||
|
|
||||||
### `slack_get_message`
|
### `slack_get_message`
|
||||||
|
|
||||||
@@ -202,39 +273,60 @@ Retrieve a specific message by its timestamp. Useful for getting a thread parent
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | object | The retrieved message object |
|
| `message` | object | The retrieved message object |
|
||||||
| ↳ `type` | string | Message type |
|
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||||
| ↳ `ts` | string | Message timestamp |
|
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||||
| ↳ `text` | string | Message text content |
|
| ↳ `text` | string | Message text content |
|
||||||
| ↳ `user` | string | User ID who sent the message |
|
| ↳ `user` | string | User ID who sent the message |
|
||||||
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||||
| ↳ `username` | string | Display username |
|
| ↳ `username` | string | Display username |
|
||||||
| ↳ `channel` | string | Channel ID |
|
| ↳ `channel` | string | Channel ID |
|
||||||
| ↳ `team` | string | Team ID |
|
| ↳ `team` | string | Team/workspace ID |
|
||||||
| ↳ `thread_ts` | string | Thread parent timestamp |
|
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||||
| ↳ `parent_user_id` | string | User ID of thread parent |
|
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||||
| ↳ `reply_count` | number | Number of thread replies |
|
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||||
| ↳ `reply_users_count` | number | Number of users who replied |
|
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||||
| ↳ `latest_reply` | string | Timestamp of latest reply |
|
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||||
| ↳ `subtype` | string | Message subtype |
|
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||||
| ↳ `reactions` | array | Array of reactions on this message |
|
| ↳ `last_read` | string | Timestamp of last read message |
|
||||||
| ↳ `name` | string | Emoji name |
|
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||||
| ↳ `count` | number | Number of reactions |
|
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||||
| ↳ `users` | array | User IDs who reacted |
|
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||||
| ↳ `is_starred` | boolean | Whether message is starred |
|
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||||
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
| ↳ `permalink` | string | Permanent URL to the message |
|
||||||
| ↳ `files` | array | Files attached to message |
|
| ↳ `reactions` | array | Reactions on this message |
|
||||||
| ↳ `id` | string | File ID |
|
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||||
| ↳ `name` | string | File name |
|
| ↳ `count` | number | Number of times this reaction was added |
|
||||||
| ↳ `mimetype` | string | MIME type |
|
| ↳ `users` | array | Array of user IDs who reacted |
|
||||||
| ↳ `size` | number | File size in bytes |
|
| ↳ `files` | array | Files attached to the message |
|
||||||
| ↳ `url_private` | string | Private download URL |
|
| ↳ `id` | string | Unique file identifier |
|
||||||
| ↳ `permalink` | string | Permanent link to file |
|
| ↳ `name` | string | File name |
|
||||||
| ↳ `attachments` | array | Legacy attachments |
|
| ↳ `mimetype` | string | MIME type of the file |
|
||||||
| ↳ `blocks` | array | Block Kit blocks |
|
| ↳ `size` | number | File size in bytes |
|
||||||
| ↳ `edited` | object | Edit information if message was edited |
|
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||||
| ↳ `user` | string | User ID who edited |
|
| ↳ `permalink` | string | Permanent link to the file |
|
||||||
| ↳ `ts` | string | Edit timestamp |
|
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||||
| ↳ `permalink` | string | Permanent link to message |
|
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||||
|
| ↳ `id` | number | Attachment ID |
|
||||||
|
| ↳ `fallback` | string | Plain text summary |
|
||||||
|
| ↳ `text` | string | Main attachment text |
|
||||||
|
| ↳ `pretext` | string | Text shown before attachment |
|
||||||
|
| ↳ `color` | string | Color bar hex code or preset |
|
||||||
|
| ↳ `author_name` | string | Author display name |
|
||||||
|
| ↳ `author_link` | string | Author link URL |
|
||||||
|
| ↳ `author_icon` | string | Author icon URL |
|
||||||
|
| ↳ `title` | string | Attachment title |
|
||||||
|
| ↳ `title_link` | string | Title link URL |
|
||||||
|
| ↳ `image_url` | string | Image URL |
|
||||||
|
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||||
|
| ↳ `footer` | string | Footer text |
|
||||||
|
| ↳ `footer_icon` | string | Footer icon URL |
|
||||||
|
| ↳ `ts` | string | Timestamp shown in footer |
|
||||||
|
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||||
|
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||||
|
| ↳ `block_id` | string | Unique block identifier |
|
||||||
|
| ↳ `edited` | object | Edit information if message was edited |
|
||||||
|
| ↳ `user` | string | User ID who edited the message |
|
||||||
|
| ↳ `ts` | string | Timestamp of the edit |
|
||||||
|
|
||||||
### `slack_get_thread`
|
### `slack_get_thread`
|
||||||
|
|
||||||
@@ -255,31 +347,170 @@ Retrieve an entire thread including the parent message and all replies. Useful f
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `parentMessage` | object | The thread parent message |
|
| `parentMessage` | object | The thread parent message |
|
||||||
| ↳ `type` | string | Message type |
|
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||||
| ↳ `ts` | string | Message timestamp |
|
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||||
| ↳ `text` | string | Message text content |
|
|
||||||
| ↳ `user` | string | User ID who sent the message |
|
|
||||||
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
|
||||||
| ↳ `username` | string | Display username |
|
|
||||||
| ↳ `reply_count` | number | Total number of thread replies |
|
|
||||||
| ↳ `reply_users_count` | number | Number of users who replied |
|
|
||||||
| ↳ `latest_reply` | string | Timestamp of latest reply |
|
|
||||||
| ↳ `reactions` | array | Array of reactions on the parent message |
|
|
||||||
| ↳ `name` | string | Emoji name |
|
|
||||||
| ↳ `count` | number | Number of reactions |
|
|
||||||
| ↳ `users` | array | User IDs who reacted |
|
|
||||||
| ↳ `files` | array | Files attached to the parent message |
|
|
||||||
| ↳ `id` | string | File ID |
|
|
||||||
| ↳ `name` | string | File name |
|
|
||||||
| ↳ `mimetype` | string | MIME type |
|
|
||||||
| ↳ `size` | number | File size in bytes |
|
|
||||||
| `replies` | array | Array of reply messages in the thread \(excluding the parent\) |
|
|
||||||
| ↳ `ts` | string | Message timestamp |
|
|
||||||
| ↳ `text` | string | Message text content |
|
| ↳ `text` | string | Message text content |
|
||||||
| ↳ `user` | string | User ID who sent the reply |
|
| ↳ `user` | string | User ID who sent the message |
|
||||||
| ↳ `reactions` | array | Reactions on the reply |
|
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||||
| ↳ `files` | array | Files attached to the reply |
|
| ↳ `username` | string | Display username |
|
||||||
|
| ↳ `channel` | string | Channel ID |
|
||||||
|
| ↳ `team` | string | Team/workspace ID |
|
||||||
|
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||||
|
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||||
|
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||||
|
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||||
|
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||||
|
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||||
|
| ↳ `last_read` | string | Timestamp of last read message |
|
||||||
|
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||||
|
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||||
|
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||||
|
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||||
|
| ↳ `permalink` | string | Permanent URL to the message |
|
||||||
|
| ↳ `reactions` | array | Reactions on this message |
|
||||||
|
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||||
|
| ↳ `count` | number | Number of times this reaction was added |
|
||||||
|
| ↳ `users` | array | Array of user IDs who reacted |
|
||||||
|
| ↳ `files` | array | Files attached to the message |
|
||||||
|
| ↳ `id` | string | Unique file identifier |
|
||||||
|
| ↳ `name` | string | File name |
|
||||||
|
| ↳ `mimetype` | string | MIME type of the file |
|
||||||
|
| ↳ `size` | number | File size in bytes |
|
||||||
|
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||||
|
| ↳ `permalink` | string | Permanent link to the file |
|
||||||
|
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||||
|
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||||
|
| ↳ `id` | number | Attachment ID |
|
||||||
|
| ↳ `fallback` | string | Plain text summary |
|
||||||
|
| ↳ `text` | string | Main attachment text |
|
||||||
|
| ↳ `pretext` | string | Text shown before attachment |
|
||||||
|
| ↳ `color` | string | Color bar hex code or preset |
|
||||||
|
| ↳ `author_name` | string | Author display name |
|
||||||
|
| ↳ `author_link` | string | Author link URL |
|
||||||
|
| ↳ `author_icon` | string | Author icon URL |
|
||||||
|
| ↳ `title` | string | Attachment title |
|
||||||
|
| ↳ `title_link` | string | Title link URL |
|
||||||
|
| ↳ `image_url` | string | Image URL |
|
||||||
|
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||||
|
| ↳ `footer` | string | Footer text |
|
||||||
|
| ↳ `footer_icon` | string | Footer icon URL |
|
||||||
|
| ↳ `ts` | string | Timestamp shown in footer |
|
||||||
|
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||||
|
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||||
|
| ↳ `block_id` | string | Unique block identifier |
|
||||||
|
| ↳ `edited` | object | Edit information if message was edited |
|
||||||
|
| ↳ `user` | string | User ID who edited the message |
|
||||||
|
| ↳ `ts` | string | Timestamp of the edit |
|
||||||
|
| `replies` | array | Array of reply messages in the thread \(excluding the parent\) |
|
||||||
|
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||||
|
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||||
|
| ↳ `text` | string | Message text content |
|
||||||
|
| ↳ `user` | string | User ID who sent the message |
|
||||||
|
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||||
|
| ↳ `username` | string | Display username |
|
||||||
|
| ↳ `channel` | string | Channel ID |
|
||||||
|
| ↳ `team` | string | Team/workspace ID |
|
||||||
|
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||||
|
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||||
|
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||||
|
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||||
|
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||||
|
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||||
|
| ↳ `last_read` | string | Timestamp of last read message |
|
||||||
|
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||||
|
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||||
|
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||||
|
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||||
|
| ↳ `permalink` | string | Permanent URL to the message |
|
||||||
|
| ↳ `reactions` | array | Reactions on this message |
|
||||||
|
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||||
|
| ↳ `count` | number | Number of times this reaction was added |
|
||||||
|
| ↳ `users` | array | Array of user IDs who reacted |
|
||||||
|
| ↳ `files` | array | Files attached to the message |
|
||||||
|
| ↳ `id` | string | Unique file identifier |
|
||||||
|
| ↳ `name` | string | File name |
|
||||||
|
| ↳ `mimetype` | string | MIME type of the file |
|
||||||
|
| ↳ `size` | number | File size in bytes |
|
||||||
|
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||||
|
| ↳ `permalink` | string | Permanent link to the file |
|
||||||
|
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||||
|
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||||
|
| ↳ `id` | number | Attachment ID |
|
||||||
|
| ↳ `fallback` | string | Plain text summary |
|
||||||
|
| ↳ `text` | string | Main attachment text |
|
||||||
|
| ↳ `pretext` | string | Text shown before attachment |
|
||||||
|
| ↳ `color` | string | Color bar hex code or preset |
|
||||||
|
| ↳ `author_name` | string | Author display name |
|
||||||
|
| ↳ `author_link` | string | Author link URL |
|
||||||
|
| ↳ `author_icon` | string | Author icon URL |
|
||||||
|
| ↳ `title` | string | Attachment title |
|
||||||
|
| ↳ `title_link` | string | Title link URL |
|
||||||
|
| ↳ `image_url` | string | Image URL |
|
||||||
|
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||||
|
| ↳ `footer` | string | Footer text |
|
||||||
|
| ↳ `footer_icon` | string | Footer icon URL |
|
||||||
|
| ↳ `ts` | string | Timestamp shown in footer |
|
||||||
|
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||||
|
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||||
|
| ↳ `block_id` | string | Unique block identifier |
|
||||||
|
| ↳ `edited` | object | Edit information if message was edited |
|
||||||
|
| ↳ `user` | string | User ID who edited the message |
|
||||||
|
| ↳ `ts` | string | Timestamp of the edit |
|
||||||
| `messages` | array | All messages in the thread \(parent + replies\) in chronological order |
|
| `messages` | array | All messages in the thread \(parent + replies\) in chronological order |
|
||||||
|
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||||
|
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||||
|
| ↳ `text` | string | Message text content |
|
||||||
|
| ↳ `user` | string | User ID who sent the message |
|
||||||
|
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||||
|
| ↳ `username` | string | Display username |
|
||||||
|
| ↳ `channel` | string | Channel ID |
|
||||||
|
| ↳ `team` | string | Team/workspace ID |
|
||||||
|
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||||
|
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||||
|
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||||
|
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||||
|
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||||
|
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||||
|
| ↳ `last_read` | string | Timestamp of last read message |
|
||||||
|
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||||
|
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||||
|
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||||
|
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||||
|
| ↳ `permalink` | string | Permanent URL to the message |
|
||||||
|
| ↳ `reactions` | array | Reactions on this message |
|
||||||
|
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||||
|
| ↳ `count` | number | Number of times this reaction was added |
|
||||||
|
| ↳ `users` | array | Array of user IDs who reacted |
|
||||||
|
| ↳ `files` | array | Files attached to the message |
|
||||||
|
| ↳ `id` | string | Unique file identifier |
|
||||||
|
| ↳ `name` | string | File name |
|
||||||
|
| ↳ `mimetype` | string | MIME type of the file |
|
||||||
|
| ↳ `size` | number | File size in bytes |
|
||||||
|
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||||
|
| ↳ `permalink` | string | Permanent link to the file |
|
||||||
|
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||||
|
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||||
|
| ↳ `id` | number | Attachment ID |
|
||||||
|
| ↳ `fallback` | string | Plain text summary |
|
||||||
|
| ↳ `text` | string | Main attachment text |
|
||||||
|
| ↳ `pretext` | string | Text shown before attachment |
|
||||||
|
| ↳ `color` | string | Color bar hex code or preset |
|
||||||
|
| ↳ `author_name` | string | Author display name |
|
||||||
|
| ↳ `author_link` | string | Author link URL |
|
||||||
|
| ↳ `author_icon` | string | Author icon URL |
|
||||||
|
| ↳ `title` | string | Attachment title |
|
||||||
|
| ↳ `title_link` | string | Title link URL |
|
||||||
|
| ↳ `image_url` | string | Image URL |
|
||||||
|
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||||
|
| ↳ `footer` | string | Footer text |
|
||||||
|
| ↳ `footer_icon` | string | Footer icon URL |
|
||||||
|
| ↳ `ts` | string | Timestamp shown in footer |
|
||||||
|
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||||
|
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||||
|
| ↳ `block_id` | string | Unique block identifier |
|
||||||
|
| ↳ `edited` | object | Edit information if message was edited |
|
||||||
|
| ↳ `user` | string | User ID who edited the message |
|
||||||
|
| ↳ `ts` | string | Timestamp of the edit |
|
||||||
| `replyCount` | number | Number of replies returned in this response |
|
| `replyCount` | number | Number of replies returned in this response |
|
||||||
| `hasMore` | boolean | Whether there are more messages in the thread \(pagination needed\) |
|
| `hasMore` | boolean | Whether there are more messages in the thread \(pagination needed\) |
|
||||||
|
|
||||||
@@ -304,14 +535,20 @@ List all channels in a Slack workspace. Returns public and private channels the
|
|||||||
| `channels` | array | Array of channel objects from the workspace |
|
| `channels` | array | Array of channel objects from the workspace |
|
||||||
| ↳ `id` | string | Channel ID \(e.g., C1234567890\) |
|
| ↳ `id` | string | Channel ID \(e.g., C1234567890\) |
|
||||||
| ↳ `name` | string | Channel name without # prefix |
|
| ↳ `name` | string | Channel name without # prefix |
|
||||||
| ↳ `is_private` | boolean | Whether the channel is private |
|
| ↳ `is_channel` | boolean | Whether this is a channel |
|
||||||
| ↳ `is_archived` | boolean | Whether the channel is archived |
|
| ↳ `is_private` | boolean | Whether channel is private |
|
||||||
| ↳ `is_member` | boolean | Whether the bot is a member of the channel |
|
| ↳ `is_archived` | boolean | Whether channel is archived |
|
||||||
|
| ↳ `is_general` | boolean | Whether this is the general channel |
|
||||||
|
| ↳ `is_member` | boolean | Whether the bot/user is a member |
|
||||||
|
| ↳ `is_shared` | boolean | Whether channel is shared across workspaces |
|
||||||
|
| ↳ `is_ext_shared` | boolean | Whether channel is externally shared |
|
||||||
|
| ↳ `is_org_shared` | boolean | Whether channel is org-wide shared |
|
||||||
| ↳ `num_members` | number | Number of members in the channel |
|
| ↳ `num_members` | number | Number of members in the channel |
|
||||||
| ↳ `topic` | string | Channel topic |
|
| ↳ `topic` | string | Channel topic |
|
||||||
| ↳ `purpose` | string | Channel purpose/description |
|
| ↳ `purpose` | string | Channel purpose/description |
|
||||||
| ↳ `created` | number | Unix timestamp when channel was created |
|
| ↳ `created` | number | Unix timestamp when channel was created |
|
||||||
| ↳ `creator` | string | User ID of channel creator |
|
| ↳ `creator` | string | User ID of channel creator |
|
||||||
|
| ↳ `updated` | number | Unix timestamp of last update |
|
||||||
| `ids` | array | Array of channel IDs for easy access |
|
| `ids` | array | Array of channel IDs for easy access |
|
||||||
| `names` | array | Array of channel names for easy access |
|
| `names` | array | Array of channel names for easy access |
|
||||||
| `count` | number | Total number of channels returned |
|
| `count` | number | Total number of channels returned |
|
||||||
@@ -387,34 +624,40 @@ Get detailed information about a specific Slack user by their user ID.
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `user` | object | Detailed user information |
|
| `user` | object | Detailed user information |
|
||||||
| ↳ `id` | string | User ID |
|
| ↳ `id` | string | User ID \(e.g., U1234567890\) |
|
||||||
| ↳ `name` | string | Username \(handle\) |
|
| ↳ `team_id` | string | Workspace/team ID |
|
||||||
| ↳ `real_name` | string | Full real name |
|
| ↳ `name` | string | Username \(handle\) |
|
||||||
| ↳ `display_name` | string | Display name shown in Slack |
|
| ↳ `real_name` | string | Full real name |
|
||||||
| ↳ `first_name` | string | First name |
|
| ↳ `display_name` | string | Display name shown in Slack |
|
||||||
| ↳ `last_name` | string | Last name |
|
| ↳ `first_name` | string | First name |
|
||||||
| ↳ `title` | string | Job title |
|
| ↳ `last_name` | string | Last name |
|
||||||
| ↳ `phone` | string | Phone number |
|
| ↳ `title` | string | Job title |
|
||||||
| ↳ `skype` | string | Skype handle |
|
| ↳ `phone` | string | Phone number |
|
||||||
| ↳ `is_bot` | boolean | Whether the user is a bot |
|
| ↳ `skype` | string | Skype handle |
|
||||||
| ↳ `is_admin` | boolean | Whether the user is a workspace admin |
|
| ↳ `is_bot` | boolean | Whether the user is a bot |
|
||||||
| ↳ `is_owner` | boolean | Whether the user is the workspace owner |
|
| ↳ `is_admin` | boolean | Whether the user is a workspace admin |
|
||||||
| ↳ `is_primary_owner` | boolean | Whether the user is the primary owner |
|
| ↳ `is_owner` | boolean | Whether the user is the workspace owner |
|
||||||
| ↳ `is_restricted` | boolean | Whether the user is a guest \(restricted\) |
|
| ↳ `is_primary_owner` | boolean | Whether the user is the primary owner |
|
||||||
| ↳ `is_ultra_restricted` | boolean | Whether the user is a single-channel guest |
|
| ↳ `is_restricted` | boolean | Whether the user is a guest \(restricted\) |
|
||||||
| ↳ `deleted` | boolean | Whether the user is deactivated |
|
| ↳ `is_ultra_restricted` | boolean | Whether the user is a single-channel guest |
|
||||||
| ↳ `timezone` | string | Timezone identifier \(e.g., America/Los_Angeles\) |
|
| ↳ `is_app_user` | boolean | Whether user is an app user |
|
||||||
| ↳ `timezone_label` | string | Human-readable timezone label |
|
| ↳ `is_stranger` | boolean | Whether user is from different workspace |
|
||||||
| ↳ `timezone_offset` | number | Timezone offset in seconds from UTC |
|
| ↳ `deleted` | boolean | Whether the user is deactivated |
|
||||||
| ↳ `avatar_24` | string | URL to 24px avatar |
|
| ↳ `color` | string | User color for display |
|
||||||
| ↳ `avatar_48` | string | URL to 48px avatar |
|
| ↳ `timezone` | string | Timezone identifier \(e.g., America/Los_Angeles\) |
|
||||||
| ↳ `avatar_72` | string | URL to 72px avatar |
|
| ↳ `timezone_label` | string | Human-readable timezone label |
|
||||||
| ↳ `avatar_192` | string | URL to 192px avatar |
|
| ↳ `timezone_offset` | number | Timezone offset in seconds from UTC |
|
||||||
| ↳ `avatar_512` | string | URL to 512px avatar |
|
| ↳ `avatar` | string | URL to user avatar image |
|
||||||
| ↳ `status_text` | string | Custom status text |
|
| ↳ `avatar_24` | string | URL to 24px avatar |
|
||||||
| ↳ `status_emoji` | string | Custom status emoji |
|
| ↳ `avatar_48` | string | URL to 48px avatar |
|
||||||
| ↳ `status_expiration` | number | Unix timestamp when status expires |
|
| ↳ `avatar_72` | string | URL to 72px avatar |
|
||||||
| ↳ `updated` | number | Unix timestamp of last profile update |
|
| ↳ `avatar_192` | string | URL to 192px avatar |
|
||||||
|
| ↳ `avatar_512` | string | URL to 512px avatar |
|
||||||
|
| ↳ `status_text` | string | Custom status text |
|
||||||
|
| ↳ `status_emoji` | string | Custom status emoji |
|
||||||
|
| ↳ `status_expiration` | number | Unix timestamp when status expires |
|
||||||
|
| ↳ `updated` | number | Unix timestamp of last profile update |
|
||||||
|
| ↳ `has_2fa` | boolean | Whether two-factor auth is enabled |
|
||||||
|
|
||||||
### `slack_download`
|
### `slack_download`
|
||||||
|
|
||||||
@@ -454,11 +697,65 @@ Update a message previously sent by the bot in Slack
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `message` | object | Complete updated message object with all properties returned by Slack |
|
| `message` | object | Complete updated message object with all properties returned by Slack |
|
||||||
|
| ↳ `type` | string | Message type \(usually "message"\) |
|
||||||
|
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
|
||||||
|
| ↳ `text` | string | Message text content |
|
||||||
|
| ↳ `user` | string | User ID who sent the message |
|
||||||
|
| ↳ `bot_id` | string | Bot ID if sent by a bot |
|
||||||
|
| ↳ `username` | string | Display username |
|
||||||
|
| ↳ `channel` | string | Channel ID |
|
||||||
|
| ↳ `team` | string | Team/workspace ID |
|
||||||
|
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
|
||||||
|
| ↳ `parent_user_id` | string | User ID of thread parent message author |
|
||||||
|
| ↳ `reply_count` | number | Total number of replies in thread |
|
||||||
|
| ↳ `reply_users_count` | number | Number of unique users who replied |
|
||||||
|
| ↳ `latest_reply` | string | Timestamp of most recent reply |
|
||||||
|
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
|
||||||
|
| ↳ `last_read` | string | Timestamp of last read message |
|
||||||
|
| ↳ `unread_count` | number | Number of unread messages in thread |
|
||||||
|
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
|
||||||
|
| ↳ `is_starred` | boolean | Whether message is starred by user |
|
||||||
|
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
|
||||||
|
| ↳ `permalink` | string | Permanent URL to the message |
|
||||||
|
| ↳ `reactions` | array | Reactions on this message |
|
||||||
|
| ↳ `name` | string | Emoji name \(without colons\) |
|
||||||
|
| ↳ `count` | number | Number of times this reaction was added |
|
||||||
|
| ↳ `users` | array | Array of user IDs who reacted |
|
||||||
|
| ↳ `files` | array | Files attached to the message |
|
||||||
|
| ↳ `id` | string | Unique file identifier |
|
||||||
|
| ↳ `name` | string | File name |
|
||||||
|
| ↳ `mimetype` | string | MIME type of the file |
|
||||||
|
| ↳ `size` | number | File size in bytes |
|
||||||
|
| ↳ `url_private` | string | Private download URL \(requires auth\) |
|
||||||
|
| ↳ `permalink` | string | Permanent link to the file |
|
||||||
|
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
|
||||||
|
| ↳ `attachments` | array | Legacy attachments on the message |
|
||||||
|
| ↳ `id` | number | Attachment ID |
|
||||||
|
| ↳ `fallback` | string | Plain text summary |
|
||||||
|
| ↳ `text` | string | Main attachment text |
|
||||||
|
| ↳ `pretext` | string | Text shown before attachment |
|
||||||
|
| ↳ `color` | string | Color bar hex code or preset |
|
||||||
|
| ↳ `author_name` | string | Author display name |
|
||||||
|
| ↳ `author_link` | string | Author link URL |
|
||||||
|
| ↳ `author_icon` | string | Author icon URL |
|
||||||
|
| ↳ `title` | string | Attachment title |
|
||||||
|
| ↳ `title_link` | string | Title link URL |
|
||||||
|
| ↳ `image_url` | string | Image URL |
|
||||||
|
| ↳ `thumb_url` | string | Thumbnail URL |
|
||||||
|
| ↳ `footer` | string | Footer text |
|
||||||
|
| ↳ `footer_icon` | string | Footer icon URL |
|
||||||
|
| ↳ `ts` | string | Timestamp shown in footer |
|
||||||
|
| ↳ `blocks` | array | Block Kit blocks in the message |
|
||||||
|
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
|
||||||
|
| ↳ `block_id` | string | Unique block identifier |
|
||||||
|
| ↳ `edited` | object | Edit information if message was edited |
|
||||||
|
| ↳ `user` | string | User ID who edited the message |
|
||||||
|
| ↳ `ts` | string | Timestamp of the edit |
|
||||||
| `content` | string | Success message |
|
| `content` | string | Success message |
|
||||||
| `metadata` | object | Updated message metadata |
|
| `metadata` | object | Updated message metadata |
|
||||||
| ↳ `channel` | string | Channel ID |
|
| ↳ `channel` | string | Channel ID |
|
||||||
| ↳ `timestamp` | string | Message timestamp |
|
| ↳ `timestamp` | string | Message timestamp |
|
||||||
| ↳ `text` | string | Updated message text |
|
| ↳ `text` | string | Updated message text |
|
||||||
|
|
||||||
### `slack_delete_message`
|
### `slack_delete_message`
|
||||||
|
|
||||||
@@ -479,8 +776,8 @@ Delete a message previously sent by the bot in Slack
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `content` | string | Success message |
|
| `content` | string | Success message |
|
||||||
| `metadata` | object | Deleted message metadata |
|
| `metadata` | object | Deleted message metadata |
|
||||||
| ↳ `channel` | string | Channel ID |
|
| ↳ `channel` | string | Channel ID |
|
||||||
| ↳ `timestamp` | string | Message timestamp |
|
| ↳ `timestamp` | string | Message timestamp |
|
||||||
|
|
||||||
### `slack_add_reaction`
|
### `slack_add_reaction`
|
||||||
|
|
||||||
@@ -502,8 +799,8 @@ Add an emoji reaction to a Slack message
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `content` | string | Success message |
|
| `content` | string | Success message |
|
||||||
| `metadata` | object | Reaction metadata |
|
| `metadata` | object | Reaction metadata |
|
||||||
| ↳ `channel` | string | Channel ID |
|
| ↳ `channel` | string | Channel ID |
|
||||||
| ↳ `timestamp` | string | Message timestamp |
|
| ↳ `timestamp` | string | Message timestamp |
|
||||||
| ↳ `reaction` | string | Emoji reaction name |
|
| ↳ `reaction` | string | Emoji reaction name |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -48,10 +48,10 @@ Send a message to an Amazon SQS queue
|
|||||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||||
| `queueUrl` | string | Yes | Queue URL |
|
| `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue\) |
|
||||||
| `data` | object | Yes | Message body to send |
|
| `data` | object | Yes | Message body to send as JSON object \(e.g., \{ "action": "process", "payload": \{...\} \}\) |
|
||||||
| `messageGroupId` | string | No | Message group ID \(optional\) |
|
| `messageGroupId` | string | No | Message group ID for FIFO queues \(e.g., "order-processing-group"\) |
|
||||||
| `messageDeduplicationId` | string | No | Message deduplication ID \(optional\) |
|
| `messageDeduplicationId` | string | No | Message deduplication ID for FIFO queues \(e.g., "order-12345-v1"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
|
|||||||
@@ -79,13 +79,19 @@ Run an autonomous web agent to complete tasks and extract structured data
|
|||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `agentResult` | object | Result from the Stagehand agent execution |
|
| `agentResult` | object | Result from the Stagehand agent execution |
|
||||||
| ↳ `success` | boolean | Whether the agent task completed successfully |
|
| ↳ `success` | boolean | Whether the agent task completed successfully without errors |
|
||||||
| ↳ `completed` | boolean | Whether the task was fully completed |
|
| ↳ `completed` | boolean | Whether the agent finished executing \(may be false if max steps reached\) |
|
||||||
| ↳ `message` | string | Status message or final result |
|
| ↳ `message` | string | Final status message or result summary from the agent |
|
||||||
| ↳ `actions` | array | Type of action performed |
|
| ↳ `actions` | array | List of all actions performed by the agent during task execution |
|
||||||
| ↳ `type` | string | Type of action performed |
|
| ↳ `type` | string | Type of action performed \(e.g., "act", "observe", "ariaTree", "close", "wait", "navigate"\) |
|
||||||
| ↳ `params` | object | Parameters used for the action |
|
| ↳ `reasoning` | string | AI reasoning for why this action was taken |
|
||||||
| ↳ `result` | object | Result of the action |
|
| ↳ `taskCompleted` | boolean | Whether the task was completed after this action |
|
||||||
|
| ↳ `action` | string | Description of the action taken \(e.g., "click the submit button"\) |
|
||||||
|
| ↳ `instruction` | string | Instruction that triggered this action |
|
||||||
|
| ↳ `pageUrl` | string | URL of the page when this action was performed |
|
||||||
|
| ↳ `pageText` | string | Page text content \(for ariaTree actions\) |
|
||||||
|
| ↳ `timestamp` | number | Unix timestamp when the action was performed |
|
||||||
|
| ↳ `timeMs` | number | Time in milliseconds \(for wait actions\) |
|
||||||
| `structuredOutput` | object | Extracted data matching the provided output schema |
|
| `structuredOutput` | object | Extracted data matching the provided output schema |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -59,7 +59,7 @@ Transcribe audio to text using OpenAI Whisper
|
|||||||
| `provider` | string | Yes | STT provider \(whisper\) |
|
| `provider` | string | Yes | STT provider \(whisper\) |
|
||||||
| `apiKey` | string | Yes | OpenAI API key |
|
| `apiKey` | string | Yes | OpenAI API key |
|
||||||
| `model` | string | No | Whisper model to use \(default: whisper-1\) |
|
| `model` | string | No | Whisper model to use \(default: whisper-1\) |
|
||||||
| `audioFile` | file | No | Audio or video file to transcribe |
|
| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) |
|
||||||
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
|
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
|
||||||
| `audioUrl` | string | No | URL to audio or video file |
|
| `audioUrl` | string | No | URL to audio or video file |
|
||||||
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
|
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
|
||||||
@@ -67,6 +67,7 @@ Transcribe audio to text using OpenAI Whisper
|
|||||||
| `translateToEnglish` | boolean | No | Translate audio to English |
|
| `translateToEnglish` | boolean | No | Translate audio to English |
|
||||||
| `prompt` | string | No | Optional text to guide the model's style or continue a previous audio segment. Helps with proper nouns and context. |
|
| `prompt` | string | No | Optional text to guide the model's style or continue a previous audio segment. Helps with proper nouns and context. |
|
||||||
| `temperature` | number | No | Sampling temperature between 0 and 1. Higher values make output more random, lower values more focused and deterministic. |
|
| `temperature` | number | No | Sampling temperature between 0 and 1. Higher values make output more random, lower values more focused and deterministic. |
|
||||||
|
| `responseFormat` | string | No | Output format for the transcription \(e.g., "json", "text", "srt", "verbose_json", "vtt"\) |
|
||||||
|
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
@@ -74,6 +75,11 @@ Transcribe audio to text using OpenAI Whisper
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `transcript` | string | Full transcribed text |
|
| `transcript` | string | Full transcribed text |
|
||||||
| `segments` | array | Timestamped segments |
|
| `segments` | array | Timestamped segments |
|
||||||
|
| ↳ `text` | string | Transcribed text for this segment |
|
||||||
|
| ↳ `start` | number | Start time in seconds |
|
||||||
|
| ↳ `end` | number | End time in seconds |
|
||||||
|
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
|
||||||
|
| ↳ `confidence` | number | Confidence score \(0-1\) |
|
||||||
| `language` | string | Detected or specified language |
|
| `language` | string | Detected or specified language |
|
||||||
| `duration` | number | Audio duration in seconds |
|
| `duration` | number | Audio duration in seconds |
|
||||||
|
|
||||||
@@ -88,7 +94,7 @@ Transcribe audio to text using Deepgram
|
|||||||
| `provider` | string | Yes | STT provider \(deepgram\) |
|
| `provider` | string | Yes | STT provider \(deepgram\) |
|
||||||
| `apiKey` | string | Yes | Deepgram API key |
|
| `apiKey` | string | Yes | Deepgram API key |
|
||||||
| `model` | string | No | Deepgram model to use \(nova-3, nova-2, whisper-large, etc.\) |
|
| `model` | string | No | Deepgram model to use \(nova-3, nova-2, whisper-large, etc.\) |
|
||||||
| `audioFile` | file | No | Audio or video file to transcribe |
|
| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) |
|
||||||
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
|
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
|
||||||
| `audioUrl` | string | No | URL to audio or video file |
|
| `audioUrl` | string | No | URL to audio or video file |
|
||||||
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
|
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
|
||||||
@@ -101,6 +107,11 @@ Transcribe audio to text using Deepgram
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `transcript` | string | Full transcribed text |
|
| `transcript` | string | Full transcribed text |
|
||||||
| `segments` | array | Timestamped segments with speaker labels |
|
| `segments` | array | Timestamped segments with speaker labels |
|
||||||
|
| ↳ `text` | string | Transcribed text for this segment |
|
||||||
|
| ↳ `start` | number | Start time in seconds |
|
||||||
|
| ↳ `end` | number | End time in seconds |
|
||||||
|
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
|
||||||
|
| ↳ `confidence` | number | Confidence score \(0-1\) |
|
||||||
| `language` | string | Detected or specified language |
|
| `language` | string | Detected or specified language |
|
||||||
| `duration` | number | Audio duration in seconds |
|
| `duration` | number | Audio duration in seconds |
|
||||||
| `confidence` | number | Overall confidence score |
|
| `confidence` | number | Overall confidence score |
|
||||||
@@ -116,7 +127,7 @@ Transcribe audio to text using ElevenLabs
|
|||||||
| `provider` | string | Yes | STT provider \(elevenlabs\) |
|
| `provider` | string | Yes | STT provider \(elevenlabs\) |
|
||||||
| `apiKey` | string | Yes | ElevenLabs API key |
|
| `apiKey` | string | Yes | ElevenLabs API key |
|
||||||
| `model` | string | No | ElevenLabs model to use \(scribe_v1, scribe_v1_experimental\) |
|
| `model` | string | No | ElevenLabs model to use \(scribe_v1, scribe_v1_experimental\) |
|
||||||
| `audioFile` | file | No | Audio or video file to transcribe |
|
| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) |
|
||||||
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
|
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
|
||||||
| `audioUrl` | string | No | URL to audio or video file |
|
| `audioUrl` | string | No | URL to audio or video file |
|
||||||
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
|
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
|
||||||
@@ -143,7 +154,7 @@ Transcribe audio to text using AssemblyAI with advanced NLP features
|
|||||||
| `provider` | string | Yes | STT provider \(assemblyai\) |
|
| `provider` | string | Yes | STT provider \(assemblyai\) |
|
||||||
| `apiKey` | string | Yes | AssemblyAI API key |
|
| `apiKey` | string | Yes | AssemblyAI API key |
|
||||||
| `model` | string | No | AssemblyAI model to use \(default: best\) |
|
| `model` | string | No | AssemblyAI model to use \(default: best\) |
|
||||||
| `audioFile` | file | No | Audio or video file to transcribe |
|
| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) |
|
||||||
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
|
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
|
||||||
| `audioUrl` | string | No | URL to audio or video file |
|
| `audioUrl` | string | No | URL to audio or video file |
|
||||||
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
|
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
|
||||||
@@ -160,11 +171,25 @@ Transcribe audio to text using AssemblyAI with advanced NLP features
|
|||||||
| --------- | ---- | ----------- |
|
| --------- | ---- | ----------- |
|
||||||
| `transcript` | string | Full transcribed text |
|
| `transcript` | string | Full transcribed text |
|
||||||
| `segments` | array | Timestamped segments with speaker labels |
|
| `segments` | array | Timestamped segments with speaker labels |
|
||||||
|
| ↳ `text` | string | Transcribed text for this segment |
|
||||||
|
| ↳ `start` | number | Start time in seconds |
|
||||||
|
| ↳ `end` | number | End time in seconds |
|
||||||
|
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
|
||||||
|
| ↳ `confidence` | number | Confidence score \(0-1\) |
|
||||||
| `language` | string | Detected or specified language |
|
| `language` | string | Detected or specified language |
|
||||||
| `duration` | number | Audio duration in seconds |
|
| `duration` | number | Audio duration in seconds |
|
||||||
| `confidence` | number | Overall confidence score |
|
| `confidence` | number | Overall confidence score |
|
||||||
| `sentiment` | array | Sentiment analysis results |
|
| `sentiment` | array | Sentiment analysis results |
|
||||||
|
| ↳ `text` | string | Text that was analyzed |
|
||||||
|
| ↳ `sentiment` | string | Sentiment \(POSITIVE, NEGATIVE, NEUTRAL\) |
|
||||||
|
| ↳ `confidence` | number | Confidence score |
|
||||||
|
| ↳ `start` | number | Start time in milliseconds |
|
||||||
|
| ↳ `end` | number | End time in milliseconds |
|
||||||
| `entities` | array | Detected entities |
|
| `entities` | array | Detected entities |
|
||||||
|
| ↳ `entity_type` | string | Entity type \(e.g., person_name, location, organization\) |
|
||||||
|
| ↳ `text` | string | Entity text |
|
||||||
|
| ↳ `start` | number | Start time in milliseconds |
|
||||||
|
| ↳ `end` | number | End time in milliseconds |
|
||||||
| `summary` | string | Auto-generated summary |
|
| `summary` | string | Auto-generated summary |
|
||||||
|
|
||||||
### `stt_gemini`
|
### `stt_gemini`
|
||||||
@@ -178,7 +203,7 @@ Transcribe audio to text using Google Gemini with multimodal capabilities
|
|||||||
| `provider` | string | Yes | STT provider \(gemini\) |
|
| `provider` | string | Yes | STT provider \(gemini\) |
|
||||||
| `apiKey` | string | Yes | Google API key |
|
| `apiKey` | string | Yes | Google API key |
|
||||||
| `model` | string | No | Gemini model to use \(default: gemini-2.5-flash\) |
|
| `model` | string | No | Gemini model to use \(default: gemini-2.5-flash\) |
|
||||||
| `audioFile` | file | No | Audio or video file to transcribe |
|
| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) |
|
||||||
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
|
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
|
||||||
| `audioUrl` | string | No | URL to audio or video file |
|
| `audioUrl` | string | No | URL to audio or video file |
|
||||||
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
|
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user