Compare commits

..

65 Commits

Author SHA1 Message Date
waleed
74c0ba4ec8 feat(deployments): human-readable version descriptions 2026-01-30 00:39:13 -08:00
Waleed
dd2f0c6a6a feat(tools): added similarweb (#3071) 2026-01-29 20:39:23 -08:00
Waleed
f99518b837 feat(calcom): added calcom (#3070)
* feat(tools): added calcom

* added more triggers, tested

* updated regex in script for release to be more lenient

* fix(tag-dropdown): performance improvements and scroll bug fixes

- Add flatTagIndexMap for O(1) tag lookups (replaces O(n²) findIndex calls)
- Memoize caret position calculation to avoid DOM manipulation on every render
- Use refs for inputValue/cursorPosition to keep handleTagSelect callback stable
- Change itemRefs from index-based to tag-based keys to prevent stale refs
- Fix scroll jump in nested folders by removing scroll reset from registerFolder
- Add onFolderEnter callback for scroll reset when entering folder via keyboard
- Disable keyboard navigation wrap-around at boundaries
- Simplify selection reset to single effect on flatTagList.length change

Also:
- Add safeCompare utility for timing-safe string comparison
- Refactor webhook signature validation to use safeCompare

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* updated types

* fix(calcom): simplify required field constraints for booking attendee

The condition field already restricts these to calcom_create_booking,
so simplified to required: true. Per Cal.com API docs, email is optional
while name and timeZone are required.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* added tests

* updated folder multi select, updated calcom and github tools and docs generator script

* updated drag, updated outputs for tools, regen docs with nested docs script

* updated setup instructions links, destructure trigger outputs, fix text subblock styling

* updated docs gen script

* updated docs script

* updated docs script

* updated script

* remove destructuring of stripe webhook

* expanded wand textarea, updated calcom tools

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-29 20:37:30 -08:00
Siddharth Ganesan
2b026ded16 fix(copilot): hosted api key validation + credential validation (#3000)
* Fix

* Fix greptile

* Fix validation

* Fix comments

* Lint

* Fix

* remove passed in workspace id ref

* Fix comments

---------

Co-authored-by: Vikhyath Mondreti <vikhyath@simstudio.ai>
2026-01-29 10:48:59 -08:00
Siddharth Ganesan
dca0758054 fix(executor): conditional deactivation for loops/parallels (#3069)
* Fix deactivation

* Remove comments
2026-01-29 10:43:30 -08:00
Waleed
ae17c90bdf chore(readme): update readme.md (#3066) 2026-01-28 23:51:34 -08:00
Waleed
1256a15266 fix(posthog): move session recording proxy to middleware for large payload support (#3065)
Next.js rewrites can strip request bodies for large payloads (1MB+),
causing 400 errors from CloudFront. PostHog session recordings require
up to 64MB per message. Moving the proxy to middleware ensures proper
body passthrough.

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-28 23:49:57 -08:00
Waleed
0b2b7ed9c8 fix(oauth): use createElement for icon components to fix React hooks error (#3064) 2026-01-28 23:37:00 -08:00
Vikhyath Mondreti
0d8d9fb238 fix(type): logs workspace delivery (#3063) 2026-01-28 21:54:20 -08:00
Vikhyath Mondreti
e0f1e66f4f feat(child-workflows): nested execution snapshots (#3059)
* feat(child-workflows): nested execution snapshots

* cleanup typing

* address bugbot comments and fix tests

* do not cascade delete logs/snapshots

* fix few more inconsitencies

* fix external logs route

* add fallback color
2026-01-28 19:40:52 -08:00
Emir Karabeg
20bb7cdec6 improvement(preview): include current workflow badge in breadcrumb in workflow snapshot (#3062)
* feat(preview): add workflow context badge for nested navigation

Adds a badge next to the Back button when viewing nested workflows
to help users identify which workflow they are currently viewing.
This is especially helpful when navigating deeply into nested
workflow blocks.

Changes:
- Added workflowName field to WorkflowStackEntry interface
- Capture workflow name from metadata when drilling down
- Display workflow name badge next to Back button

Co-authored-by: emir <emir@simstudio.ai>

* added workflow name and desc to metadata for workflow preview

* added copy and search icon in code in preview editor

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: waleed <walif6@gmail.com>
2026-01-28 19:33:19 -08:00
Waleed
1469e9c66c feat(youtube): add captions, trending, and video categories tools with enhanced API coverage (#3060)
* feat(youtube): add captions, trending, and video categories tools with enhanced API coverage

* fix(youtube): remove captions tool (requires OAuth), fix tinybird defaults, encode pageToken
2026-01-28 19:08:33 -08:00
Waleed
06d7ce7667 feat(timeout): add API block timeout configuration (#3053)
* feat(timeout): add timeout subblock to the api block

* fix(timeout): honor timeout config for internal routes and fix type coercion

- Add AbortController support for internal routes (/api/*) to honor timeout
- Fix type coercion: convert string timeout from short-input to number
- Handle NaN gracefully by falling back to undefined (default timeout)

Fixes #2786
Fixes #2242

* fix: remove redundant clearTimeout in catch block

* fix: validate timeout is positive number

Negative timeout values would cause immediate request abort since
JavaScript treats negative setTimeout delays as 0.

* update docs image, update search modal performance

* removed unused keywords type

* ack comments

* cleanup

* fix: add default timeout for internal routes and validate finite timeout

- Internal routes now use same 5-minute default as external routes
- Added Number.isFinite() check to reject Infinity values

* fix: enforce max timeout and improve error message consistency

- Clamp timeout to max 600000ms (10 minutes) as documented
- External routes now report timeout value in error message

* remove unused code
2026-01-28 17:14:26 -08:00
Emir Karabeg
1bc476f10b fix(copilot): panning on workflow (#3057) 2026-01-28 16:37:12 -08:00
Vikhyath Mondreti
9e40342af8 fix(snapshot): consolidate to use hasWorkflowChanges check (#3051)
* fix(snapshot): consolidate to use hasWorkflowChanges check

* Remove debug logs

* fix normalization logic

* fix serializer for canonical modes
2026-01-28 16:29:17 -08:00
Waleed
0c0f19c717 fix(icons): update strokeWidth of action bar items to match, update run from block icon to match run workflow button (#3056)
* fix(icons): update strokeWidth of action bar items to match, update run from block icon to match run workflow button

* update docs
2026-01-28 16:24:06 -08:00
Emir Karabeg
12d529d045 fix: terminal spacing, subflow disabled in preview (#3055)
* fix: terminal spacing, subflow disabled in preview

* addressed comments
2026-01-28 15:41:46 -08:00
Vikhyath Mondreti
57f0837da7 fix(child-workflow-error-spans): pass trace-spans accurately in block logs (#3054)
* fix(child-workflow): must bypass hiddenFromDisplay config

* fix passing of spans to be in block log

* keep fallback for backwards compat

* fix error message formatting

* clean up
2026-01-28 14:54:35 -08:00
Emir Karabeg
5c02d46d55 feat(terminal): structured output (#3026)
* feat(code): collapsed JSON in terminal

* improvement(code): addressed comments

* feat(terminal): added structured output; improvement(preview): note block

* feat(terminal): log view

* improvement(terminal): ui/ux

* improvement(terminal): default sizing and collapsed width

* fix: code colors, terminal large output handling

* fix(terminal): structured search

* improvement: preivew accuracy, invite-modal admin, logs live
2026-01-28 14:40:43 -08:00
Waleed
8b2404752b feat(description): add deployment version descriptions (#3048)
* feat(description): added version description for deployments table

* feat(description): refactor to tanstack query and remove useEffect

* add wand to generate diff

* ack comments

* removed redundant logic, kept single source of truth for diff

* updated docs

* use consolidated sse parsing util, add loops & parallels check

* DRY
2026-01-28 13:52:40 -08:00
Waleed
c00f05c346 fix(tests): use UTC methods for timezone-independent schedule assertions (#3052) 2026-01-28 13:50:22 -08:00
Vikhyath Mondreti
78410eef84 improvement(inputs): sanitize trigger inputs better (#3047) 2026-01-28 12:57:20 -08:00
Siddharth Ganesan
655fe4f3b7 feat(executor): run from/until block (#3029)
* Run from block

* Fixes

* Fix

* Fix

* Minor improvements

* Fix

* Fix trace spans

* Fix loop l ogs

* Change ordering

* Run u ntil block

* Lint

* Clean up

* Fix

* Allow run from block for triggers

* Consolidation

* Fix lint

* Fix

* Fix mock payload

* Fix

* Fix trigger clear snapshot

* Fix loops and parallels

* Fix

* Cleanup

* Fix test

* Fix bugs

* Catch error

* Fix

* Fix

* I think it works??

* Fix

* Fix

* Add tests

* Fix lint

---------

Co-authored-by: Vikhyath Mondreti <vikhyath@simstudio.ai>
2026-01-28 12:53:23 -08:00
Waleed
72a2f79701 improvement(search-modal): add quick navigation items and fix cmdk value uniqueness (#3050)
* improvement(search-modal): add quick navigation items and fix cmdk value uniqueness

* rerank
2026-01-28 12:39:00 -08:00
Waleed
2c2b485f81 fix(workflow): update container dimensions on keyboard movement (#3043)
* fix(workflow): update container dimensions on keyboard movement

* fix(workflow): avoid duplicate container updates during drag

Add !change.dragging check to only handle keyboard movements in
onNodesChange, since mouse drags are already handled by onNodeDrag.

* fix(workflow): persist keyboard movements to backend

Keyboard arrow key movements now call collaborativeBatchUpdatePositions
to sync position changes to the backend for persistence and real-time
collaboration.

* improvement(cmdk): refactor search modal to use cmdk + fix icon SVG IDs (#3044)

* improvement(cmdk): refactor search modal to use cmdk + fix icon SVG IDs

* chore: remove unrelated workflow.tsx changes

* chore: remove comments

* chore: add devtools middleware to search modal store

* fix: allow search data re-initialization when permissions change

* fix: include keywords in search filter + show service name in tool operations

* fix: correct filterBlocks type signature

* fix: move generic to function parameter position

* fix(mcp): correct event handler type for onInput

* perf: always render command palette for instant opening

* fix: clear search input when modal reopens

* fix(helm): move rotationPolicy under privateKey for cert-manager compatibility (#3046)

* fix(helm): move rotationPolicy under privateKey for cert-manager compatibility

* docs(helm): add reclaimPolicy Retain guidance for production database storage

* fix(helm): prevent empty branding ConfigMap creation

* fix(workflow): avoid duplicate position updates on drag end

Check isInDragOperation before persisting in onNodesChange to prevent
duplicate calls. Drag-end events have dragStartPosition still set,
while keyboard movements don't, allowing proper distinction.
2026-01-28 12:31:38 -08:00
Siddharth Ganesan
01e0723a3a fix(loops): fix loops on empty collection (#3049)
* Fix

* Cleanup

* order of ops for validations

* only reachable subflow nodes should hit validation

---------

Co-authored-by: Vikhyath Mondreti <vikhyath@simstudio.ai>
2026-01-28 12:16:36 -08:00
Waleed
6814f33243 fix(helm): move rotationPolicy under privateKey for cert-manager compatibility (#3046)
* fix(helm): move rotationPolicy under privateKey for cert-manager compatibility

* docs(helm): add reclaimPolicy Retain guidance for production database storage

* fix(helm): prevent empty branding ConfigMap creation
2026-01-28 10:51:19 -08:00
Waleed
304cf717a4 improvement(cmdk): refactor search modal to use cmdk + fix icon SVG IDs (#3044)
* improvement(cmdk): refactor search modal to use cmdk + fix icon SVG IDs

* chore: remove unrelated workflow.tsx changes

* chore: remove comments

* chore: add devtools middleware to search modal store

* fix: allow search data re-initialization when permissions change

* fix: include keywords in search filter + show service name in tool operations

* fix: correct filterBlocks type signature

* fix: move generic to function parameter position

* fix(mcp): correct event handler type for onInput

* perf: always render command palette for instant opening

* fix: clear search input when modal reopens
2026-01-28 10:38:09 -08:00
Vikhyath Mondreti
0d0209a108 fix(autolayout): pass through gridsize (#3042)
* fix(autolayout): pass through gridsize

* fix tests
2026-01-27 20:09:26 -08:00
Vikhyath Mondreti
500dcd4734 fix(openrouter): ignored when tools are configured but unused (#3041) 2026-01-27 19:43:44 -08:00
Vikhyath Mondreti
8bdba373c6 improvement(function): timeout increase to 5 min (#3040) 2026-01-27 19:32:11 -08:00
Vikhyath Mondreti
c8ffda1616 fix(gemini): token count (#3039)
* fix(gemini): token count

* fix to include tool call tokens
2026-01-27 19:16:54 -08:00
Waleed
b4a389a71f improvement(helm): update GPU device plugin and add cert-manager issuers (#3036)
* improvement(helm): update GPU device plugin and add cert-manager issuers

* fix(helm): address code review feedback for GPU plugin and cert-manager

* fix(helm): remove duplicate nodeSelector, add hook for CA issuer ordering

* fix(helm): remove incorrect hook, CA issuer auto-reconciles
2026-01-27 18:25:08 -08:00
Vikhyath Mondreti
65bc21608c improvement(block-inputs): must parse json accurately + models max_tokens fix (#3033)
* improvement(block-inputs): must parse json accurately

* fix sheets typing

* add reference comment

* fix models

* revert blocks changes

* fix param to follow openai new convention
2026-01-27 18:17:35 -08:00
Waleed
ef613ef035 fix(models): update cerebras and groq models (#3038) 2026-01-27 18:12:48 -08:00
Waleed
20b76e67b3 improvement(skills): extend skills (#3035) 2026-01-27 17:58:58 -08:00
Waleed
7640fdf742 feat(autolayout): add snap-to-grid support (#3031)
* feat(autolayout): add snap-to-grid support

* fix(autolayout): recalculate dimensions after grid snapping

* fix(autolayout): correct dimension calculation and propagate gridSize
2026-01-27 17:02:27 -08:00
Waleed
bca355c36d feat(tools): added clerk tools and block (#3032)
* feat(tools): added clerk tools and block

* updated docs gen script

* use clerk api types
2026-01-27 16:45:48 -08:00
Vikhyath Mondreti
089427822e fix(hitl): add missing fields to block configs (#3027)
* fix(hitl): add missing fields to block configs

* update copilot paths

* one more case

* update helper usage
2026-01-27 14:35:37 -08:00
Waleed
6b412c578d fix(security): add authentication to remaining tool API routes (#3028)
* fix(security): add authentication to tool API routes

* fix(drive): use checkSessionOrInternalAuth to allow browser access

* fix(selectors): use checkSessionOrInternalAuth for UI-accessible routes
2026-01-27 12:37:03 -08:00
Waleed
dddd0c8277 fix(workflow): use panel-aware viewport center for paste and block placement (#3024) 2026-01-27 12:36:38 -08:00
Waleed
be7f3db059 fix(badge): add type variant for dark mode contrast (#3025)
* fix(badge): add type variant for dark mode contrast

* docs(badge): add type variant to TSDoc
2026-01-27 11:40:14 -08:00
Waleed
416c08267a fix(terminal): persist collapsed state across page refresh (#3023)
* fix(terminal): persist collapsed state across page refresh

* fix(terminal): add activeWorkflowId to auto-open effect deps
2026-01-27 11:38:44 -08:00
Waleed
46ba315701 feat(tools): added more intercom tools (#3022) 2026-01-26 21:41:44 -08:00
Waleed
077e702dd8 improvement(tools): updated kalshi and polymarket tools and blocks (#3021) 2026-01-26 21:01:33 -08:00
Waleed
d8df08d3d3 improvement(mcp): remove mcp-remote for cursor config (#3020) 2026-01-26 19:54:27 -08:00
Vikhyath Mondreti
51891daf9a feat(code): undo-redo state (#3018)
* feat(code): undo-redo state

* address greptile

* address bugbot comments

* fix debounce flush

* inc debounce time

* fix wand case

* address comments
2026-01-26 19:40:40 -08:00
Vikhyath Mondreti
9ee5dfe185 improvement(workflow): hide raw json childworkflow span (#3019) 2026-01-26 18:47:35 -08:00
Emir Karabeg
9cba8eee48 improvement(preview): error paths, loops, workflow (#3010)
* improvement(switch): dark styling

* improvement(settings): change deployed MCPs to MCPs servers

* improvement(preview): added error paths, loop logic

* improvement(preview): nested workflows preview

* feat(preview): lightweight param

* improvement(preview): staging changes integrated
2026-01-26 17:57:48 -08:00
Siddharth Ganesan
cb650132c7 fix(executor): fix. convergent error edges (#3015) 2026-01-26 17:25:09 -08:00
Waleed
9dbf56f9cd feat(note-block): expand media embed support with tuned aspect ratios (#3016)
* feat(note-block): expand media embed support with tuned aspect ratios

* fix(note-block): add artist parameter to Bandcamp embed URLs

Include the artist subdomain in Bandcamp track and album embed URLs
to ensure proper embed resolution.

* fix(note-block): add required src attribute to track elements

HTML spec requires track elements to have a src attribute.

* fix(note-block): address embed URL matching issues

- Fix YouTube regex to handle v= anywhere in query params
- Fix Twitch channel match to exclude /clip/ URLs
- Remove Mux support (HLS not supported in most browsers)
- Remove Bandcamp support (requires numeric IDs, not slugs)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-26 17:22:44 -08:00
Vikhyath Mondreti
5189473e06 fix(max-tokens): anthropic models streaming vs non-streaming (#2999)
* fix(max-tokens): anthropic models streaming vs non-streaming

* default max inc

* update the docs
2026-01-26 17:05:33 -08:00
Vikhyath Mondreti
37900988eb fix(kb): workspace id required for creation (#3001)
* fix(kb): workspace id required for creation

* fix tests
2026-01-26 16:27:07 -08:00
Vikhyath Mondreti
3cc9b1ae56 fix(input-format): resolution for blocks with input format fields (#3012)
* fix input format

* fix tests

* address bugbot comment
2026-01-26 16:04:19 -08:00
Waleed
3ccbee187d improvement(docs): updated logo, added lightbox to action media, fixed minor styling inconsistencies between themes (#3014)
* improvement(docs): updated logo, added lightbox to action media, fixed minor styling inconsistencies between themes

* updated og image

* ack comments
2026-01-26 15:49:23 -08:00
Waleed
36945deaa5 improvement(preview): consolidate block rendering and fix handle configurations (#3013)
* improvement(preview): consolidate block rendering and fix handle configurations

* refactor(preview): extract SubflowContainerProps interface
2026-01-26 14:56:06 -08:00
Waleed
ebf2852733 fix(copilot): reliable zoom to changed blocks after diff applied (#3011) 2026-01-26 13:54:01 -08:00
Waleed
12495ef89c feat(ci): auto-create github releases and add workflow permissions (#3009) 2026-01-26 13:28:59 -08:00
Waleed
d8d85fccf0 feat(helm): add branding configmap for custom assets (#3008) 2026-01-26 13:19:23 -08:00
Waleed
56bc809c6f fix(docs): separate local and blob asset resolution for quick-reference (#3007)
* fix(docs): separate local and blob asset resolution for quick-reference

ActionImage now uses local paths directly for PNGs while ActionVideo
uses blob storage with proper path normalization (strips static/ prefix).

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): simplify asset resolution by using correct paths directly

Remove path normalization logic from action-media component. Instead,
use the appropriate paths in MDX:
- PNGs: /static/quick-reference/... (local)
- MP4s: quick-reference/... (blob via getAssetUrl)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-26 13:07:11 -08:00
Vikhyath Mondreti
c7bd48573a fix(codegen): function prologue resolution edge cases (#3005)
* fix(codegen): function prologue resolution edge cases

* remove hacky fallback

* case insensitive lookup

* fix python nan and inf resolution

* remove template literal check

* fix tests

* consolidate literal gen
2026-01-26 10:16:13 -08:00
Waleed
80f00479a3 improvement(docs): added images and videos to quick references (#3004)
* improvement(docs): added images and videos to quick references

* moved mp4s to blob, completed quick reference guide
2026-01-25 23:31:40 -08:00
Vikhyath Mondreti
c140e90559 fix(multi-trigger): resolution paths for triggers (#3002)
* fix(multi-trigger): resolution paths for triggers

* fix trigger input format version

* fix output condition logic

* update type guard:

* fix
2026-01-25 23:20:42 -08:00
Vikhyath Mondreti
d83c418111 fix(supabase): storage upload + add basic mode version (#2996)
* fix(supabase): storage upload + add basic mode version

* fix subblock update

* remove redundant check in a2a

* add check consistently for baseline diff
2026-01-25 14:19:30 -08:00
Waleed
be2a9ef0f8 fix(storage): support Azure connection string for presigned URLs (#2997)
* fix(docs): update requirements to be more accurate for deploying the app

* updated kb to support 1536 dimension vectors for models other than text embedding 3 small

* fix(storage): support Azure connection string for presigned URLs

* fix(kb): update test for embedding dimensions parameter

* fix(storage): align credential source ordering for consistency
2026-01-25 13:06:12 -08:00
1031 changed files with 84929 additions and 17430 deletions

View File

@@ -55,21 +55,21 @@ export const {serviceName}{Action}Tool: ToolConfig<
}, },
params: { params: {
// Hidden params (system-injected) // Hidden params (system-injected, only use hidden for oauth accessToken)
accessToken: { accessToken: {
type: 'string', type: 'string',
required: true, required: true,
visibility: 'hidden', visibility: 'hidden',
description: 'OAuth access token', description: 'OAuth access token',
}, },
// User-only params (credentials, IDs user must provide) // User-only params (credentials, api key, IDs user must provide)
someId: { someId: {
type: 'string', type: 'string',
required: true, required: true,
visibility: 'user-only', visibility: 'user-only',
description: 'The ID of the resource', description: 'The ID of the resource',
}, },
// User-or-LLM params (can be provided by user OR computed by LLM) // User-or-LLM params (everything else, can be provided by user OR computed by LLM)
query: { query: {
type: 'string', type: 'string',
required: false, // Use false for optional required: false, // Use false for optional
@@ -114,8 +114,8 @@ export const {serviceName}{Action}Tool: ToolConfig<
### Visibility Options ### Visibility Options
- `'hidden'` - System-injected (OAuth tokens, internal params). User never sees. - `'hidden'` - System-injected (OAuth tokens, internal params). User never sees.
- `'user-only'` - User must provide (credentials, account-specific IDs) - `'user-only'` - User must provide (credentials, api keys, account-specific IDs)
- `'user-or-llm'` - User provides OR LLM can compute (search queries, content, filters) - `'user-or-llm'` - User provides OR LLM can compute (search queries, content, filters, most fall into this category)
### Parameter Types ### Parameter Types
- `'string'` - Text values - `'string'` - Text values

View File

@@ -44,7 +44,7 @@ services:
deploy: deploy:
resources: resources:
limits: limits:
memory: 4G memory: 1G
environment: environment:
- NODE_ENV=development - NODE_ENV=development
- DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio - DATABASE_URL=postgresql://postgres:postgres@db:5432/simstudio

View File

@@ -10,6 +10,9 @@ concurrency:
group: ci-${{ github.ref }} group: ci-${{ github.ref }}
cancel-in-progress: false cancel-in-progress: false
permissions:
contents: read
jobs: jobs:
test-build: test-build:
name: Test and Build name: Test and Build
@@ -278,3 +281,30 @@ jobs:
if: needs.check-docs-changes.outputs.docs_changed == 'true' if: needs.check-docs-changes.outputs.docs_changed == 'true'
uses: ./.github/workflows/docs-embeddings.yml uses: ./.github/workflows/docs-embeddings.yml
secrets: inherit secrets: inherit
# Create GitHub Release (only for version commits on main, after all builds complete)
create-release:
name: Create GitHub Release
runs-on: blacksmith-4vcpu-ubuntu-2404
needs: [create-ghcr-manifests, detect-version]
if: needs.detect-version.outputs.is_release == 'true'
permissions:
contents: write
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest
- name: Install dependencies
run: bun install --frozen-lockfile
- name: Create release
env:
GH_PAT: ${{ secrets.GITHUB_TOKEN }}
run: bun run scripts/create-single-release.ts ${{ needs.detect-version.outputs.version }}

View File

@@ -4,6 +4,9 @@ on:
workflow_call: workflow_call:
workflow_dispatch: # Allow manual triggering workflow_dispatch: # Allow manual triggering
permissions:
contents: read
jobs: jobs:
process-docs-embeddings: process-docs-embeddings:
name: Process Documentation Embeddings name: Process Documentation Embeddings

View File

@@ -4,6 +4,9 @@ on:
workflow_call: workflow_call:
workflow_dispatch: workflow_dispatch:
permissions:
contents: read
jobs: jobs:
migrate: migrate:
name: Apply Database Migrations name: Apply Database Migrations

View File

@@ -6,6 +6,9 @@ on:
paths: paths:
- 'packages/cli/**' - 'packages/cli/**'
permissions:
contents: read
jobs: jobs:
publish-npm: publish-npm:
runs-on: blacksmith-4vcpu-ubuntu-2404 runs-on: blacksmith-4vcpu-ubuntu-2404

View File

@@ -6,6 +6,9 @@ on:
paths: paths:
- 'packages/python-sdk/**' - 'packages/python-sdk/**'
permissions:
contents: write
jobs: jobs:
publish-pypi: publish-pypi:
runs-on: blacksmith-4vcpu-ubuntu-2404 runs-on: blacksmith-4vcpu-ubuntu-2404

View File

@@ -6,6 +6,9 @@ on:
paths: paths:
- 'packages/ts-sdk/**' - 'packages/ts-sdk/**'
permissions:
contents: write
jobs: jobs:
publish-npm: publish-npm:
runs-on: blacksmith-4vcpu-ubuntu-2404 runs-on: blacksmith-4vcpu-ubuntu-2404

View File

@@ -4,6 +4,9 @@ on:
workflow_call: workflow_call:
workflow_dispatch: workflow_dispatch:
permissions:
contents: read
jobs: jobs:
test-build: test-build:
name: Test and Build name: Test and Build

View File

@@ -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)

View File

@@ -185,11 +185,6 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
tableOfContent={{ tableOfContent={{
style: 'clerk', style: 'clerk',
enabled: true, enabled: true,
header: (
<div key='toc-header' className='mb-2 font-medium text-sm'>
On this page
</div>
),
footer: <TOCFooter />, footer: <TOCFooter />,
single: false, single: false,
}} }}

View File

@@ -3,13 +3,13 @@ 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 Image from 'next/image'
import { import {
SidebarFolder, SidebarFolder,
SidebarItem, SidebarItem,
SidebarSeparator, SidebarSeparator,
} from '@/components/docs-layout/sidebar-components' } from '@/components/docs-layout/sidebar-components'
import { Navbar } from '@/components/navbar/navbar' import { Navbar } from '@/components/navbar/navbar'
import { SimLogoFull } from '@/components/ui/sim-logo'
import { i18n } from '@/lib/i18n' import { i18n } from '@/lib/i18n'
import { source } from '@/lib/source' import { source } from '@/lib/source'
import '../global.css' import '../global.css'
@@ -102,16 +102,7 @@ export default async function Layout({ children, params }: LayoutProps) {
<DocsLayout <DocsLayout
tree={source.pageTree[lang]} tree={source.pageTree[lang]}
nav={{ nav={{
title: ( title: <SimLogoFull className='h-7 w-auto' />,
<Image
src='/static/logo.png'
alt='Sim'
width={72}
height={28}
className='h-7 w-auto'
priority
/>
),
}} }}
sidebar={{ sidebar={{
defaultOpenLevel: 0, defaultOpenLevel: 0,

View File

@@ -33,15 +33,41 @@ async function loadGoogleFont(font: string, weights: string, text: string): Prom
throw new Error('Failed to load font data') throw new Error('Failed to load font data')
} }
/**
* Sim logo with icon and "Sim" text for OG image.
*/
function SimLogoFull() {
return (
<svg height='28' viewBox='720 440 1020 320' fill='none'>
{/* Green icon - top left shape with cutout */}
<path
fillRule='evenodd'
clipRule='evenodd'
d='M875.791 577.171C875.791 581.922 873.911 586.483 870.576 589.842L870.098 590.323C866.764 593.692 862.234 595.575 857.517 595.575H750.806C740.978 595.575 733 603.6 733 613.498V728.902C733 738.799 740.978 746.826 750.806 746.826H865.382C875.209 746.826 883.177 738.799 883.177 728.902V620.853C883.177 616.448 884.912 612.222 888.008 609.104C891.093 605.997 895.29 604.249 899.664 604.249H1008.16C1017.99 604.249 1025.96 596.224 1025.96 586.327V470.923C1025.96 461.025 1017.99 453 1008.16 453H893.586C883.759 453 875.791 461.025 875.791 470.923V577.171ZM910.562 477.566H991.178C996.922 477.566 1001.57 482.254 1001.57 488.029V569.22C1001.57 574.995 996.922 579.683 991.178 579.683H910.562C904.828 579.683 900.173 574.995 900.173 569.22V488.029C900.173 482.254 904.828 477.566 910.562 477.566Z'
fill='#33C482'
/>
{/* Green icon - bottom right square */}
<path
d='M1008.3 624.59H923.113C912.786 624.59 904.414 633.022 904.414 643.423V728.171C904.414 738.572 912.786 747.004 923.113 747.004H1008.3C1018.63 747.004 1027 738.572 1027 728.171V643.423C1027 633.022 1018.63 624.59 1008.3 624.59Z'
fill='#33C482'
/>
{/* "Sim" text - white for dark background */}
<path
d='M1210.54 515.657C1226.65 515.657 1240.59 518.51 1252.31 524.257H1252.31C1264.3 529.995 1273.63 538.014 1280.26 548.319H1280.26C1287.19 558.635 1290.78 570.899 1291.08 585.068L1291.1 586.089H1249.11L1249.09 585.115C1248.8 574.003 1245.18 565.493 1238.32 559.451C1231.45 553.399 1221.79 550.308 1209.21 550.308C1196.3 550.308 1186.48 553.113 1179.61 558.588C1172.76 564.046 1169.33 571.499 1169.33 581.063C1169.33 588.092 1171.88 593.978 1177.01 598.783C1182.17 603.618 1189.99 607.399 1200.56 610.061H1200.56L1238.77 619.451C1257.24 623.65 1271.21 630.571 1280.57 640.293L1281.01 640.739C1290.13 650.171 1294.64 662.97 1294.64 679.016C1294.64 692.923 1290.88 705.205 1283.34 715.822L1283.33 715.834C1275.81 726.134 1265.44 734.14 1252.26 739.866L1252.25 739.871C1239.36 745.302 1224.12 748 1206.54 748C1180.9 748 1160.36 741.696 1145.02 728.984C1129.67 716.258 1122 699.269 1122 678.121V677.121H1163.99V678.121C1163.99 688.869 1167.87 697.367 1175.61 703.722L1176.34 704.284C1184.04 709.997 1194.37 712.902 1207.43 712.902C1222.13 712.902 1233.3 710.087 1241.07 704.588C1248.8 698.812 1252.64 691.21 1252.64 681.699C1252.64 674.769 1250.5 669.057 1246.25 664.49L1246.23 664.478L1246.22 664.464C1242.28 659.929 1234.83 656.119 1223.64 653.152L1185.43 644.208L1185.42 644.204C1166.05 639.407 1151.49 632.035 1141.83 622.012L1141.83 622.006L1141.82 622C1132.43 611.94 1127.78 598.707 1127.78 582.405C1127.78 568.81 1131.23 556.976 1138.17 546.949L1138.18 546.941L1138.19 546.933C1145.41 536.936 1155.18 529.225 1167.48 523.793L1167.48 523.79C1180.07 518.36 1194.43 515.657 1210.54 515.657ZM1323.39 521.979C1331.68 525.008 1337.55 526.482 1343.51 526.482C1349.48 526.482 1355.64 525.005 1364.49 521.973L1365.82 521.52V742.633H1322.05V521.489L1323.39 521.979ZM1642.01 515.657C1667.11 515.657 1686.94 523.031 1701.39 537.876C1715.83 552.716 1723 572.968 1723 598.507V742.633H1680.12V608.794C1680.12 591.666 1675.72 578.681 1667.07 569.681L1667.06 569.669L1667.04 569.656C1658.67 560.359 1647.26 555.675 1632.68 555.675C1622.47 555.675 1613.47 558.022 1605.64 562.69L1605.63 562.696C1598.11 567.064 1592.17 573.475 1587.8 581.968C1583.44 590.448 1581.25 600.424 1581.25 611.925V742.633H1537.92V608.347C1537.92 591.208 1533.67 578.376 1525.31 569.68L1525.31 569.674L1525.3 569.668C1516.93 560.664 1505.52 556.122 1490.93 556.122C1480.72 556.122 1471.72 558.469 1463.89 563.138L1463.88 563.144C1456.36 567.511 1450.41 573.922 1446.05 582.415L1446.05 582.422L1446.04 582.428C1441.69 590.602 1439.5 600.423 1439.5 611.925V742.633H1395.72V521.919H1435.05V554.803C1439.92 544.379 1447.91 535.465 1458.37 528.356C1470.71 519.875 1485.58 515.657 1502.93 515.657C1522.37 515.657 1538.61 520.931 1551.55 531.538C1560.38 538.771 1567.1 547.628 1571.72 558.091C1576.05 547.619 1582.83 538.757 1592.07 531.524C1605.61 520.93 1622.28 515.657 1642.01 515.657ZM1343.49 452C1351.45 452 1358.23 454.786 1363.75 460.346C1369.27 465.905 1372.04 472.721 1372.04 480.73C1372.04 488.452 1369.27 495.254 1363.77 501.096L1363.76 501.105L1363.75 501.115C1358.23 506.675 1351.45 509.461 1343.49 509.461C1335.81 509.461 1329.05 506.669 1323.25 501.134L1323.23 501.115L1323.21 501.096C1317.71 495.254 1314.94 488.452 1314.94 480.73C1314.94 472.721 1317.7 465.905 1323.23 460.346L1323.24 460.337L1323.25 460.327C1329.05 454.792 1335.81 452 1343.49 452Z'
fill='#fafafa'
/>
</svg>
)
}
/** /**
* Generates dynamic Open Graph images for documentation pages. * Generates dynamic Open Graph images for documentation pages.
* Style matches Cursor docs: dark background, title at top, logo bottom-left, domain bottom-right.
*/ */
export async function GET(request: NextRequest) { export async function GET(request: NextRequest) {
const { searchParams } = new URL(request.url) const { searchParams } = new URL(request.url)
const title = searchParams.get('title') || 'Documentation' const title = searchParams.get('title') || 'Documentation'
const baseUrl = new URL(request.url).origin
const allText = `${title}docs.sim.ai` const allText = `${title}docs.sim.ai`
const fontData = await loadGoogleFont('Geist', '400;500;600', allText) const fontData = await loadGoogleFont('Geist', '400;500;600', allText)
@@ -52,84 +78,39 @@ export async function GET(request: NextRequest) {
width: '100%', width: '100%',
display: 'flex', display: 'flex',
flexDirection: 'column', flexDirection: 'column',
background: '#0c0c0c', justifyContent: 'space-between',
position: 'relative', padding: '56px 64px',
background: '#121212', // Dark mode background matching docs (hsla 0, 0%, 7%)
fontFamily: 'Geist', fontFamily: 'Geist',
}} }}
> >
{/* Base gradient layer - subtle purple tint across the entire image */} {/* Title at top */}
<div <span
style={{ style={{
position: 'absolute', fontSize: getTitleFontSize(title),
top: 0, fontWeight: 500,
left: 0, color: '#fafafa', // Light text matching docs
width: '100%', lineHeight: 1.2,
height: '100%', letterSpacing: '-0.02em',
background:
'radial-gradient(ellipse 150% 100% at 50% 100%, rgba(88, 28, 135, 0.15) 0%, rgba(88, 28, 135, 0.08) 25%, rgba(88, 28, 135, 0.03) 50%, transparent 80%)',
display: 'flex',
}}
/>
{/* Secondary glow - adds depth without harsh edges */}
<div
style={{
position: 'absolute',
top: 0,
left: 0,
width: '100%',
height: '100%',
background:
'radial-gradient(ellipse 100% 80% at 80% 90%, rgba(112, 31, 252, 0.12) 0%, rgba(112, 31, 252, 0.04) 40%, transparent 70%)',
display: 'flex',
}}
/>
{/* Top darkening - creates natural vignette */}
<div
style={{
position: 'absolute',
top: 0,
left: 0,
width: '100%',
height: '100%',
background:
'linear-gradient(180deg, rgba(0, 0, 0, 0.3) 0%, transparent 40%, transparent 100%)',
display: 'flex',
}}
/>
{/* Content */}
<div
style={{
display: 'flex',
flexDirection: 'column',
padding: '56px 72px',
height: '100%',
justifyContent: 'space-between',
}} }}
> >
{/* Logo */} {title}
<img src={`${baseUrl}/static/logo.png`} alt='sim' height={32} /> </span>
{/* Title */} {/* Footer: icon left, domain right */}
<span <div
style={{ style={{
fontSize: getTitleFontSize(title), display: 'flex',
fontWeight: 600, justifyContent: 'space-between',
color: '#ffffff', alignItems: 'center',
lineHeight: 1.1, width: '100%',
letterSpacing: '-0.02em', }}
}} >
> <SimLogoFull />
{title}
</span>
{/* Footer */}
<span <span
style={{ style={{
fontSize: 20, fontSize: 20,
fontWeight: 500, fontWeight: 400,
color: '#71717a', color: '#71717a',
}} }}
> >

View File

@@ -9,11 +9,20 @@ body {
} }
@theme { @theme {
--color-fd-primary: #802fff; /* Purple from control-bar component */ --color-fd-primary: #33c482; /* Green from Sim logo */
--font-geist-sans: var(--font-geist-sans); --font-geist-sans: var(--font-geist-sans);
--font-geist-mono: var(--font-geist-mono); --font-geist-mono: var(--font-geist-mono);
} }
/* Ensure primary color is set in both light and dark modes */
:root {
--color-fd-primary: #33c482;
}
.dark {
--color-fd-primary: #33c482;
}
/* Font family utilities */ /* Font family utilities */
.font-sans { .font-sans {
font-family: var(--font-geist-sans), ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, font-family: var(--font-geist-sans), ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont,
@@ -34,7 +43,7 @@ body {
:root { :root {
--fd-border: transparent !important; --fd-border: transparent !important;
--fd-border-sidebar: transparent !important; --fd-border-sidebar: transparent !important;
--fd-nav-height: 64px; /* Custom navbar height (h-16 = 4rem = 64px) */ --fd-nav-height: 65px; /* Custom navbar height (h-16 = 64px + 1px border) */
/* Content container width used to center main content */ /* Content container width used to center main content */
--spacing-fd-container: 1400px; --spacing-fd-container: 1400px;
/* Edge gutter = leftover space on each side of centered container */ /* Edge gutter = leftover space on each side of centered container */
@@ -136,11 +145,11 @@ aside#nd-sidebar {
/* On mobile, let fumadocs handle the layout natively */ /* On mobile, let fumadocs handle the layout natively */
@media (min-width: 1024px) { @media (min-width: 1024px) {
:root { :root {
--fd-banner-height: 64px !important; --fd-banner-height: 65px !important; /* 64px navbar + 1px border */
} }
#nd-docs-layout { #nd-docs-layout {
--fd-docs-height: calc(100dvh - 64px) !important; --fd-docs-height: calc(100dvh - 65px) !important; /* 64px navbar + 1px border */
--fd-sidebar-width: 300px !important; --fd-sidebar-width: 300px !important;
margin-left: var(--sidebar-offset) !important; margin-left: var(--sidebar-offset) !important;
margin-right: var(--toc-offset) !important; margin-right: var(--toc-offset) !important;
@@ -227,19 +236,19 @@ html:not(.dark) #nd-sidebar button:not([aria-label*="ollapse"]):not([aria-label*
letter-spacing: 0.05em !important; letter-spacing: 0.05em !important;
} }
/* Override active state (NO PURPLE) */ /* Override active state */
#nd-sidebar a[data-active="true"], #nd-sidebar a[data-active="true"],
#nd-sidebar button[data-active="true"], #nd-sidebar button[data-active="true"],
#nd-sidebar a.bg-fd-primary\/10, #nd-sidebar a.bg-fd-primary\/10,
#nd-sidebar a.text-fd-primary, #nd-sidebar a.text-fd-primary,
#nd-sidebar a[class*="bg-fd-primary"], #nd-sidebar a[class*="bg-fd-primary"],
#nd-sidebar a[class*="text-fd-primary"], #nd-sidebar a[class*="text-fd-primary"],
/* Override custom sidebar purple classes */ /* Override custom sidebar green classes */
#nd-sidebar #nd-sidebar
a.bg-purple-50\/80, a.bg-emerald-50\/80,
#nd-sidebar a.text-purple-600, #nd-sidebar a.text-emerald-600,
#nd-sidebar a[class*="bg-purple"], #nd-sidebar a[class*="bg-emerald"],
#nd-sidebar a[class*="text-purple"] { #nd-sidebar a[class*="text-emerald"] {
background-image: none !important; background-image: none !important;
} }
@@ -250,10 +259,10 @@ html.dark #nd-sidebar a.bg-fd-primary\/10,
html.dark #nd-sidebar a.text-fd-primary, html.dark #nd-sidebar a.text-fd-primary,
html.dark #nd-sidebar a[class*="bg-fd-primary"], html.dark #nd-sidebar a[class*="bg-fd-primary"],
html.dark #nd-sidebar a[class*="text-fd-primary"], html.dark #nd-sidebar a[class*="text-fd-primary"],
html.dark #nd-sidebar a.bg-purple-50\/80, html.dark #nd-sidebar a.bg-emerald-50\/80,
html.dark #nd-sidebar a.text-purple-600, html.dark #nd-sidebar a.text-emerald-600,
html.dark #nd-sidebar a[class*="bg-purple"], html.dark #nd-sidebar a[class*="bg-emerald"],
html.dark #nd-sidebar a[class*="text-purple"] { html.dark #nd-sidebar a[class*="text-emerald"] {
background-color: rgba(255, 255, 255, 0.15) !important; background-color: rgba(255, 255, 255, 0.15) !important;
color: rgba(255, 255, 255, 1) !important; color: rgba(255, 255, 255, 1) !important;
} }
@@ -265,10 +274,10 @@ html:not(.dark) #nd-sidebar a.bg-fd-primary\/10,
html:not(.dark) #nd-sidebar a.text-fd-primary, html:not(.dark) #nd-sidebar a.text-fd-primary,
html:not(.dark) #nd-sidebar a[class*="bg-fd-primary"], html:not(.dark) #nd-sidebar a[class*="bg-fd-primary"],
html:not(.dark) #nd-sidebar a[class*="text-fd-primary"], html:not(.dark) #nd-sidebar a[class*="text-fd-primary"],
html:not(.dark) #nd-sidebar a.bg-purple-50\/80, html:not(.dark) #nd-sidebar a.bg-emerald-50\/80,
html:not(.dark) #nd-sidebar a.text-purple-600, html:not(.dark) #nd-sidebar a.text-emerald-600,
html:not(.dark) #nd-sidebar a[class*="bg-purple"], html:not(.dark) #nd-sidebar a[class*="bg-emerald"],
html:not(.dark) #nd-sidebar a[class*="text-purple"] { html:not(.dark) #nd-sidebar a[class*="text-emerald"] {
background-color: rgba(0, 0, 0, 0.07) !important; background-color: rgba(0, 0, 0, 0.07) !important;
color: rgba(0, 0, 0, 0.9) !important; color: rgba(0, 0, 0, 0.9) !important;
} }
@@ -286,8 +295,8 @@ html:not(.dark) #nd-sidebar button:hover:not([data-active="true"]) {
} }
/* Dark mode - ensure active/selected items don't change on hover */ /* Dark mode - ensure active/selected items don't change on hover */
html.dark #nd-sidebar a.bg-purple-50\/80:hover, html.dark #nd-sidebar a.bg-emerald-50\/80:hover,
html.dark #nd-sidebar a[class*="bg-purple"]:hover, html.dark #nd-sidebar a[class*="bg-emerald"]:hover,
html.dark #nd-sidebar a[data-active="true"]:hover, html.dark #nd-sidebar a[data-active="true"]:hover,
html.dark #nd-sidebar button[data-active="true"]:hover { html.dark #nd-sidebar button[data-active="true"]:hover {
background-color: rgba(255, 255, 255, 0.15) !important; background-color: rgba(255, 255, 255, 0.15) !important;
@@ -295,8 +304,8 @@ html.dark #nd-sidebar button[data-active="true"]:hover {
} }
/* Light mode - ensure active/selected items don't change on hover */ /* Light mode - ensure active/selected items don't change on hover */
html:not(.dark) #nd-sidebar a.bg-purple-50\/80:hover, html:not(.dark) #nd-sidebar a.bg-emerald-50\/80:hover,
html:not(.dark) #nd-sidebar a[class*="bg-purple"]:hover, html:not(.dark) #nd-sidebar a[class*="bg-emerald"]:hover,
html:not(.dark) #nd-sidebar a[data-active="true"]:hover, html:not(.dark) #nd-sidebar a[data-active="true"]:hover,
html:not(.dark) #nd-sidebar button[data-active="true"]:hover { html:not(.dark) #nd-sidebar button[data-active="true"]:hover {
background-color: rgba(0, 0, 0, 0.07) !important; background-color: rgba(0, 0, 0, 0.07) !important;
@@ -368,16 +377,24 @@ aside[data-sidebar] > *:not([data-sidebar-viewport]) {
button[aria-label="Toggle Sidebar"], button[aria-label="Toggle Sidebar"],
button[aria-label="Collapse Sidebar"], button[aria-label="Collapse Sidebar"],
/* Hide nav title/logo in sidebar on desktop - target all possible locations */ /* Hide nav title/logo in sidebar on desktop - target all possible locations */
/* Lower specificity selectors first (attribute selectors) */
[data-sidebar-header],
[data-sidebar] [data-title],
aside[data-sidebar] a[href="/"], aside[data-sidebar] a[href="/"],
aside[data-sidebar] a[href="/"] img, aside[data-sidebar] a[href="/"] img,
aside[data-sidebar] > a:first-child, aside[data-sidebar] > a:first-child,
aside[data-sidebar] > div > a:first-child, aside[data-sidebar] > div > a:first-child,
aside[data-sidebar] img[alt="Sim"], aside[data-sidebar] img[alt="Sim"],
[data-sidebar-header], aside[data-sidebar] svg[aria-label="Sim"],
[data-sidebar] [data-title], /* Higher specificity selectors (ID selectors) */
#nd-sidebar
a[href="/"],
#nd-sidebar a[href="/"] img,
#nd-sidebar a[href="/"] svg,
#nd-sidebar > a:first-child, #nd-sidebar > a:first-child,
#nd-sidebar > div:first-child > a:first-child, #nd-sidebar > div:first-child > a:first-child,
#nd-sidebar img[alt="Sim"], #nd-sidebar img[alt="Sim"],
#nd-sidebar svg[aria-label="Sim"],
/* Hide theme toggle at bottom of sidebar on desktop */ /* Hide theme toggle at bottom of sidebar on desktop */
#nd-sidebar #nd-sidebar
> footer, > footer,
@@ -515,6 +532,15 @@ pre code .line {
color: var(--color-fd-primary); color: var(--color-fd-primary);
} }
/* ============================================
TOC (Table of Contents) Styling
============================================ */
/* Remove the thin border-left on nested TOC items (keeps main indicator only) */
#nd-toc a[style*="padding-inline-start"] {
border-left: none !important;
}
/* Add bottom spacing to prevent abrupt page endings */ /* Add bottom spacing to prevent abrupt page endings */
[data-content] { [data-content] {
padding-top: 1.5rem !important; padding-top: 1.5rem !important;

View File

@@ -44,7 +44,7 @@ export function SidebarItem({ item }: { item: Item }) {
'lg:text-gray-600 lg:dark:text-gray-400', 'lg:text-gray-600 lg:dark:text-gray-400',
!active && 'lg:hover:bg-gray-100/60 lg:dark:hover:bg-gray-800/40', !active && 'lg:hover:bg-gray-100/60 lg:dark:hover:bg-gray-800/40',
active && active &&
'lg:bg-purple-50/80 lg:font-normal lg:text-purple-600 lg:dark:bg-purple-900/15 lg:dark:text-purple-400' 'lg:bg-emerald-50/80 lg:font-normal lg:text-emerald-600 lg:dark:bg-emerald-900/15 lg:dark:text-emerald-400'
)} )}
> >
{item.name} {item.name}
@@ -79,7 +79,7 @@ export function SidebarFolder({ item, children }: { item: Folder; children: Reac
'lg:text-gray-600 lg:dark:text-gray-400', 'lg:text-gray-600 lg:dark:text-gray-400',
!active && 'lg:hover:bg-gray-100/60 lg:dark:hover:bg-gray-800/40', !active && 'lg:hover:bg-gray-100/60 lg:dark:hover:bg-gray-800/40',
active && active &&
'lg:bg-purple-50/80 lg:font-normal lg:text-purple-600 lg:dark:bg-purple-900/15 lg:dark:text-purple-400' 'lg:bg-emerald-50/80 lg:font-normal lg:text-emerald-600 lg:dark:bg-emerald-900/15 lg:dark:text-emerald-400'
)} )}
> >
{item.name} {item.name}
@@ -104,7 +104,7 @@ export function SidebarFolder({ item, children }: { item: Folder; children: Reac
'lg:text-gray-800 lg:dark:text-gray-200', 'lg:text-gray-800 lg:dark:text-gray-200',
!active && 'lg:hover:bg-gray-100/60 lg:dark:hover:bg-gray-800/40', !active && 'lg:hover:bg-gray-100/60 lg:dark:hover:bg-gray-800/40',
active && active &&
'lg:bg-purple-50/80 lg:text-purple-600 lg:dark:bg-purple-900/15 lg:dark:text-purple-400' 'lg:bg-emerald-50/80 lg:text-emerald-600 lg:dark:bg-emerald-900/15 lg:dark:text-emerald-400'
)} )}
> >
{item.name} {item.name}

View File

@@ -23,7 +23,7 @@ export function TOCFooter() {
rel='noopener noreferrer' rel='noopener noreferrer'
onMouseEnter={() => setIsHovered(true)} onMouseEnter={() => setIsHovered(true)}
onMouseLeave={() => setIsHovered(false)} onMouseLeave={() => setIsHovered(false)}
className='group mt-2 inline-flex h-8 w-fit items-center justify-center gap-1 whitespace-nowrap rounded-[10px] border border-[#6F3DFA] bg-gradient-to-b from-[#8357FF] to-[#6F3DFA] px-3 pr-[10px] pl-[12px] font-medium text-sm text-white shadow-[inset_0_2px_4px_0_#9B77FF] outline-none transition-all hover:shadow-lg focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50' className='group mt-2 inline-flex h-8 w-fit items-center justify-center gap-1 whitespace-nowrap rounded-[10px] border border-[#2AAD6C] bg-gradient-to-b from-[#3ED990] to-[#2AAD6C] px-3 pr-[10px] pl-[12px] font-medium text-sm text-white shadow-[inset_0_2px_4px_0_#5EE8A8] outline-none transition-all hover:shadow-lg focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50'
aria-label='Get started with Sim - Sign up for free' aria-label='Get started with Sim - Sign up for free'
> >
<span>Get started</span> <span>Get started</span>

File diff suppressed because one or more lines are too long

View File

@@ -1,9 +1,9 @@
'use client' 'use client'
import Image from 'next/image'
import Link from 'next/link' import Link from 'next/link'
import { LanguageDropdown } from '@/components/ui/language-dropdown' import { LanguageDropdown } from '@/components/ui/language-dropdown'
import { SearchTrigger } from '@/components/ui/search-trigger' import { SearchTrigger } from '@/components/ui/search-trigger'
import { SimLogoFull } from '@/components/ui/sim-logo'
import { ThemeToggle } from '@/components/ui/theme-toggle' import { ThemeToggle } from '@/components/ui/theme-toggle'
export function Navbar() { export function Navbar() {
@@ -27,13 +27,7 @@ export function Navbar() {
{/* Left cluster: logo */} {/* Left cluster: logo */}
<div className='flex items-center'> <div className='flex items-center'>
<Link href='/' className='flex min-w-[100px] items-center'> <Link href='/' className='flex min-w-[100px] items-center'>
<Image <SimLogoFull className='h-7 w-auto' />
src='/static/logo.png'
alt='Sim'
width={72}
height={28}
className='h-7 w-auto'
/>
</Link> </Link>
</div> </div>

View File

@@ -0,0 +1,87 @@
'use client'
import { useState } from 'react'
import { cn, getAssetUrl } from '@/lib/utils'
import { Lightbox } from './lightbox'
interface ActionImageProps {
src: string
alt: string
enableLightbox?: boolean
}
interface ActionVideoProps {
src: string
alt: string
enableLightbox?: boolean
}
export function ActionImage({ src, alt, enableLightbox = true }: ActionImageProps) {
const [isLightboxOpen, setIsLightboxOpen] = useState(false)
const handleClick = () => {
if (enableLightbox) {
setIsLightboxOpen(true)
}
}
return (
<>
<img
src={src}
alt={alt}
onClick={handleClick}
className={cn(
'inline-block w-full max-w-[200px] rounded border border-neutral-200 dark:border-neutral-700',
enableLightbox && 'cursor-pointer transition-opacity hover:opacity-90'
)}
/>
{enableLightbox && (
<Lightbox
isOpen={isLightboxOpen}
onClose={() => setIsLightboxOpen(false)}
src={src}
alt={alt}
type='image'
/>
)}
</>
)
}
export function ActionVideo({ src, alt, enableLightbox = true }: ActionVideoProps) {
const [isLightboxOpen, setIsLightboxOpen] = useState(false)
const resolvedSrc = getAssetUrl(src)
const handleClick = () => {
if (enableLightbox) {
setIsLightboxOpen(true)
}
}
return (
<>
<video
src={resolvedSrc}
autoPlay
loop
muted
playsInline
onClick={handleClick}
className={cn(
'inline-block w-full max-w-[200px] rounded border border-neutral-200 dark:border-neutral-700',
enableLightbox && 'cursor-pointer transition-opacity hover:opacity-90'
)}
/>
{enableLightbox && (
<Lightbox
isOpen={isLightboxOpen}
onClose={() => setIsLightboxOpen(false)}
src={src}
alt={alt}
type='video'
/>
)}
</>
)
}

View File

@@ -13,9 +13,11 @@ import {
AsanaIcon, AsanaIcon,
BrainIcon, BrainIcon,
BrowserUseIcon, BrowserUseIcon,
CalComIcon,
CalendlyIcon, CalendlyIcon,
CirclebackIcon, CirclebackIcon,
ClayIcon, ClayIcon,
ClerkIcon,
ConfluenceIcon, ConfluenceIcon,
CursorIcon, CursorIcon,
DatadogIcon, DatadogIcon,
@@ -99,9 +101,9 @@ import {
ServiceNowIcon, ServiceNowIcon,
SftpIcon, SftpIcon,
ShopifyIcon, ShopifyIcon,
SimilarwebIcon,
SlackIcon, SlackIcon,
SmtpIcon, SmtpIcon,
SpotifyIcon,
SQSIcon, SQSIcon,
SshIcon, SshIcon,
STTIcon, STTIcon,
@@ -141,9 +143,11 @@ 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,
clerk: ClerkIcon,
confluence_v2: ConfluenceIcon, confluence_v2: ConfluenceIcon,
cursor_v2: CursorIcon, cursor_v2: CursorIcon,
datadog: DatadogIcon, datadog: DatadogIcon,
@@ -182,7 +186,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
jina: JinaAIIcon, jina: JinaAIIcon,
jira: JiraIcon, jira: JiraIcon,
jira_service_management: JiraServiceManagementIcon, jira_service_management: JiraServiceManagementIcon,
kalshi: KalshiIcon, kalshi_v2: KalshiIcon,
knowledge: PackageSearchIcon, knowledge: PackageSearchIcon,
langsmith: LangsmithIcon, langsmith: LangsmithIcon,
lemlist: LemlistIcon, lemlist: LemlistIcon,
@@ -227,9 +231,9 @@ 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,
spotify: SpotifyIcon,
sqs: SQSIcon, sqs: SQSIcon,
ssh: SshIcon, ssh: SshIcon,
stagehand: StagehandIcon, stagehand: StagehandIcon,

View File

@@ -1,8 +1,9 @@
'use client' 'use client'
import { useEffect, useState } from 'react' import { useEffect, useState } from 'react'
import { Check, ChevronRight } from 'lucide-react' import { Check, ChevronDown } from 'lucide-react'
import { useParams, usePathname, useRouter } from 'next/navigation' import { useParams, usePathname, useRouter } from 'next/navigation'
import { cn } from '@/lib/utils'
const languages = { const languages = {
en: { name: 'English', flag: '🇺🇸' }, en: { name: 'English', flag: '🇺🇸' },
@@ -15,6 +16,7 @@ const languages = {
export function LanguageDropdown() { export function LanguageDropdown() {
const [isOpen, setIsOpen] = useState(false) const [isOpen, setIsOpen] = useState(false)
const [hoveredIndex, setHoveredIndex] = useState<number>(-1)
const pathname = usePathname() const pathname = usePathname()
const params = useParams() const params = useParams()
const router = useRouter() const router = useRouter()
@@ -71,6 +73,15 @@ export function LanguageDropdown() {
return () => window.removeEventListener('keydown', onKey) return () => window.removeEventListener('keydown', onKey)
}, [isOpen]) }, [isOpen])
// Reset hovered index when popover closes
useEffect(() => {
if (!isOpen) {
setHoveredIndex(-1)
}
}, [isOpen])
const languageEntries = Object.entries(languages)
return ( return (
<div className='relative'> <div className='relative'>
<button <button
@@ -82,14 +93,14 @@ export function LanguageDropdown() {
aria-haspopup='listbox' aria-haspopup='listbox'
aria-expanded={isOpen} aria-expanded={isOpen}
aria-controls='language-menu' aria-controls='language-menu'
className='flex cursor-pointer items-center gap-1.5 rounded-xl px-3 py-2 font-normal text-[0.9375rem] text-foreground/60 leading-[1.4] transition-colors hover:bg-foreground/8 hover:text-foreground focus:outline-none focus-visible:ring-2 focus-visible:ring-ring' className='flex cursor-pointer items-center gap-1.5 rounded-[6px] px-3 py-2 font-normal text-[0.9375rem] text-foreground/60 leading-[1.4] transition-colors hover:bg-foreground/8 hover:text-foreground focus:outline-none focus-visible:ring-2 focus-visible:ring-ring'
style={{ style={{
fontFamily: fontFamily:
'-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif', '-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif',
}} }}
> >
<span>{languages[currentLang as keyof typeof languages]?.name}</span> <span>{languages[currentLang as keyof typeof languages]?.name}</span>
<ChevronRight className='h-3.5 w-3.5' /> <ChevronDown className={cn('h-3.5 w-3.5 transition-transform', isOpen && 'rotate-180')} />
</button> </button>
{isOpen && ( {isOpen && (
@@ -98,29 +109,37 @@ export function LanguageDropdown() {
<div <div
id='language-menu' id='language-menu'
role='listbox' role='listbox'
className='absolute top-full right-0 z-[1001] mt-1 max-h-[75vh] w-56 overflow-auto rounded-xl border border-border/50 bg-white shadow-2xl md:w-44 md:bg-background/95 md:backdrop-blur-md dark:bg-neutral-950 md:dark:bg-background/95' className='absolute top-full right-0 z-[1001] mt-2 max-h-[400px] min-w-[160px] overflow-auto rounded-[6px] bg-white px-[6px] py-[6px] shadow-lg dark:bg-neutral-900'
> >
{Object.entries(languages).map(([code, lang]) => ( {languageEntries.map(([code, lang], index) => {
<button const isSelected = currentLang === code
key={code} const isHovered = hoveredIndex === index
onClick={(e) => {
e.preventDefault() return (
e.stopPropagation() <button
handleLanguageChange(code) key={code}
}} onClick={(e) => {
role='option' e.preventDefault()
aria-selected={currentLang === code} e.stopPropagation()
className={`flex w-full cursor-pointer items-center gap-3 px-3 py-3 text-base transition-colors first:rounded-t-xl last:rounded-b-xl hover:bg-muted/80 focus:outline-none focus-visible:ring-2 focus-visible:ring-ring md:gap-2 md:px-2.5 md:py-2 md:text-sm ${ handleLanguageChange(code)
currentLang === code ? 'bg-muted/60 font-medium text-primary' : 'text-foreground' }}
}`} onMouseEnter={() => setHoveredIndex(index)}
> onMouseLeave={() => setHoveredIndex(-1)}
<span className='text-base md:text-sm'>{lang.flag}</span> role='option'
<span className='leading-none'>{lang.name}</span> aria-selected={isSelected}
{currentLang === code && ( className={cn(
<Check className='ml-auto h-4 w-4 text-primary md:h-3.5 md:w-3.5' /> 'flex h-[26px] w-full min-w-0 cursor-pointer items-center gap-[8px] rounded-[6px] px-[6px] text-[13px] transition-colors',
)} 'text-neutral-700 dark:text-neutral-200',
</button> isHovered && 'bg-neutral-100 dark:bg-neutral-800',
))} 'focus:outline-none'
)}
>
<span className='text-[13px]'>{lang.flag}</span>
<span className='flex-1 text-left leading-none'>{lang.name}</span>
{isSelected && <Check className='ml-auto h-3.5 w-3.5' />}
</button>
)
})}
</div> </div>
</> </>
)} )}

View File

@@ -0,0 +1,108 @@
'use client'
import { cn } from '@/lib/utils'
interface SimLogoProps {
className?: string
}
/**
* Sim logo with icon and text.
* The icon stays green (#33C482), text adapts to light/dark mode.
*/
export function SimLogo({ className }: SimLogoProps) {
return (
<svg
viewBox='720 440 320 320'
fill='none'
xmlns='http://www.w3.org/2000/svg'
className={cn('h-7 w-auto', className)}
aria-label='Sim'
>
{/* Green icon - top left shape with cutout */}
<path
fillRule='evenodd'
clipRule='evenodd'
d='M875.791 577.171C875.791 581.922 873.911 586.483 870.576 589.842L870.098 590.323C866.764 593.692 862.234 595.575 857.517 595.575H750.806C740.978 595.575 733 603.6 733 613.498V728.902C733 738.799 740.978 746.826 750.806 746.826H865.382C875.209 746.826 883.177 738.799 883.177 728.902V620.853C883.177 616.448 884.912 612.222 888.008 609.104C891.093 605.997 895.29 604.249 899.664 604.249H1008.16C1017.99 604.249 1025.96 596.224 1025.96 586.327V470.923C1025.96 461.025 1017.99 453 1008.16 453H893.586C883.759 453 875.791 461.025 875.791 470.923V577.171ZM910.562 477.566H991.178C996.922 477.566 1001.57 482.254 1001.57 488.029V569.22C1001.57 574.995 996.922 579.683 991.178 579.683H910.562C904.828 579.683 900.173 574.995 900.173 569.22V488.029C900.173 482.254 904.828 477.566 910.562 477.566Z'
fill='#33C482'
/>
{/* Green icon - bottom right square */}
<path
d='M1008.3 624.59H923.113C912.786 624.59 904.414 633.022 904.414 643.423V728.171C904.414 738.572 912.786 747.004 923.113 747.004H1008.3C1018.63 747.004 1027 738.572 1027 728.171V643.423C1027 633.022 1018.63 624.59 1008.3 624.59Z'
fill='#33C482'
/>
{/* Gradient overlay on bottom right square */}
<path
d='M1008.3 624.199H923.113C912.786 624.199 904.414 632.631 904.414 643.033V727.78C904.414 738.181 912.786 746.612 923.113 746.612H1008.3C1018.63 746.612 1027 738.181 1027 727.78V643.033C1027 632.631 1018.63 624.199 1008.3 624.199Z'
fill='url(#sim-logo-gradient)'
fillOpacity='0.2'
/>
<defs>
<linearGradient
id='sim-logo-gradient'
x1='904.414'
y1='624.199'
x2='978.836'
y2='698.447'
gradientUnits='userSpaceOnUse'
>
<stop />
<stop offset='1' stopOpacity='0' />
</linearGradient>
</defs>
</svg>
)
}
/**
* Full Sim logo with icon and "Sim" text.
* The icon stays green (#33C482), text adapts to light/dark mode.
*/
export function SimLogoFull({ className }: SimLogoProps) {
return (
<svg
viewBox='720 440 1020 320'
fill='none'
xmlns='http://www.w3.org/2000/svg'
className={cn('h-7 w-auto', className)}
aria-label='Sim'
>
{/* Green icon - top left shape with cutout */}
<path
fillRule='evenodd'
clipRule='evenodd'
d='M875.791 577.171C875.791 581.922 873.911 586.483 870.576 589.842L870.098 590.323C866.764 593.692 862.234 595.575 857.517 595.575H750.806C740.978 595.575 733 603.6 733 613.498V728.902C733 738.799 740.978 746.826 750.806 746.826H865.382C875.209 746.826 883.177 738.799 883.177 728.902V620.853C883.177 616.448 884.912 612.222 888.008 609.104C891.093 605.997 895.29 604.249 899.664 604.249H1008.16C1017.99 604.249 1025.96 596.224 1025.96 586.327V470.923C1025.96 461.025 1017.99 453 1008.16 453H893.586C883.759 453 875.791 461.025 875.791 470.923V577.171ZM910.562 477.566H991.178C996.922 477.566 1001.57 482.254 1001.57 488.029V569.22C1001.57 574.995 996.922 579.683 991.178 579.683H910.562C904.828 579.683 900.173 574.995 900.173 569.22V488.029C900.173 482.254 904.828 477.566 910.562 477.566Z'
fill='#33C482'
/>
{/* Green icon - bottom right square */}
<path
d='M1008.3 624.59H923.113C912.786 624.59 904.414 633.022 904.414 643.423V728.171C904.414 738.572 912.786 747.004 923.113 747.004H1008.3C1018.63 747.004 1027 738.572 1027 728.171V643.423C1027 633.022 1018.63 624.59 1008.3 624.59Z'
fill='#33C482'
/>
{/* Gradient overlay on bottom right square */}
<path
d='M1008.3 624.199H923.113C912.786 624.199 904.414 632.631 904.414 643.033V727.78C904.414 738.181 912.786 746.612 923.113 746.612H1008.3C1018.63 746.612 1027 738.181 1027 727.78V643.033C1027 632.631 1018.63 624.199 1008.3 624.199Z'
fill='url(#sim-logo-full-gradient)'
fillOpacity='0.2'
/>
{/* "Sim" text - adapts to light/dark mode via currentColor */}
<path
d='M1210.54 515.657C1226.65 515.657 1240.59 518.51 1252.31 524.257H1252.31C1264.3 529.995 1273.63 538.014 1280.26 548.319H1280.26C1287.19 558.635 1290.78 570.899 1291.08 585.068L1291.1 586.089H1249.11L1249.09 585.115C1248.8 574.003 1245.18 565.493 1238.32 559.451C1231.45 553.399 1221.79 550.308 1209.21 550.308C1196.3 550.308 1186.48 553.113 1179.61 558.588C1172.76 564.046 1169.33 571.499 1169.33 581.063C1169.33 588.092 1171.88 593.978 1177.01 598.783C1182.17 603.618 1189.99 607.399 1200.56 610.061H1200.56L1238.77 619.451C1257.24 623.65 1271.21 630.571 1280.57 640.293L1281.01 640.739C1290.13 650.171 1294.64 662.97 1294.64 679.016C1294.64 692.923 1290.88 705.205 1283.34 715.822L1283.33 715.834C1275.81 726.134 1265.44 734.14 1252.26 739.866L1252.25 739.871C1239.36 745.302 1224.12 748 1206.54 748C1180.9 748 1160.36 741.696 1145.02 728.984C1129.67 716.258 1122 699.269 1122 678.121V677.121H1163.99V678.121C1163.99 688.869 1167.87 697.367 1175.61 703.722L1176.34 704.284C1184.04 709.997 1194.37 712.902 1207.43 712.902C1222.13 712.902 1233.3 710.087 1241.07 704.588C1248.8 698.812 1252.64 691.21 1252.64 681.699C1252.64 674.769 1250.5 669.057 1246.25 664.49L1246.23 664.478L1246.22 664.464C1242.28 659.929 1234.83 656.119 1223.64 653.152L1185.43 644.208L1185.42 644.204C1166.05 639.407 1151.49 632.035 1141.83 622.012L1141.83 622.006L1141.82 622C1132.43 611.94 1127.78 598.707 1127.78 582.405C1127.78 568.81 1131.23 556.976 1138.17 546.949L1138.18 546.941L1138.19 546.933C1145.41 536.936 1155.18 529.225 1167.48 523.793L1167.48 523.79C1180.07 518.36 1194.43 515.657 1210.54 515.657ZM1323.39 521.979C1331.68 525.008 1337.55 526.482 1343.51 526.482C1349.48 526.482 1355.64 525.005 1364.49 521.973L1365.82 521.52V742.633H1322.05V521.489L1323.39 521.979ZM1642.01 515.657C1667.11 515.657 1686.94 523.031 1701.39 537.876C1715.83 552.716 1723 572.968 1723 598.507V742.633H1680.12V608.794C1680.12 591.666 1675.72 578.681 1667.07 569.681L1667.06 569.669L1667.04 569.656C1658.67 560.359 1647.26 555.675 1632.68 555.675C1622.47 555.675 1613.47 558.022 1605.64 562.69L1605.63 562.696C1598.11 567.064 1592.17 573.475 1587.8 581.968C1583.44 590.448 1581.25 600.424 1581.25 611.925V742.633H1537.92V608.347C1537.92 591.208 1533.67 578.376 1525.31 569.68L1525.31 569.674L1525.3 569.668C1516.93 560.664 1505.52 556.122 1490.93 556.122C1480.72 556.122 1471.72 558.469 1463.89 563.138L1463.88 563.144C1456.36 567.511 1450.41 573.922 1446.05 582.415L1446.05 582.422L1446.04 582.428C1441.69 590.602 1439.5 600.423 1439.5 611.925V742.633H1395.72V521.919H1435.05V554.803C1439.92 544.379 1447.91 535.465 1458.37 528.356C1470.71 519.875 1485.58 515.657 1502.93 515.657C1522.37 515.657 1538.61 520.931 1551.55 531.538C1560.38 538.771 1567.1 547.628 1571.72 558.091C1576.05 547.619 1582.83 538.757 1592.07 531.524C1605.61 520.93 1622.28 515.657 1642.01 515.657ZM1343.49 452C1351.45 452 1358.23 454.786 1363.75 460.346C1369.27 465.905 1372.04 472.721 1372.04 480.73C1372.04 488.452 1369.27 495.254 1363.77 501.096L1363.76 501.105L1363.75 501.115C1358.23 506.675 1351.45 509.461 1343.49 509.461C1335.81 509.461 1329.05 506.669 1323.25 501.134L1323.23 501.115L1323.21 501.096C1317.71 495.254 1314.94 488.452 1314.94 480.73C1314.94 472.721 1317.7 465.905 1323.23 460.346L1323.24 460.337L1323.25 460.327C1329.05 454.792 1335.81 452 1343.49 452Z'
className='fill-neutral-900 dark:fill-white'
/>
<defs>
<linearGradient
id='sim-logo-full-gradient'
x1='904.414'
y1='624.199'
x2='978.836'
y2='698.447'
gradientUnits='userSpaceOnUse'
>
<stop />
<stop offset='1' stopOpacity='0' />
</linearGradient>
</defs>
</svg>
)
}

View File

@@ -17,7 +17,7 @@ MCP-Server gruppieren Ihre Workflow-Tools zusammen. Erstellen und verwalten Sie
<Video src="mcp/mcp-server.mp4" width={700} height={450} /> <Video src="mcp/mcp-server.mp4" width={700} height={450} />
</div> </div>
1. Navigieren Sie zu **Einstellungen → Bereitgestellte MCPs** 1. Navigieren Sie zu **Einstellungen → MCP-Server**
2. Klicken Sie auf **Server erstellen** 2. Klicken Sie auf **Server erstellen**
3. Geben Sie einen Namen und eine optionale Beschreibung ein 3. Geben Sie einen Namen und eine optionale Beschreibung ein
4. Kopieren Sie die Server-URL zur Verwendung in Ihren MCP-Clients 4. Kopieren Sie die Server-URL zur Verwendung in Ihren MCP-Clients
@@ -79,7 +79,7 @@ Füge deinen API-Key-Header (`X-API-Key`) für authentifizierten Zugriff hinzu,
## Server-Verwaltung ## Server-Verwaltung
In der Server-Detailansicht unter **Einstellungen → Bereitgestellte MCPs** können Sie: In der Server-Detailansicht unter **Einstellungen → MCP-Server** können Sie:
- **Tools anzeigen**: Alle Workflows sehen, die einem Server hinzugefügt wurden - **Tools anzeigen**: Alle Workflows sehen, die einem Server hinzugefügt wurden
- **URL kopieren**: Die Server-URL für MCP-Clients abrufen - **URL kopieren**: Die Server-URL für MCP-Clients abrufen

View File

@@ -27,7 +27,7 @@ MCP-Server stellen Sammlungen von Tools bereit, die Ihre Agenten nutzen können.
</div> </div>
1. Navigieren Sie zu Ihren Workspace-Einstellungen 1. Navigieren Sie zu Ihren Workspace-Einstellungen
2. Gehen Sie zum Abschnitt **Bereitgestellte MCPs** 2. Gehen Sie zum Abschnitt **MCP-Server**
3. Klicken Sie auf **MCP-Server hinzufügen** 3. Klicken Sie auf **MCP-Server hinzufügen**
4. Geben Sie die Server-Konfigurationsdetails ein 4. Geben Sie die Server-Konfigurationsdetails ein
5. Speichern Sie die Konfiguration 5. Speichern Sie die Konfiguration

View File

@@ -10,12 +10,20 @@ Stellen Sie Sim auf Ihrer eigenen Infrastruktur mit Docker oder Kubernetes berei
## Anforderungen ## Anforderungen
| Ressource | Minimum | Empfohlen | | Ressource | Klein | Standard | Produktion |
|----------|---------|-------------| |----------|-------|----------|------------|
| CPU | 2 Kerne | 4+ Kerne | | CPU | 2 Kerne | 4 Kerne | 8+ Kerne |
| RAM | 12 GB | 16+ GB | | RAM | 12 GB | 16 GB | 32+ GB |
| Speicher | 20 GB SSD | 50+ GB SSD | | Speicher | 20 GB SSD | 50 GB SSD | 100+ GB SSD |
| Docker | 20.10+ | Neueste Version | | Docker | 20.10+ | 20.10+ | Neueste Version |
**Klein**: Entwicklung, Tests, Einzelnutzer (1-5 Nutzer)
**Standard**: Teams (5-50 Nutzer), moderate Arbeitslasten
**Produktion**: Große Teams (50+ Nutzer), Hochverfügbarkeit, intensive Workflow-Ausführung
<Callout type="info">
Die Ressourcenanforderungen werden durch Workflow-Ausführung (isolated-vm Sandboxing), Dateiverarbeitung (In-Memory-Dokumentenparsing) und Vektoroperationen (pgvector) bestimmt. Arbeitsspeicher ist typischerweise der limitierende Faktor, nicht CPU. Produktionsdaten zeigen, dass die Hauptanwendung durchschnittlich 4-8 GB und bei hoher Last bis zu 12 GB benötigt.
</Callout>
## Schnellstart ## Schnellstart

View File

@@ -56,6 +56,10 @@ Controls response randomness and creativity:
- **Medium (0.3-0.7)**: Balanced creativity and focus. Good for general use. - **Medium (0.3-0.7)**: Balanced creativity and focus. Good for general use.
- **High (0.7-2.0)**: Creative and varied. Ideal for brainstorming and content generation. - **High (0.7-2.0)**: Creative and varied. Ideal for brainstorming and content generation.
### Max Output Tokens
Controls the maximum length of the model's response. For Anthropic models, Sim uses reliable defaults: streaming executions use the model's full capacity (e.g. 64,000 tokens for Claude 4.5), while non-streaming executions default to 8,192 to avoid timeout issues. For long-form content generation via API, explicitly set a higher value.
### API Key ### API Key
Your API key for the selected LLM provider. This is securely stored and used for authentication. Your API key for the selected LLM provider. This is securely stored and used for authentication.

View File

@@ -16,7 +16,7 @@ MCP servers group your workflow tools together. Create and manage them in worksp
<Video src="mcp/mcp-server.mp4" width={700} height={450} /> <Video src="mcp/mcp-server.mp4" width={700} height={450} />
</div> </div>
1. Navigate to **Settings → Deployed MCPs** 1. Navigate to **Settings → MCP Servers**
2. Click **Create Server** 2. Click **Create Server**
3. Enter a name and optional description 3. Enter a name and optional description
4. Copy the server URL for use in your MCP clients 4. Copy the server URL for use in your MCP clients
@@ -78,7 +78,7 @@ Include your API key header (`X-API-Key`) for authenticated access when using mc
## Server Management ## Server Management
From the server detail view in **Settings → Deployed MCPs**, you can: From the server detail view in **Settings → MCP Servers**, you can:
- **View tools**: See all workflows added to a server - **View tools**: See all workflows added to a server
- **Copy URL**: Get the server URL for MCP clients - **Copy URL**: Get the server URL for MCP clients

View File

@@ -27,7 +27,7 @@ MCP servers provide collections of tools that your agents can use. Configure the
</div> </div>
1. Navigate to your workspace settings 1. Navigate to your workspace settings
2. Go to the **Deployed MCPs** section 2. Go to the **MCP Servers** section
3. Click **Add MCP Server** 3. Click **Add MCP Server**
4. Enter the server configuration details 4. Enter the server configuration details
5. Save the configuration 5. Save the configuration

View File

@@ -4,6 +4,7 @@ description: Essential actions for navigating and using the Sim workflow editor
--- ---
import { Callout } from 'fumadocs-ui/components/callout' import { Callout } from 'fumadocs-ui/components/callout'
import { ActionImage, ActionVideo } from '@/components/ui/action-media'
A quick lookup for everyday actions in the Sim workflow editor. For keyboard shortcuts, see [Keyboard Shortcuts](/keyboard-shortcuts). A quick lookup for everyday actions in the Sim workflow editor. For keyboard shortcuts, see [Keyboard Shortcuts](/keyboard-shortcuts).
@@ -13,124 +14,377 @@ A quick lookup for everyday actions in the Sim workflow editor. For keyboard sho
## Workspaces ## Workspaces
| Action | How | <table>
|--------|-----| <thead>
| Create a workspace | Click workspace dropdown in sidebar → **New Workspace** | <tr><th>Action</th><th>How</th><th>Preview</th></tr>
| Rename a workspace | Workspace settings → Edit name | </thead>
| Switch workspaces | Click workspace dropdown in sidebar → Select workspace | <tbody>
| Invite team members | Workspace settings → **Team** → **Invite** | <tr>
<td>Create a workspace</td>
<td>Click workspace dropdown → **New Workspace**</td>
<td><ActionVideo src="quick-reference/create-workspace.mp4" alt="Create workspace" /></td>
</tr>
<tr>
<td>Switch workspaces</td>
<td>Click workspace dropdown → Select workspace</td>
<td><ActionVideo src="quick-reference/switch-workspace.mp4" alt="Switch workspaces" /></td>
</tr>
<tr>
<td>Invite team members</td>
<td>Sidebar → **Invite**</td>
<td><ActionVideo src="quick-reference/invite.mp4" alt="Invite team members" /></td>
</tr>
<tr>
<td>Rename a workspace</td>
<td>Right-click workspace → **Rename**</td>
<td rowSpan={4}><ActionImage src="/static/quick-reference/workspace-context-menu.png" alt="Workspace context menu" /></td>
</tr>
<tr>
<td>Duplicate a workspace</td>
<td>Right-click workspace → **Duplicate**</td>
</tr>
<tr>
<td>Export a workspace</td>
<td>Right-click workspace → **Export**</td>
</tr>
<tr>
<td>Delete a workspace</td>
<td>Right-click workspace → **Delete**</td>
</tr>
</tbody>
</table>
## Workflows ## Workflows
| Action | How | <table>
|--------|-----| <thead>
| Create a workflow | Click **New Workflow** button or `Mod+Shift+A` | <tr><th>Action</th><th>How</th><th>Preview</th></tr>
| Rename a workflow | Double-click workflow name in sidebar, or right-click → **Rename** | </thead>
| Duplicate a workflow | Right-click workflow → **Duplicate** | <tbody>
| Reorder workflows | Drag workflow up/down in the sidebar list | <tr>
| Import a workflow | Sidebar menu → **Import** → Select file | <td>Create a workflow</td>
| Create a folder | Right-click in sidebar → **New Folder** | <td>Click **+** button in sidebar</td>
| Rename a folder | Right-click folder → **Rename** | <td><ActionImage src="/static/quick-reference/create-workflow.png" alt="Create workflow" /></td>
| Delete a folder | Right-click folder → **Delete** | </tr>
| Collapse/expand folder | Click folder arrow, or double-click folder | <tr>
| Move workflow to folder | Drag workflow onto folder in sidebar | <td>Reorder / move workflows</td>
| Delete a workflow | Right-click workflow → **Delete** | <td>Drag workflow up/down or onto a folder</td>
| Export a workflow | Right-click workflow → **Export** | <td><ActionVideo src="quick-reference/reordering.mp4" alt="Reorder workflows" /></td>
| Assign workflow color | Right-click workflow → **Change Color** | </tr>
| Multi-select workflows | `Mod+Click` or `Shift+Click` workflows in sidebar | <tr>
| Open in new tab | Right-click workflow → **Open in New Tab** | <td>Import a workflow</td>
<td>Click import button in sidebar → Select file</td>
<td><ActionImage src="/static/quick-reference/import-workflow.png" alt="Import workflow" /></td>
</tr>
<tr>
<td>Multi-select workflows</td>
<td>`Mod+Click` or `Shift+Click` workflows in sidebar</td>
<td><ActionVideo src="quick-reference/multiselect.mp4" alt="Multi-select workflows" /></td>
</tr>
<tr>
<td>Open in new tab</td>
<td>Right-click workflow → **Open in New Tab**</td>
<td rowSpan={6}><ActionImage src="/static/quick-reference/workflow-context-menu.png" alt="Workflow context menu" /></td>
</tr>
<tr>
<td>Rename a workflow</td>
<td>Right-click workflow → **Rename**</td>
</tr>
<tr>
<td>Assign workflow color</td>
<td>Right-click workflow → **Change Color**</td>
</tr>
<tr>
<td>Duplicate a workflow</td>
<td>Right-click workflow → **Duplicate**</td>
</tr>
<tr>
<td>Export a workflow</td>
<td>Right-click workflow → **Export**</td>
</tr>
<tr>
<td>Delete a workflow</td>
<td>Right-click workflow → **Delete**</td>
</tr>
<tr>
<td>Rename a folder</td>
<td>Right-click folder → **Rename**</td>
<td rowSpan={6}><ActionImage src="/static/quick-reference/folder-context-menu.png" alt="Folder context menu" /></td>
</tr>
<tr>
<td>Create workflow in folder</td>
<td>Right-click folder → **Create workflow**</td>
</tr>
<tr>
<td>Create folder in folder</td>
<td>Right-click folder → **Create folder**</td>
</tr>
<tr>
<td>Duplicate a folder</td>
<td>Right-click folder → **Duplicate**</td>
</tr>
<tr>
<td>Export a folder</td>
<td>Right-click folder → **Export**</td>
</tr>
<tr>
<td>Delete a folder</td>
<td>Right-click folder → **Delete**</td>
</tr>
</tbody>
</table>
## Blocks ## Blocks
| Action | How | <table>
|--------|-----| <thead>
| Add a block | Drag from Toolbar panel, or right-click canvas → **Add Block** | <tr><th>Action</th><th>How</th><th>Preview</th></tr>
| Select a block | Click on the block | </thead>
| Multi-select blocks | `Mod+Click` additional blocks, or right-drag to draw selection box | <tbody>
| Move blocks | Drag selected block(s) to new position | <tr>
| Copy blocks | `Mod+C` with blocks selected | <td>Add a block</td>
| Paste blocks | `Mod+V` to paste copied blocks | <td>Drag from Toolbar panel, or right-click canvas → **Add Block**</td>
| Duplicate blocks | Right-click → **Duplicate** | <td><ActionVideo src="quick-reference/add-block.mp4" alt="Add a block" /></td>
| Delete blocks | `Delete` or `Backspace` key, or right-click → **Delete** | </tr>
| Rename a block | Click block name in header, or edit in the Editor panel | <tr>
| Enable/Disable a block | Right-click → **Enable/Disable** | <td>Multi-select blocks</td>
| Toggle handle orientation | Right-click → **Toggle Handles** | <td>`Mod+Click` additional blocks, or shift-drag to draw selection box</td>
| Toggle trigger mode | Right-click trigger block → **Toggle Trigger Mode** | <td><ActionVideo src="quick-reference/multiselect-blocks.mp4" alt="Multi-select blocks" /></td>
| Configure a block | Select block → use Editor panel on right | </tr>
<tr>
<td>Copy blocks</td>
<td>`Mod+C` with blocks selected</td>
<td rowSpan={2}><ActionVideo src="quick-reference/copy-paste.mp4" alt="Copy and paste blocks" /></td>
</tr>
<tr>
<td>Paste blocks</td>
<td>`Mod+V` to paste copied blocks</td>
</tr>
<tr>
<td>Duplicate blocks</td>
<td>Right-click → **Duplicate**</td>
<td><ActionVideo src="quick-reference/duplicate-block.mp4" alt="Duplicate blocks" /></td>
</tr>
<tr>
<td>Delete blocks</td>
<td>`Delete` or `Backspace` key, or right-click → **Delete**</td>
<td><ActionImage src="/static/quick-reference/delete-block.png" alt="Delete block" /></td>
</tr>
<tr>
<td>Rename a block</td>
<td>Click block name in header, or edit in the Editor panel</td>
<td><ActionVideo src="quick-reference/rename-block.mp4" alt="Rename a block" /></td>
</tr>
<tr>
<td>Enable/Disable a block</td>
<td>Right-click → **Enable/Disable**</td>
<td><ActionImage src="/static/quick-reference/disable-block.png" alt="Disable block" /></td>
</tr>
<tr>
<td>Toggle handle orientation</td>
<td>Right-click → **Toggle Handles**</td>
<td><ActionVideo src="quick-reference/toggle-handles.mp4" alt="Toggle handle orientation" /></td>
</tr>
<tr>
<td>Configure a block</td>
<td>Select block → use Editor panel on right</td>
<td><ActionVideo src="quick-reference/configure-block.mp4" alt="Configure a block" /></td>
</tr>
</tbody>
</table>
## Connections ## Connections
| Action | How | <table>
|--------|-----| <thead>
| Create a connection | Drag from output handle to input handle | <tr><th>Action</th><th>How</th><th>Preview</th></tr>
| Delete a connection | Click edge to select → `Delete` key | </thead>
| Use output in another block | Drag connection tag into input field | <tbody>
<tr>
## Canvas Navigation <td>Create a connection</td>
<td>Drag from output handle to input handle</td>
| Action | How | <td><ActionVideo src="quick-reference/connect-blocks.mp4" alt="Connect blocks" /></td>
|--------|-----| </tr>
| Pan/move canvas | Left-drag on empty space, or scroll/trackpad | <tr>
| Zoom in/out | Scroll wheel or pinch gesture | <td>Delete a connection</td>
| Auto-layout | `Shift+L` | <td>Click edge to select `Delete` key</td>
| Draw selection box | Right-drag on empty canvas area | <td><ActionVideo src="quick-reference/delete-connection.mp4" alt="Delete connection" /></td>
</tr>
<tr>
<td>Use output in another block</td>
<td>Drag connection tag into input field</td>
<td><ActionVideo src="quick-reference/connection-tag.mp4" alt="Use connection tag" /></td>
</tr>
</tbody>
</table>
## Panels & Views ## Panels & Views
| Action | How | <table>
|--------|-----| <thead>
| Open Copilot tab | Press `C` or click Copilot tab | <tr><th>Action</th><th>How</th><th>Preview</th></tr>
| Open Toolbar tab | Press `T` or click Toolbar tab | </thead>
| Open Editor tab | Press `E` or click Editor tab | <tbody>
| Search toolbar | `Mod+F` | <tr>
| Toggle advanced mode | Click toggle button on input fields | <td>Search toolbar</td>
| Resize panels | Drag panel edge | <td>`Mod+F`</td>
| Collapse/expand sidebar | Click collapse button on sidebar | <td><ActionVideo src="quick-reference/search-toolbar.mp4" alt="Search toolbar" /></td>
</tr>
<tr>
<td>Search everything</td>
<td>`Mod+K`</td>
<td><ActionImage src="/static/quick-reference/search-everything.png" alt="Search everything" /></td>
</tr>
<tr>
<td>Toggle manual mode</td>
<td>Click toggle button to switch between manual and selector</td>
<td><ActionImage src="/static/quick-reference/toggle-manual-mode.png" alt="Toggle manual mode" /></td>
</tr>
<tr>
<td>Collapse/expand sidebar</td>
<td>Click collapse button on sidebar</td>
<td><ActionVideo src="quick-reference/collapse-sidebar.mp4" alt="Collapse sidebar" /></td>
</tr>
</tbody>
</table>
## Running & Testing ## Running & Testing
| Action | How | <table>
|--------|-----| <thead>
| Run workflow | Click Play button or `Mod+Enter` | <tr><th>Action</th><th>How</th><th>Preview</th></tr>
| Stop workflow | Click Stop button or `Mod+Enter` while running | </thead>
| Test with chat | Use Chat panel on the right side | <tbody>
| Select output to view | Click dropdown in Chat panel → Select block output | <tr>
| Clear chat history | Click clear button in Chat panel | <td>Run workflow</td>
| View execution logs | Open terminal panel at bottom, or `Mod+L` | <td>Click Run Workflow button or `Mod+Enter`</td>
| Filter logs by block | Click block filter in terminal | <td><ActionImage src="/static/quick-reference/run-workflow.png" alt="Run workflow" /></td>
| Filter logs by status | Click status filter in terminal | </tr>
| Search logs | Use search field in terminal | <tr>
| Copy log entry | Right-click log entry → **Copy** | <td>Stop workflow</td>
| Clear terminal | `Mod+D` | <td>Click Stop button or `Mod+Enter` while running</td>
<td><ActionImage src="/static/quick-reference/stop-workflow.png" alt="Stop workflow" /></td>
</tr>
<tr>
<td>Test with chat</td>
<td>Use Chat panel on the right side</td>
<td><ActionImage src="/static/quick-reference/test-chat.png" alt="Test with chat" /></td>
</tr>
<tr>
<td>Select output to view</td>
<td>Click dropdown in Chat panel → Select block output</td>
<td><ActionImage src="/static/quick-reference/output-select.png" alt="Select output to view" /></td>
</tr>
<tr>
<td>Clear chat history</td>
<td>Click clear button in Chat panel</td>
<td><ActionImage src="/static/quick-reference/clear-chat.png" alt="Clear chat history" /></td>
</tr>
<tr>
<td>Run from block</td>
<td>Hover block → Click play button, or right-click → **Run from block**</td>
<td><ActionImage src="/static/quick-reference/run-from-block.png" alt="Run from block" /></td>
</tr>
<tr>
<td>Run until block</td>
<td>Right-click block → **Run until block**</td>
<td><ActionImage src="/static/quick-reference/run-until-block.png" alt="Run until block" /></td>
</tr>
<tr>
<td>View execution logs</td>
<td>Open terminal panel at bottom, or `Mod+L`</td>
<td><ActionImage src="/static/quick-reference/terminal.png" alt="Execution logs terminal" /></td>
</tr>
<tr>
<td>Filter logs</td>
<td>Click filter icon in terminal → Filter by block or status</td>
<td><ActionImage src="/static/quick-reference/filter-block.png" alt="Filter logs by block" /></td>
</tr>
<tr>
<td>Search logs</td>
<td>Use search field in terminal or right-click log entry → **Search**</td>
<td><ActionImage src="/static/quick-reference/terminal-search.png" alt="Search logs" /></td>
</tr>
<tr>
<td>Copy log entry</td>
<td>Clipboard Icon or Right-click log entry → **Copy**</td>
<td><ActionImage src="/static/quick-reference/copy-log.png" alt="Copy log entry" /></td>
</tr>
<tr>
<td>Clear terminal</td>
<td>Trash icon or `Mod+D`</td>
<td><ActionImage src="/static/quick-reference/clear-terminal.png" alt="Clear terminal" /></td>
</tr>
</tbody>
</table>
## Deployment ## Deployment
| Action | How | <table>
|--------|-----| <thead>
| Deploy a workflow | Click **Deploy** button in Deploy tab | <tr><th>Action</th><th>How</th><th>Preview</th></tr>
| Update deployment | Click **Update** when changes are detected | </thead>
| View deployment status | Check status indicator (Live/Update/Deploy) in Deploy tab | <tbody>
| Revert deployment | Access previous versions in Deploy tab | <tr>
| Copy webhook URL | Deploy tab → Copy webhook URL | <td>Deploy a workflow</td>
| Copy API endpoint | Deploy tab → Copy API endpoint URL | <td>Click **Deploy** button in panel</td>
| Set up a schedule | Add Schedule trigger block → Configure interval | <td><ActionImage src="/static/quick-reference/deploy.png" alt="Deploy workflow" /></td>
</tr>
<tr>
<td>Update deployment</td>
<td>Click **Update** when changes are detected</td>
<td><ActionImage src="/static/quick-reference/update-deployment.png" alt="Update deployment" /></td>
</tr>
<tr>
<td>View deployment status</td>
<td>Check status indicator (Live/Update/Deploy) in Deploy tab</td>
<td><ActionImage src="/static/quick-reference/view-deployment.png" alt="View deployment status" /></td>
</tr>
<tr>
<td>Revert deployment</td>
<td>Access previous versions in Deploy tab → **Promote to live**</td>
<td><ActionImage src="/static/quick-reference/promote-deployment.png" alt="Promote deployment to live" /></td>
</tr>
<tr>
<td>Add version description</td>
<td>Deploy tab → Click description icon → Add or generate description</td>
<td><ActionVideo src="quick-reference/deployment-description.mp4" alt="Add deployment version description" /></td>
</tr>
<tr>
<td>Copy API endpoint</td>
<td>Deploy tab → API → Copy API cURL</td>
<td><ActionImage src="/static/quick-reference/copy-api.png" alt="Copy API endpoint" /></td>
</tr>
</tbody>
</table>
## Variables ## Variables
| Action | How | <table>
|--------|-----| <thead>
| Add workflow variable | Variables tab → **Add Variable** | <tr><th>Action</th><th>How</th><th>Preview</th></tr>
| Edit workflow variable | Variables tab → Click variable to edit | </thead>
| Delete workflow variable | Variables tab → Click delete icon on variable | <tbody>
| Add environment variable | Settings → **Environment Variables** → **Add** | <tr>
| Reference a variable | Use `{{variableName}}` syntax in block inputs | <td>Add / Edit / Delete workflow variable</td>
<td>Panel -> Variables -> **Add Variable**, click to edit, or delete icon</td>
## Credentials <td><ActionImage src="/static/quick-reference/variables.png" alt="Variables panel" /></td>
</tr>
| Action | How | <tr>
|--------|-----| <td>Add environment variable</td>
| Add API key | Block credential field → **Add Credential** → Enter API key | <td>Settings → **Environment Variables** → **Add**</td>
| Connect OAuth account | Block credential field → **Connect** → Authorize with provider | <td><ActionImage src="/static/quick-reference/add-env-variable.png" alt="Add environment variable" /></td>
| Manage credentials | Settings → **Credentials** | </tr>
| Remove credential | Settings → **Credentials** → Delete credential | <tr>
<td>Reference a workflow variable</td>
<td>Use `<blockName.itemName>` syntax in block inputs</td>
<td><ActionImage src="/static/quick-reference/variable-reference.png" alt="Reference workflow variable" /></td>
</tr>
<tr>
<td>Reference an environment variable</td>
<td>Use `{{ENV_VAR}}` syntax in block inputs</td>
<td><ActionImage src="/static/quick-reference/env-variable-reference.png" alt="Reference environment variable" /></td>
</tr>
</tbody>
</table>

View File

@@ -16,12 +16,20 @@ Deploy Sim on your own infrastructure with Docker or Kubernetes.
## Requirements ## Requirements
| Resource | Minimum | Recommended | | Resource | Small | Standard | Production |
|----------|---------|-------------| |----------|-------|----------|------------|
| CPU | 2 cores | 4+ cores | | CPU | 2 cores | 4 cores | 8+ cores |
| RAM | 12 GB | 16+ GB | | RAM | 12 GB | 16 GB | 32+ GB |
| Storage | 20 GB SSD | 50+ GB SSD | | Storage | 20 GB SSD | 50 GB SSD | 100+ GB SSD |
| Docker | 20.10+ | Latest | | Docker | 20.10+ | 20.10+ | Latest |
**Small**: Development, testing, single user (1-5 users)
**Standard**: Teams (5-50 users), moderate workloads
**Production**: Large teams (50+ users), high availability, heavy workflow execution
<Callout type="info">
Resource requirements are driven by workflow execution (isolated-vm sandboxing), file processing (in-memory document parsing), and vector operations (pgvector). Memory is typically the constraining factor rather than CPU. Production telemetry shows the main app uses 4-8 GB average with peaks up to 12 GB under heavy load.
</Callout>
## Quick Start ## Quick Start

View File

@@ -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 |

View File

@@ -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`
@@ -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`

View File

@@ -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 |
@@ -168,22 +168,22 @@ Search for tasks in an Asana workspace
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `ts` | string | Timestamp of the response | | `ts` | string | Timestamp of the response |
| `tasks` | array | Array of matching tasks | | `tasks` | array | Array of matching tasks |
| ↳ `gid` | string | Assignee GID | | ↳ `gid` | string | Task GID |
| ↳ `resource_type` | string | Resource type | | ↳ `resource_type` | string | Resource type |
| ↳ `resource_subtype` | string | Resource subtype | | ↳ `resource_subtype` | string | Resource subtype |
| ↳ `name` | string | Assignee name | | ↳ `name` | string | Task name |
| ↳ `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`
@@ -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 |

View File

@@ -47,6 +47,7 @@ Runs a browser automation task using BrowserUse
| `save_browser_data` | boolean | No | Whether to save browser data | | `save_browser_data` | boolean | No | Whether to save browser data |
| `model` | string | No | LLM model to use \(default: gpt-4o\) | | `model` | string | No | LLM model to use \(default: gpt-4o\) |
| `apiKey` | string | Yes | API key for BrowserUse API | | `apiKey` | string | Yes | API key for BrowserUse API |
| `profile_id` | string | No | Browser profile ID for persistent sessions \(cookies, login state\) |
#### Output #### Output

View File

@@ -0,0 +1,789 @@
---
title: CalCom
description: Manage Cal.com bookings, event types, schedules, and availability
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
<BlockInfoCard
type="calcom"
color="#FFFFFE"
/>
{/* MANUAL-CONTENT-START:intro */}
[Cal.com](https://cal.com/) is a flexible and open-source scheduling platform that makes it easy to manage appointments, bookings, event types, and team availabilities.
With Cal.com, you can:
- **Automate scheduling**: Allow users to view your available time slots and book meetings automatically, without back-and-forth emails.
- **Manage events**: Create and customize event types, durations, and rules for one-on-one or group meetings.
- **Integrate calendars**: Seamlessly connect with Google, Outlook, Apple, or other calendar providers to avoid double bookings.
- **Handle attendees and guests**: Collect attendee information, manage guests, and send invitations or reminders.
- **Control availability**: Define custom working hours, buffer times, and cancellation/rebooking rules.
- **Power workflows**: Trigger custom actions via webhooks when a booking is created, cancelled, or rescheduled.
In Sim, the Cal.com integration enables your agents to book meetings, check availabilities, manage event types, and automate scheduling tasks programmatically. This helps agents coordinate meetings, send bookings on behalf of users, check schedules, or respond to booking events—all without manual intervention. By connecting Sim with Cal.com, you unlock highly automated and intelligent scheduling workflows that can integrate seamlessly with your broader automation needs.
{/* MANUAL-CONTENT-END */}
## Usage Instructions
Integrate Cal.com into your workflow. Create and manage bookings, event types, schedules, and check availability slots. Supports creating, listing, rescheduling, and canceling bookings, as well as managing event types and schedules. Can also trigger workflows based on Cal.com webhook events (booking created, cancelled, rescheduled). Connect your Cal.com account via OAuth.
## Tools
### `calcom_create_booking`
Create a new booking on Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `eventTypeId` | number | Yes | The ID of the event type to book |
| `start` | string | Yes | Start time in UTC ISO 8601 format \(e.g., 2024-01-15T09:00:00Z\) |
| `attendee` | object | Yes | Attendee information object with name, email, timeZone, and optional phoneNumber \(constructed from individual attendee fields\) |
| `guests` | array | No | Array of guest email addresses |
| `items` | string | No | Guest email address |
| `lengthInMinutes` | number | No | Duration of the booking in minutes \(overrides event type default\) |
| `metadata` | object | No | Custom metadata to attach to the booking |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Created booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `meetingUrl` | string | URL to join the meeting |
| ↳ `location` | string | Location of the booking |
| ↳ `absentHost` | boolean | Whether the host was absent |
| ↳ `guests` | array | Guest email addresses |
| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `icsUid` | string | ICS calendar UID |
| ↳ `createdAt` | string | When the booking was created |
### `calcom_get_booking`
Get details of a specific booking by its UID
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `description` | string | Description of the booking |
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `meetingUrl` | string | URL to join the meeting |
| ↳ `location` | string | Location of the booking |
| ↳ `absentHost` | boolean | Whether the host was absent |
| ↳ `guests` | array | Guest email addresses |
| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `rating` | number | Booking rating |
| ↳ `icsUid` | string | ICS calendar UID |
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled |
| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled |
| ↳ `rescheduledToUid` | string | New booking UID after reschedule |
| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking |
| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `updatedAt` | string | When the booking was last updated |
### `calcom_list_bookings`
List all bookings with optional status filter
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `status` | string | No | Filter bookings by status: upcoming, recurring, past, cancelled, or unconfirmed |
| `take` | number | No | Number of bookings to return \(pagination limit\) |
| `skip` | number | No | Number of bookings to skip \(pagination offset\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | array | Array of bookings |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `description` | string | Description of the booking |
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `meetingUrl` | string | URL to join the meeting |
| ↳ `location` | string | Location of the booking |
| ↳ `absentHost` | boolean | Whether the host was absent |
| ↳ `guests` | array | Guest email addresses |
| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `rating` | number | Booking rating |
| ↳ `icsUid` | string | ICS calendar UID |
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking |
| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled |
| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking |
| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled |
| ↳ `rescheduledToUid` | string | New booking UID after reschedule |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `updatedAt` | string | When the booking was last updated |
| `pagination` | object | Pagination metadata |
| ↳ `totalItems` | number | Total number of items |
| ↳ `remainingItems` | number | Remaining items after current page |
| ↳ `returnedItems` | number | Number of items returned in this response |
| ↳ `itemsPerPage` | number | Items per page |
| ↳ `currentPage` | number | Current page number |
| ↳ `totalPages` | number | Total number of pages |
| ↳ `hasNextPage` | boolean | Whether there is a next page |
| ↳ `hasPreviousPage` | boolean | Whether there is a previous page |
### `calcom_cancel_booking`
Cancel an existing booking
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to cancel |
| `cancellationReason` | string | No | Reason for cancelling the booking |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Cancelled booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `location` | string | Location of the booking |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `status` | string | Booking status \(should be cancelled\) |
### `calcom_reschedule_booking`
Reschedule an existing booking to a new time
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to reschedule |
| `start` | string | Yes | New start time in UTC ISO 8601 format \(e.g., 2024-01-15T09:00:00Z\) |
| `reschedulingReason` | string | No | Reason for rescheduling the booking |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Rescheduled booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `title` | string | Title of the booking |
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled |
| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled |
| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `meetingUrl` | string | URL to join the meeting |
| ↳ `location` | string | Location of the booking |
| ↳ `guests` | array | Guest email addresses |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `icsUid` | string | ICS calendar UID |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `uid` | string | Unique identifier for the new booking |
| ↳ `start` | string | New start time in ISO 8601 format |
| ↳ `end` | string | New end time in ISO 8601 format |
### `calcom_confirm_booking`
Confirm a pending booking that requires confirmation
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to confirm |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Confirmed booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `meetingUrl` | string | URL to join the meeting |
| ↳ `location` | string | Location of the booking |
| ↳ `guests` | array | Guest email addresses |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `icsUid` | string | ICS calendar UID |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `status` | string | Booking status \(should be accepted/confirmed\) |
### `calcom_decline_booking`
Decline a pending booking request
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to decline |
| `reason` | string | No | Reason for declining the booking |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Declined booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `location` | string | Location of the booking |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `status` | string | Booking status \(should be cancelled/rejected\) |
### `calcom_create_event_type`
Create a new event type in Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `title` | string | Yes | Title of the event type |
| `slug` | string | Yes | Unique slug for the event type URL |
| `lengthInMinutes` | number | Yes | Duration of the event in minutes |
| `description` | string | No | Description of the event type |
| `slotInterval` | number | No | Interval between available booking slots in minutes |
| `minimumBookingNotice` | number | No | Minimum notice required before booking in minutes |
| `beforeEventBuffer` | number | No | Buffer time before the event in minutes |
| `afterEventBuffer` | number | No | Buffer time after the event in minutes |
| `scheduleId` | number | No | ID of the schedule to use for availability |
| `disableGuests` | boolean | No | Whether to disable guests from being added to bookings |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Created event type details |
| ↳ `id` | number | Event type ID |
| ↳ `title` | string | Event type title |
| ↳ `slug` | string | Event type slug |
| ↳ `description` | string | Event type description |
| ↳ `lengthInMinutes` | number | Duration in minutes |
| ↳ `slotInterval` | number | Slot interval in minutes |
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
| ↳ `scheduleId` | number | Schedule ID |
| ↳ `disableGuests` | boolean | Whether guests are disabled |
| ↳ `createdAt` | string | ISO timestamp of creation |
| ↳ `updatedAt` | string | ISO timestamp of last update |
### `calcom_get_event_type`
Get detailed information about a specific event type
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `eventTypeId` | number | Yes | Event type ID to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `title` | string | Event type title |
| ↳ `slug` | string | Event type slug |
| ↳ `description` | string | Event type description |
| ↳ `lengthInMinutes` | number | Duration in minutes |
| ↳ `slotInterval` | number | Slot interval in minutes |
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
| ↳ `scheduleId` | number | Schedule ID |
| ↳ `disableGuests` | boolean | Whether guests are disabled |
| ↳ `createdAt` | string | ISO timestamp of creation |
| ↳ `updatedAt` | string | ISO timestamp of last update |
### `calcom_list_event_types`
Retrieve a list of all event types
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `sortCreatedAt` | string | No | Sort by creation date: "asc" or "desc" |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | array | Array of event types |
| ↳ `id` | number | Event type ID |
| ↳ `title` | string | Event type title |
| ↳ `slug` | string | Event type slug |
| ↳ `description` | string | Event type description |
| ↳ `lengthInMinutes` | number | Duration in minutes |
| ↳ `slotInterval` | number | Slot interval in minutes |
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
| ↳ `scheduleId` | number | Schedule ID |
| ↳ `disableGuests` | boolean | Whether guests are disabled |
| ↳ `createdAt` | string | ISO timestamp of creation |
| ↳ `updatedAt` | string | ISO timestamp of last update |
### `calcom_update_event_type`
Update an existing event type in Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `eventTypeId` | number | Yes | Event type ID to update |
| `title` | string | No | Title of the event type |
| `slug` | string | No | Unique slug for the event type URL |
| `lengthInMinutes` | number | No | Duration of the event in minutes |
| `description` | string | No | Description of the event type |
| `slotInterval` | number | No | Interval between available booking slots in minutes |
| `minimumBookingNotice` | number | No | Minimum notice required before booking in minutes |
| `beforeEventBuffer` | number | No | Buffer time before the event in minutes |
| `afterEventBuffer` | number | No | Buffer time after the event in minutes |
| `scheduleId` | number | No | ID of the schedule to use for availability |
| `disableGuests` | boolean | No | Whether to disable guests from being added to bookings |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Updated event type details |
| ↳ `id` | number | Event type ID |
| ↳ `title` | string | Event type title |
| ↳ `slug` | string | Event type slug |
| ↳ `description` | string | Event type description |
| ↳ `lengthInMinutes` | number | Duration in minutes |
| ↳ `slotInterval` | number | Slot interval in minutes |
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
| ↳ `scheduleId` | number | Schedule ID |
| ↳ `disableGuests` | boolean | Whether guests are disabled |
| ↳ `createdAt` | string | ISO timestamp of creation |
| ↳ `updatedAt` | string | ISO timestamp of last update |
### `calcom_delete_event_type`
Delete an event type from Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `eventTypeId` | number | Yes | Event type ID to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Deleted event type details |
| ↳ `id` | number | Event type ID |
| ↳ `lengthInMinutes` | number | Duration in minutes |
| ↳ `title` | string | Event type title |
| ↳ `slug` | string | Event type slug |
### `calcom_create_schedule`
Create a new availability schedule in Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `name` | string | Yes | Name of the schedule |
| `timeZone` | string | Yes | Timezone for the schedule \(e.g., America/New_York\) |
| `isDefault` | boolean | Yes | Whether this schedule should be the default |
| `availability` | array | No | Availability intervals for the schedule |
| `items` | object | No | Availability interval |
| `properties` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
| `days` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
| `startTime` | string | No | Start time in HH:MM format |
| `endTime` | string | No | End time in HH:MM format |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Created schedule data |
| ↳ `id` | number | Schedule ID |
| ↳ `ownerId` | number | Owner user ID |
| ↳ `name` | string | Schedule name |
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
| ↳ `isDefault` | boolean | Whether this is the default schedule |
| ↳ `availability` | array | Availability windows |
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
| ↳ `overrides` | array | Date-specific availability overrides |
| ↳ `date` | string | Date in YYYY-MM-DD format |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
### `calcom_get_schedule`
Get a specific schedule by ID from Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `scheduleId` | string | Yes | ID of the schedule to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Schedule data |
| ↳ `id` | number | Schedule ID |
| ↳ `ownerId` | number | Owner user ID |
| ↳ `name` | string | Schedule name |
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
| ↳ `isDefault` | boolean | Whether this is the default schedule |
| ↳ `availability` | array | Availability windows |
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
| ↳ `overrides` | array | Date-specific availability overrides |
| ↳ `date` | string | Date in YYYY-MM-DD format |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
### `calcom_list_schedules`
List all availability schedules from Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | array | Array of schedule objects |
| ↳ `id` | number | Schedule ID |
| ↳ `ownerId` | number | Owner user ID |
| ↳ `name` | string | Schedule name |
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
| ↳ `isDefault` | boolean | Whether this is the default schedule |
| ↳ `availability` | array | Availability windows |
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
| ↳ `overrides` | array | Date-specific availability overrides |
| ↳ `date` | string | Date in YYYY-MM-DD format |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
### `calcom_update_schedule`
Update an existing schedule in Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `scheduleId` | string | Yes | ID of the schedule to update |
| `name` | string | No | New name for the schedule |
| `timeZone` | string | No | New timezone for the schedule \(e.g., America/New_York\) |
| `isDefault` | boolean | No | Whether this schedule should be the default |
| `availability` | array | No | New availability intervals for the schedule |
| `items` | object | No | Availability interval |
| `properties` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
| `days` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
| `startTime` | string | No | Start time in HH:MM format |
| `endTime` | string | No | End time in HH:MM format |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Updated schedule data |
| ↳ `id` | number | Schedule ID |
| ↳ `ownerId` | number | Owner user ID |
| ↳ `name` | string | Schedule name |
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
| ↳ `isDefault` | boolean | Whether this is the default schedule |
| ↳ `availability` | array | Availability windows |
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
| ↳ `overrides` | array | Date-specific availability overrides |
| ↳ `date` | string | Date in YYYY-MM-DD format |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
### `calcom_delete_schedule`
Delete a schedule from Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `scheduleId` | string | Yes | ID of the schedule to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status \(success or error\) |
### `calcom_get_default_schedule`
Get the default availability schedule from Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Default schedule data |
| ↳ `id` | number | Schedule ID |
| ↳ `ownerId` | number | Owner user ID |
| ↳ `name` | string | Schedule name |
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
| ↳ `isDefault` | boolean | Whether this is the default schedule |
| ↳ `availability` | array | Availability windows |
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
| ↳ `overrides` | array | Date-specific availability overrides |
| ↳ `date` | string | Date in YYYY-MM-DD format |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
### `calcom_get_slots`
Get available booking slots for a Cal.com event type within a time range
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `start` | string | Yes | Start of time range in UTC ISO 8601 format \(e.g., 2024-01-15T00:00:00Z\) |
| `end` | string | Yes | End of time range in UTC ISO 8601 format \(e.g., 2024-01-22T00:00:00Z\) |
| `eventTypeId` | number | No | Event type ID for direct lookup |
| `eventTypeSlug` | string | No | Event type slug \(requires username to be set\) |
| `username` | string | No | Username for personal event types \(required when using eventTypeSlug\) |
| `timeZone` | string | No | Timezone for returned slots \(defaults to UTC\) |
| `duration` | number | No | Slot length in minutes |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | json | Available time slots grouped by date \(YYYY-MM-DD keys\). Each date maps to an array of slot objects with start time, optional end time, and seated event info. |

View File

@@ -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`
@@ -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`
@@ -115,30 +115,26 @@ Get detailed information about a specific event type
| 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 | Question text | | ↳ `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 |
| ↳ `type` | string | Event type classification | | ↳ `description_html` | string | HTML formatted description |
| ↳ `position` | number | Question order | | ↳ `description_plain` | string | Plain text description |
| ↳ `enabled` | boolean | Whether question is enabled | | ↳ `duration` | number | Duration in minutes |
| ↳ `required` | boolean | Whether question is required | | ↳ `scheduling_url` | string | URL to scheduling page |
| ↳ `answer_choices` | array | Available answer choices | | ↳ `slug` | string | Unique identifier for URLs |
| ↳ `description_html` | string | HTML formatted description | | ↳ `type` | string | Event type classification |
| ↳ `description_plain` | string | Plain text description | | ↳ `updated_at` | string | ISO timestamp of last update |
| ↳ `duration` | number | Duration in minutes |
| ↳ `scheduling_url` | string | URL to scheduling page |
| ↳ `slug` | string | Unique identifier for URLs |
| ↳ `updated_at` | string | ISO timestamp of last update |
### `calendly_list_scheduled_events` ### `calendly_list_scheduled_events`
@@ -170,24 +166,22 @@ Retrieve a list of scheduled events for a user or organization
| ↳ `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` | string | Location description | | ↳ `location` | object | Event location details |
| ↳ `type` | string | Location type \(e.g., | | ↳ `type` | string | Location type \(e.g., "zoom", "google_meet", "physical"\) |
| ↳ `join_url` | string | URL to join online meeting \(if applicable\) | | ↳ `location` | string | Location description |
| ↳ `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 |
| ↳ `total` | number | Total number of invitees |
| ↳ `active` | number | Number of active invitees |
| ↳ `limit` | number | Maximum number of invitees |
| ↳ `created_at` | string | ISO timestamp of event creation | | ↳ `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`
@@ -205,36 +199,30 @@ Get detailed information about a specific scheduled event
| 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` | string | Location description | | ↳ `location` | object | Event location details |
| ↳ `type` | string | Location type | | ↳ `type` | string | Location type |
| ↳ `join_url` | string | URL to join online meeting | | ↳ `location` | string | Location description |
| ↳ `invitees_counter` | object | Invitee count information | | ↳ `join_url` | string | URL to join online meeting |
| ↳ `total` | number | Total number of invitees | | ↳ `invitees_counter` | object | Invitee count information |
| ↳ `active` | number | Number of active invitees | | ↳ `total` | number | Total number of invitees |
| ↳ `limit` | number | Maximum number of invitees | | ↳ `active` | number | Number of active invitees |
| ↳ `total` | number | Total number of invitees | | ↳ `limit` | number | Maximum number of invitees |
| ↳ `active` | number | Number of active invitees | | ↳ `event_memberships` | array | Event hosts/members |
| ↳ `limit` | number | Maximum number of invitees | | ↳ `user` | string | User URI |
| ↳ `event_memberships` | array | Event hosts/members | | ↳ `user_email` | string | User email |
| ↳ `user` | string | User URI | | ↳ `user_name` | string | User name |
| ↳ `user_email` | string | User email | | ↳ `event_guests` | array | Additional guests |
| ↳ `user_name` | string | User name | | ↳ `email` | string | Guest email |
| ↳ `user` | string | User URI | | ↳ `created_at` | string | When guest was added |
| ↳ `user_email` | string | User email | | ↳ `updated_at` | string | When guest info was updated |
| ↳ `user_name` | string | User name | | ↳ `created_at` | string | ISO timestamp of event creation |
| ↳ `event_guests` | array | Additional guests | | ↳ `updated_at` | string | ISO timestamp of last update |
| ↳ `email` | string | Guest email |
| ↳ `created_at` | string | When guest was added |
| ↳ `updated_at` | string | When guest info was updated |
| ↳ `email` | string | Guest email |
| ↳ `created_at` | string | ISO timestamp of event creation |
| ↳ `updated_at` | string | ISO timestamp of last update |
### `calendly_list_event_invitees` ### `calendly_list_event_invitees`
@@ -264,12 +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 |
| ↳ `question` | string | Question text |
| ↳ `answer` | string | Invitee answer |
| ↳ `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 |
@@ -278,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`
@@ -301,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 |

View File

@@ -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 |

View File

@@ -0,0 +1,442 @@
---
title: Clerk
description: Manage users, organizations, and sessions in Clerk
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
<BlockInfoCard
type="clerk"
color="#131316"
/>
{/* MANUAL-CONTENT-START:intro */}
[Clerk](https://clerk.com/) is a comprehensive identity infrastructure platform that helps you manage users, authentication, and sessions for your applications.
In Sim, the Clerk integration lets your agents automate user and session management through easy-to-use API-based tools. Agents can securely list users, update user profiles, manage organizations, monitor sessions, and revoke access directly in your workflow.
With Clerk, you can:
- **Authenticate users and manage sessions**: Seamlessly control sign-in, sign-up, and session lifecycle for your users.
- **List and update users**: Automatically pull user lists, update user attributes, or view profile details as part of your agent tasks.
- **Manage organizations and memberships**: Add or update organizations and administer user memberships with clarity.
- **Monitor and revoke sessions**: See active or past user sessions, and revoke access immediately if needed for security.
The integration enables real-time, auditable management of your user base—all from within Sim. Connected agents can automate onboarding, enforce policies, keep directories up to date, and react to authentication events or organizational changes, helping you run secure and flexible processes using Clerk as your identity engine.
{/* MANUAL-CONTENT-END */}
## Usage Instructions
Integrate Clerk authentication and user management into your workflow. Create, update, delete, and list users. Manage organizations and their memberships. Monitor and control user sessions.
## Tools
### `clerk_list_users`
List all users in your Clerk application with optional filtering and pagination
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `limit` | number | No | Number of results per page \(1-500, default: 10\) |
| `offset` | number | No | Number of results to skip for pagination |
| `orderBy` | string | No | Sort field with optional +/- prefix for direction \(default: -created_at\) |
| `emailAddress` | string | No | Filter by email address \(comma-separated for multiple\) |
| `phoneNumber` | string | No | Filter by phone number \(comma-separated for multiple\) |
| `externalId` | string | No | Filter by external ID \(comma-separated for multiple\) |
| `username` | string | No | Filter by username \(comma-separated for multiple\) |
| `userId` | string | No | Filter by user ID \(comma-separated for multiple\) |
| `query` | string | No | Search query to match across email, phone, username, and names |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `users` | array | Array of Clerk user objects |
| ↳ `id` | string | User ID |
| ↳ `username` | string | Username |
| ↳ `firstName` | string | First name |
| ↳ `lastName` | string | Last name |
| ↳ `imageUrl` | string | Profile image URL |
| ↳ `hasImage` | boolean | Whether user has a profile image |
| ↳ `primaryEmailAddressId` | string | Primary email address ID |
| ↳ `primaryPhoneNumberId` | string | Primary phone number ID |
| ↳ `emailAddresses` | array | User email addresses |
| ↳ `id` | string | Email address ID |
| ↳ `emailAddress` | string | Email address |
| ↳ `phoneNumbers` | array | User phone numbers |
| ↳ `id` | string | Phone number ID |
| ↳ `phoneNumber` | string | Phone number |
| ↳ `externalId` | string | External system ID |
| ↳ `passwordEnabled` | boolean | Whether password is enabled |
| ↳ `twoFactorEnabled` | boolean | Whether 2FA is enabled |
| ↳ `banned` | boolean | Whether user is banned |
| ↳ `locked` | boolean | Whether user is locked |
| ↳ `lastSignInAt` | number | Last sign-in timestamp |
| ↳ `lastActiveAt` | number | Last activity timestamp |
| ↳ `createdAt` | number | Creation timestamp |
| ↳ `updatedAt` | number | Last update timestamp |
| ↳ `publicMetadata` | json | Public metadata |
| `totalCount` | number | Total number of users matching the query |
| `success` | boolean | Operation success status |
### `clerk_get_user`
Retrieve a single user by their ID from Clerk
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `userId` | string | Yes | The ID of the user to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | User ID |
| `username` | string | Username |
| `firstName` | string | First name |
| `lastName` | string | Last name |
| `imageUrl` | string | Profile image URL |
| `hasImage` | boolean | Whether user has a profile image |
| `primaryEmailAddressId` | string | Primary email address ID |
| `primaryPhoneNumberId` | string | Primary phone number ID |
| `primaryWeb3WalletId` | string | Primary Web3 wallet ID |
| `emailAddresses` | array | User email addresses |
| ↳ `id` | string | Email address ID |
| ↳ `emailAddress` | string | Email address |
| ↳ `verified` | boolean | Whether email is verified |
| `phoneNumbers` | array | User phone numbers |
| ↳ `id` | string | Phone number ID |
| ↳ `phoneNumber` | string | Phone number |
| ↳ `verified` | boolean | Whether phone is verified |
| `externalId` | string | External system ID |
| `passwordEnabled` | boolean | Whether password is enabled |
| `twoFactorEnabled` | boolean | Whether 2FA is enabled |
| `totpEnabled` | boolean | Whether TOTP is enabled |
| `backupCodeEnabled` | boolean | Whether backup codes are enabled |
| `banned` | boolean | Whether user is banned |
| `locked` | boolean | Whether user is locked |
| `deleteSelfEnabled` | boolean | Whether user can delete themselves |
| `createOrganizationEnabled` | boolean | Whether user can create organizations |
| `lastSignInAt` | number | Last sign-in timestamp |
| `lastActiveAt` | number | Last activity timestamp |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `publicMetadata` | json | Public metadata \(readable from frontend\) |
| `privateMetadata` | json | Private metadata \(backend only\) |
| `unsafeMetadata` | json | Unsafe metadata \(modifiable from frontend\) |
| `success` | boolean | Operation success status |
### `clerk_create_user`
Create a new user in your Clerk application
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `emailAddress` | string | No | Email addresses for the user \(comma-separated for multiple\) |
| `phoneNumber` | string | No | Phone numbers for the user \(comma-separated for multiple\) |
| `username` | string | No | Username for the user \(must be unique\) |
| `password` | string | No | Password for the user \(minimum 8 characters\) |
| `firstName` | string | No | First name of the user |
| `lastName` | string | No | Last name of the user |
| `externalId` | string | No | External system identifier \(must be unique\) |
| `publicMetadata` | json | No | Public metadata \(JSON object, readable from frontend\) |
| `privateMetadata` | json | No | Private metadata \(JSON object, backend only\) |
| `unsafeMetadata` | json | No | Unsafe metadata \(JSON object, modifiable from frontend\) |
| `skipPasswordChecks` | boolean | No | Skip password validation checks |
| `skipPasswordRequirement` | boolean | No | Make password optional |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Created user ID |
| `username` | string | Username |
| `firstName` | string | First name |
| `lastName` | string | Last name |
| `imageUrl` | string | Profile image URL |
| `primaryEmailAddressId` | string | Primary email address ID |
| `primaryPhoneNumberId` | string | Primary phone number ID |
| `emailAddresses` | array | User email addresses |
| ↳ `id` | string | Email address ID |
| ↳ `emailAddress` | string | Email address |
| ↳ `verified` | boolean | Whether email is verified |
| `phoneNumbers` | array | User phone numbers |
| ↳ `id` | string | Phone number ID |
| ↳ `phoneNumber` | string | Phone number |
| ↳ `verified` | boolean | Whether phone is verified |
| `externalId` | string | External system ID |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `publicMetadata` | json | Public metadata |
| `success` | boolean | Operation success status |
### `clerk_update_user`
Update an existing user in your Clerk application
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `userId` | string | Yes | The ID of the user to update |
| `firstName` | string | No | First name of the user |
| `lastName` | string | No | Last name of the user |
| `username` | string | No | Username \(must be unique\) |
| `password` | string | No | New password \(minimum 8 characters\) |
| `externalId` | string | No | External system identifier |
| `primaryEmailAddressId` | string | No | ID of verified email to set as primary |
| `primaryPhoneNumberId` | string | No | ID of verified phone to set as primary |
| `publicMetadata` | json | No | Public metadata \(JSON object\) |
| `privateMetadata` | json | No | Private metadata \(JSON object\) |
| `unsafeMetadata` | json | No | Unsafe metadata \(JSON object\) |
| `skipPasswordChecks` | boolean | No | Skip password validation checks |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Updated user ID |
| `username` | string | Username |
| `firstName` | string | First name |
| `lastName` | string | Last name |
| `imageUrl` | string | Profile image URL |
| `primaryEmailAddressId` | string | Primary email address ID |
| `primaryPhoneNumberId` | string | Primary phone number ID |
| `emailAddresses` | array | User email addresses |
| ↳ `id` | string | Email address ID |
| ↳ `emailAddress` | string | Email address |
| ↳ `verified` | boolean | Whether email is verified |
| `phoneNumbers` | array | User phone numbers |
| ↳ `id` | string | Phone number ID |
| ↳ `phoneNumber` | string | Phone number |
| ↳ `verified` | boolean | Whether phone is verified |
| `externalId` | string | External system ID |
| `banned` | boolean | Whether user is banned |
| `locked` | boolean | Whether user is locked |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `publicMetadata` | json | Public metadata |
| `success` | boolean | Operation success status |
### `clerk_delete_user`
Delete a user from your Clerk application
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `userId` | string | Yes | The ID of the user to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Deleted user ID |
| `object` | string | Object type \(user\) |
| `deleted` | boolean | Whether the user was deleted |
| `success` | boolean | Operation success status |
### `clerk_list_organizations`
List all organizations in your Clerk application with optional filtering
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `limit` | number | No | Number of results per page \(1-500, default: 10\) |
| `offset` | number | No | Number of results to skip for pagination |
| `includeMembersCount` | boolean | No | Include member count for each organization |
| `query` | string | No | Search by organization ID, name, or slug |
| `orderBy` | string | No | Sort field \(name, created_at, members_count\) with +/- prefix |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `organizations` | array | Array of Clerk organization objects |
| ↳ `id` | string | Organization ID |
| ↳ `name` | string | Organization name |
| ↳ `slug` | string | Organization slug |
| ↳ `imageUrl` | string | Organization image URL |
| ↳ `hasImage` | boolean | Whether organization has an image |
| ↳ `membersCount` | number | Number of members |
| ↳ `pendingInvitationsCount` | number | Number of pending invitations |
| ↳ `maxAllowedMemberships` | number | Max allowed memberships |
| ↳ `adminDeleteEnabled` | boolean | Whether admin delete is enabled |
| ↳ `createdBy` | string | Creator user ID |
| ↳ `createdAt` | number | Creation timestamp |
| ↳ `updatedAt` | number | Last update timestamp |
| ↳ `publicMetadata` | json | Public metadata |
| `totalCount` | number | Total number of organizations |
| `success` | boolean | Operation success status |
### `clerk_get_organization`
Retrieve a single organization by ID or slug from Clerk
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `organizationId` | string | Yes | The ID or slug of the organization to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Organization ID |
| `name` | string | Organization name |
| `slug` | string | Organization slug |
| `imageUrl` | string | Organization image URL |
| `hasImage` | boolean | Whether organization has an image |
| `membersCount` | number | Number of members |
| `pendingInvitationsCount` | number | Number of pending invitations |
| `maxAllowedMemberships` | number | Max allowed memberships |
| `adminDeleteEnabled` | boolean | Whether admin delete is enabled |
| `createdBy` | string | Creator user ID |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `publicMetadata` | json | Public metadata |
| `success` | boolean | Operation success status |
### `clerk_create_organization`
Create a new organization in your Clerk application
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `name` | string | Yes | Name of the organization |
| `createdBy` | string | Yes | User ID of the creator \(will become admin\) |
| `slug` | string | No | Slug identifier for the organization |
| `maxAllowedMemberships` | number | No | Maximum member capacity \(0 for unlimited\) |
| `publicMetadata` | json | No | Public metadata \(JSON object\) |
| `privateMetadata` | json | No | Private metadata \(JSON object\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Created organization ID |
| `name` | string | Organization name |
| `slug` | string | Organization slug |
| `imageUrl` | string | Organization image URL |
| `hasImage` | boolean | Whether organization has an image |
| `membersCount` | number | Number of members |
| `pendingInvitationsCount` | number | Number of pending invitations |
| `maxAllowedMemberships` | number | Max allowed memberships |
| `adminDeleteEnabled` | boolean | Whether admin delete is enabled |
| `createdBy` | string | Creator user ID |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `publicMetadata` | json | Public metadata |
| `success` | boolean | Operation success status |
### `clerk_list_sessions`
List sessions for a user or client in your Clerk application
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `userId` | string | No | User ID to list sessions for \(required if clientId not provided\) |
| `clientId` | string | No | Client ID to list sessions for \(required if userId not provided\) |
| `status` | string | No | Filter by session status \(abandoned, active, ended, expired, pending, removed, replaced, revoked\) |
| `limit` | number | No | Number of results per page \(1-500, default: 10\) |
| `offset` | number | No | Number of results to skip for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `sessions` | array | Array of Clerk session objects |
| ↳ `id` | string | Session ID |
| ↳ `userId` | string | User ID |
| ↳ `clientId` | string | Client ID |
| ↳ `status` | string | Session status |
| ↳ `lastActiveAt` | number | Last activity timestamp |
| ↳ `lastActiveOrganizationId` | string | Last active organization ID |
| ↳ `expireAt` | number | Expiration timestamp |
| ↳ `abandonAt` | number | Abandon timestamp |
| ↳ `createdAt` | number | Creation timestamp |
| ↳ `updatedAt` | number | Last update timestamp |
| `totalCount` | number | Total number of sessions |
| `success` | boolean | Operation success status |
### `clerk_get_session`
Retrieve a single session by ID from Clerk
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `sessionId` | string | Yes | The ID of the session to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Session ID |
| `userId` | string | User ID |
| `clientId` | string | Client ID |
| `status` | string | Session status |
| `lastActiveAt` | number | Last activity timestamp |
| `lastActiveOrganizationId` | string | Last active organization ID |
| `expireAt` | number | Expiration timestamp |
| `abandonAt` | number | Abandon timestamp |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `success` | boolean | Operation success status |
### `clerk_revoke_session`
Revoke a session to immediately invalidate it
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `sessionId` | string | Yes | The ID of the session to revoke |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Session ID |
| `userId` | string | User ID |
| `clientId` | string | Client ID |
| `status` | string | Session status \(should be revoked\) |
| `lastActiveAt` | number | Last activity timestamp |
| `lastActiveOrganizationId` | string | Last active organization ID |
| `expireAt` | number | Expiration timestamp |
| `abandonAt` | number | Abandon timestamp |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `success` | boolean | Operation success status |

View File

@@ -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\) |

View File

@@ -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`
@@ -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`
@@ -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`
@@ -252,16 +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 |
| ↳ `timestamp` | string | Log timestamp |
| ↳ `host` | string | Host name |
| ↳ `service` | string | Service name |
| ↳ `message` | string | Log message |
| ↳ `status` | string | Log status/level |
| `nextLogId` | string | Cursor for pagination | | `nextLogId` | string | Cursor for pagination |
### `datadog_send_logs` ### `datadog_send_logs`
@@ -307,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`

View File

@@ -64,24 +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 | Author user 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 |
| ↳ `username` | string | Author username | | ↳ `timestamp` | string | Message timestamp |
| ↳ `avatar` | string | Author avatar hash | | ↳ `edited_timestamp` | string | Message edited timestamp |
| ↳ `bot` | boolean | Whether author is a bot | | ↳ `embeds` | array | Message embeds |
| ↳ `timestamp` | string | Message timestamp | | ↳ `attachments` | array | Message attachments |
| ↳ `edited_timestamp` | string | Message edited timestamp | | ↳ `mentions` | array | User mentions in message |
| ↳ `embeds` | array | Message embeds | | ↳ `mention_roles` | array | Role mentions in message |
| ↳ `attachments` | array | Message attachments | | ↳ `mention_everyone` | boolean | Whether message mentions everyone |
| ↳ `mentions` | array | User mentions in message |
| ↳ `mention_roles` | array | Role mentions in message |
| ↳ `mention_everyone` | boolean | Whether message mentions everyone |
### `discord_get_messages` ### `discord_get_messages`
@@ -101,43 +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 | Author user 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 |
| ↳ `username` | string | Author username |
| ↳ `avatar` | string | Author avatar hash |
| ↳ `bot` | boolean | Whether author is a bot |
| ↳ `timestamp` | string | Message timestamp |
| ↳ `edited_timestamp` | string | Message edited timestamp |
| ↳ `embeds` | array | Message embeds |
| ↳ `attachments` | array | Message attachments |
| ↳ `mentions` | array | User mentions in message |
| ↳ `mention_roles` | array | Role mentions in message |
| ↳ `mention_everyone` | boolean | Whether message mentions everyone |
| ↳ `id` | string | Author user ID |
| ↳ `content` | string | Message content |
| ↳ `channel_id` | string | Channel ID |
| ↳ `author` | object | Message author information |
| ↳ `id` | string | Author user ID |
| ↳ `username` | string | Author username |
| ↳ `avatar` | string | Author avatar hash |
| ↳ `bot` | boolean | Whether author is a bot |
| ↳ `username` | string | Author username |
| ↳ `avatar` | string | Author avatar hash |
| ↳ `bot` | boolean | Whether author is a bot |
| ↳ `timestamp` | string | Message timestamp |
| ↳ `edited_timestamp` | string | Message edited timestamp |
| ↳ `embeds` | array | Message embeds |
| ↳ `attachments` | array | Message attachments |
| ↳ `mentions` | array | User mentions in message |
| ↳ `mention_roles` | array | Role mentions in message |
| ↳ `mention_everyone` | boolean | Whether message mentions everyone |
### `discord_get_server` ### `discord_get_server`
@@ -156,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`
@@ -182,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`
@@ -211,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`
@@ -335,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`
@@ -396,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`
@@ -420,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`
@@ -445,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`
@@ -486,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`
@@ -513,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`
@@ -541,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`
@@ -677,16 +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 |
| ↳ `id` | string | User ID | | ↳ `nick` | string | Server nickname |
| ↳ `username` | string | Username | | ↳ `roles` | array | Array of role IDs |
| ↳ `avatar` | string | Avatar hash | | ↳ `joined_at` | string | When the member joined |
| ↳ `nick` | string | Server nickname |
| ↳ `roles` | array | Array of role IDs |
| ↳ `joined_at` | string | When the member joined |
### `discord_update_member` ### `discord_update_member`
@@ -709,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`
@@ -734,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`
@@ -758,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`
@@ -801,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`
@@ -827,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`
@@ -850,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`

View File

@@ -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`

View File

@@ -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 |

View File

@@ -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`
@@ -98,18 +126,17 @@ Crawl entire websites and extract structured content from all accessible pages
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pages` | array | Array of crawled pages with their content and metadata | | `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 |
| ↳ `title` | string | Page title | | ↳ `language` | string | Page language code |
| ↳ `description` | string | Page description | | ↳ `sourceURL` | string | Original source URL |
| ↳ `language` | string | Page language | | ↳ `statusCode` | number | HTTP status code |
| ↳ `sourceURL` | string | Source URL of the page | | ↳ `ogLocaleAlternate` | array | Alternate locale versions |
| ↳ `statusCode` | number | HTTP status code |
| `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 |

View File

@@ -75,18 +75,18 @@ Get a single transcript with full details including summary, action items, and a
| 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`
@@ -104,15 +104,15 @@ Get user information from Fireflies.ai. Returns current user if no ID specified.
| 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`
@@ -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`

File diff suppressed because it is too large Load Diff

View File

@@ -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`
@@ -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 |

View File

@@ -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`
@@ -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`
@@ -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 |

View File

@@ -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`
@@ -131,47 +131,25 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `replies` | array | The replies from each update request | | `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 |
| ↳ `title` | string | Item title | | ↳ `settings` | object | Form settings |
| ↳ `description` | string | Item description | | ↳ `quizSettings` | object | Quiz settings |
| ↳ `documentTitle` | string | The document title visible in Drive | | ↳ `isQuiz` | boolean | Whether the form is a quiz |
| ↳ `settings` | object | Form settings | | ↳ `emailCollectionType` | string | Email collection type |
| ↳ `quizSettings` | object | Quiz settings | | ↳ `revisionId` | string | The revision ID of the form |
| ↳ `isQuiz` | boolean | Whether the form is a quiz | | ↳ `responderUri` | string | The URI to share with responders |
| ↳ `isQuiz` | boolean | Whether the form is a quiz | | ↳ `linkedSheetId` | string | The ID of the linked Google Sheet |
| ↳ `emailCollectionType` | string | Email collection type | | ↳ `publishSettings` | object | Form publish settings |
| ↳ `quizSettings` | object | Quiz settings | | ↳ `publishState` | object | Current publish state |
| ↳ `isQuiz` | boolean | Whether the form is a quiz | | ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isQuiz` | boolean | Whether the form is a quiz | | ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
| ↳ `emailCollectionType` | string | Email collection type |
| ↳ `itemId` | string | Item ID |
| ↳ `questionItem` | json | Question item configuration |
| ↳ `questionGroupItem` | json | Question group configuration |
| ↳ `pageBreakItem` | json | Page break configuration |
| ↳ `textItem` | json | Text item configuration |
| ↳ `imageItem` | json | Image item configuration |
| ↳ `videoItem` | json | Video item configuration |
| ↳ `revisionId` | string | The revision ID of the form |
| ↳ `responderUri` | string | The URI to share with responders |
| ↳ `linkedSheetId` | string | The ID of the linked Google Sheet |
| ↳ `publishSettings` | object | Form publish settings |
| ↳ `publishState` | object | Current publish state |
| ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
| ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
| ↳ `publishState` | object | Current publish state |
| ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
| ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
### `google_forms_set_publish_settings` ### `google_forms_set_publish_settings`
@@ -191,11 +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 |
| ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses |
### `google_forms_create_watch` ### `google_forms_create_watch`

View File

@@ -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 |
@@ -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 |
@@ -288,7 +288,7 @@ Get the settings for a Google Group including access permissions, moderation, an
| 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 |
@@ -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 |

View File

@@ -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 |

View File

@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`

View File

@@ -52,15 +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 |
| ↳ `width` | json | Page width as a Dimension object | | ↳ `mimeType` | string | The mime type of the presentation |
| ↳ `height` | json | Page height as a Dimension object | | ↳ `url` | string | URL to open the presentation |
| ↳ `mimeType` | string | The mime type of the presentation |
| ↳ `url` | string | URL to open the presentation |
### `google_slides_write` ### `google_slides_write`
@@ -80,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`
@@ -103,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`
@@ -128,10 +126,10 @@ Find and replace all occurrences of text throughout a Google Slides presentation
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `occurrencesChanged` | number | Number of text occurrences that were replaced | | `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`
@@ -152,10 +150,10 @@ Add a new slide to a Google Slides presentation with a specified layout
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `slideId` | string | The object ID of the newly created slide | | `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`
@@ -179,10 +177,10 @@ Insert an image into a specific slide in a Google Slides presentation
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `imageId` | string | The object ID of the newly created image | | `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`
@@ -205,10 +203,10 @@ Generate a thumbnail image of a specific slide in a Google Slides presentation
| `width` | number | Width of the thumbnail in pixels | | `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`
@@ -229,12 +227,12 @@ Get detailed information about a specific slide/page in a Google Slides presenta
| `pageType` | string | The type of page \(SLIDE, MASTER, LAYOUT, NOTES, NOTES_MASTER\) | | `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`
@@ -254,8 +252,8 @@ Delete a page element (shape, image, table, etc.) or an entire slide from a Goog
| `deleted` | boolean | Whether the object was successfully deleted | | `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`
@@ -276,9 +274,9 @@ Duplicate an object (slide, shape, image, table, etc.) in a Google Slides presen
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `duplicatedObjectId` | string | The object ID of the newly created duplicate | | `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`
@@ -300,8 +298,8 @@ Move one or more slides to a new position in a Google Slides presentation
| `slideObjectIds` | array | The slide object IDs that were moved | | `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`
@@ -328,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`
@@ -355,9 +353,9 @@ Create a shape (rectangle, ellipse, text box, arrow, etc.) on a slide in a Googl
| `shapeId` | string | The object ID of the newly created shape | | `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`
@@ -380,7 +378,7 @@ Insert text into a shape or table cell in a Google Slides presentation. Use this
| `objectId` | string | The object ID where text was inserted | | `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 |

View File

@@ -51,6 +51,12 @@ Retrieve all users from HubSpot account
| 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 |
@@ -71,9 +77,33 @@ Retrieve all contacts from HubSpot account with pagination support
| 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`
@@ -93,7 +123,27 @@ Retrieve a single contact by ID or email from HubSpot
| 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 |
@@ -112,7 +162,27 @@ Create a new contact in HubSpot. Requires at least one of: email, firstname, or
| 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 |
@@ -132,7 +202,27 @@ Update an existing contact in HubSpot by ID or email
| 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 |
@@ -155,10 +245,34 @@ Search for contacts in HubSpot using filters, sorting, and queries
| 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`
@@ -178,9 +292,34 @@ Retrieve all companies from HubSpot account with pagination support
| 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`
@@ -200,7 +339,28 @@ Retrieve a single company by ID or domain from HubSpot
| 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 |
@@ -219,7 +379,28 @@ Create a new company in HubSpot
| 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 |
@@ -239,7 +420,28 @@ Update an existing company in HubSpot by ID or domain
| 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 |
@@ -262,10 +464,35 @@ Search for companies in HubSpot using filters, sorting, and queries
| 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`
@@ -285,9 +512,25 @@ Retrieve all deals from HubSpot account with pagination support
| 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 |

View File

@@ -54,14 +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 |
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
| ↳ `completion_tokens` | number | Number of tokens in the completion |
| ↳ `total_tokens` | number | Total number of tokens used |

View File

@@ -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`
@@ -74,26 +79,46 @@ Returns all the email addresses found using one given domain name, with sources.
| 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`
@@ -113,10 +138,17 @@ Finds the most likely email address for a person given their name and company do
| 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`
@@ -163,8 +200,15 @@ Enriches company data using domain name.
| 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`
@@ -183,10 +227,27 @@ Returns the total number of email addresses found for a domain or company.
| 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\) |

View File

@@ -58,10 +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 |
| ↳ `model` | string | Model used for image generation |

File diff suppressed because it is too large Load Diff

View File

@@ -61,59 +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 | List type | | ↳ `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 |
| ↳ `url` | string | URL to fetch companies | | ↳ `notes` | object | Notes associated with the contact |
| ↳ `data` | array | Array of social profile objects | | ↳ `type` | string | List type |
| ↳ `has_more` | boolean | Whether there are more companies | | ↳ `url` | string | URL to fetch notes |
| ↳ `total_count` | number | Total number of companies | | ↳ `data` | array | Array of note objects |
| ↳ `notes` | object | Notes associated with the contact | | ↳ `has_more` | boolean | Whether there are more notes |
| ↳ `type` | string | List type | | ↳ `total_count` | number | Total number of notes |
| ↳ `url` | string | URL to fetch notes | | ↳ `companies` | object | Companies associated with the contact |
| ↳ `data` | array | Array of note objects | | ↳ `type` | string | List type |
| ↳ `has_more` | boolean | Whether there are more notes | | ↳ `url` | string | URL to fetch companies |
| ↳ `total_count` | number | Total number of notes | | ↳ `data` | array | Array of company objects |
| ↳ `companies` | object | Companies associated with the contact | | ↳ `has_more` | boolean | Whether there are more companies |
| ↳ `type` | string | List type | | ↳ `total_count` | number | Total number of companies |
| ↳ `url` | string | URL to fetch companies | | ↳ `location` | object | Location information for the contact |
| ↳ `data` | array | Array of company objects | | ↳ `type` | string | Location type |
| ↳ `has_more` | boolean | Whether there are more companies | | ↳ `city` | string | City |
| ↳ `total_count` | number | Total number of companies | | ↳ `region` | string | Region/State |
| ↳ `location` | object | Location information for the contact | | ↳ `country` | string | Country |
| ↳ `type` | string | Location type | | ↳ `country_code` | string | Country code |
| ↳ `city` | string | City | | ↳ `continent_code` | string | Continent code |
| ↳ `region` | string | Region/State | | ↳ `social_profiles` | object | Social profiles of the contact |
| ↳ `country` | string | Country | | ↳ `type` | string | List type |
| ↳ `country_code` | string | Country code | | ↳ `data` | array | Array of social profile objects |
| ↳ `continent_code` | string | Continent code | | ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
| ↳ `city` | string | City |
| ↳ `region` | string | Region/State |
| ↳ `country` | string | Country |
| ↳ `country_code` | string | Country code |
| ↳ `continent_code` | string | Continent code |
| ↳ `social_profiles` | object | Social profiles of the contact |
| ↳ `type` | string | List type |
| ↳ `data` | array | Array of social profile objects |
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
| `contactId` | string | ID of the created contact | | `contactId` | string | ID of the created contact |
### `intercom_get_contact` ### `intercom_get_contact`
@@ -131,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`
@@ -178,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`
@@ -229,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`
@@ -276,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`
@@ -322,24 +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 | Segment list type | | ↳ `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` | array | Array of tag objects | | ↳ `tags` | object | Tags associated with the company |
| ↳ `segments` | array | Array of segment objects | | ↳ `type` | string | Tag list type |
| ↳ `tags` | array | Array of tag objects |
| ↳ `segments` | object | Segments the company belongs to |
| ↳ `type` | string | Segment list type |
| ↳ `segments` | array | Array of segment objects |
| `companyId` | string | ID of the created/updated company | | `companyId` | string | ID of the created/updated company |
### `intercom_get_company` ### `intercom_get_company`
@@ -357,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`
@@ -408,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 |
@@ -432,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`
@@ -487,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 |
@@ -514,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 |
@@ -568,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 |
@@ -596,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 |
@@ -629,24 +664,60 @@ 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 |
### `intercom_update_ticket`
Update a ticket in Intercom (change state, assignment, attributes)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `ticketId` | string | Yes | The ID of the ticket to update |
| `ticket_attributes` | string | No | JSON object with ticket attributes \(e.g., \{"_default_title_":"New Title","_default_description_":"Updated description"\}\) |
| `open` | boolean | No | Set to false to close the ticket, true to keep it open |
| `is_shared` | boolean | No | Whether the ticket is visible to users |
| `snoozed_until` | number | No | Unix timestamp for when the ticket should reopen |
| `admin_id` | string | No | The ID of the admin performing the update \(needed for workflows and attribution\) |
| `assignee_id` | string | No | The ID of the admin or team to assign the ticket to. Set to "0" to unassign. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ticket` | object | The updated ticket object |
| ↳ `id` | string | Unique identifier for the ticket |
| ↳ `type` | string | Object type \(ticket\) |
| ↳ `ticket_id` | string | Ticket ID shown in Intercom UI |
| ↳ `ticket_state` | string | State of the ticket |
| ↳ `ticket_attributes` | object | Attributes of the ticket |
| ↳ `open` | boolean | Whether the ticket is open |
| ↳ `is_shared` | boolean | Whether the ticket is visible to users |
| ↳ `snoozed_until` | number | Unix timestamp when ticket will reopen |
| ↳ `admin_assignee_id` | string | ID of assigned admin |
| ↳ `team_assignee_id` | string | ID of assigned team |
| ↳ `created_at` | number | Unix timestamp when ticket was created |
| ↳ `updated_at` | number | Unix timestamp when ticket was last updated |
| `ticketId` | string | ID of the updated ticket |
| `ticket_state` | string | Current state of the ticket |
### `intercom_create_message` ### `intercom_create_message`
Create and send a new admin-initiated message in Intercom. Returns API-aligned fields only. Create and send a new admin-initiated message in Intercom. Returns API-aligned fields only.
@@ -670,14 +741,350 @@ Create and send a new admin-initiated message in Intercom. Returns API-aligned f
| Parameter | Type | Description | | 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 |
### `intercom_list_admins`
Fetch a list of all admins for the workspace
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `admins` | array | Array of admin objects |
| ↳ `id` | string | Unique identifier for the admin |
| ↳ `type` | string | Object type \(admin\) |
| ↳ `name` | string | Name of the admin |
| ↳ `email` | string | Email of the admin |
| ↳ `job_title` | string | Job title of the admin |
| ↳ `away_mode_enabled` | boolean | Whether admin is in away mode |
| ↳ `away_mode_reassign` | boolean | Whether to reassign conversations when away |
| ↳ `has_inbox_seat` | boolean | Whether admin has a paid inbox seat |
| ↳ `team_ids` | array | List of team IDs the admin belongs to |
| ↳ `avatar` | object | Avatar information |
| ↳ `email_verified` | boolean | Whether email is verified |
| `type` | string | Object type \(admin.list\) |
### `intercom_close_conversation`
Close a conversation in Intercom
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `conversationId` | string | Yes | The ID of the conversation to close |
| `admin_id` | string | Yes | The ID of the admin performing the action |
| `body` | string | No | Optional closing message to add to the conversation |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `conversation` | object | The closed conversation object |
| ↳ `id` | string | Unique identifier for the conversation |
| ↳ `type` | string | Object type \(conversation\) |
| ↳ `state` | string | State of the conversation \(closed\) |
| ↳ `open` | boolean | Whether the conversation is open \(false\) |
| ↳ `read` | boolean | Whether the conversation has been read |
| ↳ `created_at` | number | Unix timestamp when conversation was created |
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
| `conversationId` | string | ID of the closed conversation |
| `state` | string | State of the conversation \(closed\) |
### `intercom_open_conversation`
Open a closed or snoozed conversation in Intercom
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `conversationId` | string | Yes | The ID of the conversation to open |
| `admin_id` | string | Yes | The ID of the admin performing the action |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `conversation` | object | The opened conversation object |
| ↳ `id` | string | Unique identifier for the conversation |
| ↳ `type` | string | Object type \(conversation\) |
| ↳ `state` | string | State of the conversation \(open\) |
| ↳ `open` | boolean | Whether the conversation is open \(true\) |
| ↳ `read` | boolean | Whether the conversation has been read |
| ↳ `created_at` | number | Unix timestamp when conversation was created |
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
| `conversationId` | string | ID of the opened conversation |
| `state` | string | State of the conversation \(open\) |
### `intercom_snooze_conversation`
Snooze a conversation to reopen at a future time
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `conversationId` | string | Yes | The ID of the conversation to snooze |
| `admin_id` | string | Yes | The ID of the admin performing the action |
| `snoozed_until` | number | Yes | Unix timestamp for when the conversation should reopen |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `conversation` | object | The snoozed conversation object |
| ↳ `id` | string | Unique identifier for the conversation |
| ↳ `type` | string | Object type \(conversation\) |
| ↳ `state` | string | State of the conversation \(snoozed\) |
| ↳ `open` | boolean | Whether the conversation is open |
| ↳ `snoozed_until` | number | Unix timestamp when conversation will reopen |
| ↳ `created_at` | number | Unix timestamp when conversation was created |
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
| `conversationId` | string | ID of the snoozed conversation |
| `state` | string | State of the conversation \(snoozed\) |
| `snoozed_until` | number | Unix timestamp when conversation will reopen |
### `intercom_assign_conversation`
Assign a conversation to an admin or team in Intercom
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `conversationId` | string | Yes | The ID of the conversation to assign |
| `admin_id` | string | Yes | The ID of the admin performing the assignment |
| `assignee_id` | string | Yes | The ID of the admin or team to assign the conversation to. Set to "0" to unassign. |
| `body` | string | No | Optional message to add when assigning \(e.g., "Passing to the support team"\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `conversation` | object | The assigned conversation object |
| ↳ `id` | string | Unique identifier for the conversation |
| ↳ `type` | string | Object type \(conversation\) |
| ↳ `state` | string | State of the conversation |
| ↳ `open` | boolean | Whether the conversation is open |
| ↳ `admin_assignee_id` | number | ID of the assigned admin |
| ↳ `team_assignee_id` | string | ID of the assigned team |
| ↳ `created_at` | number | Unix timestamp when conversation was created |
| ↳ `updated_at` | number | Unix timestamp when conversation was last updated |
| `conversationId` | string | ID of the assigned conversation |
| `admin_assignee_id` | number | ID of the assigned admin |
| `team_assignee_id` | string | ID of the assigned team |
### `intercom_list_tags`
Fetch a list of all tags in the workspace
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tags` | array | Array of tag objects |
| ↳ `id` | string | Unique identifier for the tag |
| ↳ `type` | string | Object type \(tag\) |
| ↳ `name` | string | Name of the tag |
| `type` | string | Object type \(list\) |
### `intercom_create_tag`
Create a new tag or update an existing tag name
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `name` | string | Yes | The name of the tag. Will create a new tag if not found, or update the name if id is provided. |
| `id` | string | No | The ID of an existing tag to update. Omit to create a new tag. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Unique identifier for the tag |
| `name` | string | Name of the tag |
| `type` | string | Object type \(tag\) |
### `intercom_tag_contact`
Add a tag to a specific contact
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `contactId` | string | Yes | The ID of the contact to tag |
| `tagId` | string | Yes | The ID of the tag to apply |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Unique identifier for the tag |
| `name` | string | Name of the tag |
| `type` | string | Object type \(tag\) |
### `intercom_untag_contact`
Remove a tag from a specific contact
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `contactId` | string | Yes | The ID of the contact to untag |
| `tagId` | string | Yes | The ID of the tag to remove |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Unique identifier for the tag that was removed |
| `name` | string | Name of the tag that was removed |
| `type` | string | Object type \(tag\) |
### `intercom_tag_conversation`
Add a tag to a specific conversation
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `conversationId` | string | Yes | The ID of the conversation to tag |
| `tagId` | string | Yes | The ID of the tag to apply |
| `admin_id` | string | Yes | The ID of the admin applying the tag |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Unique identifier for the tag |
| `name` | string | Name of the tag |
| `type` | string | Object type \(tag\) |
### `intercom_create_note`
Add a note to a specific contact
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `contactId` | string | Yes | The ID of the contact to add the note to |
| `body` | string | Yes | The text content of the note |
| `admin_id` | string | No | The ID of the admin creating the note |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Unique identifier for the note |
| `body` | string | The text content of the note |
| `created_at` | number | Unix timestamp when the note was created |
| `type` | string | Object type \(note\) |
| `author` | object | The admin who created the note |
| ↳ `type` | string | Author type \(admin\) |
| ↳ `id` | string | Author ID |
| ↳ `name` | string | Author name |
| ↳ `email` | string | Author email |
| `contact` | object | The contact the note was created for |
| ↳ `type` | string | Contact type |
| ↳ `id` | string | Contact ID |
### `intercom_create_event`
Track a custom event for a contact in Intercom
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `event_name` | string | Yes | The name of the event \(e.g., "order-completed"\). Use past-tense verb-noun format for readability. |
| `created_at` | number | No | Unix timestamp for when the event occurred. Strongly recommended for uniqueness. |
| `user_id` | string | No | Your identifier for the user \(external_id\) |
| `email` | string | No | Email address of the user. Use only if your app uses email to uniquely identify users. |
| `id` | string | No | The Intercom contact ID |
| `metadata` | string | No | JSON object with up to 10 metadata key-value pairs about the event \(e.g., \{"order_value": 99.99\}\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `accepted` | boolean | Whether the event was accepted \(202 Accepted\) |
### `intercom_attach_contact_to_company`
Attach a contact to a company in Intercom
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `contactId` | string | Yes | The ID of the contact to attach to the company |
| `companyId` | string | Yes | The ID of the company to attach the contact to |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `company` | object | The company object the contact was attached to |
| ↳ `id` | string | Unique identifier for the company |
| ↳ `type` | string | Object type \(company\) |
| ↳ `company_id` | string | The company_id you defined |
| ↳ `name` | string | Name of the company |
| ↳ `created_at` | number | Unix timestamp when company was created |
| ↳ `updated_at` | number | Unix timestamp when company was updated |
| ↳ `user_count` | number | Number of users in the company |
| ↳ `session_count` | number | Number of sessions |
| ↳ `monthly_spend` | number | Monthly spend amount |
| ↳ `plan` | object | Company plan details |
| `companyId` | string | ID of the company |
| `name` | string | Name of the company |
### `intercom_detach_contact_from_company`
Remove a contact from a company in Intercom
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `contactId` | string | Yes | The ID of the contact to detach from the company |
| `companyId` | string | Yes | The ID of the company to detach the contact from |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `company` | object | The company object the contact was detached from |
| ↳ `id` | string | Unique identifier for the company |
| ↳ `type` | string | Object type \(company\) |
| ↳ `company_id` | string | The company_id you defined |
| ↳ `name` | string | Name of the company |
| `companyId` | string | ID of the company |
| `name` | string | Name of the company |

View File

@@ -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 |

View File

@@ -6,7 +6,7 @@ description: Access prediction markets and trade on Kalshi
import { BlockInfoCard } from "@/components/ui/block-info-card" import { BlockInfoCard } from "@/components/ui/block-info-card"
<BlockInfoCard <BlockInfoCard
type="kalshi" type="kalshi_v2"
color="#09C285" color="#09C285"
/> />
@@ -36,7 +36,7 @@ Integrate Kalshi prediction markets into the workflow. Can get markets, market,
### `kalshi_get_markets` ### `kalshi_get_markets`
Retrieve a list of prediction markets from Kalshi with optional filtering Retrieve a list of prediction markets from Kalshi with all filtering options (V2 - full API response)
#### Input #### Input
@@ -52,12 +52,39 @@ Retrieve a list of prediction markets from Kalshi with optional filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `markets` | array | Array of market objects | | `markets` | array | Array of market objects with all API fields |
| `paging` | object | Pagination cursor for fetching more results | | ↳ `ticker` | string | Unique market ticker identifier |
| ↳ `event_ticker` | string | Parent event ticker |
| ↳ `market_type` | string | Market type \(binary, etc.\) |
| ↳ `title` | string | Market title/question |
| ↳ `subtitle` | string | Market subtitle |
| ↳ `yes_sub_title` | string | Yes outcome subtitle |
| ↳ `no_sub_title` | string | No outcome subtitle |
| ↳ `open_time` | string | Market open time \(ISO 8601\) |
| ↳ `close_time` | string | Market close time \(ISO 8601\) |
| ↳ `expiration_time` | string | Contract expiration time |
| ↳ `status` | string | Market status \(open, closed, settled, etc.\) |
| ↳ `yes_bid` | number | Current best yes bid price in cents |
| ↳ `yes_ask` | number | Current best yes ask price in cents |
| ↳ `no_bid` | number | Current best no bid price in cents |
| ↳ `no_ask` | number | Current best no ask price in cents |
| ↳ `last_price` | number | Last trade price in cents |
| ↳ `previous_yes_bid` | number | Previous yes bid |
| ↳ `previous_yes_ask` | number | Previous yes ask |
| ↳ `previous_price` | number | Previous last price |
| ↳ `volume` | number | Total volume \(contracts traded\) |
| ↳ `volume_24h` | number | 24-hour trading volume |
| ↳ `liquidity` | number | Market liquidity measure |
| ↳ `open_interest` | number | Open interest \(outstanding contracts\) |
| ↳ `result` | string | Settlement result \(yes, no, null\) |
| ↳ `cap_strike` | number | Cap strike for ranged markets |
| ↳ `floor_strike` | number | Floor strike for ranged markets |
| ↳ `category` | string | Market category |
| `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_market` ### `kalshi_get_market`
Retrieve details of a specific prediction market by ticker Retrieve details of a specific prediction market by ticker (V2 - full API response)
#### Input #### Input
@@ -69,11 +96,62 @@ Retrieve details of a specific prediction market by ticker
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `market` | object | Market object with details | | `market` | object | Market object with all API fields |
| ↳ `ticker` | string | Market ticker |
| ↳ `event_ticker` | string | Event ticker |
| ↳ `market_type` | string | Market type |
| ↳ `title` | string | Market title |
| ↳ `subtitle` | string | Market subtitle |
| ↳ `yes_sub_title` | string | Yes outcome subtitle |
| ↳ `no_sub_title` | string | No outcome subtitle |
| ↳ `open_time` | string | Market open time |
| ↳ `close_time` | string | Market close time |
| ↳ `expected_expiration_time` | string | Expected expiration time |
| ↳ `expiration_time` | string | Expiration time |
| ↳ `latest_expiration_time` | string | Latest expiration time |
| ↳ `settlement_timer_seconds` | number | Settlement timer in seconds |
| ↳ `status` | string | Market status |
| ↳ `response_price_units` | string | Response price units |
| ↳ `notional_value` | number | Notional value |
| ↳ `tick_size` | number | Tick size |
| ↳ `yes_bid` | number | Current yes bid price |
| ↳ `yes_ask` | number | Current yes ask price |
| ↳ `no_bid` | number | Current no bid price |
| ↳ `no_ask` | number | Current no ask price |
| ↳ `last_price` | number | Last trade price |
| ↳ `previous_yes_bid` | number | Previous yes bid |
| ↳ `previous_yes_ask` | number | Previous yes ask |
| ↳ `previous_price` | number | Previous price |
| ↳ `volume` | number | Total volume |
| ↳ `volume_24h` | number | 24-hour volume |
| ↳ `liquidity` | number | Market liquidity |
| ↳ `open_interest` | number | Open interest |
| ↳ `result` | string | Market result |
| ↳ `cap_strike` | number | Cap strike |
| ↳ `floor_strike` | number | Floor strike |
| ↳ `can_close_early` | boolean | Can close early |
| ↳ `expiration_value` | string | Expiration value |
| ↳ `category` | string | Market category |
| ↳ `risk_limit_cents` | number | Risk limit in cents |
| ↳ `strike_type` | string | Strike type |
| ↳ `rules_primary` | string | Primary rules |
| ↳ `rules_secondary` | string | Secondary rules |
| ↳ `settlement_source_url` | string | Settlement source URL |
| ↳ `custom_strike` | object | Custom strike object |
| ↳ `underlying` | string | Underlying asset |
| ↳ `settlement_value` | number | Settlement value |
| ↳ `cfd_contract_size` | number | CFD contract size |
| ↳ `yes_fee_fp` | number | Yes fee \(fixed-point\) |
| ↳ `no_fee_fp` | number | No fee \(fixed-point\) |
| ↳ `last_price_fp` | number | Last price \(fixed-point\) |
| ↳ `yes_bid_fp` | number | Yes bid \(fixed-point\) |
| ↳ `yes_ask_fp` | number | Yes ask \(fixed-point\) |
| ↳ `no_bid_fp` | number | No bid \(fixed-point\) |
| ↳ `no_ask_fp` | number | No ask \(fixed-point\) |
### `kalshi_get_events` ### `kalshi_get_events`
Retrieve a list of events from Kalshi with optional filtering Retrieve a list of events from Kalshi with optional filtering (V2 - exact API response)
#### Input #### Input
@@ -90,11 +168,24 @@ Retrieve a list of events from Kalshi with optional filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `events` | array | Array of event objects | | `events` | array | Array of event objects |
| `paging` | object | Pagination cursor for fetching more results | | ↳ `event_ticker` | string | Unique event ticker identifier |
| ↳ `series_ticker` | string | Parent series ticker |
| ↳ `title` | string | Event title |
| ↳ `sub_title` | string | Event subtitle |
| ↳ `mutually_exclusive` | boolean | Whether markets are mutually exclusive |
| ↳ `category` | string | Event category |
| ↳ `strike_date` | string | Strike/settlement date |
| ↳ `status` | string | Event status |
| `milestones` | array | Array of milestone objects \(if requested\) |
| ↳ `event_ticker` | string | Event ticker |
| ↳ `milestone_type` | string | Milestone type |
| ↳ `milestone_date` | string | Milestone date |
| ↳ `milestone_title` | string | Milestone title |
| `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_event` ### `kalshi_get_event`
Retrieve details of a specific event by ticker Retrieve details of a specific event by ticker (V2 - exact API response)
#### Input #### Input
@@ -107,11 +198,23 @@ Retrieve details of a specific event by ticker
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `event` | object | Event object with details | | `event` | object | Event object with full details matching Kalshi API response |
| ↳ `event_ticker` | string | Event ticker |
| ↳ `series_ticker` | string | Series ticker |
| ↳ `title` | string | Event title |
| ↳ `sub_title` | string | Event subtitle |
| ↳ `mutually_exclusive` | boolean | Mutually exclusive markets |
| ↳ `category` | string | Event category |
| ↳ `collateral_return_type` | string | Collateral return type |
| ↳ `strike_date` | string | Strike date |
| ↳ `strike_period` | string | Strike period |
| ↳ `available_on_brokers` | boolean | Available on brokers |
| ↳ `product_metadata` | object | Product metadata |
| ↳ `markets` | array | Nested markets \(if requested\) |
### `kalshi_get_balance` ### `kalshi_get_balance`
Retrieve your account balance and portfolio value from Kalshi Retrieve your account balance and portfolio value from Kalshi (V2 - exact API response)
#### Input #### Input
@@ -125,11 +228,12 @@ Retrieve your account balance and portfolio value from Kalshi
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `balance` | number | Account balance in cents | | `balance` | number | Account balance in cents |
| `portfolioValue` | number | Portfolio value in cents | | `portfolio_value` | number | Portfolio value in cents |
| `updated_ts` | number | Unix timestamp of last update \(milliseconds\) |
### `kalshi_get_positions` ### `kalshi_get_positions`
Retrieve your open positions from Kalshi Retrieve your open positions from Kalshi (V2 - exact API response)
#### Input #### Input
@@ -147,12 +251,27 @@ Retrieve your open positions from Kalshi
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `positions` | array | Array of position objects | | `market_positions` | array | Array of market position objects |
| `paging` | object | Pagination cursor for fetching more results | | ↳ `ticker` | string | Market ticker |
| ↳ `event_ticker` | string | Event ticker |
| ↳ `event_title` | string | Event title |
| ↳ `market_title` | string | Market title |
| ↳ `position` | number | Net position \(positive=yes, negative=no\) |
| ↳ `market_exposure` | number | Maximum potential loss in cents |
| ↳ `realized_pnl` | number | Realized profit/loss in cents |
| ↳ `total_traded` | number | Total contracts traded |
| ↳ `resting_orders_count` | number | Number of resting orders |
| ↳ `fees_paid` | number | Total fees paid in cents |
| `event_positions` | array | Array of event position objects |
| ↳ `event_ticker` | string | Event ticker |
| ↳ `event_exposure` | number | Event-level exposure in cents |
| ↳ `realized_pnl` | number | Realized P&L in cents |
| ↳ `total_cost` | number | Total cost basis in cents |
| `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_orders` ### `kalshi_get_orders`
Retrieve your orders from Kalshi with optional filtering Retrieve your orders from Kalshi with optional filtering (V2 with full API response)
#### Input #### Input
@@ -170,12 +289,30 @@ Retrieve your orders from Kalshi with optional filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `orders` | array | Array of order objects | | `orders` | array | Array of order objects with full API response fields |
| `paging` | object | Pagination cursor for fetching more results | | ↳ `order_id` | string | Unique order identifier |
| ↳ `user_id` | string | User ID |
| ↳ `client_order_id` | string | Client-provided order ID |
| ↳ `ticker` | string | Market ticker |
| ↳ `side` | string | Order side \(yes/no\) |
| ↳ `action` | string | Order action \(buy/sell\) |
| ↳ `type` | string | Order type \(limit/market\) |
| ↳ `status` | string | Order status \(resting, canceled, executed\) |
| ↳ `yes_price` | number | Yes price in cents |
| ↳ `no_price` | number | No price in cents |
| ↳ `fill_count` | number | Number of contracts filled |
| ↳ `remaining_count` | number | Remaining contracts to fill |
| ↳ `initial_count` | number | Initial order size |
| ↳ `taker_fees` | number | Taker fees paid in cents |
| ↳ `maker_fees` | number | Maker fees paid in cents |
| ↳ `created_time` | string | Order creation time \(ISO 8601\) |
| ↳ `expiration_time` | string | Order expiration time |
| ↳ `last_update_time` | string | Last order update time |
| `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_order` ### `kalshi_get_order`
Retrieve details of a specific order by ID from Kalshi Retrieve details of a specific order by ID from Kalshi (V2 with full API response)
#### Input #### Input
@@ -189,11 +326,44 @@ Retrieve details of a specific order by ID from Kalshi
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `order` | object | Order object with details | | `order` | object | Order object with full API response fields |
| ↳ `order_id` | string | Order ID |
| ↳ `user_id` | string | User ID |
| ↳ `client_order_id` | string | Client order ID |
| ↳ `ticker` | string | Market ticker |
| ↳ `side` | string | Order side \(yes/no\) |
| ↳ `action` | string | Action \(buy/sell\) |
| ↳ `type` | string | Order type \(limit/market\) |
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
| ↳ `yes_price` | number | Yes price in cents |
| ↳ `no_price` | number | No price in cents |
| ↳ `yes_price_dollars` | string | Yes price in dollars |
| ↳ `no_price_dollars` | string | No price in dollars |
| ↳ `fill_count` | number | Filled contract count |
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
| ↳ `remaining_count` | number | Remaining contracts |
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
| ↳ `initial_count` | number | Initial contract count |
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
| ↳ `taker_fees` | number | Taker fees in cents |
| ↳ `maker_fees` | number | Maker fees in cents |
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
| ↳ `queue_position` | number | Queue position \(deprecated\) |
| ↳ `expiration_time` | string | Order expiration time |
| ↳ `created_time` | string | Order creation time |
| ↳ `last_update_time` | string | Last update time |
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
| ↳ `order_group_id` | string | Order group ID |
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
### `kalshi_get_orderbook` ### `kalshi_get_orderbook`
Retrieve the orderbook (yes and no bids) for a specific market Retrieve the orderbook (yes and no bids) for a specific market (V2 - includes depth and fp fields)
#### Input #### Input
@@ -205,11 +375,18 @@ Retrieve the orderbook (yes and no bids) for a specific market
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `orderbook` | object | Orderbook with yes/no bids and asks | | `orderbook` | object | Orderbook with yes/no bids \(legacy integer counts\) |
| ↳ `yes` | array | Yes side bids as tuples \[price_cents, count\] |
| ↳ `no` | array | No side bids as tuples \[price_cents, count\] |
| ↳ `yes_dollars` | array | Yes side bids as tuples \[dollars_string, count\] |
| ↳ `no_dollars` | array | No side bids as tuples \[dollars_string, count\] |
| `orderbook_fp` | object | Orderbook with fixed-point counts \(preferred\) |
| ↳ `yes_dollars` | array | Yes side bids as tuples \[dollars_string, fp_count_string\] |
| ↳ `no_dollars` | array | No side bids as tuples \[dollars_string, fp_count_string\] |
### `kalshi_get_trades` ### `kalshi_get_trades`
Retrieve recent trades across all markets Retrieve recent trades with additional filtering options (V2 - includes trade_id and count_fp)
#### Input #### Input
@@ -222,12 +399,18 @@ Retrieve recent trades across all markets
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `trades` | array | Array of trade objects | | `trades` | array | Array of trade objects with trade_id and count_fp |
| `paging` | object | Pagination cursor for fetching more results | | ↳ `ticker` | string | Market ticker |
| ↳ `yes_price` | number | Trade price for yes in cents |
| ↳ `no_price` | number | Trade price for no in cents |
| ↳ `count` | number | Number of contracts traded |
| ↳ `taker_side` | string | Taker side \(yes/no\) |
| ↳ `created_time` | string | Trade time \(ISO 8601\) |
| `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_candlesticks` ### `kalshi_get_candlesticks`
Retrieve OHLC candlestick data for a specific market Retrieve OHLC candlestick data for a specific market (V2 - full API response)
#### Input #### Input
@@ -243,7 +426,8 @@ Retrieve OHLC candlestick data for a specific market
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `candlesticks` | array | Array of OHLC candlestick data | | `ticker` | string | Market ticker |
| `candlesticks` | array | Array of OHLC candlestick data with nested bid/ask/price objects |
### `kalshi_get_fills` ### `kalshi_get_fills`
@@ -266,12 +450,22 @@ Retrieve your portfolio
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `fills` | array | Array of fill/trade objects | | `fills` | array | Array of fill/trade objects with all API fields |
| `paging` | object | Pagination cursor for fetching more results | | ↳ `trade_id` | string | Unique trade identifier |
| ↳ `order_id` | string | Associated order ID |
| ↳ `ticker` | string | Market ticker |
| ↳ `side` | string | Trade side \(yes/no\) |
| ↳ `action` | string | Trade action \(buy/sell\) |
| ↳ `count` | number | Number of contracts |
| ↳ `yes_price` | number | Yes price in cents |
| ↳ `no_price` | number | No price in cents |
| ↳ `is_taker` | boolean | Whether this was a taker trade |
| ↳ `created_time` | string | Trade execution time \(ISO 8601\) |
| `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_series_by_ticker` ### `kalshi_get_series_by_ticker`
Retrieve details of a specific market series by ticker Retrieve details of a specific market series by ticker (V2 - exact API response)
#### Input #### Input
@@ -283,11 +477,25 @@ Retrieve details of a specific market series by ticker
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `series` | object | Series object with details | | `series` | object | Series object with full details matching Kalshi API response |
| ↳ `ticker` | string | Series ticker |
| ↳ `title` | string | Series title |
| ↳ `frequency` | string | Event frequency |
| ↳ `category` | string | Series category |
| ↳ `tags` | array | Series tags |
| ↳ `settlement_sources` | array | Settlement sources |
| ↳ `contract_url` | string | Contract URL |
| ↳ `contract_terms_url` | string | Contract terms URL |
| ↳ `fee_type` | string | Fee type |
| ↳ `fee_multiplier` | number | Fee multiplier |
| ↳ `additional_prohibitions` | array | Additional prohibitions |
| ↳ `product_metadata` | object | Product metadata |
| ↳ `volume` | number | Series volume |
| ↳ `volume_fp` | number | Volume \(fixed-point\) |
### `kalshi_get_exchange_status` ### `kalshi_get_exchange_status`
Retrieve the current status of the Kalshi exchange (trading and exchange activity) Retrieve the current status of the Kalshi exchange (V2 - exact API response)
#### Input #### Input
@@ -298,11 +506,13 @@ Retrieve the current status of the Kalshi exchange (trading and exchange activit
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `status` | object | Exchange status with trading_active and exchange_active flags | | `exchange_active` | boolean | Whether the exchange is active |
| `trading_active` | boolean | Whether trading is active |
| `exchange_estimated_resume_time` | string | Estimated time when exchange will resume \(if inactive\) |
### `kalshi_create_order` ### `kalshi_create_order`
Create a new order on a Kalshi prediction market Create a new order on a Kalshi prediction market (V2 with full API response)
#### Input #### Input
@@ -332,11 +542,44 @@ Create a new order on a Kalshi prediction market
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `order` | object | The created order object | | `order` | object | The created order object with full API response fields |
| ↳ `order_id` | string | Order ID |
| ↳ `user_id` | string | User ID |
| ↳ `client_order_id` | string | Client order ID |
| ↳ `ticker` | string | Market ticker |
| ↳ `side` | string | Order side \(yes/no\) |
| ↳ `action` | string | Action \(buy/sell\) |
| ↳ `type` | string | Order type \(limit/market\) |
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
| ↳ `yes_price` | number | Yes price in cents |
| ↳ `no_price` | number | No price in cents |
| ↳ `yes_price_dollars` | string | Yes price in dollars |
| ↳ `no_price_dollars` | string | No price in dollars |
| ↳ `fill_count` | number | Filled contract count |
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
| ↳ `remaining_count` | number | Remaining contracts |
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
| ↳ `initial_count` | number | Initial contract count |
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
| ↳ `taker_fees` | number | Taker fees in cents |
| ↳ `maker_fees` | number | Maker fees in cents |
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
| ↳ `queue_position` | number | Queue position \(deprecated\) |
| ↳ `expiration_time` | string | Order expiration time |
| ↳ `created_time` | string | Order creation time |
| ↳ `last_update_time` | string | Last update time |
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
| ↳ `order_group_id` | string | Order group ID |
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
### `kalshi_cancel_order` ### `kalshi_cancel_order`
Cancel an existing order on Kalshi Cancel an existing order on Kalshi (V2 with full API response)
#### Input #### Input
@@ -350,12 +593,46 @@ Cancel an existing order on Kalshi
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `order` | object | The canceled order object | | `order` | object | The canceled order object with full API response fields |
| `reducedBy` | number | Number of contracts canceled | | ↳ `order_id` | string | Order ID |
| ↳ `user_id` | string | User ID |
| ↳ `client_order_id` | string | Client order ID |
| ↳ `ticker` | string | Market ticker |
| ↳ `side` | string | Order side \(yes/no\) |
| ↳ `action` | string | Action \(buy/sell\) |
| ↳ `type` | string | Order type \(limit/market\) |
| ↳ `status` | string | Order status \(resting/canceled/executed\) |
| ↳ `yes_price` | number | Yes price in cents |
| ↳ `no_price` | number | No price in cents |
| ↳ `yes_price_dollars` | string | Yes price in dollars |
| ↳ `no_price_dollars` | string | No price in dollars |
| ↳ `fill_count` | number | Filled contract count |
| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) |
| ↳ `remaining_count` | number | Remaining contracts |
| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) |
| ↳ `initial_count` | number | Initial contract count |
| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) |
| ↳ `taker_fees` | number | Taker fees in cents |
| ↳ `maker_fees` | number | Maker fees in cents |
| ↳ `taker_fees_dollars` | string | Taker fees in dollars |
| ↳ `maker_fees_dollars` | string | Maker fees in dollars |
| ↳ `taker_fill_cost` | number | Taker fill cost in cents |
| ↳ `maker_fill_cost` | number | Maker fill cost in cents |
| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars |
| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars |
| ↳ `queue_position` | number | Queue position \(deprecated\) |
| ↳ `expiration_time` | string | Order expiration time |
| ↳ `created_time` | string | Order creation time |
| ↳ `last_update_time` | string | Last update time |
| ↳ `self_trade_prevention_type` | string | Self-trade prevention type |
| ↳ `order_group_id` | string | Order group ID |
| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause |
| `reduced_by` | number | Number of contracts canceled |
| `reduced_by_fp` | string | Number of contracts canceled in fixed-point format |
### `kalshi_amend_order` ### `kalshi_amend_order`
Modify the price or quantity of an existing order on Kalshi Modify the price or quantity of an existing order on Kalshi (V2 with full API response)
#### Input #### Input
@@ -379,6 +656,63 @@ Modify the price or quantity of an existing order on Kalshi
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `order` | object | The amended order object | | `old_order` | object | The original order object before amendment |
| ↳ `order_id` | string | Order ID |
| ↳ `user_id` | string | User ID |
| ↳ `ticker` | string | Market ticker |
| ↳ `event_ticker` | string | Event ticker |
| ↳ `status` | string | Order status |
| ↳ `side` | string | Order side \(yes/no\) |
| ↳ `type` | string | Order type \(limit/market\) |
| ↳ `yes_price` | number | Yes price in cents |
| ↳ `no_price` | number | No price in cents |
| ↳ `action` | string | Action \(buy/sell\) |
| ↳ `count` | number | Number of contracts |
| ↳ `remaining_count` | number | Remaining contracts |
| ↳ `created_time` | string | Order creation time |
| ↳ `expiration_time` | string | Order expiration time |
| ↳ `order_group_id` | string | Order group ID |
| ↳ `client_order_id` | string | Client order ID |
| ↳ `place_count` | number | Place count |
| ↳ `decrease_count` | number | Decrease count |
| ↳ `queue_position` | number | Queue position |
| ↳ `maker_fill_count` | number | Maker fill count |
| ↳ `taker_fill_count` | number | Taker fill count |
| ↳ `maker_fees` | number | Maker fees |
| ↳ `taker_fees` | number | Taker fees |
| ↳ `last_update_time` | string | Last update time |
| ↳ `take_profit_order_id` | string | Take profit order ID |
| ↳ `stop_loss_order_id` | string | Stop loss order ID |
| ↳ `amend_count` | number | Amend count |
| ↳ `amend_taker_fill_count` | number | Amend taker fill count |
| `order` | object | The amended order object with full API response fields |
| ↳ `order_id` | string | Order ID |
| ↳ `user_id` | string | User ID |
| ↳ `ticker` | string | Market ticker |
| ↳ `event_ticker` | string | Event ticker |
| ↳ `status` | string | Order status |
| ↳ `side` | string | Order side \(yes/no\) |
| ↳ `type` | string | Order type \(limit/market\) |
| ↳ `yes_price` | number | Yes price in cents |
| ↳ `no_price` | number | No price in cents |
| ↳ `action` | string | Action \(buy/sell\) |
| ↳ `count` | number | Number of contracts |
| ↳ `remaining_count` | number | Remaining contracts |
| ↳ `created_time` | string | Order creation time |
| ↳ `expiration_time` | string | Order expiration time |
| ↳ `order_group_id` | string | Order group ID |
| ↳ `client_order_id` | string | Client order ID |
| ↳ `place_count` | number | Place count |
| ↳ `decrease_count` | number | Decrease count |
| ↳ `queue_position` | number | Queue position |
| ↳ `maker_fill_count` | number | Maker fill count |
| ↳ `taker_fill_count` | number | Taker fill count |
| ↳ `maker_fees` | number | Maker fees |
| ↳ `taker_fees` | number | Taker fees |
| ↳ `last_update_time` | string | Last update time |
| ↳ `take_profit_order_id` | string | Take profit order ID |
| ↳ `stop_loss_order_id` | string | Stop loss order ID |
| ↳ `amend_count` | number | Amend count |
| ↳ `amend_taker_fill_count` | number | Amend taker fill count |

View File

@@ -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 |

View File

@@ -59,18 +59,27 @@ Fetch and filter issues from Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `hasNextPage` | boolean | Whether there are more results |
| `endCursor` | string | Cursor for the next page |
| `issues` | array | Array of filtered issues from Linear | | `issues` | array | Array of filtered issues from Linear |
| ↳ `id` | string | Issue ID | | ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `description` | string | Issue description | | ↳ `description` | string | Issue description |
| ↳ `priority` | number | Issue priority | | ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
| ↳ `estimate` | number | Issue estimate | | ↳ `estimate` | number | Estimate in points |
| ↳ `url` | string | Issue URL | | ↳ `url` | string | Issue URL |
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | | ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last update timestamp | | ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `state` | object | Issue state | | ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
| ↳ `assignee` | object | Assigned user | | ↳ `state` | object | Workflow state/status |
| ↳ `id` | string | State ID |
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `assignee` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teamId` | string | Team ID | | ↳ `teamId` | string | Team ID |
| ↳ `teamName` | string | Team name | | ↳ `teamName` | string | Team name |
| ↳ `projectId` | string | Project ID | | ↳ `projectId` | string | Project ID |
@@ -79,8 +88,9 @@ Fetch and filter issues from Linear
| ↳ `cycleNumber` | number | Cycle number | | ↳ `cycleNumber` | number | Cycle number |
| ↳ `cycleName` | string | Cycle name | | ↳ `cycleName` | string | Cycle name |
| ↳ `labels` | array | Issue labels | | ↳ `labels` | array | Issue labels |
| `hasNextPage` | boolean | Whether there are more results available | | ↳ `id` | string | Label ID |
| `endCursor` | string | Cursor for fetching the next page \(use as | | ↳ `name` | string | Label name |
| ↳ `color` | string | Label color \(hex\) |
### `linear_get_issue` ### `linear_get_issue`
@@ -97,17 +107,32 @@ Get a single issue by ID from Linear with full details
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `issue` | object | The issue with full details | | `issue` | object | The issue with full details |
| ↳ `id` | string | Issue ID | | ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `description` | string | Issue description | | ↳ `description` | string | Issue description |
| ↳ `priority` | number | Issue priority \(0-4\) | | ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
| ↳ `estimate` | number | Issue estimate in points | | ↳ `estimate` | number | Estimate in points |
| ↳ `url` | string | Issue URL | | ↳ `url` | string | Issue URL |
| ↳ `state` | object | Issue state/status | | ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
| ↳ `assignee` | object | Assigned user | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `labels` | array | Issue labels | | ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last update timestamp | | ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
| ↳ `state` | object | Workflow state/status |
| ↳ `id` | string | State ID |
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `assignee` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teamId` | string | Team ID |
| ↳ `projectId` | string | Project ID |
| ↳ `labels` | array | Issue labels |
| ↳ `id` | string | Label ID |
| ↳ `name` | string | Label name |
| ↳ `color` | string | Label color \(hex\) |
### `linear_create_issue` ### `linear_create_issue`
@@ -137,25 +162,39 @@ Create a new issue in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `issue` | object | The created issue with all its properties | | `issue` | object | The created issue with all its properties |
| ↳ `id` | string | Issue ID | | ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `description` | string | Issue description | | ↳ `description` | string | Issue description |
| ↳ `priority` | number | Issue priority | | ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
| ↳ `estimate` | number | Issue estimate | | ↳ `estimate` | number | Estimate in points |
| ↳ `url` | string | Issue URL | | ↳ `url` | string | Issue URL |
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | | ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
| ↳ `state` | object | Issue state | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `assignee` | object | Assigned user | | ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `teamId` | string | Team ID | | ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
| ↳ `projectId` | string | Project ID | | ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `cycleId` | string | Cycle ID | | ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
| ↳ `cycleNumber` | number | Cycle number | | ↳ `state` | object | Workflow state/status |
| ↳ `cycleName` | string | Cycle name | | ↳ `id` | string | State ID |
| ↳ `parentId` | string | Parent issue ID | | ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `parentTitle` | string | Parent issue title | | ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `projectMilestoneId` | string | Project milestone ID | | ↳ `assignee` | object | User object |
| ↳ `projectMilestoneName` | string | Project milestone name | | ↳ `id` | string | User ID |
| ↳ `labels` | array | Issue labels | | ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teamId` | string | Team ID |
| ↳ `projectId` | string | Project ID |
| ↳ `labels` | array | Issue labels |
| ↳ `id` | string | Label ID |
| ↳ `name` | string | Label name |
| ↳ `color` | string | Label color \(hex\) |
| ↳ `cycleId` | string | Cycle ID |
| ↳ `cycleNumber` | number | Cycle number |
| ↳ `cycleName` | string | Cycle name |
| ↳ `parentId` | string | Parent issue ID |
| ↳ `parentTitle` | string | Parent issue title |
| ↳ `projectMilestoneId` | string | Project milestone ID |
| ↳ `projectMilestoneName` | string | Project milestone name |
### `linear_update_issue` ### `linear_update_issue`
@@ -185,22 +224,39 @@ Update an existing issue in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `issue` | object | The updated issue | | `issue` | object | The updated issue |
| ↳ `id` | string | Issue ID | | ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `description` | string | Issue description | | ↳ `description` | string | Issue description |
| ↳ `priority` | number | Issue priority | | ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
| ↳ `estimate` | number | Issue estimate | | ↳ `estimate` | number | Estimate in points |
| ↳ `state` | object | Issue state | | ↳ `url` | string | Issue URL |
| ↳ `assignee` | object | Assigned user | | ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
| ↳ `labels` | array | Issue labels | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last update timestamp | | ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | | ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
| ↳ `projectId` | string | Project ID | | ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `cycleId` | string | Cycle ID | | ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
| ↳ `cycleNumber` | number | Cycle number | | ↳ `state` | object | Workflow state/status |
| ↳ `cycleName` | string | Cycle name | | ↳ `id` | string | State ID |
| ↳ `parentId` | string | Parent issue ID | | ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `parentTitle` | string | Parent issue title | | ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `assignee` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teamId` | string | Team ID |
| ↳ `projectId` | string | Project ID |
| ↳ `labels` | array | Issue labels |
| ↳ `id` | string | Label ID |
| ↳ `name` | string | Label name |
| ↳ `color` | string | Label color \(hex\) |
| ↳ `cycleId` | string | Cycle ID |
| ↳ `cycleNumber` | number | Cycle number |
| ↳ `cycleName` | string | Cycle name |
| ↳ `parentId` | string | Parent issue ID |
| ↳ `parentTitle` | string | Parent issue title |
| ↳ `projectMilestoneId` | string | Project milestone ID |
| ↳ `projectMilestoneName` | string | Project milestone name |
### `linear_archive_issue` ### `linear_archive_issue`
@@ -269,17 +325,36 @@ Search for issues in Linear using full-text search
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `issues` | array | Array of matching issues | | `issues` | array | Array of matching issues |
| ↳ `id` | string | Issue ID | | ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `description` | string | Issue description | | ↳ `description` | string | Issue description |
| ↳ `priority` | number | Issue priority | | ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
| ↳ `state` | object | Issue state | | ↳ `estimate` | number | Estimate in points |
| ↳ `assignee` | object | Assigned user | | ↳ `url` | string | Issue URL |
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
| ↳ `state` | object | Workflow state/status |
| ↳ `id` | string | State ID |
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `assignee` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teamId` | string | Team ID |
| ↳ `projectId` | string | Project ID |
| ↳ `labels` | array | Issue labels | | ↳ `labels` | array | Issue labels |
| `pageInfo` | object | Pagination information | | ↳ `id` | string | Label ID |
| ↳ `hasNextPage` | boolean | Whether there are more results | | ↳ `name` | string | Label name |
| ↳ `endCursor` | string | Cursor for next page | | ↳ `color` | string | Label color \(hex\) |
### `linear_add_label_to_issue` ### `linear_add_label_to_issue`
@@ -333,11 +408,17 @@ Add a comment to an issue in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `comment` | object | The created comment | | `comment` | object | The created comment |
| ↳ `id` | string | Comment ID | | ↳ `id` | string | Comment ID |
| ↳ `body` | string | Comment text | | ↳ `body` | string | Comment text \(Markdown\) |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `user` | object | User who created the comment | | ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `issue` | object | Associated issue | | ↳ `user` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `issue` | object | Issue object |
| ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title |
### `linear_update_comment` ### `linear_update_comment`
@@ -355,10 +436,17 @@ Edit a comment in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `comment` | object | The updated comment | | `comment` | object | The updated comment |
| ↳ `id` | string | Comment ID | | ↳ `id` | string | Comment ID |
| ↳ `body` | string | Comment text | | ↳ `body` | string | Comment text \(Markdown\) |
| ↳ `updatedAt` | string | Last update timestamp | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `user` | object | User who created the comment | | ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `user` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `issue` | object | Issue object |
| ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title |
### `linear_delete_comment` ### `linear_delete_comment`
@@ -392,15 +480,21 @@ List all comments on an issue in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `comments` | array | Array of comments on the issue | | `comments` | array | Array of comments on the issue |
| ↳ `id` | string | Comment ID | | ↳ `id` | string | Comment ID |
| ↳ `body` | string | Comment text | | ↳ `body` | string | Comment text \(Markdown\) |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last update timestamp | | ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `user` | object | User who created the comment | | ↳ `user` | object | User object |
| `pageInfo` | object | Pagination information | | ↳ `id` | string | User ID |
| ↳ `hasNextPage` | boolean | Whether there are more results | | ↳ `name` | string | User name |
| ↳ `endCursor` | string | Cursor for next page | | ↳ `email` | string | User email |
| ↳ `issue` | object | Issue object |
| ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title |
### `linear_list_projects` ### `linear_list_projects`
@@ -419,15 +513,25 @@ List projects in Linear with optional filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `projects` | array | Array of projects | | `projects` | array | Array of projects |
| ↳ `id` | string | Project ID | | ↳ `id` | string | Project ID |
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `description` | string | Project description | | ↳ `description` | string | Project description |
| ↳ `state` | string | Project state | | ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) |
| ↳ `priority` | number | Project priority | | ↳ `priority` | number | Project priority \(0-4\) |
| ↳ `lead` | object | Project lead | | ↳ `startDate` | string | Start date \(YYYY-MM-DD\) |
| ↳ `teams` | array | Teams associated with project | | ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) |
| `pageInfo` | object | Pagination information | | ↳ `url` | string | Project URL |
| ↳ `lead` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teams` | array | Associated teams |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_get_project` ### `linear_get_project`
@@ -444,15 +548,21 @@ Get a single project by ID from Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `project` | object | The project with full details | | `project` | object | The project with full details |
| ↳ `id` | string | Project ID | | ↳ `id` | string | Project ID |
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `description` | string | Project description | | ↳ `description` | string | Project description |
| ↳ `state` | string | Project state | | ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) |
| ↳ `priority` | number | Project priority | | ↳ `priority` | number | Project priority \(0-4\) |
| ↳ `startDate` | string | Start date | | ↳ `startDate` | string | Start date \(YYYY-MM-DD\) |
| ↳ `targetDate` | string | Target completion date | | ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) |
| ↳ `lead` | object | Project lead | | ↳ `url` | string | Project URL |
| ↳ `teams` | array | Associated teams | | ↳ `lead` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teams` | array | Associated teams |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_create_project` ### `linear_create_project`
@@ -475,13 +585,21 @@ Create a new project in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `project` | object | The created project | | `project` | object | The created project |
| ↳ `id` | string | Project ID | | ↳ `id` | string | Project ID |
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `description` | string | Project description | | ↳ `description` | string | Project description |
| ↳ `state` | string | Project state | | ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) |
| ↳ `priority` | number | Project priority | | ↳ `priority` | number | Project priority \(0-4\) |
| ↳ `lead` | object | Project lead | | ↳ `startDate` | string | Start date \(YYYY-MM-DD\) |
| ↳ `teams` | array | Associated teams | | ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) |
| ↳ `url` | string | Project URL |
| ↳ `lead` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teams` | array | Associated teams |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_update_project` ### `linear_update_project`
@@ -505,15 +623,21 @@ Update an existing project in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `project` | object | The updated project | | `project` | object | The updated project |
| ↳ `id` | string | Project ID | | ↳ `id` | string | Project ID |
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `description` | string | Project description | | ↳ `description` | string | Project description |
| ↳ `state` | string | Project state | | ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) |
| ↳ `priority` | number | Project priority | | ↳ `priority` | number | Project priority \(0-4\) |
| ↳ `startDate` | string | Project start date | | ↳ `startDate` | string | Start date \(YYYY-MM-DD\) |
| ↳ `targetDate` | string | Project target date | | ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) |
| ↳ `lead` | object | Project lead | | ↳ `url` | string | Project URL |
| ↳ `teams` | array | Associated teams | | ↳ `lead` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teams` | array | Associated teams |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_archive_project` ### `linear_archive_project`
@@ -548,6 +672,9 @@ List all users in the Linear workspace
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `users` | array | Array of workspace users | | `users` | array | Array of workspace users |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
@@ -556,7 +683,6 @@ List all users in the Linear workspace
| ↳ `active` | boolean | Whether user is active | | ↳ `active` | boolean | Whether user is active |
| ↳ `admin` | boolean | Whether user is admin | | ↳ `admin` | boolean | Whether user is admin |
| ↳ `avatarUrl` | string | Avatar URL | | ↳ `avatarUrl` | string | Avatar URL |
| `pageInfo` | object | Pagination information |
### `linear_list_teams` ### `linear_list_teams`
@@ -573,12 +699,14 @@ List all teams in the Linear workspace
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `teams` | array | Array of teams | | `teams` | array | Array of teams |
| ↳ `id` | string | Team ID | | ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name | | ↳ `name` | string | Team name |
| ↳ `key` | string | Team key \(used in issue identifiers\) | | ↳ `key` | string | Team key \(used in issue identifiers\) |
| ↳ `description` | string | Team description | | ↳ `description` | string | Team description |
| `pageInfo` | object | Pagination information |
### `linear_get_viewer` ### `linear_get_viewer`
@@ -594,13 +722,13 @@ Get the currently authenticated user (viewer) information
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `user` | object | The currently authenticated user | | `user` | object | The currently authenticated user |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `displayName` | string | Display name | | ↳ `displayName` | string | Display name |
| ↳ `active` | boolean | Whether user is active | | ↳ `active` | boolean | Whether user is active |
| ↳ `admin` | boolean | Whether user is admin | | ↳ `admin` | boolean | Whether user is admin |
| ↳ `avatarUrl` | string | Avatar URL | | ↳ `avatarUrl` | string | Avatar URL |
### `linear_list_labels` ### `linear_list_labels`
@@ -618,13 +746,17 @@ List all labels in Linear workspace or team
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `labels` | array | Array of labels | | `labels` | array | Array of labels |
| ↳ `id` | string | Label ID | | ↳ `id` | string | Label ID |
| ↳ `name` | string | Label name | | ↳ `name` | string | Label name |
| ↳ `color` | string | Label color \(hex\) | | ↳ `color` | string | Label color \(hex\) |
| ↳ `description` | string | Label description | | ↳ `description` | string | Label description |
| ↳ `team` | object | Team this label belongs to | | ↳ `team` | object | Team object |
| `pageInfo` | object | Pagination information | | ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_create_label` ### `linear_create_label`
@@ -644,11 +776,13 @@ Create a new label in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `label` | object | The created label | | `label` | object | The created label |
| ↳ `id` | string | Label ID | | ↳ `id` | string | Label ID |
| ↳ `name` | string | Label name | | ↳ `name` | string | Label name |
| ↳ `color` | string | Label color | | ↳ `color` | string | Label color \(hex\) |
| ↳ `description` | string | Label description | | ↳ `description` | string | Label description |
| ↳ `team` | object | Team this label belongs to | | ↳ `team` | object | Team object |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_update_label` ### `linear_update_label`
@@ -668,10 +802,13 @@ Update an existing label in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `label` | object | The updated label | | `label` | object | The updated label |
| ↳ `id` | string | Label ID | | ↳ `id` | string | Label ID |
| ↳ `name` | string | Label name | | ↳ `name` | string | Label name |
| ↳ `color` | string | Label color | | ↳ `color` | string | Label color \(hex\) |
| ↳ `description` | string | Label description | | ↳ `description` | string | Label description |
| ↳ `team` | object | Team object |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_archive_label` ### `linear_archive_label`
@@ -706,14 +843,18 @@ List all workflow states (statuses) in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `states` | array | Array of workflow states | | `states` | array | Array of workflow states |
| ↳ `id` | string | State ID | | ↳ `id` | string | State ID |
| ↳ `name` | string | State name \(e.g., | | ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `type` | string | State type \(e.g., | | ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `color` | string | State color | | ↳ `color` | string | State color \(hex\) |
| ↳ `position` | number | State position in workflow | | ↳ `position` | number | State position in workflow |
| ↳ `team` | object | Team this state belongs to | | ↳ `team` | object | Team object |
| `pageInfo` | object | Pagination information | | ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_create_workflow_state` ### `linear_create_workflow_state`
@@ -735,12 +876,12 @@ Create a new workflow state (status) in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `state` | object | The created workflow state | | `state` | object | The created workflow state |
| ↳ `id` | string | State ID | | ↳ `id` | string | State ID |
| ↳ `name` | string | State name | | ↳ `name` | string | State name |
| ↳ `type` | string | State type | | ↳ `type` | string | State type |
| ↳ `color` | string | State color | | ↳ `color` | string | State color |
| ↳ `position` | number | State position | | ↳ `position` | number | State position |
| ↳ `team` | object | Team this state belongs to | | ↳ `team` | object | Team this state belongs to |
### `linear_update_workflow_state` ### `linear_update_workflow_state`
@@ -761,11 +902,11 @@ Update an existing workflow state in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `state` | object | The updated workflow state | | `state` | object | The updated workflow state |
| ↳ `id` | string | State ID | | ↳ `id` | string | State ID |
| ↳ `name` | string | State name | | ↳ `name` | string | State name |
| ↳ `type` | string | State type | | ↳ `type` | string | State type |
| ↳ `color` | string | State color | | ↳ `color` | string | State color |
| ↳ `position` | number | State position | | ↳ `position` | number | State position |
### `linear_list_cycles` ### `linear_list_cycles`
@@ -783,16 +924,20 @@ List cycles (sprints/iterations) in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `cycles` | array | Array of cycles | | `cycles` | array | Array of cycles |
| ↳ `id` | string | Cycle ID | | ↳ `id` | string | Cycle ID |
| ↳ `number` | number | Cycle number | | ↳ `number` | number | Cycle number |
| ↳ `name` | string | Cycle name | | ↳ `name` | string | Cycle name |
| ↳ `startsAt` | string | Start date | | ↳ `startsAt` | string | Start date \(ISO 8601\) |
| ↳ `endsAt` | string | End date | | ↳ `endsAt` | string | End date \(ISO 8601\) |
| ↳ `completedAt` | string | Completion date | | ↳ `completedAt` | string | Completion date \(ISO 8601\) |
| ↳ `progress` | number | Progress percentage \(0-1\) | | ↳ `progress` | number | Progress percentage \(0-1\) |
| ↳ `team` | object | Team this cycle belongs to | | ↳ `team` | object | Team object |
| `pageInfo` | object | Pagination information | | ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_get_cycle` ### `linear_get_cycle`
@@ -809,13 +954,16 @@ Get a single cycle by ID from Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `cycle` | object | The cycle with full details | | `cycle` | object | The cycle with full details |
| ↳ `id` | string | Cycle ID | | ↳ `id` | string | Cycle ID |
| ↳ `number` | number | Cycle number | | ↳ `number` | number | Cycle number |
| ↳ `name` | string | Cycle name | | ↳ `name` | string | Cycle name |
| ↳ `startsAt` | string | Start date | | ↳ `startsAt` | string | Start date \(ISO 8601\) |
| ↳ `endsAt` | string | End date | | ↳ `endsAt` | string | End date \(ISO 8601\) |
| ↳ `progress` | number | Progress percentage | | ↳ `completedAt` | string | Completion date \(ISO 8601\) |
| ↳ `team` | object | Team this cycle belongs to | | ↳ `progress` | number | Progress percentage \(0-1\) |
| ↳ `team` | object | Team object |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_create_cycle` ### `linear_create_cycle`
@@ -835,12 +983,12 @@ Create a new cycle (sprint/iteration) in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `cycle` | object | The created cycle | | `cycle` | object | The created cycle |
| ↳ `id` | string | Cycle ID | | ↳ `id` | string | Cycle ID |
| ↳ `number` | number | Cycle number | | ↳ `number` | number | Cycle number |
| ↳ `name` | string | Cycle name | | ↳ `name` | string | Cycle name |
| ↳ `startsAt` | string | Start date | | ↳ `startsAt` | string | Start date |
| ↳ `endsAt` | string | End date | | ↳ `endsAt` | string | End date |
| ↳ `team` | object | Team this cycle belongs to | | ↳ `team` | object | Team this cycle belongs to |
### `linear_get_active_cycle` ### `linear_get_active_cycle`
@@ -857,13 +1005,13 @@ Get the currently active cycle for a team
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `cycle` | object | The active cycle \(null if no active cycle\) | | `cycle` | object | The active cycle \(null if no active cycle\) |
| ↳ `id` | string | Cycle ID | | ↳ `id` | string | Cycle ID |
| ↳ `number` | number | Cycle number | | ↳ `number` | number | Cycle number |
| ↳ `name` | string | Cycle name | | ↳ `name` | string | Cycle name |
| ↳ `startsAt` | string | Start date | | ↳ `startsAt` | string | Start date |
| ↳ `endsAt` | string | End date | | ↳ `endsAt` | string | End date |
| ↳ `progress` | number | Progress percentage | | ↳ `progress` | number | Progress percentage |
| ↳ `team` | object | Team this cycle belongs to | | ↳ `team` | object | Team this cycle belongs to |
### `linear_create_attachment` ### `linear_create_attachment`
@@ -883,11 +1031,12 @@ Add an attachment to an issue in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `attachment` | object | The created attachment | | `attachment` | object | The created attachment |
| ↳ `id` | string | Attachment ID | | ↳ `id` | string | Attachment ID |
| ↳ `title` | string | Attachment title | | ↳ `title` | string | Attachment title |
| ↳ `subtitle` | string | Attachment subtitle | | ↳ `subtitle` | string | Attachment subtitle |
| ↳ `url` | string | Attachment URL | | ↳ `url` | string | Attachment URL |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
### `linear_list_attachments` ### `linear_list_attachments`
@@ -905,13 +1054,16 @@ List all attachments on an issue in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `attachments` | array | Array of attachments | | `attachments` | array | Array of attachments |
| ↳ `id` | string | Attachment ID | | ↳ `id` | string | Attachment ID |
| ↳ `title` | string | Attachment title | | ↳ `title` | string | Attachment title |
| ↳ `subtitle` | string | Attachment subtitle | | ↳ `subtitle` | string | Attachment subtitle |
| ↳ `url` | string | Attachment URL | | ↳ `url` | string | Attachment URL |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| `pageInfo` | object | Pagination information | | ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
### `linear_update_attachment` ### `linear_update_attachment`
@@ -930,11 +1082,12 @@ Update an attachment metadata in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `attachment` | object | The updated attachment | | `attachment` | object | The updated attachment |
| ↳ `id` | string | Attachment ID | | ↳ `id` | string | Attachment ID |
| ↳ `title` | string | Attachment title | | ↳ `title` | string | Attachment title |
| ↳ `subtitle` | string | Attachment subtitle | | ↳ `subtitle` | string | Attachment subtitle |
| ↳ `url` | string | Attachment URL | | ↳ `url` | string | Attachment URL |
| ↳ `updatedAt` | string | Last update timestamp | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
### `linear_delete_attachment` ### `linear_delete_attachment`
@@ -969,10 +1122,10 @@ Link two issues together in Linear (blocks, relates to, duplicates)
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `relation` | object | The created issue relation | | `relation` | object | The created issue relation |
| ↳ `id` | string | Relation ID | | ↳ `id` | string | Relation ID |
| ↳ `type` | string | Relation type | | ↳ `type` | string | Relation type |
| ↳ `issue` | object | Source issue | | ↳ `issue` | object | Source issue |
| ↳ `relatedIssue` | object | Target issue | | ↳ `relatedIssue` | object | Target issue |
### `linear_list_issue_relations` ### `linear_list_issue_relations`
@@ -1031,11 +1184,11 @@ Bookmark an issue, project, cycle, or label in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `favorite` | object | The created favorite | | `favorite` | object | The created favorite |
| ↳ `id` | string | Favorite ID | | ↳ `id` | string | Favorite ID |
| ↳ `type` | string | Favorite type | | ↳ `type` | string | Favorite type |
| ↳ `issue` | object | Favorited issue \(if applicable\) | | ↳ `issue` | object | Favorited issue \(if applicable\) |
| ↳ `project` | object | Favorited project \(if applicable\) | | ↳ `project` | object | Favorited project \(if applicable\) |
| ↳ `cycle` | object | Favorited cycle \(if applicable\) | | ↳ `cycle` | object | Favorited cycle \(if applicable\) |
### `linear_list_favorites` ### `linear_list_favorites`
@@ -1077,11 +1230,11 @@ Post a status update for a project in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `update` | object | The created project update | | `update` | object | The created project update |
| ↳ `id` | string | Update ID | | ↳ `id` | string | Update ID |
| ↳ `body` | string | Update message | | ↳ `body` | string | Update message |
| ↳ `health` | string | Project health status | | ↳ `health` | string | Project health status |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `user` | object | User who created the update | | ↳ `user` | object | User who created the update |
### `linear_list_project_updates` ### `linear_list_project_updates`
@@ -1146,11 +1299,11 @@ Mark a notification as read or unread in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `notification` | object | The updated notification | | `notification` | object | The updated notification |
| ↳ `id` | string | Notification ID | | ↳ `id` | string | Notification ID |
| ↳ `type` | string | Notification type | | ↳ `type` | string | Notification type |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `readAt` | string | Read timestamp | | ↳ `readAt` | string | Read timestamp |
| ↳ `issue` | object | Related issue | | ↳ `issue` | object | Related issue |
### `linear_create_customer` ### `linear_create_customer`
@@ -1175,14 +1328,14 @@ Create a new customer in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customer` | object | The created customer | | `customer` | object | The created customer |
| ↳ `id` | string | Customer ID | | ↳ `id` | string | Customer ID |
| ↳ `name` | string | Customer name | | ↳ `name` | string | Customer name |
| ↳ `domains` | array | Associated domains | | ↳ `domains` | array | Associated domains |
| ↳ `externalIds` | array | External IDs | | ↳ `externalIds` | array | External IDs from other systems |
| ↳ `logoUrl` | string | Logo URL | | ↳ `logoUrl` | string | Logo URL |
| ↳ `approximateNeedCount` | number | Number of customer needs | | ↳ `approximateNeedCount` | number | Number of customer needs |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | | ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_list_customers` ### `linear_list_customers`
@@ -1200,16 +1353,18 @@ List all customers in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `customers` | array | Array of customers | | `customers` | array | Array of customers |
| ↳ `id` | string | Customer ID | | ↳ `id` | string | Customer ID |
| ↳ `name` | string | Customer name | | ↳ `name` | string | Customer name |
| ↳ `domains` | array | Associated domains | | ↳ `domains` | array | Associated domains |
| ↳ `externalIds` | array | External IDs | | ↳ `externalIds` | array | External IDs from other systems |
| ↳ `logoUrl` | string | Logo URL | | ↳ `logoUrl` | string | Logo URL |
| ↳ `approximateNeedCount` | number | Number of customer needs | | ↳ `approximateNeedCount` | number | Number of customer needs |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | | ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
| `pageInfo` | object | Pagination information |
### `linear_create_customer_request` ### `linear_create_customer_request`
@@ -1230,17 +1385,17 @@ Create a customer request (need) in Linear. Assign to customer, set urgency (pri
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customerNeed` | object | The created customer request | | `customerNeed` | object | The created customer request |
| ↳ `id` | string | Customer request ID | | ↳ `id` | string | Customer request ID |
| ↳ `body` | string | Request description | | ↳ `body` | string | Request description |
| ↳ `priority` | number | Urgency level \(0 = Not important, 1 = Important\) | | ↳ `priority` | number | Urgency level \(0 = Not important, 1 = Important\) |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `updatedAt` | string | Last update timestamp | | ↳ `updatedAt` | string | Last update timestamp |
| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | | ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) |
| ↳ `customer` | object | Assigned customer | | ↳ `customer` | object | Assigned customer |
| ↳ `issue` | object | Linked issue \(null if not linked\) | | ↳ `issue` | object | Linked issue \(null if not linked\) |
| ↳ `project` | object | Linked project \(null if not linked\) | | ↳ `project` | object | Linked project \(null if not linked\) |
| ↳ `creator` | object | User who created the request | | ↳ `creator` | object | User who created the request |
| ↳ `url` | string | URL to the customer request | | ↳ `url` | string | URL to the customer request |
### `linear_update_customer_request` ### `linear_update_customer_request`
@@ -1262,17 +1417,17 @@ Update a customer request (need) in Linear. Can change urgency, description, cus
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customerNeed` | object | The updated customer request | | `customerNeed` | object | The updated customer request |
| ↳ `id` | string | Customer request ID | | ↳ `id` | string | Customer request ID |
| ↳ `body` | string | Request description | | ↳ `body` | string | Request description |
| ↳ `priority` | number | Urgency level \(0 = Not important, 1 = Important\) | | ↳ `priority` | number | Urgency level \(0 = Not important, 1 = Important\) |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `updatedAt` | string | Last update timestamp | | ↳ `updatedAt` | string | Last update timestamp |
| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | | ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) |
| ↳ `customer` | object | Assigned customer | | ↳ `customer` | object | Assigned customer |
| ↳ `issue` | object | Linked issue \(null if not linked\) | | ↳ `issue` | object | Linked issue \(null if not linked\) |
| ↳ `project` | object | Linked project \(null if not linked\) | | ↳ `project` | object | Linked project \(null if not linked\) |
| ↳ `creator` | object | User who created the request | | ↳ `creator` | object | User who created the request |
| ↳ `url` | string | URL to the customer request | | ↳ `url` | string | URL to the customer request |
### `linear_list_customer_requests` ### `linear_list_customer_requests`
@@ -1319,14 +1474,14 @@ Get a single customer by ID in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customer` | object | The customer data | | `customer` | object | The customer data |
| ↳ `id` | string | Customer ID | | ↳ `id` | string | Customer ID |
| ↳ `name` | string | Customer name | | ↳ `name` | string | Customer name |
| ↳ `domains` | array | Associated domains | | ↳ `domains` | array | Associated domains |
| ↳ `externalIds` | array | External IDs | | ↳ `externalIds` | array | External IDs from other systems |
| ↳ `logoUrl` | string | Logo URL | | ↳ `logoUrl` | string | Logo URL |
| ↳ `approximateNeedCount` | number | Number of customer needs | | ↳ `approximateNeedCount` | number | Number of customer needs |
| ↳ `createdAt` | string | Creation timestamp | | ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | | ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_update_customer` ### `linear_update_customer`
@@ -1352,6 +1507,14 @@ Update a customer in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customer` | object | The updated customer | | `customer` | object | The updated customer |
| ↳ `id` | string | Customer ID |
| ↳ `name` | string | Customer name |
| ↳ `domains` | array | Associated domains |
| ↳ `externalIds` | array | External IDs from other systems |
| ↳ `logoUrl` | string | Logo URL |
| ↳ `approximateNeedCount` | number | Number of customer needs |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_delete_customer` ### `linear_delete_customer`
@@ -1405,6 +1568,14 @@ Create a new customer status in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customerStatus` | object | The created customer status | | `customerStatus` | object | The created customer status |
| ↳ `id` | string | Customer status ID |
| ↳ `name` | string | Status name |
| ↳ `displayName` | string | Display name |
| ↳ `description` | string | Status description |
| ↳ `color` | string | Status color \(hex\) |
| ↳ `position` | number | Position in list |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_update_customer_status` ### `linear_update_customer_status`
@@ -1457,6 +1628,14 @@ List all customer statuses in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customerStatuses` | array | List of customer statuses | | `customerStatuses` | array | List of customer statuses |
| ↳ `id` | string | Customer status ID |
| ↳ `name` | string | Status name |
| ↳ `displayName` | string | Display name |
| ↳ `description` | string | Status description |
| ↳ `color` | string | Status color \(hex\) |
| ↳ `position` | number | Position in list |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_create_customer_tier` ### `linear_create_customer_tier`
@@ -1477,6 +1656,14 @@ Create a new customer tier in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customerTier` | object | The created customer tier | | `customerTier` | object | The created customer tier |
| ↳ `id` | string | Customer tier ID |
| ↳ `name` | string | Tier name |
| ↳ `displayName` | string | Display name |
| ↳ `description` | string | Tier description |
| ↳ `color` | string | Tier color \(hex\) |
| ↳ `position` | number | Position in list |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_update_customer_tier` ### `linear_update_customer_tier`
@@ -1529,6 +1716,14 @@ List all customer tiers in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customerTiers` | array | List of customer tiers | | `customerTiers` | array | List of customer tiers |
| ↳ `id` | string | Customer tier ID |
| ↳ `name` | string | Tier name |
| ↳ `displayName` | string | Display name |
| ↳ `description` | string | Tier description |
| ↳ `color` | string | Tier color \(hex\) |
| ↳ `position` | number | Position in list |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_delete_project` ### `linear_delete_project`

View File

@@ -72,9 +72,9 @@ Retrieve a list of audiences (lists) from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the audiences were successfully retrieved | | `success` | boolean | Whether the audiences were successfully retrieved |
| `output` | object | Audiences data | | `output` | object | Audiences data |
| ↳ `lists` | json | Array of audience/list objects | | ↳ `lists` | json | Array of audience/list objects |
| ↳ `total_items` | number | Total number of lists | | ↳ `total_items` | number | Total number of lists |
| ↳ `total_returned` | number | Number of lists returned in this response | | ↳ `total_returned` | number | Number of lists returned in this response |
### `mailchimp_get_audience` ### `mailchimp_get_audience`
@@ -93,8 +93,8 @@ Retrieve details of a specific audience (list) from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the audience was successfully retrieved | | `success` | boolean | Whether the audience was successfully retrieved |
| `output` | object | Audience data | | `output` | object | Audience data |
| ↳ `list` | json | Audience/list object | | ↳ `list` | json | Audience/list object |
| ↳ `list_id` | string | The unique ID of the audience | | ↳ `list_id` | string | The unique ID of the audience |
### `mailchimp_create_audience` ### `mailchimp_create_audience`
@@ -117,9 +117,9 @@ Create a new audience (list) in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created audience data | | `output` | object | Created audience data |
| ↳ `list` | json | Created audience/list object | | ↳ `list` | json | Created audience/list object |
| ↳ `list_id` | string | Created audience/list ID | | ↳ `list_id` | string | Created audience/list ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_update_audience` ### `mailchimp_update_audience`
@@ -142,9 +142,9 @@ Update an existing audience (list) in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated audience data | | `output` | object | Updated audience data |
| ↳ `list` | object | Updated audience/list object | | ↳ `list` | object | Updated audience/list object |
| ↳ `list_id` | string | List ID | | ↳ `list_id` | string | List ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_delete_audience` ### `mailchimp_delete_audience`
@@ -183,9 +183,9 @@ Retrieve a list of members from a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the members were successfully retrieved | | `success` | boolean | Whether the members were successfully retrieved |
| `output` | object | Members data | | `output` | object | Members data |
| ↳ `members` | json | Array of member objects | | ↳ `members` | json | Array of member objects |
| ↳ `total_items` | number | Total number of members | | ↳ `total_items` | number | Total number of members |
| ↳ `total_returned` | number | Number of members returned in this response | | ↳ `total_returned` | number | Number of members returned in this response |
### `mailchimp_get_member` ### `mailchimp_get_member`
@@ -205,8 +205,8 @@ Retrieve details of a specific member from a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the member was successfully retrieved | | `success` | boolean | Whether the member was successfully retrieved |
| `output` | object | Member data | | `output` | object | Member data |
| ↳ `member` | json | Member object | | ↳ `member` | json | Member object |
| ↳ `subscriber_hash` | string | The MD5 hash of the member email address | | ↳ `subscriber_hash` | string | The MD5 hash of the member email address |
### `mailchimp_add_member` ### `mailchimp_add_member`
@@ -229,9 +229,9 @@ Add a new member to a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Added member data | | `output` | object | Added member data |
| ↳ `member` | json | Added member object | | ↳ `member` | json | Added member object |
| ↳ `subscriber_hash` | string | Subscriber hash ID | | ↳ `subscriber_hash` | string | Subscriber hash ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_add_or_update_member` ### `mailchimp_add_or_update_member`
@@ -255,9 +255,9 @@ Add a new member or update an existing member in a Mailchimp audience (upsert)
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Member data | | `output` | object | Member data |
| ↳ `member` | json | Member object | | ↳ `member` | json | Member object |
| ↳ `subscriber_hash` | string | Subscriber hash ID | | ↳ `subscriber_hash` | string | Subscriber hash ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_update_member` ### `mailchimp_update_member`
@@ -281,9 +281,9 @@ Update an existing member in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated member data | | `output` | object | Updated member data |
| ↳ `member` | object | Updated member object | | ↳ `member` | object | Updated member object |
| ↳ `subscriber_hash` | string | Subscriber hash | | ↳ `subscriber_hash` | string | Subscriber hash |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_delete_member` ### `mailchimp_delete_member`
@@ -321,7 +321,7 @@ Permanently archive (delete) a member from a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Archive confirmation | | `output` | object | Archive confirmation |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_unarchive_member` ### `mailchimp_unarchive_member`
@@ -343,9 +343,9 @@ Restore an archived member to a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Unarchived member data | | `output` | object | Unarchived member data |
| ↳ `member` | object | Unarchived member object | | ↳ `member` | object | Unarchived member object |
| ↳ `subscriber_hash` | string | Subscriber hash | | ↳ `subscriber_hash` | string | Subscriber hash |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_get_campaigns` ### `mailchimp_get_campaigns`
@@ -367,9 +367,9 @@ Retrieve a list of campaigns from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the campaigns were successfully retrieved | | `success` | boolean | Whether the campaigns were successfully retrieved |
| `output` | object | Campaigns data | | `output` | object | Campaigns data |
| ↳ `campaigns` | json | Array of campaign objects | | ↳ `campaigns` | json | Array of campaign objects |
| ↳ `total_items` | number | Total number of campaigns | | ↳ `total_items` | number | Total number of campaigns |
| ↳ `total_returned` | number | Number of campaigns returned in this response | | ↳ `total_returned` | number | Number of campaigns returned in this response |
### `mailchimp_get_campaign` ### `mailchimp_get_campaign`
@@ -388,8 +388,8 @@ Retrieve details of a specific campaign from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the campaign was successfully retrieved | | `success` | boolean | Whether the campaign was successfully retrieved |
| `output` | object | Campaign data | | `output` | object | Campaign data |
| ↳ `campaign` | json | Campaign object | | ↳ `campaign` | json | Campaign object |
| ↳ `campaign_id` | string | The unique ID of the campaign | | ↳ `campaign_id` | string | The unique ID of the campaign |
### `mailchimp_create_campaign` ### `mailchimp_create_campaign`
@@ -410,9 +410,9 @@ Create a new campaign in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created campaign data | | `output` | object | Created campaign data |
| ↳ `campaign` | json | Created campaign object | | ↳ `campaign` | json | Created campaign object |
| ↳ `campaign_id` | string | Created campaign ID | | ↳ `campaign_id` | string | Created campaign ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_update_campaign` ### `mailchimp_update_campaign`
@@ -433,9 +433,9 @@ Update an existing campaign in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated campaign data | | `output` | object | Updated campaign data |
| ↳ `campaign` | object | Updated campaign object | | ↳ `campaign` | object | Updated campaign object |
| ↳ `campaign_id` | string | Campaign ID | | ↳ `campaign_id` | string | Campaign ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_delete_campaign` ### `mailchimp_delete_campaign`
@@ -471,7 +471,7 @@ Send a Mailchimp campaign
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Send confirmation | | `output` | object | Send confirmation |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_schedule_campaign` ### `mailchimp_schedule_campaign`
@@ -508,7 +508,7 @@ Unschedule a previously scheduled Mailchimp campaign
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Unschedule confirmation | | `output` | object | Unschedule confirmation |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_replicate_campaign` ### `mailchimp_replicate_campaign`
@@ -527,9 +527,9 @@ Create a copy of an existing Mailchimp campaign
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Replicated campaign data | | `output` | object | Replicated campaign data |
| ↳ `campaign` | object | Replicated campaign object | | ↳ `campaign` | object | Replicated campaign object |
| ↳ `campaign_id` | string | Campaign ID | | ↳ `campaign_id` | string | Campaign ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_get_campaign_content` ### `mailchimp_get_campaign_content`
@@ -548,7 +548,7 @@ Retrieve the HTML and plain-text content for a Mailchimp campaign
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the campaign content was successfully retrieved | | `success` | boolean | Whether the campaign content was successfully retrieved |
| `output` | object | Campaign content data | | `output` | object | Campaign content data |
| ↳ `content` | json | Campaign content object | | ↳ `content` | json | Campaign content object |
### `mailchimp_set_campaign_content` ### `mailchimp_set_campaign_content`
@@ -570,8 +570,8 @@ Set the content for a Mailchimp campaign
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Campaign content data | | `output` | object | Campaign content data |
| ↳ `content` | object | Campaign content object | | ↳ `content` | object | Campaign content object |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_get_automations` ### `mailchimp_get_automations`
@@ -591,9 +591,9 @@ Retrieve a list of automations from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the automations were successfully retrieved | | `success` | boolean | Whether the automations were successfully retrieved |
| `output` | object | Automations data | | `output` | object | Automations data |
| ↳ `automations` | json | Array of automation objects | | ↳ `automations` | json | Array of automation objects |
| ↳ `total_items` | number | Total number of automations | | ↳ `total_items` | number | Total number of automations |
| ↳ `total_returned` | number | Number of automations returned in this response | | ↳ `total_returned` | number | Number of automations returned in this response |
### `mailchimp_get_automation` ### `mailchimp_get_automation`
@@ -612,8 +612,8 @@ Retrieve details of a specific automation from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the automation was successfully retrieved | | `success` | boolean | Whether the automation was successfully retrieved |
| `output` | object | Automation data | | `output` | object | Automation data |
| ↳ `automation` | json | Automation object | | ↳ `automation` | json | Automation object |
| ↳ `workflow_id` | string | The unique ID of the automation workflow | | ↳ `workflow_id` | string | The unique ID of the automation workflow |
### `mailchimp_start_automation` ### `mailchimp_start_automation`
@@ -632,7 +632,7 @@ Start all emails in a Mailchimp automation workflow
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Start confirmation | | `output` | object | Start confirmation |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_pause_automation` ### `mailchimp_pause_automation`
@@ -651,7 +651,7 @@ Pause all emails in a Mailchimp automation workflow
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Pause confirmation | | `output` | object | Pause confirmation |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_add_subscriber_to_automation` ### `mailchimp_add_subscriber_to_automation`
@@ -672,8 +672,8 @@ Manually add a subscriber to a workflow email queue
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Subscriber queue data | | `output` | object | Subscriber queue data |
| ↳ `subscriber` | json | Subscriber object | | ↳ `subscriber` | json | Subscriber object |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_get_templates` ### `mailchimp_get_templates`
@@ -693,9 +693,9 @@ Retrieve a list of templates from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the templates were successfully retrieved | | `success` | boolean | Whether the templates were successfully retrieved |
| `output` | object | Templates data | | `output` | object | Templates data |
| ↳ `templates` | json | Array of template objects | | ↳ `templates` | json | Array of template objects |
| ↳ `total_items` | number | Total number of templates | | ↳ `total_items` | number | Total number of templates |
| ↳ `total_returned` | number | Number of templates returned in this response | | ↳ `total_returned` | number | Number of templates returned in this response |
### `mailchimp_get_template` ### `mailchimp_get_template`
@@ -714,8 +714,8 @@ Retrieve details of a specific template from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the template was successfully retrieved | | `success` | boolean | Whether the template was successfully retrieved |
| `output` | object | Template data | | `output` | object | Template data |
| ↳ `template` | json | Template object | | ↳ `template` | json | Template object |
| ↳ `template_id` | string | The unique ID of the template | | ↳ `template_id` | string | The unique ID of the template |
### `mailchimp_create_template` ### `mailchimp_create_template`
@@ -735,9 +735,9 @@ Create a new template in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created template data | | `output` | object | Created template data |
| ↳ `template` | json | Created template object | | ↳ `template` | json | Created template object |
| ↳ `template_id` | string | Created template ID | | ↳ `template_id` | string | Created template ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_update_template` ### `mailchimp_update_template`
@@ -758,9 +758,9 @@ Update an existing template in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated template data | | `output` | object | Updated template data |
| ↳ `template` | object | Updated template object | | ↳ `template` | object | Updated template object |
| ↳ `template_id` | string | Template ID | | ↳ `template_id` | string | Template ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_delete_template` ### `mailchimp_delete_template`
@@ -797,9 +797,9 @@ Retrieve a list of campaign reports from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the campaign reports were successfully retrieved | | `success` | boolean | Whether the campaign reports were successfully retrieved |
| `output` | object | Campaign reports data | | `output` | object | Campaign reports data |
| ↳ `reports` | json | Array of campaign report objects | | ↳ `reports` | json | Array of campaign report objects |
| ↳ `total_items` | number | Total number of reports | | ↳ `total_items` | number | Total number of reports |
| ↳ `total_returned` | number | Number of reports returned in this response | | ↳ `total_returned` | number | Number of reports returned in this response |
### `mailchimp_get_campaign_report` ### `mailchimp_get_campaign_report`
@@ -818,8 +818,8 @@ Retrieve the report for a specific campaign from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the campaign report was successfully retrieved | | `success` | boolean | Whether the campaign report was successfully retrieved |
| `output` | object | Campaign report data | | `output` | object | Campaign report data |
| ↳ `report` | json | Campaign report object | | ↳ `report` | json | Campaign report object |
| ↳ `campaign_id` | string | The unique ID of the campaign | | ↳ `campaign_id` | string | The unique ID of the campaign |
### `mailchimp_get_segments` ### `mailchimp_get_segments`
@@ -840,9 +840,9 @@ Retrieve a list of segments from a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the segments were successfully retrieved | | `success` | boolean | Whether the segments were successfully retrieved |
| `output` | object | Segments data | | `output` | object | Segments data |
| ↳ `segments` | json | Array of segment objects | | ↳ `segments` | json | Array of segment objects |
| ↳ `total_items` | number | Total number of segments | | ↳ `total_items` | number | Total number of segments |
| ↳ `total_returned` | number | Number of segments returned in this response | | ↳ `total_returned` | number | Number of segments returned in this response |
### `mailchimp_get_segment` ### `mailchimp_get_segment`
@@ -862,8 +862,8 @@ Retrieve details of a specific segment from a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the segment was successfully retrieved | | `success` | boolean | Whether the segment was successfully retrieved |
| `output` | object | Segment data | | `output` | object | Segment data |
| ↳ `segment` | json | Segment object | | ↳ `segment` | json | Segment object |
| ↳ `segment_id` | string | The unique ID of the segment | | ↳ `segment_id` | string | The unique ID of the segment |
### `mailchimp_create_segment` ### `mailchimp_create_segment`
@@ -884,9 +884,9 @@ Create a new segment in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created segment data | | `output` | object | Created segment data |
| ↳ `segment` | json | Created segment object | | ↳ `segment` | json | Created segment object |
| ↳ `segment_id` | string | Created segment ID | | ↳ `segment_id` | string | Created segment ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_update_segment` ### `mailchimp_update_segment`
@@ -908,9 +908,9 @@ Update an existing segment in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated segment data | | `output` | object | Updated segment data |
| ↳ `segment` | object | Updated segment object | | ↳ `segment` | object | Updated segment object |
| ↳ `segment_id` | string | Segment ID | | ↳ `segment_id` | string | Segment ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_delete_segment` ### `mailchimp_delete_segment`
@@ -950,9 +950,9 @@ Retrieve members of a specific segment from a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the segment members were successfully retrieved | | `success` | boolean | Whether the segment members were successfully retrieved |
| `output` | object | Segment members data | | `output` | object | Segment members data |
| ↳ `members` | json | Array of member objects | | ↳ `members` | json | Array of member objects |
| ↳ `total_items` | number | Total number of members | | ↳ `total_items` | number | Total number of members |
| ↳ `total_returned` | number | Number of members returned in this response | | ↳ `total_returned` | number | Number of members returned in this response |
### `mailchimp_add_segment_member` ### `mailchimp_add_segment_member`
@@ -973,8 +973,8 @@ Add a member to a specific segment in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Added member data | | `output` | object | Added member data |
| ↳ `member` | json | Added member object | | ↳ `member` | json | Added member object |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_remove_segment_member` ### `mailchimp_remove_segment_member`
@@ -995,7 +995,7 @@ Remove a member from a specific segment in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Removal confirmation | | `output` | object | Removal confirmation |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_get_member_tags` ### `mailchimp_get_member_tags`
@@ -1015,9 +1015,9 @@ Retrieve tags associated with a member in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the member tags were successfully retrieved | | `success` | boolean | Whether the member tags were successfully retrieved |
| `output` | object | Member tags data | | `output` | object | Member tags data |
| ↳ `tags` | json | Array of tag objects | | ↳ `tags` | json | Array of tag objects |
| ↳ `total_items` | number | Total number of tags | | ↳ `total_items` | number | Total number of tags |
| ↳ `total_returned` | number | Number of tags returned in this response | | ↳ `total_returned` | number | Number of tags returned in this response |
### `mailchimp_add_member_tags` ### `mailchimp_add_member_tags`
@@ -1038,7 +1038,7 @@ Add tags to a member in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Tag addition confirmation | | `output` | object | Tag addition confirmation |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_remove_member_tags` ### `mailchimp_remove_member_tags`
@@ -1059,7 +1059,7 @@ Remove tags from a member in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Tag removal confirmation | | `output` | object | Tag removal confirmation |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_get_merge_fields` ### `mailchimp_get_merge_fields`
@@ -1080,9 +1080,9 @@ Retrieve a list of merge fields from a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the merge fields were successfully retrieved | | `success` | boolean | Whether the merge fields were successfully retrieved |
| `output` | object | Merge fields data | | `output` | object | Merge fields data |
| ↳ `mergeFields` | json | Array of merge field objects | | ↳ `mergeFields` | json | Array of merge field objects |
| ↳ `total_items` | number | Total number of merge fields | | ↳ `total_items` | number | Total number of merge fields |
| ↳ `total_returned` | number | Number of merge fields returned in this response | | ↳ `total_returned` | number | Number of merge fields returned in this response |
### `mailchimp_get_merge_field` ### `mailchimp_get_merge_field`
@@ -1102,8 +1102,8 @@ Retrieve details of a specific merge field from a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the merge field was successfully retrieved | | `success` | boolean | Whether the merge field was successfully retrieved |
| `output` | object | Merge field data | | `output` | object | Merge field data |
| ↳ `mergeField` | json | Merge field object | | ↳ `mergeField` | json | Merge field object |
| ↳ `merge_id` | string | The unique ID of the merge field | | ↳ `merge_id` | string | The unique ID of the merge field |
### `mailchimp_create_merge_field` ### `mailchimp_create_merge_field`
@@ -1124,9 +1124,9 @@ Create a new merge field in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created merge field data | | `output` | object | Created merge field data |
| ↳ `mergeField` | json | Created merge field object | | ↳ `mergeField` | json | Created merge field object |
| ↳ `merge_id` | string | Created merge field ID | | ↳ `merge_id` | string | Created merge field ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_update_merge_field` ### `mailchimp_update_merge_field`
@@ -1147,9 +1147,9 @@ Update an existing merge field in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated merge field data | | `output` | object | Updated merge field data |
| ↳ `mergeField` | object | Updated merge field object | | ↳ `mergeField` | object | Updated merge field object |
| ↳ `merge_id` | string | Merge field ID | | ↳ `merge_id` | string | Merge field ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_delete_merge_field` ### `mailchimp_delete_merge_field`
@@ -1188,9 +1188,9 @@ Retrieve a list of interest categories from a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the interest categories were successfully retrieved | | `success` | boolean | Whether the interest categories were successfully retrieved |
| `output` | object | Interest categories data | | `output` | object | Interest categories data |
| ↳ `categories` | json | Array of interest category objects | | ↳ `categories` | json | Array of interest category objects |
| ↳ `total_items` | number | Total number of categories | | ↳ `total_items` | number | Total number of categories |
| ↳ `total_returned` | number | Number of categories returned in this response | | ↳ `total_returned` | number | Number of categories returned in this response |
### `mailchimp_get_interest_category` ### `mailchimp_get_interest_category`
@@ -1210,8 +1210,8 @@ Retrieve details of a specific interest category from a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the interest category was successfully retrieved | | `success` | boolean | Whether the interest category was successfully retrieved |
| `output` | object | Interest category data | | `output` | object | Interest category data |
| ↳ `category` | json | Interest category object | | ↳ `category` | json | Interest category object |
| ↳ `interest_category_id` | string | The unique ID of the interest category | | ↳ `interest_category_id` | string | The unique ID of the interest category |
### `mailchimp_create_interest_category` ### `mailchimp_create_interest_category`
@@ -1232,9 +1232,9 @@ Create a new interest category in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created interest category data | | `output` | object | Created interest category data |
| ↳ `category` | json | Created interest category object | | ↳ `category` | json | Created interest category object |
| ↳ `interest_category_id` | string | Created interest category ID | | ↳ `interest_category_id` | string | Created interest category ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_update_interest_category` ### `mailchimp_update_interest_category`
@@ -1255,9 +1255,9 @@ Update an existing interest category in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated interest category data | | `output` | object | Updated interest category data |
| ↳ `category` | object | Updated interest category object | | ↳ `category` | object | Updated interest category object |
| ↳ `interest_category_id` | string | Interest category ID | | ↳ `interest_category_id` | string | Interest category ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_delete_interest_category` ### `mailchimp_delete_interest_category`
@@ -1297,9 +1297,9 @@ Retrieve a list of interests from an interest category in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the interests were successfully retrieved | | `success` | boolean | Whether the interests were successfully retrieved |
| `output` | object | Interests data | | `output` | object | Interests data |
| ↳ `interests` | json | Array of interest objects | | ↳ `interests` | json | Array of interest objects |
| ↳ `total_items` | number | Total number of interests | | ↳ `total_items` | number | Total number of interests |
| ↳ `total_returned` | number | Number of interests returned in this response | | ↳ `total_returned` | number | Number of interests returned in this response |
### `mailchimp_get_interest` ### `mailchimp_get_interest`
@@ -1320,8 +1320,8 @@ Retrieve details of a specific interest from an interest category in a Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the interest was successfully retrieved | | `success` | boolean | Whether the interest was successfully retrieved |
| `output` | object | Interest data | | `output` | object | Interest data |
| ↳ `interest` | json | Interest object | | ↳ `interest` | json | Interest object |
| ↳ `interest_id` | string | The unique ID of the interest | | ↳ `interest_id` | string | The unique ID of the interest |
### `mailchimp_create_interest` ### `mailchimp_create_interest`
@@ -1342,9 +1342,9 @@ Create a new interest in an interest category in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created interest data | | `output` | object | Created interest data |
| ↳ `interest` | json | Created interest object | | ↳ `interest` | json | Created interest object |
| ↳ `interest_id` | string | Created interest ID | | ↳ `interest_id` | string | Created interest ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_update_interest` ### `mailchimp_update_interest`
@@ -1366,9 +1366,9 @@ Update an existing interest in an interest category in a Mailchimp audience
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated interest data | | `output` | object | Updated interest data |
| ↳ `interest` | object | Updated interest object | | ↳ `interest` | object | Updated interest object |
| ↳ `interest_id` | string | Interest ID | | ↳ `interest_id` | string | Interest ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_delete_interest` ### `mailchimp_delete_interest`
@@ -1407,9 +1407,9 @@ Retrieve a list of landing pages from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the landing pages were successfully retrieved | | `success` | boolean | Whether the landing pages were successfully retrieved |
| `output` | object | Landing pages data | | `output` | object | Landing pages data |
| ↳ `landingPages` | json | Array of landing page objects | | ↳ `landingPages` | json | Array of landing page objects |
| ↳ `total_items` | number | Total number of landing pages | | ↳ `total_items` | number | Total number of landing pages |
| ↳ `total_returned` | number | Number of landing pages returned in this response | | ↳ `total_returned` | number | Number of landing pages returned in this response |
### `mailchimp_get_landing_page` ### `mailchimp_get_landing_page`
@@ -1428,8 +1428,8 @@ Retrieve details of a specific landing page from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the landing page was successfully retrieved | | `success` | boolean | Whether the landing page was successfully retrieved |
| `output` | object | Landing page data | | `output` | object | Landing page data |
| ↳ `landingPage` | json | Landing page object | | ↳ `landingPage` | json | Landing page object |
| ↳ `page_id` | string | The unique ID of the landing page | | ↳ `page_id` | string | The unique ID of the landing page |
### `mailchimp_create_landing_page` ### `mailchimp_create_landing_page`
@@ -1449,9 +1449,9 @@ Create a new landing page in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created landing page data | | `output` | object | Created landing page data |
| ↳ `landingPage` | json | Created landing page object | | ↳ `landingPage` | json | Created landing page object |
| ↳ `page_id` | string | Created landing page ID | | ↳ `page_id` | string | Created landing page ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_update_landing_page` ### `mailchimp_update_landing_page`
@@ -1471,9 +1471,9 @@ Update an existing landing page in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated landing page data | | `output` | object | Updated landing page data |
| ↳ `landingPage` | object | Updated landing page object | | ↳ `landingPage` | object | Updated landing page object |
| ↳ `page_id` | string | Landing page ID | | ↳ `page_id` | string | Landing page ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_delete_landing_page` ### `mailchimp_delete_landing_page`
@@ -1509,7 +1509,7 @@ Publish a landing page in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Publish confirmation | | `output` | object | Publish confirmation |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_unpublish_landing_page` ### `mailchimp_unpublish_landing_page`
@@ -1528,7 +1528,7 @@ Unpublish a landing page in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Unpublish confirmation | | `output` | object | Unpublish confirmation |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_get_batch_operations` ### `mailchimp_get_batch_operations`
@@ -1548,9 +1548,9 @@ Retrieve a list of batch operations from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the batch operations were successfully retrieved | | `success` | boolean | Whether the batch operations were successfully retrieved |
| `output` | object | Batch operations data | | `output` | object | Batch operations data |
| ↳ `batches` | json | Array of batch operation objects | | ↳ `batches` | json | Array of batch operation objects |
| ↳ `total_items` | number | Total number of batch operations | | ↳ `total_items` | number | Total number of batch operations |
| ↳ `total_returned` | number | Number of batch operations returned in this response | | ↳ `total_returned` | number | Number of batch operations returned in this response |
### `mailchimp_get_batch_operation` ### `mailchimp_get_batch_operation`
@@ -1569,8 +1569,8 @@ Retrieve details of a specific batch operation from Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the batch operation was successfully retrieved | | `success` | boolean | Whether the batch operation was successfully retrieved |
| `output` | object | Batch operation data | | `output` | object | Batch operation data |
| ↳ `batch` | json | Batch operation object | | ↳ `batch` | json | Batch operation object |
| ↳ `batch_id` | string | The unique ID of the batch operation | | ↳ `batch_id` | string | The unique ID of the batch operation |
### `mailchimp_create_batch_operation` ### `mailchimp_create_batch_operation`
@@ -1589,9 +1589,9 @@ Create a new batch operation in Mailchimp
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created batch operation data | | `output` | object | Created batch operation data |
| ↳ `batch` | json | Created batch operation object | | ↳ `batch` | json | Created batch operation object |
| ↳ `batch_id` | string | Created batch operation ID | | ↳ `batch_id` | string | Created batch operation ID |
| ↳ `success` | boolean | Operation success | | ↳ `success` | boolean | Operation success |
### `mailchimp_delete_batch_operation` ### `mailchimp_delete_batch_operation`

View File

@@ -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`
@@ -70,7 +74,19 @@ Search for memories in Mem0 using semantic search
| 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`
@@ -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 |

View File

@@ -9,9 +9,11 @@
"arxiv", "arxiv",
"asana", "asana",
"browser_use", "browser_use",
"calcom",
"calendly", "calendly",
"circleback", "circleback",
"clay", "clay",
"clerk",
"confluence", "confluence",
"cursor", "cursor",
"datadog", "datadog",
@@ -95,9 +97,9 @@
"sftp", "sftp",
"sharepoint", "sharepoint",
"shopify", "shopify",
"similarweb",
"slack", "slack",
"smtp", "smtp",
"spotify",
"sqs", "sqs",
"ssh", "ssh",
"stagehand", "stagehand",

View File

@@ -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`
@@ -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 |

View File

@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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 |

View File

@@ -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`

View File

@@ -58,33 +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\) |
| ↳ `id` | string | Image identifier \(e.g., img-0.jpeg\) |
| ↳ `top_left_x` | number | Top-left X coordinate in pixels |
| ↳ `top_left_y` | number | Top-left Y coordinate in pixels |
| ↳ `bottom_right_x` | number | Bottom-right X coordinate in pixels |
| ↳ `bottom_right_y` | number | Bottom-right Y coordinate in pixels |
| ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) |
| ↳ `dimensions` | object | Page dimensions | | ↳ `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 |
| ↳ `dpi` | number | Dots per inch |
| ↳ `height` | number | Page height in pixels |
| ↳ `width` | number | Page width in pixels |
| ↳ `tables` | array | Extracted tables as HTML/markdown \(when table_format is set\). Referenced via placeholders like \[tbl-0.html\] | | ↳ `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\) |

View File

@@ -32,11 +32,11 @@ Read content from a Notion page
| 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`
@@ -52,12 +52,12 @@ Read database information and structure from Notion
| 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`
@@ -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`
@@ -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`
@@ -140,14 +170,31 @@ Search across all pages and databases in Notion workspace
| 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 |

View File

@@ -54,12 +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 |
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
| ↳ `total_tokens` | number | Total number of tokens used |

View File

@@ -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`

View File

@@ -109,12 +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 |
| ↳ `url` | string | Source URL |
| ↳ `title` | string | Source title |
| ↳ `excerpts` | array | Relevant excerpts from the source |
| ↳ `confidence` | string | Confidence level indicator | | ↳ `confidence` | string | Confidence level indicator |

View File

@@ -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`
@@ -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 |

View File

@@ -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`
@@ -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 |

View File

@@ -55,7 +55,25 @@ Retrieve all deals from Pipedrive with optional filters
| 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`
@@ -140,6 +158,16 @@ Retrieve files from Pipedrive with optional filters
| 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 |
@@ -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 |
@@ -283,6 +319,19 @@ Retrieve activities (tasks) from Pipedrive with optional filters
| 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 |
@@ -354,7 +403,33 @@ Retrieve all leads or a specific lead from Pipedrive
| 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 |

View File

@@ -29,7 +29,7 @@ By using these documented API endpoints, you can seamlessly integrate Polymarket
## Usage Instructions ## Usage Instructions
Integrate Polymarket prediction markets into the workflow. Can get markets, market, events, event, tags, series, orderbook, price, midpoint, price history, last trade price, spread, tick size, positions, trades, and search. Integrate Polymarket prediction markets into the workflow. Can get markets, market, events, event, tags, series, orderbook, price, midpoint, price history, last trade price, spread, tick size, positions, trades, activity, leaderboard, holders, and search.
@@ -43,7 +43,7 @@ Retrieve a list of prediction markets from Polymarket with optional filtering
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `closed` | string | No | Filter by closed status \(true/false\). Use false for active markets only. | | `closed` | string | No | Filter by closed status \(true/false\). Use false for open markets only. |
| `order` | string | No | Sort field \(e.g., volumeNum, liquidityNum, startDate, endDate, createdAt\) | | `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 |
@@ -55,6 +55,21 @@ Retrieve a list of prediction markets from Polymarket with optional filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `markets` | array | Array of market objects | | `markets` | array | Array of market objects |
| ↳ `id` | string | Market ID |
| ↳ `question` | string | Market question |
| ↳ `conditionId` | string | Condition ID |
| ↳ `slug` | string | Market slug |
| ↳ `endDate` | string | End date |
| ↳ `image` | string | Market image URL |
| ↳ `outcomes` | string | Outcomes JSON string |
| ↳ `outcomePrices` | string | Outcome prices JSON string |
| ↳ `volume` | string | Total volume |
| ↳ `liquidity` | string | Total liquidity |
| ↳ `active` | boolean | Whether market is active |
| ↳ `closed` | boolean | Whether market is closed |
| ↳ `volumeNum` | number | Volume as number |
| ↳ `liquidityNum` | number | Liquidity as number |
| ↳ `clobTokenIds` | array | CLOB token IDs |
### `polymarket_get_market` ### `polymarket_get_market`
@@ -72,6 +87,28 @@ Retrieve details of a specific prediction market by ID or slug
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `market` | object | Market object with details | | `market` | object | Market object with details |
| ↳ `id` | string | Market ID |
| ↳ `question` | string | Market question |
| ↳ `conditionId` | string | Condition ID |
| ↳ `slug` | string | Market slug |
| ↳ `resolutionSource` | string | Resolution source |
| ↳ `endDate` | string | End date |
| ↳ `startDate` | string | Start date |
| ↳ `image` | string | Market image URL |
| ↳ `icon` | string | Market icon URL |
| ↳ `description` | string | Market description |
| ↳ `outcomes` | string | Outcomes JSON string |
| ↳ `outcomePrices` | string | Outcome prices JSON string |
| ↳ `volume` | string | Total volume |
| ↳ `liquidity` | string | Total liquidity |
| ↳ `active` | boolean | Whether market is active |
| ↳ `closed` | boolean | Whether market is closed |
| ↳ `archived` | boolean | Whether market is archived |
| ↳ `volumeNum` | number | Volume as number |
| ↳ `liquidityNum` | number | Liquidity as number |
| ↳ `clobTokenIds` | array | CLOB token IDs |
| ↳ `acceptingOrders` | boolean | Whether accepting orders |
| ↳ `negRisk` | boolean | Whether negative risk |
### `polymarket_get_events` ### `polymarket_get_events`
@@ -81,7 +118,7 @@ Retrieve a list of events from Polymarket with optional filtering
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `closed` | string | No | Filter by closed status \(true/false\). Use false for active events only. | | `closed` | string | No | Filter by closed status \(true/false\). Use false for open events only. |
| `order` | string | No | Sort field \(e.g., volume, liquidity, startDate, endDate, createdAt\) | | `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 |
@@ -93,6 +130,21 @@ Retrieve a list of events from Polymarket with optional filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `events` | array | Array of event objects | | `events` | array | Array of event objects |
| ↳ `id` | string | Event ID |
| ↳ `ticker` | string | Event ticker |
| ↳ `slug` | string | Event slug |
| ↳ `title` | string | Event title |
| ↳ `description` | string | Event description |
| ↳ `startDate` | string | Start date |
| ↳ `endDate` | string | End date |
| ↳ `image` | string | Event image URL |
| ↳ `icon` | string | Event icon URL |
| ↳ `active` | boolean | Whether event is active |
| ↳ `closed` | boolean | Whether event is closed |
| ↳ `archived` | boolean | Whether event is archived |
| ↳ `liquidity` | number | Total liquidity |
| ↳ `volume` | number | Total volume |
| ↳ `markets` | array | Array of markets in this event |
### `polymarket_get_event` ### `polymarket_get_event`
@@ -110,6 +162,24 @@ Retrieve details of a specific event by ID or slug
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `event` | object | Event object with details | | `event` | object | Event object with details |
| ↳ `id` | string | Event ID |
| ↳ `ticker` | string | Event ticker |
| ↳ `slug` | string | Event slug |
| ↳ `title` | string | Event title |
| ↳ `description` | string | Event description |
| ↳ `startDate` | string | Start date |
| ↳ `creationDate` | string | Creation date |
| ↳ `endDate` | string | End date |
| ↳ `image` | string | Event image URL |
| ↳ `icon` | string | Event icon URL |
| ↳ `active` | boolean | Whether event is active |
| ↳ `closed` | boolean | Whether event is closed |
| ↳ `archived` | boolean | Whether event is archived |
| ↳ `liquidity` | number | Total liquidity |
| ↳ `volume` | number | Total volume |
| ↳ `openInterest` | number | Open interest |
| ↳ `commentCount` | number | Comment count |
| ↳ `markets` | array | Array of markets in this event |
### `polymarket_get_tags` ### `polymarket_get_tags`
@@ -126,7 +196,12 @@ Retrieve available tags for filtering markets from Polymarket
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `tags` | array | Array of tag objects with id, label, and slug | | `tags` | array | Array of tag objects |
| ↳ `id` | string | Tag ID |
| ↳ `label` | string | Tag label |
| ↳ `slug` | string | Tag slug |
| ↳ `createdAt` | string | Creation timestamp |
| ↳ `updatedAt` | string | Last update timestamp |
### `polymarket_search` ### `polymarket_search`
@@ -138,13 +213,28 @@ Search for markets, events, and profiles on Polymarket
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Search query term | | `query` | string | Yes | Search query term |
| `limit` | string | No | Number of results per page \(max 50\) | | `limit` | string | No | Number of results per page \(max 50\) |
| `offset` | string | No | Pagination offset | | `page` | string | No | Page number for pagination \(1-indexed\) |
| `cache` | string | No | Enable caching \(true/false\) |
| `eventsStatus` | string | No | Filter events by status |
| `limitPerType` | string | No | Limit results per type \(markets, events, profiles\) |
| `eventsTag` | string | No | Filter by event tags \(comma-separated\) |
| `sort` | string | No | Sort field |
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
| `searchTags` | string | No | Include tags in search results \(true/false\) |
| `searchProfiles` | string | No | Include profiles in search results \(true/false\) |
| `recurrence` | string | No | Filter by recurrence type |
| `excludeTagId` | string | No | Exclude events with these tag IDs \(comma-separated\) |
| `keepClosedMarkets` | string | No | Include closed markets in results \(0 or 1\) |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `results` | object | Search results containing markets, events, and profiles arrays | | `results` | object | Search results containing markets, events, tags, and profiles arrays |
| ↳ `markets` | array | Array of matching market objects |
| ↳ `events` | array | Array of matching event objects |
| ↳ `tags` | array | Array of matching tag objects |
| ↳ `profiles` | array | Array of matching profile objects |
### `polymarket_get_series` ### `polymarket_get_series`
@@ -162,6 +252,21 @@ Retrieve series (related market groups) from Polymarket
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `series` | array | Array of series objects | | `series` | array | Array of series objects |
| ↳ `id` | string | Series ID |
| ↳ `ticker` | string | Series ticker |
| ↳ `slug` | string | Series slug |
| ↳ `title` | string | Series title |
| ↳ `seriesType` | string | Series type |
| ↳ `recurrence` | string | Recurrence pattern |
| ↳ `image` | string | Series image URL |
| ↳ `icon` | string | Series icon URL |
| ↳ `active` | boolean | Whether series is active |
| ↳ `closed` | boolean | Whether series is closed |
| ↳ `archived` | boolean | Whether series is archived |
| ↳ `featured` | boolean | Whether series is featured |
| ↳ `volume` | number | Total volume |
| ↳ `liquidity` | number | Total liquidity |
| ↳ `eventCount` | number | Number of events in series |
### `polymarket_get_series_by_id` ### `polymarket_get_series_by_id`
@@ -178,6 +283,23 @@ Retrieve a specific series (related market group) by ID from Polymarket
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `series` | object | Series object with details | | `series` | object | Series object with details |
| ↳ `id` | string | Series ID |
| ↳ `ticker` | string | Series ticker |
| ↳ `slug` | string | Series slug |
| ↳ `title` | string | Series title |
| ↳ `seriesType` | string | Series type |
| ↳ `recurrence` | string | Recurrence pattern |
| ↳ `image` | string | Series image URL |
| ↳ `icon` | string | Series icon URL |
| ↳ `active` | boolean | Whether series is active |
| ↳ `closed` | boolean | Whether series is closed |
| ↳ `archived` | boolean | Whether series is archived |
| ↳ `featured` | boolean | Whether series is featured |
| ↳ `volume` | number | Total volume |
| ↳ `liquidity` | number | Total liquidity |
| ↳ `commentCount` | number | Comment count |
| ↳ `eventCount` | number | Number of events in series |
| ↳ `events` | array | Array of events in this series |
### `polymarket_get_orderbook` ### `polymarket_get_orderbook`
@@ -194,6 +316,19 @@ Retrieve the order book summary for a specific token
| 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 |
| ↳ `asset_id` | string | Asset token ID |
| ↳ `hash` | string | Order book hash |
| ↳ `timestamp` | string | Timestamp |
| ↳ `bids` | array | Bid orders |
| ↳ `price` | string | Bid price |
| ↳ `size` | string | Bid size |
| ↳ `asks` | array | Ask orders |
| ↳ `price` | string | Ask price |
| ↳ `size` | string | Ask size |
| ↳ `min_order_size` | string | Minimum order size |
| ↳ `tick_size` | string | Tick size |
| ↳ `neg_risk` | boolean | Whether negative risk |
### `polymarket_get_price` ### `polymarket_get_price`
@@ -246,7 +381,9 @@ Retrieve historical price data for a specific market token
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `history` | array | Array of price history entries with timestamp \(t\) and price \(p\) | | `history` | array | Array of price history entries |
| ↳ `t` | number | Unix timestamp |
| ↳ `p` | number | Price at timestamp |
### `polymarket_get_last_trade_price` ### `polymarket_get_last_trade_price`
@@ -263,6 +400,7 @@ Retrieve the last trade price for a specific token
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `price` | string | Last trade price | | `price` | string | Last trade price |
| `side` | string | Side of the last trade \(BUY or SELL\) |
### `polymarket_get_spread` ### `polymarket_get_spread`
@@ -278,7 +416,8 @@ Retrieve the bid-ask spread for a specific token
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `spread` | object | Bid-ask spread with bid and ask prices | | `spread` | object | Spread value between bid and ask |
| ↳ `spread` | string | The spread value |
### `polymarket_get_tick_size` ### `polymarket_get_tick_size`
@@ -305,13 +444,47 @@ 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 | Optional market ID to filter positions | | `market` | string | No | Condition IDs to filter positions \(comma-separated, mutually exclusive with eventId\) |
| `eventId` | string | No | Event ID to filter positions \(mutually exclusive with market\) |
| `sizeThreshold` | string | No | Minimum position size threshold \(default: 1\) |
| `redeemable` | string | No | Filter for redeemable positions only \(true/false\) |
| `mergeable` | string | No | Filter for mergeable positions only \(true/false\) |
| `sortBy` | string | No | Sort field \(TOKENS, CURRENT, INITIAL, CASHPNL, PERCENTPNL, TITLE, RESOLVING, PRICE, AVGPRICE\) |
| `sortDirection` | string | No | Sort direction \(ASC or DESC\) |
| `title` | string | No | Search filter by title |
| `limit` | string | No | Number of results per page |
| `offset` | string | No | Pagination offset |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `positions` | array | Array of position objects | | `positions` | array | Array of position objects |
| ↳ `proxyWallet` | string | Proxy wallet address |
| ↳ `asset` | string | Asset token ID |
| ↳ `conditionId` | string | Condition ID |
| ↳ `size` | number | Position size |
| ↳ `avgPrice` | number | Average price |
| ↳ `initialValue` | number | Initial value |
| ↳ `currentValue` | number | Current value |
| ↳ `cashPnl` | number | Cash profit/loss |
| ↳ `percentPnl` | number | Percent profit/loss |
| ↳ `totalBought` | number | Total bought |
| ↳ `realizedPnl` | number | Realized profit/loss |
| ↳ `percentRealizedPnl` | number | Percent realized profit/loss |
| ↳ `curPrice` | number | Current price |
| ↳ `redeemable` | boolean | Whether position is redeemable |
| ↳ `mergeable` | boolean | Whether position is mergeable |
| ↳ `title` | string | Market title |
| ↳ `slug` | string | Market slug |
| ↳ `icon` | string | Market icon URL |
| ↳ `eventSlug` | string | Event slug |
| ↳ `outcome` | string | Outcome name |
| ↳ `outcomeIndex` | number | Outcome index |
| ↳ `oppositeOutcome` | string | Opposite outcome name |
| ↳ `oppositeAsset` | string | Opposite asset token ID |
| ↳ `endDate` | string | End date |
| ↳ `negativeRisk` | boolean | Whether negative risk |
### `polymarket_get_trades` ### `polymarket_get_trades`
@@ -322,8 +495,13 @@ 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 ID to filter trades | | `market` | string | No | Market/condition ID to filter trades \(mutually exclusive with eventId\) |
| `limit` | string | No | Number of results per page \(max 50\) | | `eventId` | string | No | Event ID to filter trades \(mutually exclusive with market\) |
| `side` | string | No | Trade direction filter \(BUY or SELL\) |
| `takerOnly` | string | No | Filter for taker trades only \(true/false, default: true\) |
| `filterType` | string | No | Filter type \(CASH or TOKENS\) - requires filterAmount |
| `filterAmount` | string | No | Filter amount threshold - requires filterType |
| `limit` | string | No | Number of results per page \(default: 100, max: 10000\) |
| `offset` | string | No | Pagination offset \(skip this many results\) | | `offset` | string | No | Pagination offset \(skip this many results\) |
#### Output #### Output
@@ -331,5 +509,131 @@ Retrieve trade history from Polymarket
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `trades` | array | Array of trade objects | | `trades` | array | Array of trade objects |
| ↳ `proxyWallet` | string | Proxy wallet address |
| ↳ `side` | string | Trade side \(BUY or SELL\) |
| ↳ `asset` | string | Asset token ID |
| ↳ `conditionId` | string | Condition ID |
| ↳ `size` | number | Trade size |
| ↳ `price` | number | Trade price |
| ↳ `timestamp` | number | Unix timestamp |
| ↳ `title` | string | Market title |
| ↳ `slug` | string | Market slug |
| ↳ `icon` | string | Market icon URL |
| ↳ `eventSlug` | string | Event slug |
| ↳ `outcome` | string | Outcome name |
| ↳ `outcomeIndex` | number | Outcome index |
| ↳ `name` | string | Trader name |
| ↳ `pseudonym` | string | Trader pseudonym |
| ↳ `bio` | string | Trader bio |
| ↳ `profileImage` | string | Profile image URL |
| ↳ `profileImageOptimized` | string | Optimized profile image URL |
| ↳ `transactionHash` | string | Transaction hash |
### `polymarket_get_activity`
Retrieve on-chain activity for a user including trades, splits, merges, redemptions, rewards, and conversions
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `user` | string | Yes | User wallet address \(0x-prefixed\) |
| `limit` | string | No | Maximum results \(default: 100, max: 500\) |
| `offset` | string | No | Pagination offset \(default: 0, max: 10000\) |
| `market` | string | No | Comma-separated condition IDs \(mutually exclusive with eventId\) |
| `eventId` | string | No | Comma-separated event IDs \(mutually exclusive with market\) |
| `type` | string | No | Activity type filter: TRADE, SPLIT, MERGE, REDEEM, REWARD, CONVERSION, MAKER_REBATE |
| `start` | number | No | Start timestamp \(Unix seconds\) |
| `end` | number | No | End timestamp \(Unix seconds\) |
| `sortBy` | string | No | Sort field: TIMESTAMP, TOKENS, or CASH \(default: TIMESTAMP\) |
| `sortDirection` | string | No | Sort direction: ASC or DESC \(default: DESC\) |
| `side` | string | No | Trade side filter: BUY or SELL \(only applies to trades\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `activity` | array | Array of activity entries |
| ↳ `proxyWallet` | string | User proxy wallet address |
| ↳ `timestamp` | number | Unix timestamp of activity |
| ↳ `conditionId` | string | Market condition ID |
| ↳ `type` | string | Activity type \(TRADE, SPLIT, MERGE, REDEEM, REWARD, CONVERSION\) |
| ↳ `size` | number | Size in tokens |
| ↳ `usdcSize` | number | Size in USDC |
| ↳ `transactionHash` | string | Blockchain transaction hash |
| ↳ `price` | number | Price \(for trades\) |
| ↳ `asset` | string | Asset/token ID |
| ↳ `side` | string | Trade side \(BUY/SELL\) |
| ↳ `outcomeIndex` | number | Outcome index |
| ↳ `title` | string | Market title |
| ↳ `slug` | string | Market slug |
| ↳ `icon` | string | Market icon URL |
| ↳ `eventSlug` | string | Event slug |
| ↳ `outcome` | string | Outcome name |
| ↳ `name` | string | User display name |
| ↳ `pseudonym` | string | User pseudonym |
| ↳ `bio` | string | User bio |
| ↳ `profileImage` | string | User profile image URL |
| ↳ `profileImageOptimized` | string | Optimized profile image URL |
### `polymarket_get_leaderboard`
Retrieve trader leaderboard rankings by profit/loss or volume
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `category` | string | No | Category filter: OVERALL, POLITICS, SPORTS, CRYPTO, CULTURE, MENTIONS, WEATHER, ECONOMICS, TECH, FINANCE \(default: OVERALL\) |
| `timePeriod` | string | No | Time period: DAY, WEEK, MONTH, ALL \(default: DAY\) |
| `orderBy` | string | No | Order by: PNL or VOL \(default: PNL\) |
| `limit` | string | No | Number of results \(1-50, default: 25\) |
| `offset` | string | No | Pagination offset \(0-1000, default: 0\) |
| `user` | string | No | Filter by specific user wallet address |
| `userName` | string | No | Filter by username |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `leaderboard` | array | Array of leaderboard entries |
| ↳ `rank` | string | Leaderboard rank position |
| ↳ `proxyWallet` | string | User proxy wallet address |
| ↳ `userName` | string | User display name |
| ↳ `vol` | number | Trading volume |
| ↳ `pnl` | number | Profit and loss |
| ↳ `profileImage` | string | User profile image URL |
| ↳ `xUsername` | string | Twitter/X username |
| ↳ `verifiedBadge` | boolean | Whether user has verified badge |
### `polymarket_get_holders`
Retrieve top holders of a specific market token
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `market` | string | Yes | Comma-separated list of condition IDs |
| `limit` | string | No | Number of holders to return \(0-20, default: 20\) |
| `minBalance` | string | No | Minimum balance threshold \(default: 1\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `holders` | array | Array of market holder groups by token |
| ↳ `token` | string | Token/asset ID |
| ↳ `holders` | array | Array of holders for this token |
| ↳ `proxyWallet` | string | Holder wallet address |
| ↳ `bio` | string | Holder bio |
| ↳ `asset` | string | Asset ID |
| ↳ `pseudonym` | string | Holder pseudonym |
| ↳ `amount` | number | Amount held |
| ↳ `displayUsernamePublic` | boolean | Whether username is publicly displayed |
| ↳ `outcomeIndex` | number | Outcome index |
| ↳ `name` | string | Holder display name |
| ↳ `profileImage` | string | Profile image URL |
| ↳ `profileImageOptimized` | string | Optimized profile image URL |

View File

@@ -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 |

View File

@@ -125,11 +125,11 @@ Get detailed information about a specific person in PostHog by their ID or UUID.
| 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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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`
@@ -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 |

View File

@@ -56,8 +56,10 @@ Insert or update points in a Qdrant collection
| 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`
@@ -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`
@@ -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 |

View File

@@ -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 |
@@ -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`
@@ -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`
@@ -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`

View File

@@ -53,20 +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 |
| ↳ `nextRecordsUrl` | string | URL for next page of results | | ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `totalSize` | number | Total number of records | | ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `done` | boolean | Whether all records returned | | ↳ `accounts` | array | Array of account objects |
| ↳ `metadata` | object | Response metadata | | ↳ `success` | boolean | Salesforce operation success |
| ↳ `totalReturned` | number | Number of accounts returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of accounts returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `success` | boolean | Salesforce operation success |
### `salesforce_create_account` ### `salesforce_create_account`
@@ -98,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`
@@ -133,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`
@@ -154,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`
@@ -178,22 +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 |
| ↳ `nextRecordsUrl` | string | URL for next page of results | | ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `totalSize` | number | Total number of records | | ↳ `contacts` | array | Array of contacts \(list query\) |
| ↳ `done` | boolean | Whether all records returned | | ↳ `contact` | object | Single contact \(by ID\) |
| ↳ `metadata` | object | Response metadata | | ↳ `singleContact` | boolean | Whether single contact was returned |
| ↳ `totalReturned` | number | Number of contacts returned | | ↳ `success` | boolean | Salesforce operation success |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of contacts returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `singleContact` | boolean | Whether single contact was returned |
| ↳ `success` | boolean | Salesforce operation success |
### `salesforce_create_contact` ### `salesforce_create_contact`
@@ -225,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`
@@ -260,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`
@@ -281,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`
@@ -305,22 +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 |
| ↳ `nextRecordsUrl` | string | URL for next page of results | | ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `totalSize` | number | Total number of records | | ↳ `lead` | object | Single lead object \(when leadId provided\) |
| ↳ `done` | boolean | Whether all records returned | | ↳ `leads` | array | Array of lead objects \(when listing\) |
| ↳ `metadata` | object | Response metadata | | ↳ `singleLead` | boolean | Whether single lead was returned |
| ↳ `totalReturned` | number | Number of leads returned | | ↳ `success` | boolean | Operation success status |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of leads returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `singleLead` | boolean | Whether single lead was returned |
| ↳ `success` | boolean | Operation success status |
### `salesforce_create_lead` ### `salesforce_create_lead`
@@ -348,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`
@@ -379,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`
@@ -400,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`
@@ -424,21 +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 |
| ↳ `nextRecordsUrl` | string | URL for next page of results | | ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `totalSize` | number | Total number of records | | ↳ `opportunity` | object | Single opportunity object \(when opportunityId provided\) |
| ↳ `done` | boolean | Whether all records returned | | ↳ `opportunities` | array | Array of opportunity objects \(when listing\) |
| ↳ `metadata` | object | Response metadata | | ↳ `success` | boolean | Operation success status |
| ↳ `totalReturned` | number | Number of opportunities returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of opportunities returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `success` | boolean | Operation success status |
### `salesforce_create_opportunity` ### `salesforce_create_opportunity`
@@ -464,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`
@@ -493,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`
@@ -514,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`
@@ -538,21 +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 |
| ↳ `nextRecordsUrl` | string | URL for next page of results | | ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `totalSize` | number | Total number of records | | ↳ `case` | object | Single case object \(when caseId provided\) |
| ↳ `done` | boolean | Whether all records returned | | ↳ `cases` | array | Array of case objects \(when listing\) |
| ↳ `metadata` | object | Response metadata | | ↳ `success` | boolean | Operation success status |
| ↳ `totalReturned` | number | Number of cases returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of cases returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `success` | boolean | Operation success status |
### `salesforce_create_case` ### `salesforce_create_case`
@@ -578,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`
@@ -604,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`
@@ -625,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`
@@ -649,21 +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 |
| ↳ `nextRecordsUrl` | string | URL for next page of results | | ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `totalSize` | number | Total number of records | | ↳ `task` | object | Single task object \(when taskId provided\) |
| ↳ `done` | boolean | Whether all records returned | | ↳ `tasks` | array | Array of task objects \(when listing\) |
| ↳ `metadata` | object | Response metadata | | ↳ `success` | boolean | Operation success status |
| ↳ `totalReturned` | number | Number of tasks returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of tasks returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `success` | boolean | Operation success status |
### `salesforce_create_task` ### `salesforce_create_task`
@@ -689,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`
@@ -716,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`
@@ -737,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`
@@ -759,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`
@@ -781,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`
@@ -805,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`
@@ -834,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`
@@ -856,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`
@@ -878,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`
@@ -904,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`
@@ -930,17 +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 |
| ↳ `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`
@@ -960,16 +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 |
| ↳ `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`
@@ -989,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`
@@ -1020,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 |

View File

@@ -68,7 +68,7 @@ List issues from Sentry for a specific organization and optionally a specific pr
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `issues` | array | List of Sentry issues | | `issues` | array | List of Sentry issues |
| ↳ `id` | string | User 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 |
@@ -78,27 +78,22 @@ List issues from Sentry for a specific organization and optionally a specific pr
| ↳ `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 | Project platform | | ↳ `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 |
| ↳ `name` | string | User name | | ↳ `type` | string | Issue type |
| ↳ `slug` | string | Project slug |
| ↳ `type` | string | Type of error \(e.g., TypeError\) |
| ↳ `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 |
| ↳ `value` | string | Error message or value |
| ↳ `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 |
| ↳ `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 |
@@ -110,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`
@@ -130,47 +125,42 @@ Retrieve detailed information about a specific Sentry issue by its ID. Returns c
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `issue` | object | Detailed information about the Sentry issue | | `issue` | object | Detailed information about the Sentry issue |
| ↳ `id` | string | User 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 | Project platform | | ↳ `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 |
| ↳ `name` | string | User name | | ↳ `type` | string | Issue type |
| ↳ `slug` | string | Project slug | | ↳ `metadata` | object | Error metadata |
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) | | ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
| ↳ `metadata` | object | Error metadata | | ↳ `value` | string | Error message or value |
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) | | ↳ `function` | string | Function where the error occurred |
| ↳ `value` | string | Error message or value | | ↳ `numComments` | number | Number of comments on the issue |
| ↳ `function` | string | Function where the error occurred | | ↳ `assignedTo` | object | User assigned to the issue \(if any\) |
| ↳ `value` | string | Error message or value | | ↳ `id` | string | User ID |
| ↳ `function` | string | Function where the error occurred | | ↳ `name` | string | User name |
| ↳ `numComments` | number | Number of comments on the issue | | ↳ `email` | string | User email |
| ↳ `assignedTo` | object | User assigned to the issue \(if any\) | | ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
| ↳ `id` | string | User ID | | ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates |
| ↳ `name` | string | User name | | ↳ `hasSeen` | boolean | Whether the user has seen this issue |
| ↳ `email` | string | User email | | ↳ `annotations` | array | Issue annotations |
| ↳ `email` | string | User email | | ↳ `isUnhandled` | boolean | Whether the issue is unhandled |
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked | | ↳ `count` | string | Total number of occurrences |
| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates | | ↳ `userCount` | number | Number of unique users affected |
| ↳ `hasSeen` | boolean | Whether the user has seen this issue | | ↳ `firstSeen` | string | When the issue was first seen \(ISO timestamp\) |
| ↳ `annotations` | array | Issue annotations | | ↳ `lastSeen` | string | When the issue was last seen \(ISO timestamp\) |
| ↳ `isUnhandled` | boolean | Whether the issue is unhandled | | ↳ `stats` | object | Statistical information about the issue |
| ↳ `count` | string | Total number of occurrences |
| ↳ `userCount` | number | Number of unique users affected |
| ↳ `firstSeen` | string | When the issue was first seen \(ISO timestamp\) |
| ↳ `lastSeen` | string | When the issue was last seen \(ISO timestamp\) |
| ↳ `stats` | object | Statistical information about the issue |
### `sentry_issues_update` ### `sentry_issues_update`
@@ -194,20 +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 | User 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 |
| ↳ `name` | string | User name | | ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
| ↳ `email` | string | User email | | ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates |
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked | | ↳ `isPublic` | boolean | Whether the issue is publicly visible |
| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates | | ↳ `permalink` | string | Direct link to the issue in Sentry |
| ↳ `isPublic` | boolean | Whether the issue is publicly visible |
| ↳ `permalink` | string | Direct link to the issue in Sentry |
### `sentry_projects_list` ### `sentry_projects_list`
@@ -227,27 +215,27 @@ List all projects in a Sentry organization. Returns project details including na
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `projects` | array | List of Sentry projects | | `projects` | array | List of Sentry projects |
| ↳ `id` | string | Team ID | | ↳ `id` | string | Unique project ID |
| ↳ `slug` | string | Team slug | | ↳ `slug` | string | URL-friendly project identifier |
| ↳ `name` | string | Team 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 |
| ↳ `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`
@@ -266,39 +254,39 @@ Retrieve detailed information about a specific Sentry project by its slug. Retur
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `project` | object | Detailed information about the Sentry project | | `project` | object | Detailed information about the Sentry project |
| ↳ `id` | string | Team ID | | ↳ `id` | string | Unique project ID |
| ↳ `slug` | string | Team slug | | ↳ `slug` | string | URL-friendly project identifier |
| ↳ `name` | string | Team 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`
@@ -321,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 | Team ID | | ↳ `id` | string | Unique project ID |
| ↳ `slug` | string | Team slug | | ↳ `slug` | string | URL-friendly project identifier |
| ↳ `name` | string | Team 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`
@@ -370,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 | Team ID | | ↳ `id` | string | Unique project ID |
| ↳ `slug` | string | Team slug | | ↳ `slug` | string | URL-friendly project identifier |
| ↳ `name` | string | Team 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`
@@ -406,7 +394,7 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `events` | array | List of Sentry events | | `events` | array | List of Sentry events |
| ↳ `id` | string | User 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 | | ↳ `groupID` | string | Issue group ID |
@@ -417,39 +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 |
| ↳ `email` | string | User email |
| ↳ `username` | string | Username |
| ↳ `ipAddress` | string | IP address |
| ↳ `name` | string | SDK 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 |
| ↳ `key` | string | Tag key |
| ↳ `value` | string | Error message or 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 | Type of error \(e.g., TypeError\) | | ↳ `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 |
| ↳ `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 |
| ↳ `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`
@@ -469,47 +449,39 @@ Retrieve detailed information about a specific Sentry event by its ID. Returns c
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `event` | object | Detailed information about the Sentry event | | `event` | object | Detailed information about the Sentry event |
| ↳ `id` | string | User 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 |
| ↳ `email` | string | User email | | ↳ `tags` | array | Tags associated with the event |
| ↳ `username` | string | Username | | ↳ `key` | string | Tag key |
| ↳ `ipAddress` | string | IP address | | ↳ `value` | string | Tag value |
| ↳ `name` | string | SDK name | | ↳ `contexts` | object | Additional context data \(device, OS, browser, etc.\) |
| ↳ `tags` | array | Tags associated with the event | | ↳ `platform` | string | Platform where the event occurred |
| ↳ `key` | string | Tag key | | ↳ `type` | string | Event type \(error, transaction, etc.\) |
| ↳ `value` | string | Tag value | | ↳ `metadata` | object | Error metadata |
| ↳ `key` | string | Tag key | | ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
| ↳ `value` | string | Error message or value | | ↳ `value` | string | Error message or value |
| ↳ `contexts` | object | Additional context data \(device, OS, browser, etc.\) | | ↳ `function` | string | Function where the error occurred |
| ↳ `platform` | string | Platform where the event occurred | | ↳ `entries` | array | Event entries including exception, breadcrumbs, and request data |
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) | | ↳ `errors` | array | Processing errors that occurred |
| ↳ `metadata` | object | Error metadata | | ↳ `dist` | string | Distribution identifier |
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) | | ↳ `fingerprints` | array | Fingerprints used for grouping events |
| ↳ `value` | string | Error message or value | | ↳ `sdk` | object | SDK information |
| ↳ `function` | string | Function where the error occurred | | ↳ `name` | string | SDK name |
| ↳ `function` | string | Function where the error occurred | | ↳ `version` | string | SDK version |
| ↳ `entries` | array | Event entries including exception, breadcrumbs, and request data |
| ↳ `errors` | array | Processing errors that occurred |
| ↳ `dist` | string | Distribution identifier |
| ↳ `fingerprints` | array | Fingerprints used for grouping events |
| ↳ `sdk` | object | SDK information |
| ↳ `name` | string | SDK name |
| ↳ `version` | string | SDK version |
| ↳ `version` | string | SDK version |
### `sentry_releases_list` ### `sentry_releases_list`
@@ -531,61 +503,49 @@ List releases for a Sentry organization or project. Returns release details incl
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `releases` | array | List of Sentry releases | | `releases` | array | List of Sentry releases |
| ↳ `id` | string | Project ID | | ↳ `id` | string | Unique release ID |
| ↳ `version` | object | Version details | | ↳ `version` | string | Release version identifier |
| ↳ `raw` | string | Raw version string |
| ↳ `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 \(e.g., GitHub release page\) | | ↳ `url` | string | URL to the release \(e.g., GitHub release page\) |
| ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) | | ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) |
| ↳ `dateCreated` | string | Commit timestamp | | ↳ `dateCreated` | string | When the release was created \(ISO timestamp\) |
| ↳ `dateStarted` | string | Deploy start 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 |
| ↳ `name` | string | Project name |
| ↳ `email` | string | Author 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 |
| ↳ `message` | string | Commit message |
| ↳ `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 |
| ↳ `environment` | string | Deploy environment |
| ↳ `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 |
| ↳ `slug` | string | Project slug |
| ↳ `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 |
| ↳ `raw` | string | Raw version string | | ↳ `package` | string | Package name |
| ↳ `package` | string | Package name |
| ↳ `buildHash` | string | Build hash |
| ↳ `raw` | string | Raw version string |
| ↳ `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`
@@ -609,58 +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 | Project ID | | ↳ `id` | string | Unique release ID |
| ↳ `version` | object | Version details | | ↳ `version` | string | Release version identifier |
| ↳ `raw` | string | Raw version string | | ↳ `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 | Commit timestamp | | ↳ `dateStarted` | string | When the release started \(ISO timestamp\) |
| ↳ `dateStarted` | string | Deploy start 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 |
| ↳ `name` | string | Project name | | ↳ `id` | string | Commit SHA |
| ↳ `email` | string | Author email | | ↳ `message` | string | Commit message |
| ↳ `lastCommit` | object | Last commit in the release | | ↳ `dateCreated` | string | Commit timestamp |
| ↳ `id` | string | Commit SHA | | ↳ `lastDeploy` | object | Last deploy of the release |
| ↳ `message` | string | Commit message | | ↳ `id` | string | Deploy ID |
| ↳ `dateCreated` | string | Commit timestamp | | ↳ `environment` | string | Deploy environment |
| ↳ `message` | string | Commit message | | ↳ `dateStarted` | string | Deploy start timestamp |
| ↳ `lastDeploy` | object | Last deploy of the release | | ↳ `dateFinished` | string | Deploy finish timestamp |
| ↳ `id` | string | Deploy ID | | ↳ `authors` | array | Authors of commits in the release |
| ↳ `environment` | string | Deploy environment | | ↳ `id` | string | Author ID |
| ↳ `dateStarted` | string | Deploy start timestamp | | ↳ `name` | string | Author name |
| ↳ `dateFinished` | string | Deploy finish timestamp | | ↳ `email` | string | Author email |
| ↳ `environment` | string | Deploy environment | | ↳ `projects` | array | Projects associated with this release |
| ↳ `dateFinished` | string | Deploy finish timestamp | | ↳ `id` | string | Project ID |
| ↳ `authors` | array | Authors of commits in the release | | ↳ `name` | string | Project name |
| ↳ `id` | string | Author ID | | ↳ `slug` | string | Project slug |
| ↳ `name` | string | Author name | | ↳ `platform` | string | Project platform |
| ↳ `email` | string | Author email | | ↳ `firstEvent` | string | First event timestamp |
| ↳ `projects` | array | Projects associated with this release | | ↳ `lastEvent` | string | Last event timestamp |
| ↳ `id` | string | Project ID | | ↳ `versionInfo` | object | Version metadata |
| ↳ `name` | string | Project name | | ↳ `buildHash` | string | Build hash |
| ↳ `slug` | string | Project slug | | ↳ `version` | object | Version details |
| ↳ `platform` | string | Project platform | | ↳ `raw` | string | Raw version string |
| ↳ `slug` | string | Project slug | | ↳ `package` | string | Package name |
| ↳ `platform` | string | Project platform |
| ↳ `firstEvent` | string | First event timestamp |
| ↳ `lastEvent` | string | Last event timestamp |
| ↳ `versionInfo` | object | Version metadata |
| ↳ `buildHash` | string | Build hash |
| ↳ `version` | object | Version details |
| ↳ `raw` | string | Raw version string |
| ↳ `raw` | string | Raw version string |
| ↳ `package` | string | Package name |
| ↳ `buildHash` | string | Build hash |
| ↳ `raw` | string | Raw version string |
| ↳ `package` | string | Package name |
### `sentry_releases_deploy` ### `sentry_releases_deploy`
@@ -684,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\) |

View File

@@ -35,7 +35,7 @@ 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
@@ -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\) |

View File

@@ -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`
@@ -79,34 +79,28 @@ 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 | | ↳ `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 |
| ↳ `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 |
| `pages` | array | List of SharePoint pages | | `pages` | array | List of SharePoint pages |
| ↳ `page` | object | The unique ID of the page | | ↳ `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 |
| ↳ `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 |
| ↳ `id` | string | The unique ID of the page | | ↳ `content` | object | Extracted text content from the page |
| ↳ `name` | string | The name of the page | | ↳ `content` | string | Extracted text content from the page |
| ↳ `title` | string | The title of the page | | ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure |
| ↳ `webUrl` | string | The URL to access the page | | `content` | object | Content of the SharePoint 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` | 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`
@@ -125,20 +119,18 @@ List details of all SharePoint sites
| 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 |
| ↳ `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 |
| ↳ `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 |
@@ -168,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`
@@ -193,15 +185,14 @@ Get metadata (and optionally columns/items) for a SharePoint list
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `list` | object | Information about the SharePoint list | | `list` | object | Information about the SharePoint list |
| ↳ `id` | string | Item ID | | ↳ `id` | string | The unique ID of the list |
| ↳ `displayName` | string | The display name of the list | | ↳ `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 |
| ↳ `fields` | object | Field values for the item |
| `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`
@@ -223,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`
@@ -244,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`

View File

@@ -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 |

View 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 sites performance, or surface actionable market research—all integrated directly into your workflows and automations. Empower your agents to access and utilize reliable web analytics data easily and programmatically.
{/* MANUAL-CONTENT-END */}
## Usage Instructions
Access comprehensive website analytics including traffic estimates, engagement metrics, rankings, and traffic sources using the Similarweb API.
## Tools
### `similarweb_website_overview`
Get comprehensive website analytics including traffic, rankings, engagement, and traffic sources
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | SimilarWeb API key |
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `siteName` | string | Website name |
| `description` | string | Website description |
| `globalRank` | number | Global traffic rank |
| `countryRank` | number | Country traffic rank |
| `categoryRank` | number | Category traffic rank |
| `category` | string | Website category |
| `monthlyVisits` | number | Estimated monthly visits |
| `engagementVisitDuration` | number | Average visit duration in seconds |
| `engagementPagesPerVisit` | number | Average pages per visit |
| `engagementBounceRate` | number | Bounce rate \(0-1\) |
| `topCountries` | array | Top countries by traffic share |
| ↳ `country` | string | Country code |
| ↳ `share` | number | Traffic share \(0-1\) |
| `trafficSources` | json | Traffic source breakdown |
| ↳ `direct` | number | Direct traffic share |
| ↳ `referrals` | number | Referral traffic share |
| ↳ `search` | number | Search traffic share |
| ↳ `social` | number | Social traffic share |
| ↳ `mail` | number | Email traffic share |
| ↳ `paidReferrals` | number | Paid referral traffic share |
### `similarweb_traffic_visits`
Get total website visits over time (desktop and mobile combined)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | SimilarWeb API key |
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
| `startDate` | string | No | Start date in YYYY-MM format |
| `endDate` | string | No | End date in YYYY-MM format |
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `domain` | string | Analyzed domain |
| `country` | string | Country filter applied |
| `granularity` | string | Data granularity |
| `lastUpdated` | string | Data last updated timestamp |
| `visits` | array | Visit data over time |
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
| ↳ `visits` | number | Number of visits |
### `similarweb_bounce_rate`
Get website bounce rate over time (desktop and mobile combined)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | SimilarWeb API key |
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
| `startDate` | string | No | Start date in YYYY-MM format |
| `endDate` | string | No | End date in YYYY-MM format |
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `domain` | string | Analyzed domain |
| `country` | string | Country filter applied |
| `granularity` | string | Data granularity |
| `lastUpdated` | string | Data last updated timestamp |
| `bounceRate` | array | Bounce rate data over time |
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
| ↳ `bounceRate` | number | Bounce rate \(0-1\) |
### `similarweb_pages_per_visit`
Get average pages per visit over time (desktop and mobile combined)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | SimilarWeb API key |
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
| `startDate` | string | No | Start date in YYYY-MM format |
| `endDate` | string | No | End date in YYYY-MM format |
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `domain` | string | Analyzed domain |
| `country` | string | Country filter applied |
| `granularity` | string | Data granularity |
| `lastUpdated` | string | Data last updated timestamp |
| `pagesPerVisit` | array | Pages per visit data over time |
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
| ↳ `pagesPerVisit` | number | Average pages per visit |
### `similarweb_visit_duration`
Get average desktop visit duration over time (in seconds)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | SimilarWeb API key |
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
| `startDate` | string | No | Start date in YYYY-MM format |
| `endDate` | string | No | End date in YYYY-MM format |
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `domain` | string | Analyzed domain |
| `country` | string | Country filter applied |
| `granularity` | string | Data granularity |
| `lastUpdated` | string | Data last updated timestamp |
| `averageVisitDuration` | array | Desktop visit duration data over time |
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
| ↳ `durationSeconds` | number | Average visit duration in seconds |

View File

@@ -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\) |
@@ -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`
@@ -146,51 +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 | Edit timestamp | | ↳ `ts` | string | Message timestamp \(unique identifier\) |
| ↳ `text` | string | Message text content | | ↳ `text` | string | Message text content |
| ↳ `user` | string | User ID who edited | | ↳ `user` | string | User ID who sent the message |
| ↳ `bot_id` | string | Bot ID if sent by a bot | | ↳ `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 |
| ↳ `name` | string | File name | | ↳ `name` | string | Emoji name \(without colons\) |
| ↳ `count` | number | Number of reactions | | ↳ `count` | number | Number of times this reaction was added |
| ↳ `users` | array | Array of user IDs who reacted | | ↳ `users` | array | Array of user IDs who reacted |
| ↳ `is_starred` | boolean | Whether message is starred | | ↳ `files` | array | Files attached to the message |
| ↳ `pinned_to` | array | Array of channel IDs where message is pinned | | ↳ `id` | string | Unique file identifier |
| ↳ `files` | array | Array of files attached to message | | ↳ `name` | string | File name |
| ↳ `id` | string | File ID | | ↳ `mimetype` | string | MIME type of the file |
| ↳ `name` | string | File name | | ↳ `size` | number | File size in bytes |
| ↳ `mimetype` | string | MIME type | | ↳ `url_private` | string | Private download URL \(requires auth\) |
| ↳ `size` | number | File size in bytes | | ↳ `permalink` | string | Permanent link to the file |
| ↳ `url_private` | string | Private download URL | | ↳ `mode` | string | File mode \(hosted, external, etc.\) |
| ↳ `permalink` | string | Permanent link to file | | ↳ `attachments` | array | Legacy attachments on the message |
| ↳ `mode` | string | File mode | | ↳ `id` | number | Attachment ID |
| ↳ `id` | string | File ID | | ↳ `fallback` | string | Plain text summary |
| ↳ `mimetype` | string | MIME type | | ↳ `text` | string | Main attachment text |
| ↳ `size` | number | File size in bytes | | ↳ `pretext` | string | Text shown before attachment |
| ↳ `url_private` | string | Private download URL | | ↳ `color` | string | Color bar hex code or preset |
| ↳ `permalink` | string | Permanent link to message | | ↳ `author_name` | string | Author display name |
| ↳ `mode` | string | File mode | | ↳ `author_link` | string | Author link URL |
| ↳ `attachments` | array | Array of legacy attachments | | ↳ `author_icon` | string | Author icon URL |
| ↳ `blocks` | array | Array of Block Kit blocks | | ↳ `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 |
### `slack_get_message` ### `slack_get_message`
@@ -210,46 +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 | Edit timestamp | | ↳ `ts` | string | Message timestamp \(unique identifier\) |
| ↳ `text` | string | Message text content | | ↳ `text` | string | Message text content |
| ↳ `user` | string | User ID who edited | | ↳ `user` | string | User ID who sent the message |
| ↳ `bot_id` | string | Bot ID if sent by a bot | | ↳ `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 |
| ↳ `name` | string | File name | | ↳ `pinned_to` | array | Channel IDs where message is pinned |
| ↳ `count` | number | Number of reactions | | ↳ `permalink` | string | Permanent URL to the message |
| ↳ `users` | array | 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 | Channel IDs where message is pinned | | ↳ `count` | number | Number of times this reaction was added |
| ↳ `files` | array | 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\) |
| ↳ `id` | string | File ID | | ↳ `permalink` | string | Permanent link to the file |
| ↳ `mimetype` | string | MIME type | | ↳ `mode` | string | File mode \(hosted, external, etc.\) |
| ↳ `size` | number | File size in bytes | | ↳ `attachments` | array | Legacy attachments on the message |
| ↳ `url_private` | string | Private download URL | | ↳ `id` | number | Attachment ID |
| ↳ `permalink` | string | Permanent link to message | | ↳ `fallback` | string | Plain text summary |
| ↳ `attachments` | array | Legacy attachments | | ↳ `text` | string | Main attachment text |
| ↳ `blocks` | array | Block Kit blocks | | ↳ `pretext` | string | Text shown before attachment |
| ↳ `edited` | object | Edit information if message was edited | | ↳ `color` | string | Color bar hex code or preset |
| ↳ `user` | string | User ID who edited | | ↳ `author_name` | string | Author display name |
| ↳ `ts` | string | Edit timestamp | | ↳ `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`
@@ -270,37 +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 |
| ↳ `name` | string | File name |
| ↳ `count` | number | Number of reactions |
| ↳ `users` | array | User IDs who reacted |
| ↳ `files` | array | Files attached to the parent message |
| ↳ `id` | string | File ID |
| ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type |
| ↳ `size` | number | File size in bytes |
| ↳ `id` | string | File ID |
| ↳ `mimetype` | string | MIME type |
| ↳ `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\) |
@@ -325,14 +535,20 @@ List all channels in a Slack workspace. Returns public and private channels the
| `channels` | array | Array of channel objects from the workspace | | `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 |
@@ -408,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`
@@ -475,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`
@@ -500,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`
@@ -523,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 |

File diff suppressed because it is too large Load Diff

View File

@@ -79,16 +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 |
| ↳ `type` | string | Type of action performed | | ↳ `action` | string | Description of the action taken \(e.g., "click the submit button"\) |
| ↳ `params` | object | Parameters used for the action | | ↳ `instruction` | string | Instruction that triggered this action |
| ↳ `result` | object | Result of the 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

View File

@@ -74,6 +74,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 |
@@ -101,6 +106,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 |
@@ -160,11 +170,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`

View File

@@ -282,9 +282,24 @@ Introspect Supabase database schema to get table structures, columns, and relati
| ↳ `name` | string | Table name | | ↳ `name` | string | Table name |
| ↳ `schema` | string | Database schema name | | ↳ `schema` | string | Database schema name |
| ↳ `columns` | array | Array of column definitions | | ↳ `columns` | array | Array of column definitions |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Column data type |
| ↳ `nullable` | boolean | Whether the column allows null values |
| ↳ `default` | string | Default value for the column |
| ↳ `isPrimaryKey` | boolean | Whether the column is a primary key |
| ↳ `isForeignKey` | boolean | Whether the column is a foreign key |
| ↳ `references` | object | Foreign key reference details |
| ↳ `table` | string | Referenced table name |
| ↳ `column` | string | Referenced column name |
| ↳ `primaryKey` | array | Array of primary key column names | | ↳ `primaryKey` | array | Array of primary key column names |
| ↳ `foreignKeys` | array | Array of foreign key relationships | | ↳ `foreignKeys` | array | Array of foreign key relationships |
| ↳ `column` | string | Local column name |
| ↳ `referencesTable` | string | Referenced table name |
| ↳ `referencesColumn` | string | Referenced column name |
| ↳ `indexes` | array | Array of index definitions | | ↳ `indexes` | array | Array of index definitions |
| ↳ `name` | string | Index name |
| ↳ `columns` | array | Columns included in the index |
| ↳ `unique` | boolean | Whether the index enforces uniqueness |
| `schemas` | array | List of schemas found in the database | | `schemas` | array | List of schemas found in the database |
### `supabase_storage_upload` ### `supabase_storage_upload`
@@ -299,7 +314,7 @@ Upload a file to a Supabase storage bucket
| `bucket` | string | Yes | The name of the storage bucket | | `bucket` | string | Yes | The name of the storage bucket |
| `fileName` | string | Yes | The name of the file \(e.g., "document.pdf", "image.jpg"\) | | `fileName` | string | Yes | The name of the file \(e.g., "document.pdf", "image.jpg"\) |
| `path` | string | No | Optional folder path \(e.g., "folder/subfolder/"\) | | `path` | string | No | Optional folder path \(e.g., "folder/subfolder/"\) |
| `fileContent` | string | Yes | The file content \(base64 encoded for binary files, or plain text\) | | `fileData` | json | Yes | File to upload - UserFile object \(basic mode\) or string content \(advanced mode: base64 or plain text\). Supports data URLs. |
| `contentType` | string | No | MIME type of the file \(e.g., "image/jpeg", "text/plain"\) | | `contentType` | string | No | MIME type of the file \(e.g., "image/jpeg", "text/plain"\) |
| `upsert` | boolean | No | If true, overwrites existing file \(default: false\) | | `upsert` | boolean | No | If true, overwrites existing file \(default: false\) |
| `apiKey` | string | Yes | Your Supabase service role secret key | | `apiKey` | string | Yes | Your Supabase service role secret key |
@@ -309,7 +324,10 @@ Upload a file to a Supabase storage bucket
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | object | Upload result including file path and metadata | | `results` | object | Upload result including file path, bucket, and public URL |
| ↳ `id` | string | Unique identifier for the uploaded file |
| ↳ `path` | string | Path to the uploaded file within the bucket |
| ↳ `fullPath` | string | Full path including bucket name |
### `supabase_storage_download` ### `supabase_storage_download`
@@ -355,6 +373,19 @@ List files in a Supabase storage bucket
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | array | Array of file objects with metadata | | `results` | array | Array of file objects with metadata |
| ↳ `id` | string | Unique file identifier |
| ↳ `name` | string | File name |
| ↳ `bucket_id` | string | Bucket identifier the file belongs to |
| ↳ `owner` | string | Owner identifier |
| ↳ `created_at` | string | File creation timestamp |
| ↳ `updated_at` | string | Last update timestamp |
| ↳ `last_accessed_at` | string | Last access timestamp |
| ↳ `metadata` | object | File metadata including size and MIME type |
| ↳ `size` | number | File size in bytes |
| ↳ `mimetype` | string | MIME type of the file |
| ↳ `cacheControl` | string | Cache control header value |
| ↳ `lastModified` | string | Last modified timestamp |
| ↳ `eTag` | string | Entity tag for caching |
### `supabase_storage_delete` ### `supabase_storage_delete`
@@ -375,6 +406,13 @@ Delete files from a Supabase storage bucket
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | array | Array of deleted file objects | | `results` | array | Array of deleted file objects |
| ↳ `name` | string | Name of the deleted file |
| ↳ `bucket_id` | string | Bucket identifier |
| ↳ `owner` | string | Owner identifier |
| ↳ `id` | string | Unique file identifier |
| ↳ `updated_at` | string | Last update timestamp |
| ↳ `created_at` | string | File creation timestamp |
| ↳ `last_accessed_at` | string | Last access timestamp |
### `supabase_storage_move` ### `supabase_storage_move`
@@ -396,6 +434,7 @@ Move a file within a Supabase storage bucket
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | object | Move operation result | | `results` | object | Move operation result |
| ↳ `message` | string | Operation status message |
### `supabase_storage_copy` ### `supabase_storage_copy`
@@ -417,6 +456,7 @@ Copy a file within a Supabase storage bucket
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | object | Copy operation result | | `results` | object | Copy operation result |
| ↳ `message` | string | Operation status message |
### `supabase_storage_create_bucket` ### `supabase_storage_create_bucket`
@@ -439,6 +479,7 @@ Create a new storage bucket in Supabase
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | object | Created bucket information | | `results` | object | Created bucket information |
| ↳ `name` | string | Created bucket name |
### `supabase_storage_list_buckets` ### `supabase_storage_list_buckets`
@@ -457,6 +498,14 @@ List all storage buckets in Supabase
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | array | Array of bucket objects | | `results` | array | Array of bucket objects |
| ↳ `id` | string | Unique bucket identifier |
| ↳ `name` | string | Bucket name |
| ↳ `owner` | string | Owner identifier |
| ↳ `public` | boolean | Whether the bucket is publicly accessible |
| ↳ `created_at` | string | Bucket creation timestamp |
| ↳ `updated_at` | string | Last update timestamp |
| ↳ `file_size_limit` | number | Maximum file size allowed in bytes |
| ↳ `allowed_mime_types` | array | List of allowed MIME types for uploads |
### `supabase_storage_delete_bucket` ### `supabase_storage_delete_bucket`
@@ -476,6 +525,7 @@ Delete a storage bucket in Supabase
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | object | Delete operation result | | `results` | object | Delete operation result |
| ↳ `message` | string | Operation status message |
### `supabase_storage_get_public_url` ### `supabase_storage_get_public_url`

View File

@@ -65,9 +65,17 @@ Perform AI-powered web searches using Tavily
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `query` | string | The search query that was executed | | `query` | string | The search query that was executed |
| `results` | array | Search results with titles, URLs, content snippets, and optional metadata | | `results` | array | Ranked search results with titles, URLs, content snippets, and optional metadata |
| ↳ `title` | string | Result title |
| ↳ `url` | string | Result URL |
| ↳ `content` | string | Brief description or content snippet |
| ↳ `score` | number | Relevance score |
| ↳ `raw_content` | string | Full parsed HTML content \(if requested\) |
| ↳ `favicon` | string | Favicon URL for the domain |
| `answer` | string | LLM-generated answer to the query \(if requested\) | | `answer` | string | LLM-generated answer to the query \(if requested\) |
| `images` | array | Query-related images \(if requested\) | | `images` | array | Query-related images \(if requested\) |
| ↳ `url` | string | Image URL |
| ↳ `description` | string | Image description |
| `auto_parameters` | object | Automatically selected parameters based on query intent \(if enabled\) | | `auto_parameters` | object | Automatically selected parameters based on query intent \(if enabled\) |
| `response_time` | number | Time taken for the search request in seconds | | `response_time` | number | Time taken for the search request in seconds |
@@ -90,13 +98,14 @@ Extract raw content from multiple web pages simultaneously using Tavily
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `results` | array | The URL that was extracted | | `results` | array | Successfully extracted content from URLs |
| ↳ `url` | string | The URL that was extracted | | ↳ `url` | string | The source URL |
| ↳ `raw_content` | string | The raw text content from the webpage | | ↳ `raw_content` | string | Full extracted content from the page |
| ↳ `favicon` | string | Favicon URL \(if requested\) | | ↳ `images` | array | Image URLs \(when include_images is true\) |
| `failed_results` | array | The URL that failed extraction | | ↳ `favicon` | string | Favicon URL for the result |
| `failed_results` | array | URLs that failed to extract content |
| ↳ `url` | string | The URL that failed extraction | | ↳ `url` | string | The URL that failed extraction |
| ↳ `error` | string | Error message for the failed extraction | | ↳ `error` | string | Error message describing why extraction failed |
| `response_time` | number | Time taken for the extraction request in seconds | | `response_time` | number | Time taken for the extraction request in seconds |
### `tavily_crawl` ### `tavily_crawl`
@@ -128,10 +137,10 @@ Systematically crawl and extract content from websites using Tavily
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `base_url` | string | The base URL that was crawled | | `base_url` | string | The base URL that was crawled |
| `results` | array | The crawled page URL | | `results` | array | Array of crawled pages with extracted content |
| ↳ `url` | string | The crawled page URL | | ↳ `url` | string | The crawled page URL |
| ↳ `raw_content` | string | Extracted content from the page | | ↳ `raw_content` | string | Full extracted page content |
| ↳ `favicon` | string | Favicon URL \(if requested\) | | ↳ `favicon` | string | Favicon URL for the result |
| `response_time` | number | Time taken for the crawl request in seconds | | `response_time` | number | Time taken for the crawl request in seconds |
| `request_id` | string | Unique identifier for support reference | | `request_id` | string | Unique identifier for support reference |
@@ -160,7 +169,7 @@ Discover and visualize website structure using Tavily
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `base_url` | string | The base URL that was mapped | | `base_url` | string | The base URL that was mapped |
| `results` | array | Discovered URL | | `results` | array | Array of discovered URLs during mapping |
| ↳ `url` | string | Discovered URL | | ↳ `url` | string | Discovered URL |
| `response_time` | number | Time taken for the map request in seconds | | `response_time` | number | Time taken for the map request in seconds |
| `request_id` | string | Unique identifier for support reference | | `request_id` | string | Unique identifier for support reference |

View File

@@ -76,24 +76,19 @@ Send messages to Telegram channels or users through the Telegram Bot API. Enable
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Telegram message data | | `data` | object | Telegram message data |
| ↳ `message_id` | number | Unique Telegram message identifier | | ↳ `message_id` | number | Unique Telegram message identifier |
| ↳ `from` | object | Chat information | | ↳ `from` | object | Chat information |
| ↳ `id` | number | Chat ID | | ↳ `id` | number | Chat ID |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `is_bot` | boolean | Whether the chat is a bot or not |
| ↳ `first_name` | string | Chat username \(if available\) | | ↳ `first_name` | string | Chat username \(if available\) |
| ↳ `username` | string | Chat title \(for groups and channels\) | | ↳ `username` | string | Chat title \(for groups and channels\) |
| ↳ `id` | number | Bot user ID | | ↳ `chat` | object | Information about the bot that sent the message |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `id` | number | Bot user ID |
| ↳ `first_name` | string | Bot first name | | ↳ `first_name` | string | Bot first name |
| ↳ `username` | string | Bot username | | ↳ `username` | string | Bot username |
| ↳ `chat` | object | Information about the bot that sent the message | | ↳ `type` | string | chat type private or channel |
| ↳ `id` | number | Bot user ID | | ↳ `date` | number | Unix timestamp when message was sent |
| ↳ `first_name` | string | Bot first name | | ↳ `text` | string | Text content of the sent message |
| ↳ `username` | string | Bot username |
| ↳ `type` | string | chat type private or channel |
| ↳ `type` | string | chat type private or channel |
| ↳ `date` | number | Unix timestamp when message was sent |
| ↳ `text` | string | Text content of the sent message |
### `telegram_delete_message` ### `telegram_delete_message`
@@ -113,8 +108,8 @@ Delete messages in Telegram channels or chats through the Telegram Bot API. Requ
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Delete operation result | | `data` | object | Delete operation result |
| ↳ `ok` | boolean | API response success status | | ↳ `ok` | boolean | API response success status |
| ↳ `deleted` | boolean | Whether the message was successfully deleted | | ↳ `deleted` | boolean | Whether the message was successfully deleted |
### `telegram_send_photo` ### `telegram_send_photo`
@@ -135,35 +130,25 @@ Send photos to Telegram channels or users through the Telegram Bot API.
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Telegram message data including optional photo\(s\) | | `data` | object | Telegram message data including optional photo\(s\) |
| ↳ `message_id` | number | Unique Telegram message identifier | | ↳ `message_id` | number | Unique Telegram message identifier |
| ↳ `from` | object | Chat information | | ↳ `from` | object | Chat information |
| ↳ `id` | number | Chat ID | | ↳ `id` | number | Chat ID |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `is_bot` | boolean | Whether the chat is a bot or not |
| ↳ `first_name` | string | Chat username \(if available\) | | ↳ `first_name` | string | Chat username \(if available\) |
| ↳ `username` | string | Chat title \(for groups and channels\) | | ↳ `username` | string | Chat title \(for groups and channels\) |
| ↳ `id` | number | Bot user ID | | ↳ `chat` | object | Information about the bot that sent the message |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `id` | number | Bot user ID |
| ↳ `first_name` | string | Bot first name | | ↳ `first_name` | string | Bot first name |
| ↳ `username` | string | Bot username | | ↳ `username` | string | Bot username |
| ↳ `chat` | object | Information about the bot that sent the message | | ↳ `type` | string | Chat type \(private, group, supergroup, channel\) |
| ↳ `id` | number | Bot user ID | | ↳ `date` | number | Unix timestamp when message was sent |
| ↳ `first_name` | string | Bot first name | | ↳ `text` | string | Text content of the sent message \(if applicable\) |
| ↳ `username` | string | Bot username | | ↳ `photo` | array | List of photos included in the message |
| ↳ `type` | string | Chat type \(private, group, supergroup, channel\) | | ↳ `file_id` | string | Unique file ID of the photo |
| ↳ `type` | string | Chat type \(private, group, supergroup, channel\) | | ↳ `file_unique_id` | string | Unique identifier for this file across different bots |
| ↳ `date` | number | Unix timestamp when message was sent | | ↳ `file_size` | number | Size of the photo file in bytes |
| ↳ `text` | string | Text content of the sent message \(if applicable\) | | ↳ `width` | number | Photo width in pixels |
| ↳ `photo` | array | List of photos included in the message | | ↳ `height` | number | Photo height in pixels |
| ↳ `file_id` | string | Unique file ID of the photo |
| ↳ `file_unique_id` | string | Unique identifier for this file across different bots |
| ↳ `file_size` | number | Size of the photo file in bytes |
| ↳ `width` | number | Photo width in pixels |
| ↳ `height` | number | Photo height in pixels |
| ↳ `file_id` | string | Unique file ID of the photo |
| ↳ `file_unique_id` | string | Unique identifier for this file across different bots |
| ↳ `file_size` | number | Size of the photo file in bytes |
| ↳ `width` | number | Photo width in pixels |
| ↳ `height` | number | Photo height in pixels |
### `telegram_send_video` ### `telegram_send_video`
@@ -184,85 +169,58 @@ Send videos to Telegram channels or users through the Telegram Bot API.
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Telegram message data including optional media | | `data` | object | Telegram message data including optional media |
| ↳ `message_id` | number | Unique Telegram message identifier | | ↳ `message_id` | number | Unique Telegram message identifier |
| ↳ `from` | object | Information about the sender | | ↳ `from` | object | Information about the sender |
| ↳ `id` | number | Sender ID | | ↳ `id` | number | Sender ID |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `is_bot` | boolean | Whether the chat is a bot or not |
| ↳ `first_name` | string | Sender | | ↳ `first_name` | string | Sender's first name \(if available\) |
| ↳ `username` | string | Sender | | ↳ `username` | string | Sender's username \(if available\) |
| ↳ `id` | number | Chat ID | | ↳ `chat` | object | Information about the chat where message was sent |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `id` | number | Chat ID |
| ↳ `first_name` | string | Chat first name \(if private chat\) | | ↳ `first_name` | string | Chat first name \(if private chat\) |
| ↳ `username` | string | Chat username \(for private or channels\) | | ↳ `username` | string | Chat username \(for private or channels\) |
| ↳ `chat` | object | Information about the chat where message was sent | | ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
| ↳ `id` | number | Chat ID | | ↳ `date` | number | Unix timestamp when the message was sent |
| ↳ `first_name` | string | Chat first name \(if private chat\) | | ↳ `text` | string | Text content of the sent message \(if applicable\) |
| ↳ `username` | string | Chat username \(for private or channels\) | | ↳ `format` | object | Media format information \(for videos, GIFs, etc.\) |
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | | ↳ `file_name` | string | Media file name |
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | | ↳ `mime_type` | string | Media MIME type |
| ↳ `date` | number | Unix timestamp when the message was sent | | ↳ `duration` | number | Duration of media in seconds |
| ↳ `text` | string | Text content of the sent message \(if applicable\) | | ↳ `width` | number | Media width in pixels |
| ↳ `format` | object | Media format information \(for videos, GIFs, etc.\) | | ↳ `height` | number | Media height in pixels |
| ↳ `file_name` | string | Media file name | | ↳ `thumbnail` | object | Thumbnail image details |
| ↳ `mime_type` | string | Media MIME type | | ↳ `file_id` | string | Thumbnail file ID |
| ↳ `duration` | number | Duration of media in seconds | | ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `width` | number | Thumbnail width in pixels | | ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `height` | number | Thumbnail height in pixels | | ↳ `width` | number | Thumbnail width in pixels |
| ↳ `thumbnail` | object | Thumbnail image details | | ↳ `height` | number | Thumbnail height in pixels |
| ↳ `file_id` | string | Thumbnail file ID | | ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier | | ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_size` | number | Thumbnail file size in bytes | | ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `width` | number | Thumbnail width in pixels | | ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `height` | number | Thumbnail height in pixels | | ↳ `width` | number | Thumbnail width in pixels |
| ↳ `file_id` | string | Media file ID | | ↳ `height` | number | Thumbnail height in pixels |
| ↳ `file_unique_id` | string | Unique media file identifier | | ↳ `file_id` | string | Media file ID |
| ↳ `file_size` | number | Size of media file in bytes | | ↳ `file_unique_id` | string | Unique media file identifier |
| ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) | | ↳ `file_size` | number | Size of media file in bytes |
| ↳ `file_id` | string | Thumbnail file ID | | ↳ `document` | object | Document file details if the message contains a document |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier | | ↳ `file_name` | string | Document file name |
| ↳ `file_size` | number | Thumbnail file size in bytes | | ↳ `mime_type` | string | Document MIME type |
| ↳ `width` | number | Thumbnail width in pixels | | ↳ `thumbnail` | object | Document thumbnail information |
| ↳ `height` | number | Thumbnail height in pixels | | ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_name` | string | Document file name | | ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `mime_type` | string | Document MIME type | | ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `duration` | number | Duration of media in seconds | | ↳ `width` | number | Thumbnail width in pixels |
| ↳ `width` | number | Thumbnail width in pixels | | ↳ `height` | number | Thumbnail height in pixels |
| ↳ `height` | number | Thumbnail height in pixels | | ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) |
| ↳ `thumbnail` | object | Document thumbnail information | | ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_id` | string | Thumbnail file ID | | ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier | | ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `file_size` | number | Thumbnail file size in bytes | | ↳ `width` | number | Thumbnail width in pixels |
| ↳ `width` | number | Thumbnail width in pixels | | ↳ `height` | number | Thumbnail height in pixels |
| ↳ `height` | number | Thumbnail height in pixels | | ↳ `file_id` | string | Document file ID |
| ↳ `file_id` | string | Document file ID | | ↳ `file_unique_id` | string | Unique document file identifier |
| ↳ `file_unique_id` | string | Unique document file identifier | | ↳ `file_size` | number | Size of document file in bytes |
| ↳ `file_size` | number | Size of document file in bytes |
| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) |
| ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `width` | number | Thumbnail width in pixels |
| ↳ `height` | number | Thumbnail height in pixels |
| ↳ `document` | object | Document file details if the message contains a document |
| ↳ `file_name` | string | Document file name |
| ↳ `mime_type` | string | Document MIME type |
| ↳ `thumbnail` | object | Document thumbnail information |
| ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `width` | number | Thumbnail width in pixels |
| ↳ `height` | number | Thumbnail height in pixels |
| ↳ `file_id` | string | Document file ID |
| ↳ `file_unique_id` | string | Unique document file identifier |
| ↳ `file_size` | number | Size of document file in bytes |
| ↳ `width` | number | Thumbnail width in pixels |
| ↳ `height` | number | Thumbnail height in pixels |
| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) |
| ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `width` | number | Thumbnail width in pixels |
| ↳ `height` | number | Thumbnail height in pixels |
### `telegram_send_audio` ### `telegram_send_audio`
@@ -283,41 +241,28 @@ Send audio files to Telegram channels or users through the Telegram Bot API.
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Telegram message data including voice/audio information | | `data` | object | Telegram message data including voice/audio information |
| ↳ `message_id` | number | Unique Telegram message identifier | | ↳ `message_id` | number | Unique Telegram message identifier |
| ↳ `from` | object | Information about the sender | | ↳ `from` | object | Information about the sender |
| ↳ `id` | number | Sender ID | | ↳ `id` | number | Sender ID |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `is_bot` | boolean | Whether the chat is a bot or not |
| ↳ `first_name` | string | Sender | | ↳ `first_name` | string | Sender's first name \(if available\) |
| ↳ `username` | string | Sender | | ↳ `username` | string | Sender's username \(if available\) |
| ↳ `id` | number | Chat ID | | ↳ `chat` | object | Information about the chat where the message was sent |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `id` | number | Chat ID |
| ↳ `first_name` | string | Chat first name \(if private chat\) | | ↳ `first_name` | string | Chat first name \(if private chat\) |
| ↳ `username` | string | Chat username \(for private or channels\) | | ↳ `username` | string | Chat username \(for private or channels\) |
| ↳ `chat` | object | Information about the chat where the message was sent | | ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
| ↳ `id` | number | Chat ID | | ↳ `date` | number | Unix timestamp when the message was sent |
| ↳ `first_name` | string | Chat first name \(if private chat\) | | ↳ `text` | string | Text content of the sent message \(if applicable\) |
| ↳ `username` | string | Chat username \(for private or channels\) | | ↳ `audio` | object | Audio file details |
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | | ↳ `duration` | number | Duration of the audio in seconds |
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | | ↳ `performer` | string | Performer of the audio |
| ↳ `date` | number | Unix timestamp when the message was sent | | ↳ `title` | string | Title of the audio |
| ↳ `text` | string | Text content of the sent message \(if applicable\) | | ↳ `file_name` | string | Original filename of the audio |
| ↳ `audio` | object | Audio file details | | ↳ `mime_type` | string | MIME type of the audio file |
| ↳ `duration` | number | Duration of the audio in seconds | | ↳ `file_id` | string | Unique file identifier for this audio |
| ↳ `performer` | string | Performer of the audio | | ↳ `file_unique_id` | string | Unique identifier across different bots for this file |
| ↳ `title` | string | Title of the audio | | ↳ `file_size` | number | Size of the audio file in bytes |
| ↳ `file_name` | string | Original filename of the audio |
| ↳ `mime_type` | string | MIME type of the audio file |
| ↳ `file_id` | string | Unique file identifier for this audio |
| ↳ `file_unique_id` | string | Unique identifier across different bots for this file |
| ↳ `file_size` | number | Size of the audio file in bytes |
| ↳ `duration` | number | Duration of the audio in seconds |
| ↳ `performer` | string | Performer of the audio |
| ↳ `title` | string | Title of the audio |
| ↳ `file_name` | string | Original filename of the audio |
| ↳ `mime_type` | string | MIME type of the audio file |
| ↳ `file_id` | string | Unique file identifier for this audio |
| ↳ `file_unique_id` | string | Unique identifier across different bots for this file |
| ↳ `file_size` | number | Size of the audio file in bytes |
### `telegram_send_animation` ### `telegram_send_animation`
@@ -338,85 +283,58 @@ Send animations (GIFs) to Telegram channels or users through the Telegram Bot AP
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Telegram message data including optional media | | `data` | object | Telegram message data including optional media |
| ↳ `message_id` | number | Unique Telegram message identifier | | ↳ `message_id` | number | Unique Telegram message identifier |
| ↳ `from` | object | Information about the sender | | ↳ `from` | object | Information about the sender |
| ↳ `id` | number | Sender ID | | ↳ `id` | number | Sender ID |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `is_bot` | boolean | Whether the chat is a bot or not |
| ↳ `first_name` | string | Sender | | ↳ `first_name` | string | Sender's first name \(if available\) |
| ↳ `username` | string | Sender | | ↳ `username` | string | Sender's username \(if available\) |
| ↳ `id` | number | Chat ID | | ↳ `chat` | object | Information about the chat where message was sent |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `id` | number | Chat ID |
| ↳ `first_name` | string | Chat first name \(if private chat\) | | ↳ `first_name` | string | Chat first name \(if private chat\) |
| ↳ `username` | string | Chat username \(for private or channels\) | | ↳ `username` | string | Chat username \(for private or channels\) |
| ↳ `chat` | object | Information about the chat where message was sent | | ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
| ↳ `id` | number | Chat ID | | ↳ `date` | number | Unix timestamp when the message was sent |
| ↳ `first_name` | string | Chat first name \(if private chat\) | | ↳ `text` | string | Text content of the sent message \(if applicable\) |
| ↳ `username` | string | Chat username \(for private or channels\) | | ↳ `format` | object | Media format information \(for videos, GIFs, etc.\) |
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | | ↳ `file_name` | string | Media file name |
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | | ↳ `mime_type` | string | Media MIME type |
| ↳ `date` | number | Unix timestamp when the message was sent | | ↳ `duration` | number | Duration of media in seconds |
| ↳ `text` | string | Text content of the sent message \(if applicable\) | | ↳ `width` | number | Media width in pixels |
| ↳ `format` | object | Media format information \(for videos, GIFs, etc.\) | | ↳ `height` | number | Media height in pixels |
| ↳ `file_name` | string | Media file name | | ↳ `thumbnail` | object | Thumbnail image details |
| ↳ `mime_type` | string | Media MIME type | | ↳ `file_id` | string | Thumbnail file ID |
| ↳ `duration` | number | Duration of media in seconds | | ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `width` | number | Thumbnail width in pixels | | ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `height` | number | Thumbnail height in pixels | | ↳ `width` | number | Thumbnail width in pixels |
| ↳ `thumbnail` | object | Thumbnail image details | | ↳ `height` | number | Thumbnail height in pixels |
| ↳ `file_id` | string | Thumbnail file ID | | ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier | | ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_size` | number | Thumbnail file size in bytes | | ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `width` | number | Thumbnail width in pixels | | ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `height` | number | Thumbnail height in pixels | | ↳ `width` | number | Thumbnail width in pixels |
| ↳ `file_id` | string | Media file ID | | ↳ `height` | number | Thumbnail height in pixels |
| ↳ `file_unique_id` | string | Unique media file identifier | | ↳ `file_id` | string | Media file ID |
| ↳ `file_size` | number | Size of media file in bytes | | ↳ `file_unique_id` | string | Unique media file identifier |
| ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) | | ↳ `file_size` | number | Size of media file in bytes |
| ↳ `file_id` | string | Thumbnail file ID | | ↳ `document` | object | Document file details if the message contains a document |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier | | ↳ `file_name` | string | Document file name |
| ↳ `file_size` | number | Thumbnail file size in bytes | | ↳ `mime_type` | string | Document MIME type |
| ↳ `width` | number | Thumbnail width in pixels | | ↳ `thumbnail` | object | Document thumbnail information |
| ↳ `height` | number | Thumbnail height in pixels | | ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_name` | string | Document file name | | ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `mime_type` | string | Document MIME type | | ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `duration` | number | Duration of media in seconds | | ↳ `width` | number | Thumbnail width in pixels |
| ↳ `width` | number | Thumbnail width in pixels | | ↳ `height` | number | Thumbnail height in pixels |
| ↳ `height` | number | Thumbnail height in pixels | | ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) |
| ↳ `thumbnail` | object | Document thumbnail information | | ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_id` | string | Thumbnail file ID | | ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier | | ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `file_size` | number | Thumbnail file size in bytes | | ↳ `width` | number | Thumbnail width in pixels |
| ↳ `width` | number | Thumbnail width in pixels | | ↳ `height` | number | Thumbnail height in pixels |
| ↳ `height` | number | Thumbnail height in pixels | | ↳ `file_id` | string | Document file ID |
| ↳ `file_id` | string | Document file ID | | ↳ `file_unique_id` | string | Unique document file identifier |
| ↳ `file_unique_id` | string | Unique document file identifier | | ↳ `file_size` | number | Size of document file in bytes |
| ↳ `file_size` | number | Size of document file in bytes |
| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) |
| ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `width` | number | Thumbnail width in pixels |
| ↳ `height` | number | Thumbnail height in pixels |
| ↳ `document` | object | Document file details if the message contains a document |
| ↳ `file_name` | string | Document file name |
| ↳ `mime_type` | string | Document MIME type |
| ↳ `thumbnail` | object | Document thumbnail information |
| ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `width` | number | Thumbnail width in pixels |
| ↳ `height` | number | Thumbnail height in pixels |
| ↳ `file_id` | string | Document file ID |
| ↳ `file_unique_id` | string | Unique document file identifier |
| ↳ `file_size` | number | Size of document file in bytes |
| ↳ `width` | number | Thumbnail width in pixels |
| ↳ `height` | number | Thumbnail height in pixels |
| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) |
| ↳ `file_id` | string | Thumbnail file ID |
| ↳ `file_unique_id` | string | Unique thumbnail file identifier |
| ↳ `file_size` | number | Thumbnail file size in bytes |
| ↳ `width` | number | Thumbnail width in pixels |
| ↳ `height` | number | Thumbnail height in pixels |
### `telegram_send_document` ### `telegram_send_document`
@@ -437,33 +355,23 @@ Send documents (PDF, ZIP, DOC, etc.) to Telegram channels or users through the T
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Telegram message data including document | | `data` | object | Telegram message data including document |
| ↳ `message_id` | number | Unique Telegram message identifier | | ↳ `message_id` | number | Unique Telegram message identifier |
| ↳ `from` | object | Information about the sender | | ↳ `from` | object | Information about the sender |
| ↳ `id` | number | Sender ID | | ↳ `id` | number | Sender ID |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `is_bot` | boolean | Whether the chat is a bot or not |
| ↳ `first_name` | string | Sender | | ↳ `first_name` | string | Sender's first name \(if available\) |
| ↳ `username` | string | Sender | | ↳ `username` | string | Sender's username \(if available\) |
| ↳ `id` | number | Chat ID | | ↳ `chat` | object | Information about the chat where message was sent |
| ↳ `is_bot` | boolean | Whether the chat is a bot or not | | ↳ `id` | number | Chat ID |
| ↳ `first_name` | string | Chat first name \(if private chat\) | | ↳ `first_name` | string | Chat first name \(if private chat\) |
| ↳ `username` | string | Chat username \(for private or channels\) | | ↳ `username` | string | Chat username \(for private or channels\) |
| ↳ `chat` | object | Information about the chat where message was sent | | ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) |
| ↳ `id` | number | Chat ID | | ↳ `date` | number | Unix timestamp when the message was sent |
| ↳ `first_name` | string | Chat first name \(if private chat\) | | ↳ `document` | object | Document file details |
| ↳ `username` | string | Chat username \(for private or channels\) | | ↳ `file_name` | string | Document file name |
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | | ↳ `mime_type` | string | Document MIME type |
| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | | ↳ `file_id` | string | Document file ID |
| ↳ `date` | number | Unix timestamp when the message was sent | | ↳ `file_unique_id` | string | Unique document file identifier |
| ↳ `document` | object | Document file details | | ↳ `file_size` | number | Size of document file in bytes |
| ↳ `file_name` | string | Document file name |
| ↳ `mime_type` | string | Document MIME type |
| ↳ `file_id` | string | Document file ID |
| ↳ `file_unique_id` | string | Unique document file identifier |
| ↳ `file_size` | number | Size of document file in bytes |
| ↳ `file_name` | string | Document file name |
| ↳ `mime_type` | string | Document MIME type |
| ↳ `file_id` | string | Document file ID |
| ↳ `file_unique_id` | string | Unique document file identifier |
| ↳ `file_size` | number | Size of document file in bytes |

View File

@@ -63,44 +63,22 @@ Parse documents using AWS Textract OCR and document analysis
| `blocks` | array | Array of Block objects containing detected text, tables, forms, and other elements | | `blocks` | array | Array of Block objects containing detected text, tables, forms, and other elements |
| ↳ `BlockType` | string | Type of block \(PAGE, LINE, WORD, TABLE, CELL, KEY_VALUE_SET, etc.\) | | ↳ `BlockType` | string | Type of block \(PAGE, LINE, WORD, TABLE, CELL, KEY_VALUE_SET, etc.\) |
| ↳ `Id` | string | Unique identifier for the block | | ↳ `Id` | string | Unique identifier for the block |
| ↳ `Text` | string | Query text | | ↳ `Text` | string | The text content \(for LINE and WORD blocks\) |
| ↳ `TextType` | string | Type of text \(PRINTED or HANDWRITING\) | | ↳ `TextType` | string | Type of text \(PRINTED or HANDWRITING\) |
| ↳ `Confidence` | number | Confidence score \(0-100\) | | ↳ `Confidence` | number | Confidence score \(0-100\) |
| ↳ `Page` | number | Page number | | ↳ `Page` | number | Page number |
| ↳ `Geometry` | object | Location and bounding box information | | ↳ `Geometry` | object | Location and bounding box information |
| ↳ `BoundingBox` | object | Height as ratio of document height | | ↳ `BoundingBox` | object | Height as ratio of document height |
| ↳ `Height` | number | Height as ratio of document height | | ↳ `Height` | number | Height as ratio of document height |
| ↳ `Left` | number | Left position as ratio of document width | | ↳ `Left` | number | Left position as ratio of document width |
| ↳ `Top` | number | Top position as ratio of document height | | ↳ `Top` | number | Top position as ratio of document height |
| ↳ `Width` | number | Width as ratio of document width | | ↳ `Width` | number | Width as ratio of document width |
| ↳ `Height` | number | Height as ratio of document height | | ↳ `Polygon` | array | Polygon coordinates |
| ↳ `Left` | number | Left position as ratio of document width | | ↳ `X` | number | X coordinate |
| ↳ `Top` | number | Top position as ratio of document height | | ↳ `Y` | number | Y coordinate |
| ↳ `Width` | number | Width as ratio of document width |
| ↳ `Polygon` | array | Polygon coordinates |
| ↳ `X` | number | X coordinate |
| ↳ `Y` | number | Y coordinate |
| ↳ `X` | number | X coordinate |
| ↳ `Y` | number | Y coordinate |
| ↳ `BoundingBox` | object | Height as ratio of document height |
| ↳ `Height` | number | Height as ratio of document height |
| ↳ `Left` | number | Left position as ratio of document width |
| ↳ `Top` | number | Top position as ratio of document height |
| ↳ `Width` | number | Width as ratio of document width |
| ↳ `Height` | number | Height as ratio of document height |
| ↳ `Left` | number | Left position as ratio of document width |
| ↳ `Top` | number | Top position as ratio of document height |
| ↳ `Width` | number | Width as ratio of document width |
| ↳ `Polygon` | array | Polygon coordinates |
| ↳ `X` | number | X coordinate |
| ↳ `Y` | number | Y coordinate |
| ↳ `X` | number | X coordinate |
| ↳ `Y` | number | Y coordinate |
| ↳ `Relationships` | array | Relationships to other blocks | | ↳ `Relationships` | array | Relationships to other blocks |
| ↳ `Type` | string | Relationship type \(CHILD, VALUE, ANSWER, etc.\) | | ↳ `Type` | string | Relationship type \(CHILD, VALUE, ANSWER, etc.\) |
| ↳ `Ids` | array | IDs of related blocks | | ↳ `Ids` | array | IDs of related blocks |
| ↳ `Type` | string | Relationship type \(CHILD, VALUE, ANSWER, etc.\) |
| ↳ `Ids` | array | IDs of related blocks |
| ↳ `EntityTypes` | array | Entity types for KEY_VALUE_SET \(KEY or VALUE\) | | ↳ `EntityTypes` | array | Entity types for KEY_VALUE_SET \(KEY or VALUE\) |
| ↳ `SelectionStatus` | string | For checkboxes: SELECTED or NOT_SELECTED | | ↳ `SelectionStatus` | string | For checkboxes: SELECTED or NOT_SELECTED |
| ↳ `RowIndex` | number | Row index for table cells | | ↳ `RowIndex` | number | Row index for table cells |
@@ -108,13 +86,11 @@ Parse documents using AWS Textract OCR and document analysis
| ↳ `RowSpan` | number | Row span for merged cells | | ↳ `RowSpan` | number | Row span for merged cells |
| ↳ `ColumnSpan` | number | Column span for merged cells | | ↳ `ColumnSpan` | number | Column span for merged cells |
| ↳ `Query` | object | Query information for QUERY blocks | | ↳ `Query` | object | Query information for QUERY blocks |
| ↳ `Text` | string | Query text | | ↳ `Text` | string | Query text |
| ↳ `Alias` | string | Query alias | | ↳ `Alias` | string | Query alias |
| ↳ `Pages` | array | Pages to search | | ↳ `Pages` | array | Pages to search |
| ↳ `Alias` | string | Query alias |
| ↳ `Pages` | array | Pages to search |
| `documentMetadata` | object | Metadata about the analyzed document | | `documentMetadata` | object | Metadata about the analyzed document |
| ↳ `pages` | number | Number of pages in the document | | ↳ `pages` | number | Number of pages in the document |
| `modelVersion` | string | Version of the Textract model used for processing | | `modelVersion` | string | Version of the Textract model used for processing |

View File

@@ -102,25 +102,19 @@ Retrieve insights and analytics for Typeform forms
| ↳ `type` | string | Field type \(e.g., short_text, multiple_choice\) | | ↳ `type` | string | Field type \(e.g., short_text, multiple_choice\) |
| ↳ `views` | number | Number of times this field was viewed | | ↳ `views` | number | Number of times this field was viewed |
| `form` | object | Average completion time for this platform | | `form` | object | Average completion time for this platform |
| ↳ `platforms` | array | Average completion time for this platform | | ↳ `platforms` | array | Average completion time for this platform |
| ↳ `average_time` | number | Average completion time for this platform | | ↳ `average_time` | number | Average completion time for this platform |
| ↳ `completion_rate` | number | Completion rate for this platform | | ↳ `completion_rate` | number | Completion rate for this platform |
| ↳ `platform` | string | Platform name \(e.g., desktop, mobile\) | | ↳ `platform` | string | Platform name \(e.g., desktop, mobile\) |
| ↳ `responses_count` | number | Number of responses from this platform | | ↳ `responses_count` | number | Number of responses from this platform |
| ↳ `total_visits` | number | Total visits from this platform | | ↳ `total_visits` | number | Total visits from this platform |
| ↳ `unique_visits` | number | Unique visits from this platform | | ↳ `unique_visits` | number | Unique visits from this platform |
| ↳ `average_time` | number | Overall average completion time | | ↳ `summary` | object | Overall average completion time |
| ↳ `completion_rate` | number | Overall completion rate | | ↳ `average_time` | number | Overall average completion time |
| ↳ `platform` | string | Platform name \(e.g., desktop, mobile\) | | ↳ `completion_rate` | number | Overall completion rate |
| ↳ `responses_count` | number | Total number of responses | | ↳ `responses_count` | number | Total number of responses |
| ↳ `total_visits` | number | Total number of visits | | ↳ `total_visits` | number | Total number of visits |
| ↳ `unique_visits` | number | Total number of unique visits | | ↳ `unique_visits` | number | Total number of unique visits |
| ↳ `summary` | object | Overall average completion time |
| ↳ `average_time` | number | Overall average completion time |
| ↳ `completion_rate` | number | Overall completion rate |
| ↳ `responses_count` | number | Total number of responses |
| ↳ `total_visits` | number | Total number of visits |
| ↳ `unique_visits` | number | Total number of unique visits |
### `typeform_list_forms` ### `typeform_list_forms`

View File

@@ -55,8 +55,8 @@ Process and analyze images using advanced vision models. Capable of understandin
| `model` | string | The vision model that was used for analysis | | `model` | string | The vision model that was used for analysis |
| `tokens` | number | Total tokens used for the analysis | | `tokens` | number | Total tokens used for the analysis |
| `usage` | object | Detailed token usage breakdown | | `usage` | object | Detailed token usage breakdown |
| ↳ `input_tokens` | number | Tokens used for input processing | | ↳ `input_tokens` | number | Tokens used for input processing |
| ↳ `output_tokens` | number | Tokens used for response generation | | ↳ `output_tokens` | number | Tokens used for response generation |
| ↳ `total_tokens` | number | Total tokens consumed | | ↳ `total_tokens` | number | Total tokens consumed |

View File

@@ -50,15 +50,12 @@ Read content from a Wealthbox note
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Note data and metadata | | `output` | object | Note data and metadata |
| ↳ `content` | string | Formatted note information | | ↳ `content` | string | Formatted note information |
| ↳ `note` | object | Raw note data from Wealthbox | | ↳ `note` | object | Raw note data from Wealthbox |
| ↳ `metadata` | object | Operation metadata | | ↳ `metadata` | object | Operation metadata |
| ↳ `itemId` | string | ID of the note | | ↳ `itemId` | string | ID of the note |
| ↳ `noteId` | string | ID of the note | | ↳ `noteId` | string | ID of the note |
| ↳ `itemType` | string | Type of item \(note\) | | ↳ `itemType` | string | Type of item \(note\) |
| ↳ `itemId` | string | ID of the note |
| ↳ `noteId` | string | ID of the note |
| ↳ `itemType` | string | Type of item \(note\) |
### `wealthbox_write_note` ### `wealthbox_write_note`
@@ -77,15 +74,12 @@ Create or update a Wealthbox note
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created or updated note data and metadata | | `output` | object | Created or updated note data and metadata |
| ↳ `note` | object | Raw note data from Wealthbox | | ↳ `note` | object | Raw note data from Wealthbox |
| ↳ `success` | boolean | Operation success indicator | | ↳ `success` | boolean | Operation success indicator |
| ↳ `metadata` | object | Operation metadata | | ↳ `metadata` | object | Operation metadata |
| ↳ `itemId` | string | ID of the created/updated note | | ↳ `itemId` | string | ID of the created/updated note |
| ↳ `noteId` | string | ID of the created/updated note | | ↳ `noteId` | string | ID of the created/updated note |
| ↳ `itemType` | string | Type of item \(note\) | | ↳ `itemType` | string | Type of item \(note\) |
| ↳ `itemId` | string | ID of the created/updated note |
| ↳ `noteId` | string | ID of the created/updated note |
| ↳ `itemType` | string | Type of item \(note\) |
### `wealthbox_read_contact` ### `wealthbox_read_contact`
@@ -103,15 +97,12 @@ Read content from a Wealthbox contact
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Contact data and metadata | | `output` | object | Contact data and metadata |
| ↳ `content` | string | Formatted contact information | | ↳ `content` | string | Formatted contact information |
| ↳ `contact` | object | Raw contact data from Wealthbox | | ↳ `contact` | object | Raw contact data from Wealthbox |
| ↳ `metadata` | object | Operation metadata | | ↳ `metadata` | object | Operation metadata |
| ↳ `itemId` | string | ID of the contact | | ↳ `itemId` | string | ID of the contact |
| ↳ `contactId` | string | ID of the contact | | ↳ `contactId` | string | ID of the contact |
| ↳ `itemType` | string | Type of item \(contact\) | | ↳ `itemType` | string | Type of item \(contact\) |
| ↳ `itemId` | string | ID of the contact |
| ↳ `contactId` | string | ID of the contact |
| ↳ `itemType` | string | Type of item \(contact\) |
### `wealthbox_write_contact` ### `wealthbox_write_contact`
@@ -132,15 +123,12 @@ Create a new Wealthbox contact
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created or updated contact data and metadata | | `output` | object | Created or updated contact data and metadata |
| ↳ `contact` | object | Raw contact data from Wealthbox | | ↳ `contact` | object | Raw contact data from Wealthbox |
| ↳ `success` | boolean | Operation success indicator | | ↳ `success` | boolean | Operation success indicator |
| ↳ `metadata` | object | Operation metadata | | ↳ `metadata` | object | Operation metadata |
| ↳ `itemId` | string | ID of the created/updated contact | | ↳ `itemId` | string | ID of the created/updated contact |
| ↳ `contactId` | string | ID of the created/updated contact | | ↳ `contactId` | string | ID of the created/updated contact |
| ↳ `itemType` | string | Type of item \(contact\) | | ↳ `itemType` | string | Type of item \(contact\) |
| ↳ `itemId` | string | ID of the created/updated contact |
| ↳ `contactId` | string | ID of the created/updated contact |
| ↳ `itemType` | string | Type of item \(contact\) |
### `wealthbox_read_task` ### `wealthbox_read_task`
@@ -158,15 +146,12 @@ Read content from a Wealthbox task
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Task data and metadata | | `output` | object | Task data and metadata |
| ↳ `content` | string | Formatted task information | | ↳ `content` | string | Formatted task information |
| ↳ `task` | object | Raw task data from Wealthbox | | ↳ `task` | object | Raw task data from Wealthbox |
| ↳ `metadata` | object | Operation metadata | | ↳ `metadata` | object | Operation metadata |
| ↳ `itemId` | string | ID of the task | | ↳ `itemId` | string | ID of the task |
| ↳ `taskId` | string | ID of the task | | ↳ `taskId` | string | ID of the task |
| ↳ `itemType` | string | Type of item \(task\) | | ↳ `itemType` | string | Type of item \(task\) |
| ↳ `itemId` | string | ID of the task |
| ↳ `taskId` | string | ID of the task |
| ↳ `itemType` | string | Type of item \(task\) |
### `wealthbox_write_task` ### `wealthbox_write_task`
@@ -187,14 +172,11 @@ Create or update a Wealthbox task
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created or updated task data and metadata | | `output` | object | Created or updated task data and metadata |
| ↳ `task` | object | Raw task data from Wealthbox | | ↳ `task` | object | Raw task data from Wealthbox |
| ↳ `success` | boolean | Operation success indicator | | ↳ `success` | boolean | Operation success indicator |
| ↳ `metadata` | object | Operation metadata | | ↳ `metadata` | object | Operation metadata |
| ↳ `itemId` | string | ID of the created/updated task | | ↳ `itemId` | string | ID of the created/updated task |
| ↳ `taskId` | string | ID of the created/updated task | | ↳ `taskId` | string | ID of the created/updated task |
| ↳ `itemType` | string | Type of item \(task\) | | ↳ `itemType` | string | Type of item \(task\) |
| ↳ `itemId` | string | ID of the created/updated task |
| ↳ `taskId` | string | ID of the created/updated task |
| ↳ `itemType` | string | Type of item \(task\) |

Some files were not shown because too many files have changed in this diff Show More